Configures and manages metastore federation services.
Dataproc Metastore Federation Service allows federating a collection of backend metastores like BigQuery, Dataplex Lakes, and other Dataproc Metastores. The Federation Service exposes a gRPC URL through which metadata from the backend metastores are served at query time.
The Dataproc Metastore Federation API defines the following resource model:
- The service works with a collection of Google Cloud projects.
- Each project has a collection of available locations.
- Each location has a collection of federations.
- Dataproc Metastore Federations are resources with names of the form:
projects/{project_number}/locations/{location_id}/federations/{federation_id}
.
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
DataprocMetastoreFederationClient(DataprocMetastoreFederationClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DataprocMetastoreFederationClient const &
|
DataprocMetastoreFederationClient(DataprocMetastoreFederationClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DataprocMetastoreFederationClient &&
|
DataprocMetastoreFederationClient(std::shared_ptr< DataprocMetastoreFederationConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< DataprocMetastoreFederationConnection >
|
opts |
Options
|
Operators
operator=(DataprocMetastoreFederationClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DataprocMetastoreFederationClient const &
|
Returns | |
---|---|
Type | Description |
DataprocMetastoreFederationClient & |
operator=(DataprocMetastoreFederationClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
DataprocMetastoreFederationClient &&
|
Returns | |
---|---|
Type | Description |
DataprocMetastoreFederationClient & |
Functions
ListFederations(std::string const &, Options)
Lists federations in a project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The relative resource name of the location of metastore federations to list, in the following form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::metastore::v1::Federation > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListFederations(google::cloud::metastore::v1::ListFederationsRequest, Options)
Lists federations in a project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::ListFederationsRequest
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::metastore::v1::Federation > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetFederation(std::string const &, Options)
Gets the details of a single federation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The relative resource name of the metastore federation to retrieve, in the following form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::metastore::v1::Federation > | the result of the RPC. The response message type (google.cloud.metastore.v1.Federation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetFederation(google::cloud::metastore::v1::GetFederationRequest const &, Options)
Gets the details of a single federation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::GetFederationRequest 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::metastore::v1::Federation > | the result of the RPC. The response message type (google.cloud.metastore.v1.Federation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateFederation(std::string const &, google::cloud::metastore::v1::Federation const &, std::string const &, Options)
Creates a metastore federation in a project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The relative resource name of the location in which to create a federation service, in the following form: |
federation |
google::cloud::metastore::v1::Federation const &
Required. The Metastore Federation to create. The |
federation_id |
std::string const &
Required. The ID of the metastore federation, which is used as the final component of the metastore federation's name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Federation > > | A |
CreateFederation(google::cloud::metastore::v1::CreateFederationRequest const &, Options)
Creates a metastore federation in a project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::CreateFederationRequest 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::metastore::v1::Federation > > | A |
UpdateFederation(google::cloud::metastore::v1::Federation const &, google::protobuf::FieldMask const &, Options)
Updates the fields of a federation.
Parameters | |
---|---|
Name | Description |
federation |
google::cloud::metastore::v1::Federation const &
Required. The metastore federation to update. The server only merges fields in the service if they are specified in |
update_mask |
google::protobuf::FieldMask const &
Required. A field mask used to specify the fields to be overwritten in the metastore federation resource by the update. Fields specified in the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::Federation > > | A |
UpdateFederation(google::cloud::metastore::v1::UpdateFederationRequest const &, Options)
Updates the fields of a federation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::UpdateFederationRequest 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::metastore::v1::Federation > > | A |
DeleteFederation(std::string const &, Options)
Deletes a single federation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The relative resource name of the metastore federation to delete, in the following form: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::metastore::v1::OperationMetadata > > | A |
DeleteFederation(google::cloud::metastore::v1::DeleteFederationRequest const &, Options)
Deletes a single federation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::metastore::v1::DeleteFederationRequest 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::metastore::v1::OperationMetadata > > | A |