Class DataprocMetastoreFederationClient (2.23.0-rc)

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: `projects/{project_number}/locations/{location_id}`.
`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 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.metastore.v1.Federation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.metastore.v1.ListFederationsRequest. 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::metastore::v1::Federation >

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: `projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
`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 `StatusOr` contains the error details.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.metastore.v1.GetFederationRequest. 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::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 `StatusOr` contains the error details.

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: `projects/{project_number}/locations/{location_id}`.
`federation`	`google::cloud::metastore::v1::Federation const &` Required. The Metastore Federation to create. The `name` field is ignored. The ID of the created metastore federation must be provided in the request's `federation_id` field.
`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. This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
`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 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.metastore.v1.Federation proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.metastore.v1.CreateFederationRequest. 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::metastore::v1::Federation > >

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`. The metastore federation's `name` field is used to identify the metastore service to be updated.
`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 `update_mask` are relative to the resource (not to the full request). A field is overwritten if it is in the mask.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::metastore::v1::Federation > >

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.metastore.v1.UpdateFederationRequest. 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::metastore::v1::Federation > >

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: `projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
`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 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.metastore.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.metastore.v1.DeleteFederationRequest. 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::metastore::v1::OperationMetadata > >

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