DataprocMetastoreFederationClient (Google Dataproc Metastore 2.40.0 API)

java.lang.Object
- com.google.cloud.metastore.v1beta.DataprocMetastoreFederationClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class DataprocMetastoreFederationClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: 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}`.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create()) {
   FederationName name = FederationName.of("[PROJECT]", "[LOCATION]", "[FEDERATION]");
   Federation response = dataprocMetastoreFederationClient.getFederation(name);
 }

Note: close() needs to be called on the DataprocMetastoreFederationClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
ListFederations	Lists federations in a project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listFederations(ListFederationsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listFederations(LocationName parent) listFederations(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listFederationsPagedCallable() listFederationsCallable()
GetFederation	Gets the details of a single federation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getFederation(GetFederationRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getFederation(FederationName name) getFederation(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getFederationCallable()
CreateFederation	Creates a metastore federation in a project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createFederationAsync(CreateFederationRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createFederationAsync(LocationName parent, Federation federation, String federationId) createFederationAsync(String parent, Federation federation, String federationId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createFederationOperationCallable() createFederationCallable()
UpdateFederation	Updates the fields of a federation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateFederationAsync(UpdateFederationRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateFederationAsync(Federation federation, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateFederationOperationCallable() updateFederationCallable()
DeleteFederation	Deletes a single federation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteFederationAsync(DeleteFederationRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteFederationAsync(FederationName name) deleteFederationAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteFederationOperationCallable() deleteFederationCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()
SetIamPolicy	Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
GetIamPolicy	Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DataprocMetastoreFederationSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataprocMetastoreFederationSettings dataprocMetastoreFederationSettings =
     DataprocMetastoreFederationSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create(dataprocMetastoreFederationSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataprocMetastoreFederationSettings dataprocMetastoreFederationSettings =
     DataprocMetastoreFederationSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create(dataprocMetastoreFederationSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataprocMetastoreFederationSettings dataprocMetastoreFederationSettings =
     DataprocMetastoreFederationSettings.newHttpJsonBuilder().build();
 DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create(dataprocMetastoreFederationSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataprocMetastoreFederationClient.ListFederationsFixedSizeCollection`
`static class`	`DataprocMetastoreFederationClient.ListFederationsPage`
`static class`	`DataprocMetastoreFederationClient.ListFederationsPagedResponse`
`static class`	`DataprocMetastoreFederationClient.ListLocationsFixedSizeCollection`
`static class`	`DataprocMetastoreFederationClient.ListLocationsPage`
`static class`	`DataprocMetastoreFederationClient.ListLocationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DataprocMetastoreFederationClient(DataprocMetastoreFederationSettings settings)` Constructs an instance of DataprocMetastoreFederationClient, using the given settings.
`protected`	`DataprocMetastoreFederationClient(DataprocMetastoreFederationStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static DataprocMetastoreFederationClient`	`create()` Constructs an instance of DataprocMetastoreFederationClient with default settings.
`static DataprocMetastoreFederationClient`	`create(DataprocMetastoreFederationSettings settings)` Constructs an instance of DataprocMetastoreFederationClient, using the given settings.
`static DataprocMetastoreFederationClient`	`create(DataprocMetastoreFederationStub stub)` Constructs an instance of DataprocMetastoreFederationClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Federation,OperationMetadata>`	`createFederationAsync(CreateFederationRequest request)` Creates a metastore federation in a project and location.
`com.google.api.gax.longrunning.OperationFuture<Federation,OperationMetadata>`	`createFederationAsync(LocationName parent, Federation federation, String federationId)` Creates a metastore federation in a project and location.
`com.google.api.gax.longrunning.OperationFuture<Federation,OperationMetadata>`	`createFederationAsync(String parent, Federation federation, String federationId)` Creates a metastore federation in a project and location.
`com.google.api.gax.rpc.UnaryCallable<CreateFederationRequest,com.google.longrunning.Operation>`	`createFederationCallable()` Creates a metastore federation in a project and location.
`com.google.api.gax.rpc.OperationCallable<CreateFederationRequest,Federation,OperationMetadata>`	`createFederationOperationCallable()` Creates a metastore federation in a project and location.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>`	`deleteFederationAsync(DeleteFederationRequest request)` Deletes a single federation.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>`	`deleteFederationAsync(FederationName name)` Deletes a single federation.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>`	`deleteFederationAsync(String name)` Deletes a single federation.
`com.google.api.gax.rpc.UnaryCallable<DeleteFederationRequest,com.google.longrunning.Operation>`	`deleteFederationCallable()` Deletes a single federation.
`com.google.api.gax.rpc.OperationCallable<DeleteFederationRequest,com.google.protobuf.Empty,OperationMetadata>`	`deleteFederationOperationCallable()` Deletes a single federation.
`Federation`	`getFederation(FederationName name)` Gets the details of a single federation.
`Federation`	`getFederation(GetFederationRequest request)` Gets the details of a single federation.
`Federation`	`getFederation(String name)` Gets the details of a single federation.
`com.google.api.gax.rpc.UnaryCallable<GetFederationRequest,Federation>`	`getFederationCallable()` Gets the details of a single federation.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`DataprocMetastoreFederationSettings`	`getSettings()`
`DataprocMetastoreFederationStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`DataprocMetastoreFederationClient.ListFederationsPagedResponse`	`listFederations(ListFederationsRequest request)` Lists federations in a project and location.
`DataprocMetastoreFederationClient.ListFederationsPagedResponse`	`listFederations(LocationName parent)` Lists federations in a project and location.
`DataprocMetastoreFederationClient.ListFederationsPagedResponse`	`listFederations(String parent)` Lists federations in a project and location.
`com.google.api.gax.rpc.UnaryCallable<ListFederationsRequest,ListFederationsResponse>`	`listFederationsCallable()` Lists federations in a project and location.
`com.google.api.gax.rpc.UnaryCallable<ListFederationsRequest,DataprocMetastoreFederationClient.ListFederationsPagedResponse>`	`listFederationsPagedCallable()` Lists federations in a project and location.
`DataprocMetastoreFederationClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,DataprocMetastoreFederationClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.longrunning.OperationFuture<Federation,OperationMetadata>`	`updateFederationAsync(Federation federation, com.google.protobuf.FieldMask updateMask)` Updates the fields of a federation.
`com.google.api.gax.longrunning.OperationFuture<Federation,OperationMetadata>`	`updateFederationAsync(UpdateFederationRequest request)` Updates the fields of a federation.
`com.google.api.gax.rpc.UnaryCallable<UpdateFederationRequest,com.google.longrunning.Operation>`	`updateFederationCallable()` Updates the fields of a federation.
`com.google.api.gax.rpc.OperationCallable<UpdateFederationRequest,Federation,OperationMetadata>`	`updateFederationOperationCallable()` Updates the fields of a federation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DataprocMetastoreFederationClient
```
protected DataprocMetastoreFederationClient(DataprocMetastoreFederationSettings settings)
                                     throws IOException
