Class PolicyTagManagerSerializationClient (2.18.0-rc)

Policy Tag Manager Serialization API service allows you to manipulate your policy tags and taxonomies in a serialized format.

Taxonomy is a hierarchical group of policy tags.

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

PolicyTagManagerSerializationClient(PolicyTagManagerSerializationClient const &)

Copy and move support

Parameter
NameDescription
PolicyTagManagerSerializationClient const &

PolicyTagManagerSerializationClient(PolicyTagManagerSerializationClient &&)

Copy and move support

Parameter
NameDescription
PolicyTagManagerSerializationClient &&

PolicyTagManagerSerializationClient(std::shared_ptr< PolicyTagManagerSerializationConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< PolicyTagManagerSerializationConnection >
opts Options

Operators

operator=(PolicyTagManagerSerializationClient const &)

Copy and move support

Parameter
NameDescription
PolicyTagManagerSerializationClient const &
Returns
TypeDescription
PolicyTagManagerSerializationClient &

operator=(PolicyTagManagerSerializationClient &&)

Copy and move support

Parameter
NameDescription
PolicyTagManagerSerializationClient &&
Returns
TypeDescription
PolicyTagManagerSerializationClient &

Functions

ReplaceTaxonomy(google::cloud::datacatalog::v1::ReplaceTaxonomyRequest const &, Options)

Replaces (updates) a taxonomy and all its policy tags.

The taxonomy and its entire hierarchy of policy tags must be represented literally by SerializedTaxonomy and the nested SerializedPolicyTag messages.

This operation automatically does the following:

  • Deletes the existing policy tags that are missing from the SerializedPolicyTag.
  • Creates policy tags that don't have resource names. They are considered new.
  • Updates policy tags with valid resources names accordingly.
Parameters
NameDescription
request google::cloud::datacatalog::v1::ReplaceTaxonomyRequest 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.datacatalog.v1.ReplaceTaxonomyRequest. 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
TypeDescription
StatusOr< google::cloud::datacatalog::v1::Taxonomy >

the result of the RPC. The response message type (google.cloud.datacatalog.v1.Taxonomy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ImportTaxonomies(google::cloud::datacatalog::v1::ImportTaxonomiesRequest const &, Options)

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.

For a cross-regional source, new taxonomies are created by copying from a source in another region.

For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.

Parameters
NameDescription
request google::cloud::datacatalog::v1::ImportTaxonomiesRequest 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.datacatalog.v1.ImportTaxonomiesRequest. 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
TypeDescription
StatusOr< google::cloud::datacatalog::v1::ImportTaxonomiesResponse >

the result of the RPC. The response message type (google.cloud.datacatalog.v1.ImportTaxonomiesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ExportTaxonomies(google::cloud::datacatalog::v1::ExportTaxonomiesRequest const &, Options)

Exports taxonomies in the requested type and returns them, including their policy tags.

The requested taxonomies must belong to the same project.

This method generates SerializedTaxonomy protocol buffers with nested policy tags that can be used as input for ImportTaxonomies calls.

Parameters
NameDescription
request google::cloud::datacatalog::v1::ExportTaxonomiesRequest 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.datacatalog.v1.ExportTaxonomiesRequest. 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
TypeDescription
StatusOr< google::cloud::datacatalog::v1::ExportTaxonomiesResponse >

the result of the RPC. The response message type (google.cloud.datacatalog.v1.ExportTaxonomiesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.