Compute Engine v1 API - Class UrlMaps.UrlMapsClient (2.3.0)

Version 2.3.0

• 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 UrlMapsClient : ClientBase<UrlMaps.UrlMapsClient>

Reference documentation and code samples for the Compute Engine v1 API class UrlMaps.UrlMapsClient.

Client for UrlMaps

Inheritance

Object > ClientBase > ClientBase<UrlMaps.UrlMapsClient> > UrlMaps.UrlMapsClient

Inherited Members

ClientBase<UrlMaps.UrlMapsClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

UrlMapsClient()

protected UrlMapsClient()

Protected parameterless constructor to allow creation of test doubles.

UrlMapsClient(CallInvoker)

public UrlMapsClient(CallInvoker callInvoker)

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

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

UrlMapsClient(ChannelBase)

public UrlMapsClient(ChannelBase channel)

Creates a new client for UrlMaps

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

UrlMapsClient(ClientBase.ClientBaseConfiguration)

protected UrlMapsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration The client configuration.

Methods

AggregatedList(AggregatedListUrlMapsRequest, CallOptions)

public virtual UrlMapsAggregatedList AggregatedList(AggregatedListUrlMapsRequest request, CallOptions options)

Retrieves the list of all UrlMap resources, regional and global, available to the specified project.

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

Returns
Type	Description
UrlMapsAggregatedList	The response received from the server.

AggregatedList(AggregatedListUrlMapsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves the list of all UrlMap resources, regional and global, available to the specified project.

Parameters
Name	Description
request	AggregatedListUrlMapsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
UrlMapsAggregatedList	The response received from the server.

AggregatedListAsync(AggregatedListUrlMapsRequest, CallOptions)

public virtual AsyncUnaryCall<UrlMapsAggregatedList> AggregatedListAsync(AggregatedListUrlMapsRequest request, CallOptions options)

Retrieves the list of all UrlMap resources, regional and global, available to the specified project.

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

Returns
Type	Description
AsyncUnaryCall<UrlMapsAggregatedList>	The call object.

AggregatedListAsync(AggregatedListUrlMapsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Retrieves the list of all UrlMap resources, regional and global, available to the specified project.

Parameters
Name	Description
request	AggregatedListUrlMapsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<UrlMapsAggregatedList>	The call object.

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
Operations.OperationsClient	A new Operations client for the same target as this client.

Delete(DeleteUrlMapRequest, CallOptions)

public virtual Operation Delete(DeleteUrlMapRequest request, CallOptions options)

Deletes the specified UrlMap resource.

Parameters
Name	Description
request	DeleteUrlMapRequest 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(DeleteUrlMapRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified UrlMap resource.

Parameters
Name	Description
request	DeleteUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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(DeleteUrlMapRequest, CallOptions)

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

Deletes the specified UrlMap resource.

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

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

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

Deletes the specified UrlMap resource.

Parameters
Name	Description
request	DeleteUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

Get(GetUrlMapRequest, CallOptions)

public virtual UrlMap Get(GetUrlMapRequest request, CallOptions options)

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

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

Returns
Type	Description
UrlMap	The response received from the server.

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

public virtual UrlMap Get(GetUrlMapRequest 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
Name	Description
request	GetUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
UrlMap	The response received from the server.

GetAsync(GetUrlMapRequest, CallOptions)

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

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

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

Returns
Type	Description
AsyncUnaryCall<UrlMap>	The call object.

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

public virtual AsyncUnaryCall<UrlMap> GetAsync(GetUrlMapRequest 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
Name	Description
request	GetUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<UrlMap>	The call object.

Insert(InsertUrlMapRequest, CallOptions)

public virtual Operation Insert(InsertUrlMapRequest request, CallOptions options)

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

Parameters
Name	Description
request	InsertUrlMapRequest 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(InsertUrlMapRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation Insert(InsertUrlMapRequest 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
Name	Description
request	InsertUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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(InsertUrlMapRequest, CallOptions)

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

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

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

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

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertUrlMapRequest 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
Name	Description
request	InsertUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

InvalidateCache(InvalidateCacheUrlMapRequest, CallOptions)

public virtual Operation InvalidateCache(InvalidateCacheUrlMapRequest request, CallOptions options)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

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

Returns
Type	Description
Operation	The response received from the server.

InvalidateCache(InvalidateCacheUrlMapRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

Parameters
Name	Description
request	InvalidateCacheUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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.

InvalidateCacheAsync(InvalidateCacheUrlMapRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InvalidateCacheAsync(InvalidateCacheUrlMapRequest request, CallOptions options)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

InvalidateCacheAsync(InvalidateCacheUrlMapRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

Parameters
Name	Description
request	InvalidateCacheUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

List(ListUrlMapsRequest, CallOptions)

public virtual UrlMapList List(ListUrlMapsRequest request, CallOptions options)

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

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

Returns
Type	Description
UrlMapList	The response received from the server.

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

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

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

Parameters
Name	Description
request	ListUrlMapsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
UrlMapList	The response received from the server.

ListAsync(ListUrlMapsRequest, CallOptions)

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

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

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

Returns
Type	Description
AsyncUnaryCall<UrlMapList>	The call object.

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

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

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

Parameters
Name	Description
request	ListUrlMapsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<UrlMapList>	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override UrlMaps.UrlMapsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration

Returns
Type	Description
UrlMaps.UrlMapsClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Compute.V1.UrlMaps.UrlMapsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchUrlMapRequest, CallOptions)

public virtual Operation Patch(PatchUrlMapRequest request, CallOptions options)

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

Parameters
Name	Description
request	PatchUrlMapRequest 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(PatchUrlMapRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation Patch(PatchUrlMapRequest 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 the JSON merge patch format and processing rules.

Parameters
Name	Description
request	PatchUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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(PatchUrlMapRequest, CallOptions)

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

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

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

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

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchUrlMapRequest 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 the JSON merge patch format and processing rules.

Parameters
Name	Description
request	PatchUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

Update(UpdateUrlMapRequest, CallOptions)

public virtual Operation Update(UpdateUrlMapRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateUrlMapRequest 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(UpdateUrlMapRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
Name	Description
request	UpdateUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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(UpdateUrlMapRequest, CallOptions)

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

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

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

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

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

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

Parameters
Name	Description
request	UpdateUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

Validate(ValidateUrlMapRequest, CallOptions)

public virtual UrlMapsValidateResponse Validate(ValidateUrlMapRequest 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
Name	Description
request	ValidateUrlMapRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
UrlMapsValidateResponse	The response received from the server.

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

public virtual UrlMapsValidateResponse Validate(ValidateUrlMapRequest 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
Name	Description
request	ValidateUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
UrlMapsValidateResponse	The response received from the server.

ValidateAsync(ValidateUrlMapRequest, CallOptions)

public virtual AsyncUnaryCall<UrlMapsValidateResponse> ValidateAsync(ValidateUrlMapRequest 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
Name	Description
request	ValidateUrlMapRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<UrlMapsValidateResponse>	The call object.

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

public virtual AsyncUnaryCall<UrlMapsValidateResponse> ValidateAsync(ValidateUrlMapRequest 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
Name	Description
request	ValidateUrlMapRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<UrlMapsValidateResponse>	The call object.