Reference documentation and code samples for the Dataproc Metastore V1 API class Google::Cloud::Metastore::V1::DataprocMetastoreFederation::Rest::Client.
REST client for the DataprocMetastoreFederation service.
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}
.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the DataprocMetastoreFederation Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all DataprocMetastoreFederation clients ::Google::Cloud::Metastore::V1::DataprocMetastoreFederation::Rest::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the DataprocMetastoreFederation Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_federation
def create_federation(request, options = nil) -> ::Gapic::Operation
def create_federation(parent: nil, federation_id: nil, federation: nil, request_id: nil) -> ::Gapic::Operation
Creates a metastore federation in a project and location.
def create_federation(request, options = nil) -> ::Gapic::Operation
create_federation
via a request object, either of type
CreateFederationRequest or an equivalent Hash.
- request (::Google::Cloud::Metastore::V1::CreateFederationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def create_federation(parent: nil, federation_id: nil, federation: nil, request_id: nil) -> ::Gapic::Operation
create_federation
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — 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_id (::String) — 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.
-
federation (::Google::Cloud::Metastore::V1::Federation, ::Hash) — Required. The Metastore Federation to create. The
name
field is ignored. The ID of the created metastore federation must be provided in the request'sfederation_id
field. -
request_id (::String) — Optional. A request ID. Specify a unique request ID to allow the server to
ignore the request if it has completed. The server will ignore subsequent
requests that provide a duplicate request ID for at least 60 minutes after
the first request.
For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.
The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#delete_federation
def delete_federation(request, options = nil) -> ::Gapic::Operation
def delete_federation(name: nil, request_id: nil) -> ::Gapic::Operation
Deletes a single federation.
def delete_federation(request, options = nil) -> ::Gapic::Operation
delete_federation
via a request object, either of type
Google::Cloud::Metastore::V1::DeleteFederationRequest or an equivalent Hash.
- request (::Google::Cloud::Metastore::V1::DeleteFederationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete_federation(name: nil, request_id: nil) -> ::Gapic::Operation
delete_federation
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The relative resource name of the metastore federation to delete,
in the following form:
projects/{project_number}/locations/{location_id}/federations/{federation_id}
. -
request_id (::String) — Optional. A request ID. Specify a unique request ID to allow the server to
ignore the request if it has completed. The server will ignore subsequent
requests that provide a duplicate request ID for at least 60 minutes after
the first request.
For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.
The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_federation
def get_federation(request, options = nil) -> ::Google::Cloud::Metastore::V1::Federation
def get_federation(name: nil) -> ::Google::Cloud::Metastore::V1::Federation
Gets the details of a single federation.
def get_federation(request, options = nil) -> ::Google::Cloud::Metastore::V1::Federation
get_federation
via a request object, either of type
GetFederationRequest or an equivalent Hash.
- request (::Google::Cloud::Metastore::V1::GetFederationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_federation(name: nil) -> ::Google::Cloud::Metastore::V1::Federation
get_federation
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The relative resource name of the metastore federation to
retrieve, in the following form:
projects/{project_number}/locations/{location_id}/federations/{federation_id}
.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Metastore::V1::Federation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#iam_policy_client
def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Rest::Client
Get the associated client for mix-in of the IAMPolicy.
- (Google::Iam::V1::IAMPolicy::Rest::Client)
#initialize
def initialize() { |config| ... } -> Client
Create a new DataprocMetastoreFederation REST client object.
- (config) — Configure the DataprocMetastoreFederation client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Metastore::V1::DataprocMetastoreFederation::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Metastore::V1::DataprocMetastoreFederation::Rest::Client.new do |config| config.timeout = 10.0 end
#list_federations
def list_federations(request, options = nil) -> ::Google::Cloud::Metastore::V1::ListFederationsResponse
def list_federations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Metastore::V1::ListFederationsResponse
Lists federations in a project and location.
def list_federations(request, options = nil) -> ::Google::Cloud::Metastore::V1::ListFederationsResponse
list_federations
via a request object, either of type
ListFederationsRequest or an equivalent Hash.
- request (::Google::Cloud::Metastore::V1::ListFederationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_federations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Google::Cloud::Metastore::V1::ListFederationsResponse
list_federations
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The relative resource name of the location of metastore
federations to list, in the following form:
projects/{project_number}/locations/{location_id}
. - page_size (::Integer) — Optional. The maximum number of federations to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.
-
page_token (::String) — Optional. A page token, received from a previous ListFederationServices
call. Provide this token to retrieve the subsequent page.
To retrieve the first page, supply an empty page token.
When paginating, other parameters provided to ListFederationServices must match the call that provided the page token.
- filter (::String) — Optional. The filter to apply to list results.
- order_by (::String) — Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Metastore::V1::ListFederationsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#location_client
def location_client() -> Google::Cloud::Location::Locations::Rest::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Rest::Client)
#operations_client
def operations_client() -> ::Google::Cloud::Metastore::V1::DataprocMetastoreFederation::Rest::Operations
Get the associated client for long-running operations.
#update_federation
def update_federation(request, options = nil) -> ::Gapic::Operation
def update_federation(update_mask: nil, federation: nil, request_id: nil) -> ::Gapic::Operation
Updates the fields of a federation.
def update_federation(request, options = nil) -> ::Gapic::Operation
update_federation
via a request object, either of type
UpdateFederationRequest or an equivalent Hash.
- request (::Google::Cloud::Metastore::V1::UpdateFederationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def update_federation(update_mask: nil, federation: nil, request_id: nil) -> ::Gapic::Operation
update_federation
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) — 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. -
federation (::Google::Cloud::Metastore::V1::Federation, ::Hash) — 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. -
request_id (::String) — Optional. A request ID. Specify a unique request ID to allow the server to
ignore the request if it has completed. The server will ignore subsequent
requests that provide a duplicate request ID for at least 60 minutes after
the first request.
For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.
The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.