Compute Engine v1 API - Class RegionUrlMaps.RegionUrlMapsClient (2.6.0)

public class RegionUrlMapsClient : ClientBase<RegionUrlMaps.RegionUrlMapsClient>

Reference documentation and code samples for the Compute Engine v1 API class RegionUrlMaps.RegionUrlMapsClient.

Client for RegionUrlMaps

Inheritance

Object > ClientBase > ClientBase<RegionUrlMaps.RegionUrlMapsClient> > RegionUrlMaps.RegionUrlMapsClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RegionUrlMapsClient()

protected RegionUrlMapsClient()

Protected parameterless constructor to allow creation of test doubles.

RegionUrlMapsClient(CallInvoker)

public RegionUrlMapsClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

RegionUrlMapsClient(ChannelBase)

public RegionUrlMapsClient(ChannelBase channel)

Creates a new client for RegionUrlMaps

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

RegionUrlMapsClient(ClientBase.ClientBaseConfiguration)

protected RegionUrlMapsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

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

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

Delete(DeleteRegionUrlMapRequest, CallOptions)

public virtual Operation Delete(DeleteRegionUrlMapRequest request, CallOptions options)

Deletes the specified UrlMap resource.

Parameters
NameDescription
requestDeleteRegionUrlMapRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

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

Deletes the specified UrlMap resource.

Parameters
NameDescription
requestDeleteRegionUrlMapRequest

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

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

Deletes the specified UrlMap resource.

Parameters
NameDescription
requestDeleteRegionUrlMapRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

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

Deletes the specified UrlMap resource.

Parameters
NameDescription
requestDeleteRegionUrlMapRequest

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

public virtual UrlMap Get(GetRegionUrlMapRequest request, CallOptions options)

Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.

Parameters
NameDescription
requestGetRegionUrlMapRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
UrlMap

The response received from the server.

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

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

Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.

Parameters
NameDescription
requestGetRegionUrlMapRequest

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
UrlMap

The response received from the server.

GetAsync(GetRegionUrlMapRequest, CallOptions)

public virtual AsyncUnaryCall<UrlMap> GetAsync(GetRegionUrlMapRequest request, CallOptions options)

Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.

Parameters
NameDescription
requestGetRegionUrlMapRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<UrlMap>

The call object.

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

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

Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.

Parameters
NameDescription
requestGetRegionUrlMapRequest

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<UrlMap>

The call object.

Insert(InsertRegionUrlMapRequest, CallOptions)

public virtual Operation Insert(InsertRegionUrlMapRequest request, CallOptions options)

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

Parameters
NameDescription
requestInsertRegionUrlMapRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

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

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

Parameters
NameDescription
requestInsertRegionUrlMapRequest

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

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

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

Parameters
NameDescription
requestInsertRegionUrlMapRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

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

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

Parameters
NameDescription
requestInsertRegionUrlMapRequest

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

public virtual UrlMapList List(ListRegionUrlMapsRequest request, CallOptions options)

Retrieves the list of UrlMap resources available to the specified project in the specified region.

Parameters
NameDescription
requestListRegionUrlMapsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
UrlMapList

The response received from the server.

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

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

Retrieves the list of UrlMap resources available to the specified project in the specified region.

Parameters
NameDescription
requestListRegionUrlMapsRequest

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
UrlMapList

The response received from the server.

ListAsync(ListRegionUrlMapsRequest, CallOptions)

public virtual AsyncUnaryCall<UrlMapList> ListAsync(ListRegionUrlMapsRequest request, CallOptions options)

Retrieves the list of UrlMap resources available to the specified project in the specified region.

Parameters
NameDescription
requestListRegionUrlMapsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<UrlMapList>

The call object.

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

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

Retrieves the list of UrlMap resources available to the specified project in the specified region.

Parameters
NameDescription
requestListRegionUrlMapsRequest

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<UrlMapList>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override RegionUrlMaps.RegionUrlMapsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

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

Patch(PatchRegionUrlMapRequest, CallOptions)

public virtual Operation Patch(PatchRegionUrlMapRequest request, CallOptions options)

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchRegionUrlMapRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Patch(PatchRegionUrlMapRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchRegionUrlMapRequest

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.

PatchAsync(PatchRegionUrlMapRequest, CallOptions)

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

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchRegionUrlMapRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

PatchAsync(PatchRegionUrlMapRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchRegionUrlMapRequest

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.

Update(UpdateRegionUrlMapRequest, CallOptions)

public virtual Operation Update(UpdateRegionUrlMapRequest request, CallOptions options)

Updates the specified UrlMap resource with the data included in the request.

Parameters
NameDescription
requestUpdateRegionUrlMapRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Update(UpdateRegionUrlMapRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the specified UrlMap resource with the data included in the request.

Parameters
NameDescription
requestUpdateRegionUrlMapRequest

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.

UpdateAsync(UpdateRegionUrlMapRequest, CallOptions)

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

Updates the specified UrlMap resource with the data included in the request.

Parameters
NameDescription
requestUpdateRegionUrlMapRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateAsync(UpdateRegionUrlMapRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the specified UrlMap resource with the data included in the request.

Parameters
NameDescription
requestUpdateRegionUrlMapRequest

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.

Validate(ValidateRegionUrlMapRequest, CallOptions)

public virtual UrlMapsValidateResponse Validate(ValidateRegionUrlMapRequest request, CallOptions options)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Parameters
NameDescription
requestValidateRegionUrlMapRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
UrlMapsValidateResponse

The response received from the server.

Validate(ValidateRegionUrlMapRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual UrlMapsValidateResponse Validate(ValidateRegionUrlMapRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Parameters
NameDescription
requestValidateRegionUrlMapRequest

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
UrlMapsValidateResponse

The response received from the server.

ValidateAsync(ValidateRegionUrlMapRequest, CallOptions)

public virtual AsyncUnaryCall<UrlMapsValidateResponse> ValidateAsync(ValidateRegionUrlMapRequest request, CallOptions options)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Parameters
NameDescription
requestValidateRegionUrlMapRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<UrlMapsValidateResponse>

The call object.

ValidateAsync(ValidateRegionUrlMapRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<UrlMapsValidateResponse> ValidateAsync(ValidateRegionUrlMapRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Parameters
NameDescription
requestValidateRegionUrlMapRequest

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<UrlMapsValidateResponse>

The call object.