Compute Engine v1 API - Class RoutersClientImpl (2.17.0)

Version 2.17.0

• 3.2.0 (latest)
• 3.1.0
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.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

Inherited Members

RoutersClient.DefaultEndpoint

RoutersClient.DefaultScopes

RoutersClient.ServiceMetadata

RoutersClient.CreateAsync(CancellationToken)

RoutersClient.Create()

RoutersClient.ShutdownDefaultChannelsAsync()

RoutersClient.AggregatedList(string, string, int?, CallSettings)

RoutersClient.AggregatedListAsync(string, string, int?, CallSettings)

RoutersClient.DeleteAsync(DeleteRouterRequest, CancellationToken)

RoutersClient.PollOnceDelete(string, CallSettings)

RoutersClient.PollOnceDeleteAsync(string, CallSettings)

RoutersClient.Delete(string, string, string, CallSettings)

RoutersClient.DeleteAsync(string, string, string, CallSettings)

RoutersClient.DeleteAsync(string, string, string, CancellationToken)

RoutersClient.GetAsync(GetRouterRequest, CancellationToken)

RoutersClient.Get(string, string, string, CallSettings)

RoutersClient.GetAsync(string, string, string, CallSettings)

RoutersClient.GetAsync(string, string, string, CancellationToken)

RoutersClient.GetNatIpInfoAsync(GetNatIpInfoRouterRequest, CancellationToken)

RoutersClient.GetNatIpInfo(string, string, string, CallSettings)

RoutersClient.GetNatIpInfoAsync(string, string, string, CallSettings)

RoutersClient.GetNatIpInfoAsync(string, string, string, CancellationToken)

RoutersClient.GetNatMappingInfo(string, string, string, string, int?, CallSettings)

RoutersClient.GetNatMappingInfoAsync(string, string, string, string, int?, CallSettings)

RoutersClient.GetRouterStatusAsync(GetRouterStatusRouterRequest, CancellationToken)

RoutersClient.GetRouterStatus(string, string, string, CallSettings)

RoutersClient.GetRouterStatusAsync(string, string, string, CallSettings)

RoutersClient.GetRouterStatusAsync(string, string, string, CancellationToken)

RoutersClient.InsertAsync(InsertRouterRequest, CancellationToken)

RoutersClient.PollOnceInsert(string, CallSettings)

RoutersClient.PollOnceInsertAsync(string, CallSettings)

RoutersClient.Insert(string, string, Router, CallSettings)

RoutersClient.InsertAsync(string, string, Router, CallSettings)

RoutersClient.InsertAsync(string, string, Router, CancellationToken)

RoutersClient.List(string, string, string, int?, CallSettings)

RoutersClient.ListAsync(string, string, string, int?, CallSettings)

RoutersClient.PatchAsync(PatchRouterRequest, CancellationToken)

RoutersClient.PollOncePatch(string, CallSettings)

RoutersClient.PollOncePatchAsync(string, CallSettings)

RoutersClient.Patch(string, string, string, Router, CallSettings)

RoutersClient.PatchAsync(string, string, string, Router, CallSettings)

RoutersClient.PatchAsync(string, string, string, Router, CancellationToken)

RoutersClient.PreviewAsync(PreviewRouterRequest, CancellationToken)

RoutersClient.Preview(string, string, string, Router, CallSettings)

RoutersClient.PreviewAsync(string, string, string, Router, CallSettings)

RoutersClient.PreviewAsync(string, string, string, Router, CancellationToken)

RoutersClient.UpdateAsync(UpdateRouterRequest, CancellationToken)

RoutersClient.PollOnceUpdate(string, CallSettings)

RoutersClient.PollOnceUpdateAsync(string, CallSettings)

RoutersClient.Update(string, string, string, Router, CallSettings)

RoutersClient.UpdateAsync(string, string, string, Router, CallSettings)

RoutersClient.UpdateAsync(string, string, string, Router, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

RoutersClient.DeleteOperationsClient

GrpcClient

public override Routers.RoutersClient GrpcClient { get; }

The underlying gRPC Routers client

Property Value
Type	Description
RoutersRoutersClient

Overrides

RoutersClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

Overrides

RoutersClient.InsertOperationsClient

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type	Description
OperationsClient

Overrides

RoutersClient.PatchOperationsClient

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
Type	Description
OperationsClient

Overrides

RoutersClient.UpdateOperationsClient

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

RoutersClient.AggregatedList(AggregatedListRoutersRequest, CallSettings)

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

RoutersClient.AggregatedListAsync(AggregatedListRoutersRequest, CallSettings)

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

RoutersClient.Delete(DeleteRouterRequest, CallSettings)

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

RoutersClient.DeleteAsync(DeleteRouterRequest, CallSettings)

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

RoutersClient.Get(GetRouterRequest, CallSettings)

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

RoutersClient.GetAsync(GetRouterRequest, CallSettings)

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

RoutersClient.GetNatIpInfo(GetNatIpInfoRouterRequest, CallSettings)

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

RoutersClient.GetNatIpInfoAsync(GetNatIpInfoRouterRequest, CallSettings)

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

RoutersClient.GetNatMappingInfo(GetNatMappingInfoRoutersRequest, CallSettings)

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

RoutersClient.GetNatMappingInfoAsync(GetNatMappingInfoRoutersRequest, CallSettings)

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

RoutersClient.GetRouterStatus(GetRouterStatusRouterRequest, CallSettings)

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

RoutersClient.GetRouterStatusAsync(GetRouterStatusRouterRequest, CallSettings)

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

RoutersClient.Insert(InsertRouterRequest, CallSettings)

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

RoutersClient.InsertAsync(InsertRouterRequest, CallSettings)

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

RoutersClient.List(ListRoutersRequest, CallSettings)

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

RoutersClient.ListAsync(ListRoutersRequest, CallSettings)

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

RoutersClient.Patch(PatchRouterRequest, CallSettings)

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

RoutersClient.PatchAsync(PatchRouterRequest, CallSettings)

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

RoutersClient.Preview(PreviewRouterRequest, CallSettings)

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

RoutersClient.PreviewAsync(PreviewRouterRequest, CallSettings)

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

RoutersClient.Update(UpdateRouterRequest, CallSettings)

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

RoutersClient.UpdateAsync(UpdateRouterRequest, CallSettings)