Compute Engine v1 API - Class RoutersClientImpl (2.7.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

GoogleCloudGoogle.Cloud.ComputeV1

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
NameDescription
grpcClientRoutersRoutersClient

The underlying gRPC client.

settingsRoutersSettings

The base RoutersSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override Routers.RoutersClient GrpcClient { get; }

The underlying gRPC Routers client

Property Value
TypeDescription
RoutersRoutersClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
TypeDescription
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
TypeDescription
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.

Parameters
NameDescription
requestAggregatedListRoutersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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.

Parameters
NameDescription
requestAggregatedListRoutersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestDeleteRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestDeleteRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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. Gets a list of available routers by making a list() request.

Parameters
NameDescription
requestGetRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Router

The RPC response.

Overrides

GetAsync(GetRouterRequest, CallSettings)

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

Returns the specified Router resource. Gets a list of available routers by making a list() request.

Parameters
NameDescription
requestGetRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskRouter

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
NameDescription
requestGetNatMappingInfoRoutersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetNatMappingInfoRoutersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetRouterStatusRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetRouterStatusRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestInsertRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestInsertRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestListRoutersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestListRoutersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestPatchRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestPatchRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestPreviewRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestPreviewRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestUpdateRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestUpdateRouterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Overrides