```
  Constructs an instance of DataprocMetastoreFederationClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- DataprocMetastoreFederationClient
```
protected DataprocMetastoreFederationClient(DataprocMetastoreFederationStub stub)
```

Method Detail

create

public static final DataprocMetastoreFederationClient create()
                                                      throws IOException

Constructs an instance of DataprocMetastoreFederationClient with default settings.

Throws:: IOException

create
```
public static final DataprocMetastoreFederationClient create(DataprocMetastoreFederationSettings settings)
                                                      throws IOException
```
Constructs an instance of DataprocMetastoreFederationClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final DataprocMetastoreFederationClient create(DataprocMetastoreFederationStub stub)
```
Constructs an instance of DataprocMetastoreFederationClient, using the given stub for making calls. This is for advanced usage - prefer using create(DataprocMetastoreFederationSettings).

getSettings

public final DataprocMetastoreFederationSettings getSettings()

getStub

public DataprocMetastoreFederationStub getStub()

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

listFederations

public final DataprocMetastoreFederationClient.ListFederationsPagedResponse listFederations(LocationName parent)

Lists federations in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Federation element :
       dataprocMetastoreFederationClient.listFederations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The relative resource name of the location of metastore federations to list, in the following form: `projects/{project_number}/locations/{location_id}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listFederations

public final DataprocMetastoreFederationClient.ListFederationsPagedResponse listFederations(String parent)

Lists federations in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Federation element :
       dataprocMetastoreFederationClient.listFederations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The relative resource name of the location of metastore federations to list, in the following form: `projects/{project_number}/locations/{location_id}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listFederations

public final DataprocMetastoreFederationClient.ListFederationsPagedResponse listFederations(ListFederationsRequest request)

Lists federations in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create()) {
   ListFederationsRequest request =
       ListFederationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Federation element :
       dataprocMetastoreFederationClient.listFederations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listFederationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListFederationsRequest,DataprocMetastoreFederationClient.ListFederationsPagedResponse> listFederationsPagedCallable()

Lists federations in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create()) {
   ListFederationsRequest request =
       ListFederationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Federation> future =
       dataprocMetastoreFederationClient.listFederationsPagedCallable().futureCall(request);
   // Do something.
   for (Federation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listFederationsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListFederationsRequest,ListFederationsResponse> listFederationsCallable()

Lists federations in a project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create()) {
   ListFederationsRequest request =
       ListFederationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListFederationsResponse response =
         dataprocMetastoreFederationClient.listFederationsCallable().call(request);
     for (Federation element : response.getFederationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getFederation

public final Federation getFederation(FederationName name)

Gets the details of a single federation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create()) {
   FederationName name = FederationName.of("[PROJECT]", "[LOCATION]", "[FEDERATION]");
   Federation response = dataprocMetastoreFederationClient.getFederation(name);
 }

Parameters:: name - Required. The relative resource name of the metastore federation to retrieve, in the following form:
`projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getFederation

public final Federation getFederation(String name)

Gets the details of a single federation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create()) {
   String name = FederationName.of("[PROJECT]", "[LOCATION]", "[FEDERATION]").toString();
   Federation response = dataprocMetastoreFederationClient.getFederation(name);
 }

Parameters:: name - Required. The relative resource name of the metastore federation to retrieve, in the following form:
`projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getFederation

public final Federation getFederation(GetFederationRequest request)

Gets the details of a single federation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create()) {
   GetFederationRequest request =
       GetFederationRequest.newBuilder()
           .setName(FederationName.of("[PROJECT]", "[LOCATION]", "[FEDERATION]").toString())
           .build();
   Federation response = dataprocMetastoreFederationClient.getFederation(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getFederationCallable

public final com.google.api.gax.rpc.UnaryCallable<GetFederationRequest,Federation> getFederationCallable()

Gets the details of a single federation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
     DataprocMetastoreFederationClient.create()) {
   GetFederationRequest request =
       GetFederationRequest.newBuilder()
           .setName(FederationName.of("[PROJECT]", "[LOCATION]", "[FEDERATION]").toString())
           .build();
   ApiFuture<Federation> future =
       dataprocMetastoreFederationClient.getFederationCallable().futureCall(request);
   // Do something.
   Federation response = future.get();
 }