public sealed class RoutersClientImpl : RoutersClientReference documentation and code samples for the Compute Engine v1 API class RoutersClientImpl.
Routers client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Compute.V1Assembly
Google.Cloud.Compute.V1.dll
Remarks
The Routers API.
Constructors
RoutersClientImpl(RoutersClient, RoutersSettings, ILogger)
public RoutersClientImpl(Routers.RoutersClient grpcClient, RoutersSettings settings, ILogger logger)Constructs a client wrapper for the Routers service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient |
RoutersRoutersClientThe underlying gRPC client. |
settings |
RoutersSettingsThe base RoutersSettings used within this client. |
logger |
ILoggerOptional ILogger to use within this client. |
Properties
DeleteOperationsClient
public override OperationsClient DeleteOperationsClient { get; }The long-running operations client for Delete.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
DeleteRoutePolicyOperationsClient
public override OperationsClient DeleteRoutePolicyOperationsClient { get; }The long-running operations client for DeleteRoutePolicy.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
GrpcClient
public override Routers.RoutersClient GrpcClient { get; }The underlying gRPC Routers client
| Property Value | |
|---|---|
| Type | Description |
RoutersRoutersClient |
|
InsertOperationsClient
public override OperationsClient InsertOperationsClient { get; }The long-running operations client for Insert.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
PatchOperationsClient
public override OperationsClient PatchOperationsClient { get; }The long-running operations client for Patch.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
PatchRoutePolicyOperationsClient
public override OperationsClient PatchRoutePolicyOperationsClient { get; }The long-running operations client for PatchRoutePolicy.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
UpdateOperationsClient
public override OperationsClient UpdateOperationsClient { get; }The long-running operations client for Update.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
UpdateRoutePolicyOperationsClient
public override OperationsClient UpdateRoutePolicyOperationsClient { get; }The long-running operations client for UpdateRoutePolicy.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
Methods
AggregatedList(AggregatedListRoutersRequest, CallSettings)
public override PagedEnumerable<RouterAggregatedList, KeyValuePair<string, RoutersScopedList>> AggregatedList(AggregatedListRoutersRequest request, CallSettings callSettings = null)Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
| Parameters | |
|---|---|
| Name | Description |
request |
AggregatedListRoutersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableRouterAggregatedListKeyValuePairstringRoutersScopedList |
A pageable sequence of KeyValuePair<TKey, TValue> resources. |
AggregatedListAsync(AggregatedListRoutersRequest, CallSettings)
public override PagedAsyncEnumerable<RouterAggregatedList, KeyValuePair<string, RoutersScopedList>> AggregatedListAsync(AggregatedListRoutersRequest request, CallSettings callSettings = null)Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
| Parameters | |
|---|---|
| Name | Description |
request |
AggregatedListRoutersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableRouterAggregatedListKeyValuePairstringRoutersScopedList |
A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources. |
Delete(DeleteRouterRequest, CallSettings)
public override Operation<Operation, Operation> Delete(DeleteRouterRequest request, CallSettings callSettings = null)Deletes the specified Router resource.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
DeleteAsync(DeleteRouterRequest, CallSettings)
public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteRouterRequest request, CallSettings callSettings = null)Deletes the specified Router resource.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
DeleteRoutePolicy(DeleteRoutePolicyRouterRequest, CallSettings)
public override Operation<Operation, Operation> DeleteRoutePolicy(DeleteRoutePolicyRouterRequest request, CallSettings callSettings = null)Deletes Route Policy
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteRoutePolicyRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
DeleteRoutePolicyAsync(DeleteRoutePolicyRouterRequest, CallSettings)
public override Task<Operation<Operation, Operation>> DeleteRoutePolicyAsync(DeleteRoutePolicyRouterRequest request, CallSettings callSettings = null)Deletes Route Policy
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteRoutePolicyRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
Get(GetRouterRequest, CallSettings)
public override Router Get(GetRouterRequest request, CallSettings callSettings = null)Returns the specified Router resource.
| Parameters | |
|---|---|
| Name | Description |
request |
GetRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Router |
The RPC response. |
GetAsync(GetRouterRequest, CallSettings)
public override Task<Router> GetAsync(GetRouterRequest request, CallSettings callSettings = null)Returns the specified Router resource.
| Parameters | |
|---|---|
| Name | Description |
request |
GetRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskRouter |
A Task containing the RPC response. |
GetNatIpInfo(GetNatIpInfoRouterRequest, CallSettings)
public override NatIpInfoResponse GetNatIpInfo(GetNatIpInfoRouterRequest request, CallSettings callSettings = null)Retrieves runtime NAT IP information.
| Parameters | |
|---|---|
| Name | Description |
request |
GetNatIpInfoRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
NatIpInfoResponse |
The RPC response. |
GetNatIpInfoAsync(GetNatIpInfoRouterRequest, CallSettings)
public override Task<NatIpInfoResponse> GetNatIpInfoAsync(GetNatIpInfoRouterRequest request, CallSettings callSettings = null)Retrieves runtime NAT IP information.
| Parameters | |
|---|---|
| Name | Description |
request |
GetNatIpInfoRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskNatIpInfoResponse |
A Task containing the RPC response. |
GetNatMappingInfo(GetNatMappingInfoRoutersRequest, CallSettings)
public override PagedEnumerable<VmEndpointNatMappingsList, VmEndpointNatMappings> GetNatMappingInfo(GetNatMappingInfoRoutersRequest request, CallSettings callSettings = null)Retrieves runtime Nat mapping information of VM endpoints.
| Parameters | |
|---|---|
| Name | Description |
request |
GetNatMappingInfoRoutersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableVmEndpointNatMappingsListVmEndpointNatMappings |
A pageable sequence of VmEndpointNatMappings resources. |
GetNatMappingInfoAsync(GetNatMappingInfoRoutersRequest, CallSettings)
public override PagedAsyncEnumerable<VmEndpointNatMappingsList, VmEndpointNatMappings> GetNatMappingInfoAsync(GetNatMappingInfoRoutersRequest request, CallSettings callSettings = null)Retrieves runtime Nat mapping information of VM endpoints.
| Parameters | |
|---|---|
| Name | Description |
request |
GetNatMappingInfoRoutersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableVmEndpointNatMappingsListVmEndpointNatMappings |
A pageable asynchronous sequence of VmEndpointNatMappings resources. |
GetRoutePolicy(GetRoutePolicyRouterRequest, CallSettings)
public override RoutersGetRoutePolicyResponse GetRoutePolicy(GetRoutePolicyRouterRequest request, CallSettings callSettings = null)Returns specified Route Policy
| Parameters | |
|---|---|
| Name | Description |
request |
GetRoutePolicyRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
RoutersGetRoutePolicyResponse |
The RPC response. |
GetRoutePolicyAsync(GetRoutePolicyRouterRequest, CallSettings)
public override Task<RoutersGetRoutePolicyResponse> GetRoutePolicyAsync(GetRoutePolicyRouterRequest request, CallSettings callSettings = null)Returns specified Route Policy
| Parameters | |
|---|---|
| Name | Description |
request |
GetRoutePolicyRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskRoutersGetRoutePolicyResponse |
A Task containing the RPC response. |
GetRouterStatus(GetRouterStatusRouterRequest, CallSettings)
public override RouterStatusResponse GetRouterStatus(GetRouterStatusRouterRequest request, CallSettings callSettings = null)Retrieves runtime information of the specified router.
| Parameters | |
|---|---|
| Name | Description |
request |
GetRouterStatusRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
RouterStatusResponse |
The RPC response. |
GetRouterStatusAsync(GetRouterStatusRouterRequest, CallSettings)
public override Task<RouterStatusResponse> GetRouterStatusAsync(GetRouterStatusRouterRequest request, CallSettings callSettings = null)Retrieves runtime information of the specified router.
| Parameters | |
|---|---|
| Name | Description |
request |
GetRouterStatusRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskRouterStatusResponse |
A Task containing the RPC response. |
Insert(InsertRouterRequest, CallSettings)
public override Operation<Operation, Operation> Insert(InsertRouterRequest request, CallSettings callSettings = null)Creates a Router resource in the specified project and region using the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request |
InsertRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
InsertAsync(InsertRouterRequest, CallSettings)
public override Task<Operation<Operation, Operation>> InsertAsync(InsertRouterRequest request, CallSettings callSettings = null)Creates a Router resource in the specified project and region using the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request |
InsertRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
List(ListRoutersRequest, CallSettings)
public override PagedEnumerable<RouterList, Router> List(ListRoutersRequest request, CallSettings callSettings = null)Retrieves a list of Router resources available to the specified project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListRoutersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableRouterListRouter |
A pageable sequence of Router resources. |
ListAsync(ListRoutersRequest, CallSettings)
public override PagedAsyncEnumerable<RouterList, Router> ListAsync(ListRoutersRequest request, CallSettings callSettings = null)Retrieves a list of Router resources available to the specified project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListRoutersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableRouterListRouter |
A pageable asynchronous sequence of Router resources. |
ListBgpRoutes(ListBgpRoutesRoutersRequest, CallSettings)
public override PagedEnumerable<RoutersListBgpRoutes, BgpRoute> ListBgpRoutes(ListBgpRoutesRoutersRequest request, CallSettings callSettings = null)Retrieves a list of router bgp routes available to the specified project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListBgpRoutesRoutersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableRoutersListBgpRoutesBgpRoute |
A pageable sequence of BgpRoute resources. |
ListBgpRoutesAsync(ListBgpRoutesRoutersRequest, CallSettings)
public override PagedAsyncEnumerable<RoutersListBgpRoutes, BgpRoute> ListBgpRoutesAsync(ListBgpRoutesRoutersRequest request, CallSettings callSettings = null)Retrieves a list of router bgp routes available to the specified project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListBgpRoutesRoutersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableRoutersListBgpRoutesBgpRoute |
A pageable asynchronous sequence of BgpRoute resources. |
ListRoutePolicies(ListRoutePoliciesRoutersRequest, CallSettings)
public override PagedEnumerable<RoutersListRoutePolicies, RoutePolicy> ListRoutePolicies(ListRoutePoliciesRoutersRequest request, CallSettings callSettings = null)Retrieves a list of router route policy subresources available to the specified project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListRoutePoliciesRoutersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableRoutersListRoutePoliciesRoutePolicy |
A pageable sequence of RoutePolicy resources. |
ListRoutePoliciesAsync(ListRoutePoliciesRoutersRequest, CallSettings)
public override PagedAsyncEnumerable<RoutersListRoutePolicies, RoutePolicy> ListRoutePoliciesAsync(ListRoutePoliciesRoutersRequest request, CallSettings callSettings = null)Retrieves a list of router route policy subresources available to the specified project.
| Parameters | |
|---|---|
| Name | Description |
request |
ListRoutePoliciesRoutersRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableRoutersListRoutePoliciesRoutePolicy |
A pageable asynchronous sequence of RoutePolicy resources. |
Patch(PatchRouterRequest, CallSettings)
public override Operation<Operation, Operation> Patch(PatchRouterRequest request, CallSettings callSettings = null)Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
| Parameters | |
|---|---|
| Name | Description |
request |
PatchRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
PatchAsync(PatchRouterRequest, CallSettings)
public override Task<Operation<Operation, Operation>> PatchAsync(PatchRouterRequest request, CallSettings callSettings = null)Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
| Parameters | |
|---|---|
| Name | Description |
request |
PatchRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
PatchRoutePolicy(PatchRoutePolicyRouterRequest, CallSettings)
public override Operation<Operation, Operation> PatchRoutePolicy(PatchRoutePolicyRouterRequest request, CallSettings callSettings = null)Patches Route Policy
| Parameters | |
|---|---|
| Name | Description |
request |
PatchRoutePolicyRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
PatchRoutePolicyAsync(PatchRoutePolicyRouterRequest, CallSettings)
public override Task<Operation<Operation, Operation>> PatchRoutePolicyAsync(PatchRoutePolicyRouterRequest request, CallSettings callSettings = null)Patches Route Policy
| Parameters | |
|---|---|
| Name | Description |
request |
PatchRoutePolicyRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
Preview(PreviewRouterRequest, CallSettings)
public override RoutersPreviewResponse Preview(PreviewRouterRequest request, CallSettings callSettings = null)Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.
| Parameters | |
|---|---|
| Name | Description |
request |
PreviewRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
RoutersPreviewResponse |
The RPC response. |
PreviewAsync(PreviewRouterRequest, CallSettings)
public override Task<RoutersPreviewResponse> PreviewAsync(PreviewRouterRequest request, CallSettings callSettings = null)Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.
| Parameters | |
|---|---|
| Name | Description |
request |
PreviewRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskRoutersPreviewResponse |
A Task containing the RPC response. |
Update(UpdateRouterRequest, CallSettings)
public override Operation<Operation, Operation> Update(UpdateRouterRequest request, CallSettings callSettings = null)Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
UpdateAsync(UpdateRouterRequest, CallSettings)
public override Task<Operation<Operation, Operation>> UpdateAsync(UpdateRouterRequest request, CallSettings callSettings = null)Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |
UpdateRoutePolicy(UpdateRoutePolicyRouterRequest, CallSettings)
public override Operation<Operation, Operation> UpdateRoutePolicy(UpdateRoutePolicyRouterRequest request, CallSettings callSettings = null)Updates or creates new Route Policy
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateRoutePolicyRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation |
The RPC response. |
UpdateRoutePolicyAsync(UpdateRoutePolicyRouterRequest, CallSettings)
public override Task<Operation<Operation, Operation>> UpdateRoutePolicyAsync(UpdateRoutePolicyRouterRequest request, CallSettings callSettings = null)Updates or creates new Route Policy
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateRoutePolicyRouterRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation |
A Task containing the RPC response. |