Compute Engine v1 API - Class UrlMapsClientImpl (3.1.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

Namespace

Google.Cloud.Compute.V1

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

GrpcClient

public override UrlMaps.UrlMapsClient GrpcClient { get; }

The underlying gRPC UrlMaps client

Property Value
Type Description
UrlMapsUrlMapsClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

InvalidateCacheOperationsClient

public override OperationsClient InvalidateCacheOperationsClient { get; }

The long-running operations client for InvalidateCache.

Property Value
Type Description
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type Description
OperationsClient
Overrides

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
Type Description
OperationsClient
Overrides

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. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

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. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

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

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

Get(GetUrlMapRequest, CallSettings)

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

Returns the specified UrlMap resource.

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

GetAsync(GetUrlMapRequest, CallSettings)

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

Returns the specified UrlMap resource.

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

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

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

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

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

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

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

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

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

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

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

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

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