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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |