Compute Engine v1 API - Class Routes.RoutesClient (3.2.0)

public class Routes.RoutesClient : ClientBase<Routes.RoutesClient>

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

Client for Routes

Inheritance

object > ClientBase > ClientBaseRoutesRoutesClient > Routes.RoutesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RoutesClient()

protected RoutesClient()

Protected parameterless constructor to allow creation of test doubles.

RoutesClient(CallInvoker)

public RoutesClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

RoutesClient(ChannelBase)

public RoutesClient(ChannelBase channel)

Creates a new client for Routes

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

RoutesClient(ClientBaseConfiguration)

protected RoutesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateOperationsClientForGlobalOperations()

public virtual Operations.OperationsClient CreateOperationsClientForGlobalOperations()

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

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

Delete(DeleteRouteRequest, CallOptions)

public virtual Operation Delete(DeleteRouteRequest request, CallOptions options)

Deletes the specified Route resource.

Parameters
Name Description
request DeleteRouteRequest

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(DeleteRouteRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified Route resource.

Parameters
Name Description
request DeleteRouteRequest

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(DeleteRouteRequest, CallOptions)

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

Deletes the specified Route resource.

Parameters
Name Description
request DeleteRouteRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteRouteRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified Route resource.

Parameters
Name Description
request DeleteRouteRequest

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(GetRouteRequest, CallOptions)

public virtual Route Get(GetRouteRequest request, CallOptions options)

Returns the specified Route resource.

Parameters
Name Description
request GetRouteRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Route

The response received from the server.

Get(GetRouteRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified Route resource.

Parameters
Name Description
request GetRouteRequest

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
Route

The response received from the server.

GetAsync(GetRouteRequest, CallOptions)

public virtual AsyncUnaryCall<Route> GetAsync(GetRouteRequest request, CallOptions options)

Returns the specified Route resource.

Parameters
Name Description
request GetRouteRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRoute

The call object.

GetAsync(GetRouteRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified Route resource.

Parameters
Name Description
request GetRouteRequest

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
AsyncUnaryCallRoute

The call object.

Insert(InsertRouteRequest, CallOptions)

public virtual Operation Insert(InsertRouteRequest request, CallOptions options)

Creates a Route resource in the specified project using the data included in the request.

Parameters
Name Description
request InsertRouteRequest

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(InsertRouteRequest, Metadata, DateTime?, CancellationToken)

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

Creates a Route resource in the specified project using the data included in the request.

Parameters
Name Description
request InsertRouteRequest

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(InsertRouteRequest, CallOptions)

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

Creates a Route resource in the specified project using the data included in the request.

Parameters
Name Description
request InsertRouteRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertRouteRequest, Metadata, DateTime?, CancellationToken)

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

Creates a Route resource in the specified project using the data included in the request.

Parameters
Name Description
request InsertRouteRequest

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(ListRoutesRequest, CallOptions)

public virtual RouteList List(ListRoutesRequest request, CallOptions options)

Retrieves the list of Route resources available to the specified project.

Parameters
Name Description
request ListRoutesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
RouteList

The response received from the server.

List(ListRoutesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of Route resources available to the specified project.

Parameters
Name Description
request ListRoutesRequest

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
RouteList

The response received from the server.

ListAsync(ListRoutesRequest, CallOptions)

public virtual AsyncUnaryCall<RouteList> ListAsync(ListRoutesRequest request, CallOptions options)

Retrieves the list of Route resources available to the specified project.

Parameters
Name Description
request ListRoutesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRouteList

The call object.

ListAsync(ListRoutesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of Route resources available to the specified project.

Parameters
Name Description
request ListRoutesRequest

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
AsyncUnaryCallRouteList

The call object.

NewInstance(ClientBaseConfiguration)

protected override Routes.RoutesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
RoutesRoutesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.Routes.RoutesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)