Compute Engine v1 API - Class UrlMapsClientImpl (2.3.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(UrlMaps.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
NameDescription
grpcClientUrlMaps.UrlMapsClient

The underlying gRPC client.

settingsUrlMapsSettings

The base UrlMapsSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override UrlMaps.UrlMapsClient GrpcClient { get; }

The underlying gRPC UrlMaps client

Property Value
TypeDescription
UrlMaps.UrlMapsClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
TypeDescription
OperationsClient
Overrides

InvalidateCacheOperationsClient

public override OperationsClient InvalidateCacheOperationsClient { get; }

The long-running operations client for InvalidateCache.

Property Value
TypeDescription
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateOperationsClient

public override OperationsClient UpdateOperationsClient { get; }

The long-running operations client for Update.

Property Value
TypeDescription
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.

Parameters
NameDescription
requestAggregatedListUrlMapsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<UrlMapsAggregatedList, KeyValuePair<String, UrlMapsScopedList>>

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.

Parameters
NameDescription
requestAggregatedListUrlMapsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<UrlMapsAggregatedList, KeyValuePair<String, UrlMapsScopedList>>

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

DeleteAsync(DeleteUrlMapRequest, CallSettings)

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

Deletes the specified UrlMap resource.

Parameters
NameDescription
requestDeleteUrlMapRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

A Task containing the RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
UrlMap

The RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<UrlMap>

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

InsertAsync(InsertUrlMapRequest, CallSettings)

public override async 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
NameDescription
requestInsertUrlMapRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

InvalidateCacheAsync(InvalidateCacheUrlMapRequest, CallSettings)

public override async 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
NameDescription
requestInvalidateCacheUrlMapRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<UrlMapList, UrlMap>

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<UrlMapList, UrlMap>

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

PatchAsync(PatchUrlMapRequest, CallSettings)

public override async 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
NameDescription
requestPatchUrlMapRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Operation, Operation>

The RPC response.

Overrides

UpdateAsync(UpdateUrlMapRequest, CallSettings)

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

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

Parameters
NameDescription
requestUpdateUrlMapRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Operation, Operation>>

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<UrlMapsValidateResponse>

A Task containing the RPC response.

Overrides