Cloud Resource Manager v3 API - Class TagHoldsClientImpl (2.2.0)

public sealed class TagHoldsClientImpl : TagHoldsClient

Reference documentation and code samples for the Cloud Resource Manager v3 API class TagHoldsClientImpl.

TagHolds client wrapper implementation, for convenient use.

Inheritance

object > TagHoldsClient > TagHoldsClientImpl

Namespace

Google.Cloud.ResourceManager.V3

Assembly

Google.Cloud.ResourceManager.V3.dll

Remarks

Allow users to create and manage TagHolds for TagValues. TagHolds represent the use of a Tag Value that is not captured by TagBindings but should still block TagValue deletion (such as a reference in a policy condition). This service provides isolated failure domains by cloud location so that TagHolds can be managed in the same location as their usage.

Constructors

TagHoldsClientImpl(TagHoldsClient, TagHoldsSettings, ILogger)

public TagHoldsClientImpl(TagHolds.TagHoldsClient grpcClient, TagHoldsSettings settings, ILogger logger)

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

Parameters
NameDescription
grpcClientTagHoldsTagHoldsClient

The underlying gRPC client.

settingsTagHoldsSettings

The base TagHoldsSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateTagHoldOperationsClient

public override OperationsClient CreateTagHoldOperationsClient { get; }

The long-running operations client for CreateTagHold.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteTagHoldOperationsClient

public override OperationsClient DeleteTagHoldOperationsClient { get; }

The long-running operations client for DeleteTagHold.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override TagHolds.TagHoldsClient GrpcClient { get; }

The underlying gRPC TagHolds client

Property Value
TypeDescription
TagHoldsTagHoldsClient
Overrides

Methods

CreateTagHold(CreateTagHoldRequest, CallSettings)

public override Operation<TagHold, CreateTagHoldMetadata> CreateTagHold(CreateTagHoldRequest request, CallSettings callSettings = null)

Creates a TagHold. Returns ALREADY_EXISTS if a TagHold with the same resource and origin exists under the same TagValue.

Parameters
NameDescription
requestCreateTagHoldRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTagHoldCreateTagHoldMetadata

The RPC response.

Overrides

CreateTagHoldAsync(CreateTagHoldRequest, CallSettings)

public override Task<Operation<TagHold, CreateTagHoldMetadata>> CreateTagHoldAsync(CreateTagHoldRequest request, CallSettings callSettings = null)

Creates a TagHold. Returns ALREADY_EXISTS if a TagHold with the same resource and origin exists under the same TagValue.

Parameters
NameDescription
requestCreateTagHoldRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTagHoldCreateTagHoldMetadata

A Task containing the RPC response.

Overrides

DeleteTagHold(DeleteTagHoldRequest, CallSettings)

public override Operation<Empty, DeleteTagHoldMetadata> DeleteTagHold(DeleteTagHoldRequest request, CallSettings callSettings = null)

Deletes a TagHold.

Parameters
NameDescription
requestDeleteTagHoldRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteTagHoldMetadata

The RPC response.

Overrides

DeleteTagHoldAsync(DeleteTagHoldRequest, CallSettings)

public override Task<Operation<Empty, DeleteTagHoldMetadata>> DeleteTagHoldAsync(DeleteTagHoldRequest request, CallSettings callSettings = null)

Deletes a TagHold.

Parameters
NameDescription
requestDeleteTagHoldRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteTagHoldMetadata

A Task containing the RPC response.

Overrides

ListTagHolds(ListTagHoldsRequest, CallSettings)

public override PagedEnumerable<ListTagHoldsResponse, TagHold> ListTagHolds(ListTagHoldsRequest request, CallSettings callSettings = null)

Lists TagHolds under a TagValue.

Parameters
NameDescription
requestListTagHoldsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListTagHoldsResponseTagHold

A pageable sequence of TagHold resources.

Overrides

ListTagHoldsAsync(ListTagHoldsRequest, CallSettings)

public override PagedAsyncEnumerable<ListTagHoldsResponse, TagHold> ListTagHoldsAsync(ListTagHoldsRequest request, CallSettings callSettings = null)

Lists TagHolds under a TagValue.

Parameters
NameDescription
requestListTagHoldsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListTagHoldsResponseTagHold

A pageable asynchronous sequence of TagHold resources.

Overrides