Class MetadataServiceClient (2.23.0)

Metadata service manages metadata resources such as tables, filesets and partitions.

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

MetadataServiceClient(MetadataServiceClient const &)

Copy and move support

Parameter
Name	Description
	`MetadataServiceClient const &`

MetadataServiceClient(MetadataServiceClient &&)

Copy and move support

Parameter
Name	Description
	`MetadataServiceClient &&`

MetadataServiceClient(std::shared_ptr< MetadataServiceConnection >, Options)

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

Operators

operator=(MetadataServiceClient const &)

Copy and move support

Parameter
Name	Description
	`MetadataServiceClient const &`

Returns
Type	Description
`MetadataServiceClient &`

operator=(MetadataServiceClient &&)

Copy and move support

Parameter
Name	Description
	`MetadataServiceClient &&`

Returns
Type	Description
`MetadataServiceClient &`

Functions

CreateEntity(std::string const &, google::cloud::dataplex::v1::Entity const &, Options)

Create a metadata entity.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
`entity`	`google::cloud::dataplex::v1::Entity const &` Required. Entity resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

CreateEntity(google::cloud::dataplex::v1::CreateEntityRequest const &, Options)

Create a metadata entity.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::CreateEntityRequest 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.dataplex.v1.CreateEntityRequest. 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::cloud::dataplex::v1::Entity >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.Entity) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateEntity(google::cloud::dataplex::v1::UpdateEntityRequest const &, Options)

Update a metadata entity.

Only supports full resource update.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::UpdateEntityRequest 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.dataplex.v1.UpdateEntityRequest. 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::cloud::dataplex::v1::Entity >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.Entity) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteEntity(std::string const &, Options)

Delete a metadata entity.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the entity: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteEntity(google::cloud::dataplex::v1::DeleteEntityRequest const &, Options)

Delete a metadata entity.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::DeleteEntityRequest 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.dataplex.v1.DeleteEntityRequest. 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
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

GetEntity(std::string const &, Options)

Get a metadata entity.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the entity: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetEntity(google::cloud::dataplex::v1::GetEntityRequest const &, Options)

Get a metadata entity.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::GetEntityRequest 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.dataplex.v1.GetEntityRequest. 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::cloud::dataplex::v1::Entity >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.Entity) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListEntities(std::string const &, Options)

List metadata entities in a zone.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::dataplex::v1::Entity >

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

ListEntities(google::cloud::dataplex::v1::ListEntitiesRequest, Options)

List metadata entities in a zone.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::ListEntitiesRequest` 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.dataplex.v1.ListEntitiesRequest. 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::dataplex::v1::Entity >

CreatePartition(std::string const &, google::cloud::dataplex::v1::Partition const &, Options)

Create a metadata partition.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
`partition`	`google::cloud::dataplex::v1::Partition const &` Required. Partition resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

CreatePartition(google::cloud::dataplex::v1::CreatePartitionRequest const &, Options)

Create a metadata partition.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::CreatePartitionRequest 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.dataplex.v1.CreatePartitionRequest. 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::cloud::dataplex::v1::Partition >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.Partition) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeletePartition(std::string const &, Options)

Delete a metadata partition.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the partition. format: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}/partitions/{partition_value_path}`. The {partition_value_path} segment consists of an ordered sequence of partition values separated by "/". All values must be provided.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeletePartition(google::cloud::dataplex::v1::DeletePartitionRequest const &, Options)

Delete a metadata partition.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::DeletePartitionRequest 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.dataplex.v1.DeletePartitionRequest. 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
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

GetPartition(std::string const &, Options)

Get a metadata partition of an entity.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the partition: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}/partitions/{partition_value_path}`. The {partition_value_path} segment consists of an ordered sequence of partition values separated by "/". All values must be provided.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetPartition(google::cloud::dataplex::v1::GetPartitionRequest const &, Options)

Get a metadata partition of an entity.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::GetPartitionRequest 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.dataplex.v1.GetPartitionRequest. 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::cloud::dataplex::v1::Partition >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.Partition) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListPartitions(std::string const &, Options)

List metadata partitions of an entity.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent entity: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::dataplex::v1::Partition >

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

ListPartitions(google::cloud::dataplex::v1::ListPartitionsRequest, Options)

List metadata partitions of an entity.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::ListPartitionsRequest` 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.dataplex.v1.ListPartitionsRequest. 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::dataplex::v1::Partition >

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