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: |
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 |
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 |
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 |
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 |
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 |
DeleteEntity(std::string const &, Options)
Delete a metadata entity.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the entity: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
GetEntity(std::string const &, Options)
Get a metadata entity.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the entity: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
DeletePartition(std::string const &, Options)
Delete a metadata partition.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the partition. format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::ListLocationsRequest
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::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::GetLocationRequest 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 |
StatusOr< google::cloud::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)
Sets the access control policy on the specified resource.
Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::SetIamPolicyRequest 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 |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
Gets the access control policy for a resource.
Returns an empty policy if the resource exists and does not have a policy set.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::GetIamPolicyRequest 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 |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)
Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::TestIamPermissionsRequest 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 |
StatusOr< google::iam::v1::TestIamPermissionsResponse > |
the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
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::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
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 |
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 |
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 |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::DeleteOperationRequest 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 |
Status |
a |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::CancelOperationRequest 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 |
Status |
a |