Compute Engine v1 API - Class RoutersClientImpl (3.0.0) 

public sealed class RoutersClientImpl : RoutersClient

Reference documentation and code samples for the Compute Engine v1 API class RoutersClientImpl.

Routers client wrapper implementation, for convenient use.

Inheritance

object > RoutersClient > RoutersClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

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 RoutersRoutersClient

The underlying gRPC client.
settings RoutersSettings

The base RoutersSettings used within this client.
logger ILogger

Optional 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
Overrides

GrpcClient

public override Routers.RoutersClient GrpcClient { get; }

The underlying gRPC Routers client

Property Value
Type Description
RoutersRoutersClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type Description
OperationsClient
Overrides

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
Type Description
OperationsClient
Overrides

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 AggregatedListRoutersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableRouterAggregatedListKeyValuePairstringRoutersScopedList

A pageable sequence of KeyValuePair<TKey, TValue> resources.
Overrides

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 AggregatedListRoutersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableRouterAggregatedListKeyValuePairstringRoutersScopedList

A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.
Overrides

Delete(DeleteRouterRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteRouterRequest request, CallSettings callSettings = null)

Deletes the specified Router resource.

Parameters
Name Description
request DeleteRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

DeleteAsync(DeleteRouterRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteRouterRequest request, CallSettings callSettings = null)

Deletes the specified Router resource.

Parameters
Name Description
request DeleteRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

Get(GetRouterRequest, CallSettings)

public override Router Get(GetRouterRequest request, CallSettings callSettings = null)

Returns the specified Router resource.

Parameters
Name Description
request GetRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Router

The RPC response.
Overrides

GetAsync(GetRouterRequest, CallSettings)

public override Task<Router> GetAsync(GetRouterRequest request, CallSettings callSettings = null)

Returns the specified Router resource.

Parameters
Name Description
request GetRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRouter

A Task containing the RPC response.
Overrides

GetNatIpInfo(GetNatIpInfoRouterRequest, CallSettings)

public override NatIpInfoResponse GetNatIpInfo(GetNatIpInfoRouterRequest request, CallSettings callSettings = null)

Retrieves runtime NAT IP information.

Parameters
Name Description
request GetNatIpInfoRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
NatIpInfoResponse

The RPC response.
Overrides

GetNatIpInfoAsync(GetNatIpInfoRouterRequest, CallSettings)

public override Task<NatIpInfoResponse> GetNatIpInfoAsync(GetNatIpInfoRouterRequest request, CallSettings callSettings = null)

Retrieves runtime NAT IP information.

Parameters
Name Description
request GetNatIpInfoRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskNatIpInfoResponse

A Task containing the RPC response.
Overrides

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 GetNatMappingInfoRoutersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableVmEndpointNatMappingsListVmEndpointNatMappings

A pageable sequence of VmEndpointNatMappings resources.
Overrides

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 GetNatMappingInfoRoutersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableVmEndpointNatMappingsListVmEndpointNatMappings

A pageable asynchronous sequence of VmEndpointNatMappings resources.
Overrides

GetRouterStatus(GetRouterStatusRouterRequest, CallSettings)

public override RouterStatusResponse GetRouterStatus(GetRouterStatusRouterRequest request, CallSettings callSettings = null)

Retrieves runtime information of the specified router.

Parameters
Name Description
request GetRouterStatusRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RouterStatusResponse

The RPC response.
Overrides

GetRouterStatusAsync(GetRouterStatusRouterRequest, CallSettings)

public override Task<RouterStatusResponse> GetRouterStatusAsync(GetRouterStatusRouterRequest request, CallSettings callSettings = null)

Retrieves runtime information of the specified router.

Parameters
Name Description
request GetRouterStatusRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRouterStatusResponse

A Task containing the RPC response.
Overrides

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 InsertRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

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 InsertRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

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 ListRoutersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableRouterListRouter

A pageable sequence of Router resources.
Overrides

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 ListRoutersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableRouterListRouter

A pageable asynchronous sequence of Router resources.
Overrides

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 PatchRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

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 PatchRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

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 PreviewRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RoutersPreviewResponse

The RPC response.
Overrides

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 PreviewRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRoutersPreviewResponse

A Task containing the RPC response.
Overrides

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 UpdateRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

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 UpdateRouterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides