Class Routes.RoutesClient (1.3.0)

public class RoutesClient : ClientBase<Routes.RoutesClient>

Client for Routes

Inheritance

Object > ClientBase > ClientBase<Routes.RoutesClient> > 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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

RoutesClient(ChannelBase)

public RoutesClient(ChannelBase channel)

Creates a new client for Routes

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

RoutesClient(ClientBase.ClientBaseConfiguration)

protected RoutesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

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
TypeDescription
Operations.OperationsClient

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteRouteRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified Route resource.

Parameters
NameDescription
requestDeleteRouteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteAsync(DeleteRouteRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified Route resource.

Parameters
NameDescription
requestDeleteRouteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

Get(GetRouteRequest, CallOptions)

public virtual Route Get(GetRouteRequest request, CallOptions options)

Returns the specified Route resource. Gets a list of available routes by making a list() request.

Parameters
NameDescription
requestGetRouteRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Route

The response received from the server.

Get(GetRouteRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the specified Route resource. Gets a list of available routes by making a list() request.

Parameters
NameDescription
requestGetRouteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Route

The response received from the server.

GetAsync(GetRouteRequest, CallOptions)

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

Returns the specified Route resource. Gets a list of available routes by making a list() request.

Parameters
NameDescription
requestGetRouteRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Route>

The call object.

GetAsync(GetRouteRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the specified Route resource. Gets a list of available routes by making a list() request.

Parameters
NameDescription
requestGetRouteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Route>

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertRouteRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestInsertRouteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

InsertAsync(InsertRouteRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestInsertRouteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
RouteList

The response received from the server.

List(ListRoutesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestListRoutesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<RouteList>

The call object.

ListAsync(ListRoutesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestListRoutesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<RouteList>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
Routes.RoutesClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.Routes.RoutesClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)