Class TagBindingsClient (2.26.0-rc)

Allow users to create and manage TagBindings between TagValues and different Google Cloud resources throughout the GCP resource hierarchy.

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

TagBindingsClient(TagBindingsClient const &)

Copy and move support

Parameter
Name Description
TagBindingsClient const &

TagBindingsClient(TagBindingsClient &&)

Copy and move support

Parameter
Name Description
TagBindingsClient &&

TagBindingsClient(std::shared_ptr< TagBindingsConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< TagBindingsConnection >
opts Options

Operators

operator=(TagBindingsClient const &)

Copy and move support

Parameter
Name Description
TagBindingsClient const &
Returns
Type Description
TagBindingsClient &

operator=(TagBindingsClient &&)

Copy and move support

Parameter
Name Description
TagBindingsClient &&
Returns
Type Description
TagBindingsClient &

Functions

ListTagBindings(std::string const &, Options)

Lists the TagBindings for the given Google Cloud resource, as specified with parent.

NOTE: The parent field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name

Parameters
Name Description
parent std::string const &

Required. The full resource name of a resource for which you want to list existing TagBindings. E.g. "//cloudresourcemanager.googleapis.com/projects/123"

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::resourcemanager::v3::TagBinding >

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.TagBinding, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTagBindings(google::cloud::resourcemanager::v3::ListTagBindingsRequest, Options)

Lists the TagBindings for the given Google Cloud resource, as specified with parent.

NOTE: The parent field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name

Parameters
Name Description
request google::cloud::resourcemanager::v3::ListTagBindingsRequest

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.ListTagBindingsRequest. 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::TagBinding >

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.TagBinding, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateTagBinding(google::cloud::resourcemanager::v3::TagBinding const &, Options)

Creates a TagBinding between a TagValue and a Google Cloud resource.

Parameters
Name Description
tag_binding google::cloud::resourcemanager::v3::TagBinding const &

Required. The TagBinding 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::TagBinding > >

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.TagBinding proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateTagBinding(google::cloud::resourcemanager::v3::CreateTagBindingRequest const &, Options)

Creates a TagBinding between a TagValue and a Google Cloud resource.

Parameters
Name Description
request google::cloud::resourcemanager::v3::CreateTagBindingRequest 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.CreateTagBindingRequest. 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::TagBinding > >

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.TagBinding proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTagBinding(std::string const &, Options)

Deletes a TagBinding.

Parameters
Name Description
name std::string const &

Required. The name of the TagBinding. This is a String of the form: tagBindings/{id} (e.g. tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456).

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

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.DeleteTagBindingMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTagBinding(google::cloud::resourcemanager::v3::DeleteTagBindingRequest const &, Options)

Deletes a TagBinding.

Parameters
Name Description
request google::cloud::resourcemanager::v3::DeleteTagBindingRequest 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.DeleteTagBindingRequest. 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::DeleteTagBindingMetadata > >

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.DeleteTagBindingMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListEffectiveTags(std::string const &, Options)

Return a list of effective tags for the given Google Cloud resource, as specified in parent.

Parameters
Name Description
parent std::string const &

Required. The full resource name of a resource for which you want to list the effective tags. E.g. "//cloudresourcemanager.googleapis.com/projects/123"

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::resourcemanager::v3::EffectiveTag >

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.EffectiveTag, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEffectiveTags(google::cloud::resourcemanager::v3::ListEffectiveTagsRequest, Options)

Return a list of effective tags for the given Google Cloud resource, as specified in parent.

Parameters
Name Description
request google::cloud::resourcemanager::v3::ListEffectiveTagsRequest

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.ListEffectiveTagsRequest. 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::EffectiveTag >

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.EffectiveTag, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.