Compute Engine v1 API - Class UrlMapsClientImpl (2.7.0)

Version 2.7.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 sealed class UrlMapsClientImpl : UrlMapsClient

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

UrlMaps client wrapper implementation, for convenient use.

Inheritance

object > UrlMapsClient > UrlMapsClientImpl

Inherited Members

UrlMapsClient.DefaultEndpoint

UrlMapsClient.DefaultScopes

UrlMapsClient.ServiceMetadata

UrlMapsClient.CreateAsync(CancellationToken)

UrlMapsClient.Create()

UrlMapsClient.ShutdownDefaultChannelsAsync()

UrlMapsClient.AggregatedList(string, string, int?, CallSettings)

UrlMapsClient.AggregatedListAsync(string, string, int?, CallSettings)

UrlMapsClient.DeleteAsync(DeleteUrlMapRequest, CancellationToken)

UrlMapsClient.PollOnceDelete(string, CallSettings)

UrlMapsClient.PollOnceDeleteAsync(string, CallSettings)

UrlMapsClient.Delete(string, string, CallSettings)

UrlMapsClient.DeleteAsync(string, string, CallSettings)

UrlMapsClient.DeleteAsync(string, string, CancellationToken)

UrlMapsClient.GetAsync(GetUrlMapRequest, CancellationToken)

UrlMapsClient.Get(string, string, CallSettings)

UrlMapsClient.GetAsync(string, string, CallSettings)

UrlMapsClient.GetAsync(string, string, CancellationToken)

UrlMapsClient.InsertAsync(InsertUrlMapRequest, CancellationToken)

UrlMapsClient.PollOnceInsert(string, CallSettings)

UrlMapsClient.PollOnceInsertAsync(string, CallSettings)

UrlMapsClient.Insert(string, UrlMap, CallSettings)

UrlMapsClient.InsertAsync(string, UrlMap, CallSettings)

UrlMapsClient.InsertAsync(string, UrlMap, CancellationToken)

UrlMapsClient.InvalidateCacheAsync(InvalidateCacheUrlMapRequest, CancellationToken)

UrlMapsClient.PollOnceInvalidateCache(string, CallSettings)

UrlMapsClient.PollOnceInvalidateCacheAsync(string, CallSettings)

UrlMapsClient.InvalidateCache(string, string, CacheInvalidationRule, CallSettings)

UrlMapsClient.InvalidateCacheAsync(string, string, CacheInvalidationRule, CallSettings)

UrlMapsClient.InvalidateCacheAsync(string, string, CacheInvalidationRule, CancellationToken)

UrlMapsClient.List(string, string, int?, CallSettings)

UrlMapsClient.ListAsync(string, string, int?, CallSettings)

UrlMapsClient.PatchAsync(PatchUrlMapRequest, CancellationToken)

UrlMapsClient.PollOncePatch(string, CallSettings)

UrlMapsClient.PollOncePatchAsync(string, CallSettings)

UrlMapsClient.Patch(string, string, UrlMap, CallSettings)

UrlMapsClient.PatchAsync(string, string, UrlMap, CallSettings)

UrlMapsClient.PatchAsync(string, string, UrlMap, CancellationToken)

UrlMapsClient.UpdateAsync(UpdateUrlMapRequest, CancellationToken)

UrlMapsClient.PollOnceUpdate(string, CallSettings)

UrlMapsClient.PollOnceUpdateAsync(string, CallSettings)

UrlMapsClient.Update(string, string, UrlMap, CallSettings)

UrlMapsClient.UpdateAsync(string, string, UrlMap, CallSettings)

UrlMapsClient.UpdateAsync(string, string, UrlMap, CancellationToken)

UrlMapsClient.ValidateAsync(ValidateUrlMapRequest, CancellationToken)

UrlMapsClient.Validate(string, string, UrlMapsValidateRequest, CallSettings)

UrlMapsClient.ValidateAsync(string, string, UrlMapsValidateRequest, CallSettings)

UrlMapsClient.ValidateAsync(string, string, UrlMapsValidateRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The UrlMaps API.

Constructors

UrlMapsClientImpl(UrlMapsClient, UrlMapsSettings, ILogger)

public UrlMapsClientImpl(UrlMaps.UrlMapsClient grpcClient, UrlMapsSettings settings, ILogger logger)

Constructs a client wrapper for the UrlMaps service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	UrlMapsUrlMapsClient The underlying gRPC client.
settings	UrlMapsSettings The base UrlMapsSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
OperationsClient

Overrides

UrlMapsClient.DeleteOperationsClient

GrpcClient

public override UrlMaps.UrlMapsClient GrpcClient { get; }

The underlying gRPC UrlMaps client

Property Value
Type	Description
UrlMapsUrlMapsClient

Overrides

UrlMapsClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

Overrides

UrlMapsClient.InsertOperationsClient

InvalidateCacheOperationsClient

public override OperationsClient InvalidateCacheOperationsClient { get; }

The long-running operations client for InvalidateCache.

Property Value
Type	Description
OperationsClient

Overrides

UrlMapsClient.InvalidateCacheOperationsClient

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type	Description
OperationsClient

Overrides

UrlMapsClient.PatchOperationsClient

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
Type	Description
OperationsClient

Overrides

UrlMapsClient.UpdateOperationsClient

Methods

AggregatedList(AggregatedListUrlMapsRequest, CallSettings)

public override PagedEnumerable<UrlMapsAggregatedList, KeyValuePair<string, UrlMapsScopedList>> AggregatedList(AggregatedListUrlMapsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	AggregatedListUrlMapsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableUrlMapsAggregatedListKeyValuePairstringUrlMapsScopedList	A pageable sequence of KeyValuePair<TKey,TValue> resources.

Overrides

UrlMapsClient.AggregatedList(AggregatedListUrlMapsRequest, CallSettings)

AggregatedListAsync(AggregatedListUrlMapsRequest, CallSettings)

public override PagedAsyncEnumerable<UrlMapsAggregatedList, KeyValuePair<string, UrlMapsScopedList>> AggregatedListAsync(AggregatedListUrlMapsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	AggregatedListUrlMapsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableUrlMapsAggregatedListKeyValuePairstringUrlMapsScopedList	A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Overrides

UrlMapsClient.AggregatedListAsync(AggregatedListUrlMapsRequest, CallSettings)

Delete(DeleteUrlMapRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteUrlMapRequest request, CallSettings callSettings = null)

Deletes the specified UrlMap resource.

Parameters
Name	Description
request	DeleteUrlMapRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

UrlMapsClient.Delete(DeleteUrlMapRequest, CallSettings)

DeleteAsync(DeleteUrlMapRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteUrlMapRequest request, CallSettings callSettings = null)

Deletes the specified UrlMap resource.

Parameters
Name	Description
request	DeleteUrlMapRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

UrlMapsClient.DeleteAsync(DeleteUrlMapRequest, CallSettings)

Get(GetUrlMapRequest, CallSettings)

public override UrlMap Get(GetUrlMapRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetUrlMapRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
UrlMap	The RPC response.

Overrides

UrlMapsClient.Get(GetUrlMapRequest, CallSettings)

GetAsync(GetUrlMapRequest, CallSettings)

public override Task<UrlMap> GetAsync(GetUrlMapRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetUrlMapRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskUrlMap	A Task containing the RPC response.

Overrides

UrlMapsClient.GetAsync(GetUrlMapRequest, CallSettings)

Insert(InsertUrlMapRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertUrlMapRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	InsertUrlMapRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

UrlMapsClient.Insert(InsertUrlMapRequest, CallSettings)

InsertAsync(InsertUrlMapRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertUrlMapRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	InsertUrlMapRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

UrlMapsClient.InsertAsync(InsertUrlMapRequest, CallSettings)

InvalidateCache(InvalidateCacheUrlMapRequest, CallSettings)

public override Operation<Operation, Operation> InvalidateCache(InvalidateCacheUrlMapRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

UrlMapsClient.InvalidateCache(InvalidateCacheUrlMapRequest, CallSettings)

InvalidateCacheAsync(InvalidateCacheUrlMapRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InvalidateCacheAsync(InvalidateCacheUrlMapRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

UrlMapsClient.InvalidateCacheAsync(InvalidateCacheUrlMapRequest, CallSettings)

List(ListUrlMapsRequest, CallSettings)

public override PagedEnumerable<UrlMapList, UrlMap> List(ListUrlMapsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListUrlMapsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableUrlMapListUrlMap	A pageable sequence of UrlMap resources.

Overrides

UrlMapsClient.List(ListUrlMapsRequest, CallSettings)

ListAsync(ListUrlMapsRequest, CallSettings)

public override PagedAsyncEnumerable<UrlMapList, UrlMap> ListAsync(ListUrlMapsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListUrlMapsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableUrlMapListUrlMap	A pageable asynchronous sequence of UrlMap resources.

Overrides

UrlMapsClient.ListAsync(ListUrlMapsRequest, CallSettings)

Patch(PatchUrlMapRequest, CallSettings)

public override Operation<Operation, Operation> Patch(PatchUrlMapRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

UrlMapsClient.Patch(PatchUrlMapRequest, CallSettings)

PatchAsync(PatchUrlMapRequest, CallSettings)

public override Task<Operation<Operation, Operation>> PatchAsync(PatchUrlMapRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

UrlMapsClient.PatchAsync(PatchUrlMapRequest, CallSettings)

Update(UpdateUrlMapRequest, CallSettings)

public override Operation<Operation, Operation> Update(UpdateUrlMapRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	UpdateUrlMapRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationOperationOperation	The RPC response.

Overrides

UrlMapsClient.Update(UpdateUrlMapRequest, CallSettings)

UpdateAsync(UpdateUrlMapRequest, CallSettings)

public override Task<Operation<Operation, Operation>> UpdateAsync(UpdateUrlMapRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	UpdateUrlMapRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationOperationOperation	A Task containing the RPC response.

Overrides

UrlMapsClient.UpdateAsync(UpdateUrlMapRequest, CallSettings)

Validate(ValidateUrlMapRequest, CallSettings)

public override UrlMapsValidateResponse Validate(ValidateUrlMapRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
UrlMapsValidateResponse	The RPC response.

Overrides

UrlMapsClient.Validate(ValidateUrlMapRequest, CallSettings)

ValidateAsync(ValidateUrlMapRequest, CallSettings)

public override Task<UrlMapsValidateResponse> ValidateAsync(ValidateUrlMapRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskUrlMapsValidateResponse	A Task containing the RPC response.

Overrides

UrlMapsClient.ValidateAsync(ValidateUrlMapRequest, CallSettings)