Class TagHoldsClient (2.31.0-rc)

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.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

TagHoldsClient(TagHoldsClient const &)

Copy and move support

Parameter
Name	Description
	`TagHoldsClient const &`

TagHoldsClient(TagHoldsClient &&)

Copy and move support

Parameter
Name	Description
	`TagHoldsClient &&`

TagHoldsClient(std::shared_ptr< TagHoldsConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< TagHoldsConnection >`
`opts`	`Options`

Operators

operator=(TagHoldsClient const &)

Copy and move support

Parameter
Name	Description
	`TagHoldsClient const &`

Returns
Type	Description
`TagHoldsClient &`

operator=(TagHoldsClient &&)

Copy and move support

Parameter
Name	Description
	`TagHoldsClient &&`

Returns
Type	Description
`TagHoldsClient &`

Functions

CreateTagHold(std::string const &, google::cloud::resourcemanager::v3::TagHold const &, Options)

Creates a TagHold.

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

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the TagHold's parent TagValue. Must be of the form: `tagValues/{tag-value-id}`.
`tag_hold`	`google::cloud::resourcemanager::v3::TagHold const &` Required. The TagHold to be created.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::resourcemanager::v3::TagHold > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.resourcemanager.v3.TagHold proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateTagHold(NoAwaitTag, std::string const &, google::cloud::resourcemanager::v3::TagHold const &, Options)

Creates a TagHold.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`tag_hold`	`google::cloud::resourcemanager::v3::TagHold const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateTagHold(google::cloud::resourcemanager::v3::CreateTagHoldRequest const &, Options)

Creates a TagHold.

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

Parameters
Name	Description
`request`	`google::cloud::resourcemanager::v3::CreateTagHoldRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.resourcemanager.v3.CreateTagHoldRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::resourcemanager::v3::TagHold > >

CreateTagHold(NoAwaitTag, google::cloud::resourcemanager::v3::CreateTagHoldRequest const &, Options)

Creates a TagHold.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::resourcemanager::v3::CreateTagHoldRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateTagHold(google::longrunning::Operation const &, Options)

Creates a TagHold.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::resourcemanager::v3::TagHold > >`

DeleteTagHold(std::string const &, Options)

Deletes a TagHold.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the TagHold to delete. Must be of the form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::resourcemanager::v3::DeleteTagHoldMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.resourcemanager.v3.DeleteTagHoldMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTagHold(NoAwaitTag, std::string const &, Options)

Deletes a TagHold.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteTagHold(google::cloud::resourcemanager::v3::DeleteTagHoldRequest const &, Options)

Deletes a TagHold.

Parameters
Name	Description
`request`	`google::cloud::resourcemanager::v3::DeleteTagHoldRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.resourcemanager.v3.DeleteTagHoldRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::resourcemanager::v3::DeleteTagHoldMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.resourcemanager.v3.DeleteTagHoldMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTagHold(NoAwaitTag, google::cloud::resourcemanager::v3::DeleteTagHoldRequest const &, Options)

Deletes a TagHold.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::resourcemanager::v3::DeleteTagHoldRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteTagHold(google::longrunning::Operation const &, Options)

Deletes a TagHold.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::resourcemanager::v3::DeleteTagHoldMetadata > >`

ListTagHolds(std::string const &, Options)

Lists TagHolds under a TagValue.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent TagValue. Must be of the form: `tagValues/{tag-value-id}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::resourcemanager::v3::TagHold >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.resourcemanager.v3.TagHold, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTagHolds(google::cloud::resourcemanager::v3::ListTagHoldsRequest, Options)

Lists TagHolds under a TagValue.

Parameters
Name	Description
`request`	`google::cloud::resourcemanager::v3::ListTagHoldsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.resourcemanager.v3.ListTagHoldsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::resourcemanager::v3::TagHold >

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
`request`	`google::longrunning::GetOperationRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.GetOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.