Compute Engine v1 API - Class Routers.RoutersClient (3.0.0)

Version latest

• 3.0.0 (latest)
• 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 class Routers.RoutersClient : ClientBase<Routers.RoutersClient>

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

Client for Routers

Inheritance

object > ClientBase > ClientBaseRoutersRoutersClient > Routers.RoutersClient

Inherited Members

ClientBase<Routers.RoutersClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RoutersClient()

protected RoutersClient()

Protected parameterless constructor to allow creation of test doubles.

RoutersClient(CallInvoker)

public RoutersClient(CallInvoker callInvoker)

Creates a new client for Routers that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

RoutersClient(ChannelBase)

public RoutersClient(ChannelBase channel)

Creates a new client for Routers

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

RoutersClient(ClientBaseConfiguration)

protected RoutersClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListRoutersRequest, CallOptions)

public virtual RouterAggregatedList AggregatedList(AggregatedListRoutersRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RouterAggregatedList	The response received from the server.

AggregatedList(AggregatedListRoutersRequest, Metadata, DateTime?, CancellationToken)

public virtual RouterAggregatedList AggregatedList(AggregatedListRoutersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RouterAggregatedList	The response received from the server.

AggregatedListAsync(AggregatedListRoutersRequest, CallOptions)

public virtual AsyncUnaryCall<RouterAggregatedList> AggregatedListAsync(AggregatedListRoutersRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRouterAggregatedList	The call object.

AggregatedListAsync(AggregatedListRoutersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RouterAggregatedList> AggregatedListAsync(AggregatedListRoutersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRouterAggregatedList	The call object.

CreateOperationsClientForRegionOperations()

public virtual Operations.OperationsClient CreateOperationsClientForRegionOperations()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client, delegating to RegionOperations.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

Delete(DeleteRouterRequest, CallOptions)

public virtual Operation Delete(DeleteRouterRequest request, CallOptions options)

Deletes the specified Router resource.

Parameters
Name	Description
request	DeleteRouterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Delete(DeleteRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Delete(DeleteRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified Router resource.

Parameters
Name	Description
request	DeleteRouterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteAsync(DeleteRouterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteRouterRequest request, CallOptions options)

Deletes the specified Router resource.

Parameters
Name	Description
request	DeleteRouterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteAsync(DeleteRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified Router resource.

Parameters
Name	Description
request	DeleteRouterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

Get(GetRouterRequest, CallOptions)

public virtual Router Get(GetRouterRequest request, CallOptions options)

Returns the specified Router resource.

Parameters
Name	Description
request	GetRouterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Router	The response received from the server.

Get(GetRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual Router Get(GetRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified Router resource.

Parameters
Name	Description
request	GetRouterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Router	The response received from the server.

GetAsync(GetRouterRequest, CallOptions)

public virtual AsyncUnaryCall<Router> GetAsync(GetRouterRequest request, CallOptions options)

Returns the specified Router resource.

Parameters
Name	Description
request	GetRouterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRouter	The call object.

GetAsync(GetRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Router> GetAsync(GetRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified Router resource.

Parameters
Name	Description
request	GetRouterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRouter	The call object.

GetNatIpInfo(GetNatIpInfoRouterRequest, CallOptions)

public virtual NatIpInfoResponse GetNatIpInfo(GetNatIpInfoRouterRequest request, CallOptions options)

Retrieves runtime NAT IP information.

Parameters
Name	Description
request	GetNatIpInfoRouterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
NatIpInfoResponse	The response received from the server.

GetNatIpInfo(GetNatIpInfoRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual NatIpInfoResponse GetNatIpInfo(GetNatIpInfoRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves runtime NAT IP information.

Parameters
Name	Description
request	GetNatIpInfoRouterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
NatIpInfoResponse	The response received from the server.

GetNatIpInfoAsync(GetNatIpInfoRouterRequest, CallOptions)

public virtual AsyncUnaryCall<NatIpInfoResponse> GetNatIpInfoAsync(GetNatIpInfoRouterRequest request, CallOptions options)

Retrieves runtime NAT IP information.

Parameters
Name	Description
request	GetNatIpInfoRouterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallNatIpInfoResponse	The call object.

GetNatIpInfoAsync(GetNatIpInfoRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<NatIpInfoResponse> GetNatIpInfoAsync(GetNatIpInfoRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves runtime NAT IP information.

Parameters
Name	Description
request	GetNatIpInfoRouterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallNatIpInfoResponse	The call object.

GetNatMappingInfo(GetNatMappingInfoRoutersRequest, CallOptions)

public virtual VmEndpointNatMappingsList GetNatMappingInfo(GetNatMappingInfoRoutersRequest request, CallOptions options)

Retrieves runtime Nat mapping information of VM endpoints.

Parameters
Name	Description
request	GetNatMappingInfoRoutersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
VmEndpointNatMappingsList	The response received from the server.

GetNatMappingInfo(GetNatMappingInfoRoutersRequest, Metadata, DateTime?, CancellationToken)

public virtual VmEndpointNatMappingsList GetNatMappingInfo(GetNatMappingInfoRoutersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves runtime Nat mapping information of VM endpoints.

Parameters
Name	Description
request	GetNatMappingInfoRoutersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
VmEndpointNatMappingsList	The response received from the server.

GetNatMappingInfoAsync(GetNatMappingInfoRoutersRequest, CallOptions)

public virtual AsyncUnaryCall<VmEndpointNatMappingsList> GetNatMappingInfoAsync(GetNatMappingInfoRoutersRequest request, CallOptions options)

Retrieves runtime Nat mapping information of VM endpoints.

Parameters
Name	Description
request	GetNatMappingInfoRoutersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallVmEndpointNatMappingsList	The call object.

GetNatMappingInfoAsync(GetNatMappingInfoRoutersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<VmEndpointNatMappingsList> GetNatMappingInfoAsync(GetNatMappingInfoRoutersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves runtime Nat mapping information of VM endpoints.

Parameters
Name	Description
request	GetNatMappingInfoRoutersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallVmEndpointNatMappingsList	The call object.

GetRouterStatus(GetRouterStatusRouterRequest, CallOptions)

public virtual RouterStatusResponse GetRouterStatus(GetRouterStatusRouterRequest request, CallOptions options)

Retrieves runtime information of the specified router.

Parameters
Name	Description
request	GetRouterStatusRouterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RouterStatusResponse	The response received from the server.

GetRouterStatus(GetRouterStatusRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual RouterStatusResponse GetRouterStatus(GetRouterStatusRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves runtime information of the specified router.

Parameters
Name	Description
request	GetRouterStatusRouterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RouterStatusResponse	The response received from the server.

GetRouterStatusAsync(GetRouterStatusRouterRequest, CallOptions)

public virtual AsyncUnaryCall<RouterStatusResponse> GetRouterStatusAsync(GetRouterStatusRouterRequest request, CallOptions options)

Retrieves runtime information of the specified router.

Parameters
Name	Description
request	GetRouterStatusRouterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRouterStatusResponse	The call object.

GetRouterStatusAsync(GetRouterStatusRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RouterStatusResponse> GetRouterStatusAsync(GetRouterStatusRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves runtime information of the specified router.

Parameters
Name	Description
request	GetRouterStatusRouterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRouterStatusResponse	The call object.

Insert(InsertRouterRequest, CallOptions)

public virtual Operation Insert(InsertRouterRequest request, CallOptions options)

Creates a Router resource in the specified project and region using the data included in the request.

Parameters
Name	Description
request	InsertRouterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Insert(InsertRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Insert(InsertRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a Router resource in the specified project and region using the data included in the request.

Parameters
Name	Description
request	InsertRouterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

InsertAsync(InsertRouterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertRouterRequest request, CallOptions options)

Creates a Router resource in the specified project and region using the data included in the request.

Parameters
Name	Description
request	InsertRouterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InsertAsync(InsertRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a Router resource in the specified project and region using the data included in the request.

Parameters
Name	Description
request	InsertRouterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

List(ListRoutersRequest, CallOptions)

public virtual RouterList List(ListRoutersRequest request, CallOptions options)

Retrieves a list of Router resources available to the specified project.

Parameters
Name	Description
request	ListRoutersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RouterList	The response received from the server.

List(ListRoutersRequest, Metadata, DateTime?, CancellationToken)

public virtual RouterList List(ListRoutersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a list of Router resources available to the specified project.

Parameters
Name	Description
request	ListRoutersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RouterList	The response received from the server.

ListAsync(ListRoutersRequest, CallOptions)

public virtual AsyncUnaryCall<RouterList> ListAsync(ListRoutersRequest request, CallOptions options)

Retrieves a list of Router resources available to the specified project.

Parameters
Name	Description
request	ListRoutersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRouterList	The call object.

ListAsync(ListRoutersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RouterList> ListAsync(ListRoutersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a list of Router resources available to the specified project.

Parameters
Name	Description
request	ListRoutersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRouterList	The call object.

NewInstance(ClientBaseConfiguration)

protected override Routers.RoutersClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
RoutersRoutersClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.Routers.RoutersClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchRouterRequest, CallOptions)

public virtual Operation Patch(PatchRouterRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Patch(PatchRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Patch(PatchRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

PatchAsync(PatchRouterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchRouterRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

PatchAsync(PatchRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

Preview(PreviewRouterRequest, CallOptions)

public virtual RoutersPreviewResponse Preview(PreviewRouterRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RoutersPreviewResponse	The response received from the server.

Preview(PreviewRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual RoutersPreviewResponse Preview(PreviewRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RoutersPreviewResponse	The response received from the server.

PreviewAsync(PreviewRouterRequest, CallOptions)

public virtual AsyncUnaryCall<RoutersPreviewResponse> PreviewAsync(PreviewRouterRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRoutersPreviewResponse	The call object.

PreviewAsync(PreviewRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RoutersPreviewResponse> PreviewAsync(PreviewRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRoutersPreviewResponse	The call object.

Update(UpdateRouterRequest, CallOptions)

public virtual Operation Update(UpdateRouterRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

Update(UpdateRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation Update(UpdateRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateAsync(UpdateRouterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateRouterRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateAsync(UpdateRouterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateRouterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.