Class DataFusionClient
- java.lang.Object
-
- com.google.cloud.datafusion.v1.DataFusionClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class DataFusionClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service for creating and managing Data Fusion instances. Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { GetInstanceRequest request = GetInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); Instance response = dataFusionClient.getInstance(request); }
Note: close() needs to be called on the DataFusionClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
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 DataFusionSettings 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 DataFusionSettings dataFusionSettings = DataFusionSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); DataFusionClient dataFusionClient = DataFusionClient.create(dataFusionSettings);
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 DataFusionSettings dataFusionSettings = DataFusionSettings.newBuilder().setEndpoint(myEndpoint).build(); DataFusionClient dataFusionClient = DataFusionClient.create(dataFusionSettings);
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 DataFusionSettings dataFusionSettings = DataFusionSettings.newHttpJsonBuilder().build(); DataFusionClient dataFusionClient = DataFusionClient.create(dataFusionSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DataFusionClient.ListAvailableVersionsFixedSizeCollection
static class
DataFusionClient.ListAvailableVersionsPage
static class
DataFusionClient.ListAvailableVersionsPagedResponse
static class
DataFusionClient.ListInstancesFixedSizeCollection
static class
DataFusionClient.ListInstancesPage
static class
DataFusionClient.ListInstancesPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
DataFusionClient(DataFusionSettings settings)
Constructs an instance of DataFusionClient, using the given settings.protected
DataFusionClient(DataFusionStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static DataFusionClient
create()
Constructs an instance of DataFusionClient with default settings.static DataFusionClient
create(DataFusionSettings settings)
Constructs an instance of DataFusionClient, using the given settings.static DataFusionClient
create(DataFusionStub stub)
Constructs an instance of DataFusionClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>
createInstanceAsync(CreateInstanceRequest request)
Creates a new Data Fusion instance in the specified project and location.com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>
createInstanceAsync(LocationName parent, Instance instance, String instanceId)
Creates a new Data Fusion instance in the specified project and location.com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>
createInstanceAsync(String parent, Instance instance, String instanceId)
Creates a new Data Fusion instance in the specified project and location.com.google.api.gax.rpc.UnaryCallable<CreateInstanceRequest,com.google.longrunning.Operation>
createInstanceCallable()
Creates a new Data Fusion instance in the specified project and location.com.google.api.gax.rpc.OperationCallable<CreateInstanceRequest,Instance,OperationMetadata>
createInstanceOperationCallable()
Creates a new Data Fusion instance in the specified project and location.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteInstanceAsync(DeleteInstanceRequest request)
Deletes a single Date Fusion instance.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteInstanceAsync(InstanceName name)
Deletes a single Date Fusion instance.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteInstanceAsync(String name)
Deletes a single Date Fusion instance.com.google.api.gax.rpc.UnaryCallable<DeleteInstanceRequest,com.google.longrunning.Operation>
deleteInstanceCallable()
Deletes a single Date Fusion instance.com.google.api.gax.rpc.OperationCallable<DeleteInstanceRequest,com.google.protobuf.Empty,OperationMetadata>
deleteInstanceOperationCallable()
Deletes a single Date Fusion instance.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.Instance
getInstance(GetInstanceRequest request)
Gets details of a single Data Fusion instance.com.google.api.gax.rpc.UnaryCallable<GetInstanceRequest,Instance>
getInstanceCallable()
Gets details of a single Data Fusion instance.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.DataFusionSettings
getSettings()
DataFusionStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
DataFusionClient.ListAvailableVersionsPagedResponse
listAvailableVersions(ListAvailableVersionsRequest request)
Lists possible versions for Data Fusion instances in the specified project and location.DataFusionClient.ListAvailableVersionsPagedResponse
listAvailableVersions(LocationName parent)
Lists possible versions for Data Fusion instances in the specified project and location.DataFusionClient.ListAvailableVersionsPagedResponse
listAvailableVersions(String parent)
Lists possible versions for Data Fusion instances in the specified project and location.com.google.api.gax.rpc.UnaryCallable<ListAvailableVersionsRequest,ListAvailableVersionsResponse>
listAvailableVersionsCallable()
Lists possible versions for Data Fusion instances in the specified project and location.com.google.api.gax.rpc.UnaryCallable<ListAvailableVersionsRequest,DataFusionClient.ListAvailableVersionsPagedResponse>
listAvailableVersionsPagedCallable()
Lists possible versions for Data Fusion instances in the specified project and location.DataFusionClient.ListInstancesPagedResponse
listInstances(ListInstancesRequest request)
Lists Data Fusion instances in the specified project and location.com.google.api.gax.rpc.UnaryCallable<ListInstancesRequest,ListInstancesResponse>
listInstancesCallable()
Lists Data Fusion instances in the specified project and location.com.google.api.gax.rpc.UnaryCallable<ListInstancesRequest,DataFusionClient.ListInstancesPagedResponse>
listInstancesPagedCallable()
Lists Data Fusion instances in the specified project and location.com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>
restartInstanceAsync(RestartInstanceRequest request)
Restart a single Data Fusion instance.com.google.api.gax.rpc.UnaryCallable<RestartInstanceRequest,com.google.longrunning.Operation>
restartInstanceCallable()
Restart a single Data Fusion instance.com.google.api.gax.rpc.OperationCallable<RestartInstanceRequest,Instance,OperationMetadata>
restartInstanceOperationCallable()
Restart a single Data Fusion instance.void
shutdown()
void
shutdownNow()
com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>
updateInstanceAsync(Instance instance, com.google.protobuf.FieldMask updateMask)
Updates a single Data Fusion instance.com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata>
updateInstanceAsync(UpdateInstanceRequest request)
Updates a single Data Fusion instance.com.google.api.gax.rpc.UnaryCallable<UpdateInstanceRequest,com.google.longrunning.Operation>
updateInstanceCallable()
Updates a single Data Fusion instance.com.google.api.gax.rpc.OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata>
updateInstanceOperationCallable()
Updates a single Data Fusion instance.
-
-
-
Constructor Detail
-
DataFusionClient
protected DataFusionClient(DataFusionSettings settings) throws IOException
Constructs an instance of DataFusionClient, 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
-
DataFusionClient
protected DataFusionClient(DataFusionStub stub)
-
-
Method Detail
-
create
public static final DataFusionClient create() throws IOException
Constructs an instance of DataFusionClient with default settings.- Throws:
IOException
-
create
public static final DataFusionClient create(DataFusionSettings settings) throws IOException
Constructs an instance of DataFusionClient, 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 DataFusionClient create(DataFusionStub stub)
Constructs an instance of DataFusionClient, using the given stub for making calls. This is for advanced usage - prefer using create(DataFusionSettings).
-
getSettings
public final DataFusionSettings getSettings()
-
getStub
public DataFusionStub 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.
-
listAvailableVersions
public final DataFusionClient.ListAvailableVersionsPagedResponse listAvailableVersions(LocationName parent)
Lists possible versions for Data Fusion instances in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); for (Version element : dataFusionClient.listAvailableVersions(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listAvailableVersions
public final DataFusionClient.ListAvailableVersionsPagedResponse listAvailableVersions(String parent)
Lists possible versions for Data Fusion instances in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); for (Version element : dataFusionClient.listAvailableVersions(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listAvailableVersions
public final DataFusionClient.ListAvailableVersionsPagedResponse listAvailableVersions(ListAvailableVersionsRequest request)
Lists possible versions for Data Fusion instances in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { ListAvailableVersionsRequest request = ListAvailableVersionsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setLatestPatchOnly(true) .build(); for (Version element : dataFusionClient.listAvailableVersions(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
-
listAvailableVersionsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListAvailableVersionsRequest,DataFusionClient.ListAvailableVersionsPagedResponse> listAvailableVersionsPagedCallable()
Lists possible versions for Data Fusion instances in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { ListAvailableVersionsRequest request = ListAvailableVersionsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setLatestPatchOnly(true) .build(); ApiFuture<Version> future = dataFusionClient.listAvailableVersionsPagedCallable().futureCall(request); // Do something. for (Version element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listAvailableVersionsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListAvailableVersionsRequest,ListAvailableVersionsResponse> listAvailableVersionsCallable()
Lists possible versions for Data Fusion instances in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { ListAvailableVersionsRequest request = ListAvailableVersionsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setLatestPatchOnly(true) .build(); while (true) { ListAvailableVersionsResponse response = dataFusionClient.listAvailableVersionsCallable().call(request); for (Version element : response.getAvailableVersionsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listInstances
public final DataFusionClient.ListInstancesPagedResponse listInstances(ListInstancesRequest request)
Lists Data Fusion instances in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { ListInstancesRequest request = ListInstancesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .setOrderBy("orderBy-1207110587") .build(); for (Instance element : dataFusionClient.listInstances(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
-
listInstancesPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListInstancesRequest,DataFusionClient.ListInstancesPagedResponse> listInstancesPagedCallable()
Lists Data Fusion instances in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { ListInstancesRequest request = ListInstancesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .setOrderBy("orderBy-1207110587") .build(); ApiFuture<Instance> future = dataFusionClient.listInstancesPagedCallable().futureCall(request); // Do something. for (Instance element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listInstancesCallable
public final com.google.api.gax.rpc.UnaryCallable<ListInstancesRequest,ListInstancesResponse> listInstancesCallable()
Lists Data Fusion instances in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { ListInstancesRequest request = ListInstancesRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .setOrderBy("orderBy-1207110587") .build(); while (true) { ListInstancesResponse response = dataFusionClient.listInstancesCallable().call(request); for (Instance element : response.getInstancesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
getInstance
public final Instance getInstance(GetInstanceRequest request)
Gets details of a single Data Fusion instance.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { GetInstanceRequest request = GetInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); Instance response = dataFusionClient.getInstance(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
-
getInstanceCallable
public final com.google.api.gax.rpc.UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()
Gets details of a single Data Fusion instance.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { GetInstanceRequest request = GetInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); ApiFuture<Instance> future = dataFusionClient.getInstanceCallable().futureCall(request); // Do something. Instance response = future.get(); }
-
createInstanceAsync
public final com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata> createInstanceAsync(LocationName parent, Instance instance, String instanceId)
Creates a new Data Fusion instance in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); Instance instance = Instance.newBuilder().build(); String instanceId = "instanceId902024336"; Instance response = dataFusionClient.createInstanceAsync(parent, instance, instanceId).get(); }
- Parameters:
parent
- Required. The instance's project and location in the format projects/{project}/locations/{location}.instance
- An instance resource.instanceId
- Required. The name of the instance to create.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createInstanceAsync
public final com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata> createInstanceAsync(String parent, Instance instance, String instanceId)
Creates a new Data Fusion instance in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); Instance instance = Instance.newBuilder().build(); String instanceId = "instanceId902024336"; Instance response = dataFusionClient.createInstanceAsync(parent, instance, instanceId).get(); }
- Parameters:
parent
- Required. The instance's project and location in the format projects/{project}/locations/{location}.instance
- An instance resource.instanceId
- Required. The name of the instance to create.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createInstanceAsync
public final com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata> createInstanceAsync(CreateInstanceRequest request)
Creates a new Data Fusion instance in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { CreateInstanceRequest request = CreateInstanceRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setInstanceId("instanceId902024336") .setInstance(Instance.newBuilder().build()) .build(); Instance response = dataFusionClient.createInstanceAsync(request).get(); }
- 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
-
createInstanceOperationCallable
public final com.google.api.gax.rpc.OperationCallable<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationCallable()
Creates a new Data Fusion instance in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { CreateInstanceRequest request = CreateInstanceRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setInstanceId("instanceId902024336") .setInstance(Instance.newBuilder().build()) .build(); OperationFuture<Instance, OperationMetadata> future = dataFusionClient.createInstanceOperationCallable().futureCall(request); // Do something. Instance response = future.get(); }
-
createInstanceCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateInstanceRequest,com.google.longrunning.Operation> createInstanceCallable()
Creates a new Data Fusion instance in the specified 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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { CreateInstanceRequest request = CreateInstanceRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setInstanceId("instanceId902024336") .setInstance(Instance.newBuilder().build()) .build(); ApiFuture<Operation> future = dataFusionClient.createInstanceCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deleteInstanceAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInstanceAsync(InstanceName name)
Deletes a single Date Fusion instance.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]"); dataFusionClient.deleteInstanceAsync(name).get(); }
- Parameters:
name
- Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteInstanceAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInstanceAsync(String name)
Deletes a single Date Fusion instance.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString(); dataFusionClient.deleteInstanceAsync(name).get(); }
- Parameters:
name
- Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteInstanceAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteInstanceAsync(DeleteInstanceRequest request)
Deletes a single Date Fusion instance.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { DeleteInstanceRequest request = DeleteInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); dataFusionClient.deleteInstanceAsync(request).get(); }
- 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
-
deleteInstanceOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteInstanceRequest,com.google.protobuf.Empty,OperationMetadata> deleteInstanceOperationCallable()
Deletes a single Date Fusion instance.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { DeleteInstanceRequest request = DeleteInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); OperationFuture<Empty, OperationMetadata> future = dataFusionClient.deleteInstanceOperationCallable().futureCall(request); // Do something. future.get(); }
-
deleteInstanceCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteInstanceRequest,com.google.longrunning.Operation> deleteInstanceCallable()
Deletes a single Date Fusion instance.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { DeleteInstanceRequest request = DeleteInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); ApiFuture<Operation> future = dataFusionClient.deleteInstanceCallable().futureCall(request); // Do something. future.get(); }
-
updateInstanceAsync
public final com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata> updateInstanceAsync(Instance instance, com.google.protobuf.FieldMask updateMask)
Updates a single Data Fusion instance.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { Instance instance = Instance.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Instance response = dataFusionClient.updateInstanceAsync(instance, updateMask).get(); }
- Parameters:
instance
- Required. The instance resource that replaces the resource on the server. Currently, Data Fusion only allows replacing labels, options, and stack driver settings. All other fields will be ignored.updateMask
- Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels, options, and version currently) will be overwritten.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateInstanceAsync
public final com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata> updateInstanceAsync(UpdateInstanceRequest request)
Updates a single Data Fusion instance.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { UpdateInstanceRequest request = UpdateInstanceRequest.newBuilder() .setInstance(Instance.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Instance response = dataFusionClient.updateInstanceAsync(request).get(); }
- 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
-
updateInstanceOperationCallable
public final com.google.api.gax.rpc.OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationCallable()
Updates a single Data Fusion instance.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { UpdateInstanceRequest request = UpdateInstanceRequest.newBuilder() .setInstance(Instance.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); OperationFuture<Instance, OperationMetadata> future = dataFusionClient.updateInstanceOperationCallable().futureCall(request); // Do something. Instance response = future.get(); }
-
updateInstanceCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateInstanceRequest,com.google.longrunning.Operation> updateInstanceCallable()
Updates a single Data Fusion instance.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { UpdateInstanceRequest request = UpdateInstanceRequest.newBuilder() .setInstance(Instance.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Operation> future = dataFusionClient.updateInstanceCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
restartInstanceAsync
public final com.google.api.gax.longrunning.OperationFuture<Instance,OperationMetadata> restartInstanceAsync(RestartInstanceRequest request)
Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { RestartInstanceRequest request = RestartInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); Instance response = dataFusionClient.restartInstanceAsync(request).get(); }
- 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
-
restartInstanceOperationCallable
public final com.google.api.gax.rpc.OperationCallable<RestartInstanceRequest,Instance,OperationMetadata> restartInstanceOperationCallable()
Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { RestartInstanceRequest request = RestartInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); OperationFuture<Instance, OperationMetadata> future = dataFusionClient.restartInstanceOperationCallable().futureCall(request); // Do something. Instance response = future.get(); }
-
restartInstanceCallable
public final com.google.api.gax.rpc.UnaryCallable<RestartInstanceRequest,com.google.longrunning.Operation> restartInstanceCallable()
Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.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 (DataFusionClient dataFusionClient = DataFusionClient.create()) { RestartInstanceRequest request = RestartInstanceRequest.newBuilder() .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString()) .build(); ApiFuture<Operation> future = dataFusionClient.restartInstanceCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-