Class DataFusionClient (1.1.1)

public class DataFusionClient implements 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:


 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:


 DataFusionSettings dataFusionSettings =
     DataFusionSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataFusionClient dataFusionClient = DataFusionClient.create(dataFusionSettings);

To customize the endpoint:


 DataFusionSettings dataFusionSettings =
     DataFusionSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataFusionClient dataFusionClient = DataFusionClient.create(dataFusionSettings);

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

Inheritance

java.lang.Object > DataFusionClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final DataFusionClient create()

Constructs an instance of DataFusionClient with default settings.

Returns

Type	Description
DataFusionClient

Exceptions

Type	Description
IOException

create(DataFusionSettings settings)

public static final DataFusionClient create(DataFusionSettings settings)

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.

Parameter

Name	Description
settings	`DataFusionSettings`

Returns

Type	Description
DataFusionClient

Exceptions

Type	Description
IOException

create(DataFusionStub stub)

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).

Parameter

Name	Description
stub	`DataFusionStub`

Returns

Type	Description
DataFusionClient

Constructors

DataFusionClient(DataFusionSettings settings)

protected DataFusionClient(DataFusionSettings settings)

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.

Parameter

Name	Description
settings	`DataFusionSettings`

DataFusionClient(DataFusionStub stub)

protected DataFusionClient(DataFusionStub stub)

Parameter

Name	Description
stub	`DataFusionStub`

Methods

addDnsPeering(AddDnsPeeringRequest request)

public final AddDnsPeeringResponse addDnsPeering(AddDnsPeeringRequest request)

Add DNS peering on the given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   AddDnsPeeringRequest request =
       AddDnsPeeringRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setDnsPeering(DnsPeering.newBuilder().build())
           .build();
   AddDnsPeeringResponse response = dataFusionClient.addDnsPeering(request);
 }

Parameter

Name	Description
request	`AddDnsPeeringRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
AddDnsPeeringResponse

addDnsPeering(InstanceName parent)

public final AddDnsPeeringResponse addDnsPeering(InstanceName parent)

Add DNS peering on the given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   AddDnsPeeringResponse response = dataFusionClient.addDnsPeering(parent);
 }

Parameter

Name	Description
parent	`InstanceName` Required. The resource on which DNS peering will be created.

Returns

Type	Description
AddDnsPeeringResponse

addDnsPeering(String parent)

public final AddDnsPeeringResponse addDnsPeering(String parent)

Add DNS peering on the given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   AddDnsPeeringResponse response = dataFusionClient.addDnsPeering(parent);
 }

Parameter

Name	Description
parent	`String` Required. The resource on which DNS peering will be created.

Returns

Type	Description
AddDnsPeeringResponse

addDnsPeeringCallable()

public final UnaryCallable<AddDnsPeeringRequest,AddDnsPeeringResponse> addDnsPeeringCallable()

Add DNS peering on the given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   AddDnsPeeringRequest request =
       AddDnsPeeringRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setDnsPeering(DnsPeering.newBuilder().build())
           .build();
   ApiFuture<AddDnsPeeringResponse> future =
       dataFusionClient.addDnsPeeringCallable().futureCall(request);
   // Do something.
   AddDnsPeeringResponse response = future.get();
 }

Returns

Type	Description
UnaryCallable<AddDnsPeeringRequest,AddDnsPeeringResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	`long`
unit	`TimeUnit`

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

createInstanceAsync(CreateInstanceRequest request)

public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(CreateInstanceRequest request)

Creates a new Data Fusion instance in the specified project and location.

Sample code:


 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();
 }

Parameter

Name	Description
request	`CreateInstanceRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Instance,OperationMetadata>

createInstanceAsync(LocationName parent, Instance instance, String instanceId)

public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(LocationName parent, Instance instance, String instanceId)

Creates a new Data Fusion instance in the specified project and location.

Sample code:


 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

Name	Description
parent	`LocationName` Required. The instance's project and location in the format projects/{project}/locations/{location}.
instance	`Instance` An instance resource.
instanceId	`String` Required. The name of the instance to create.

Returns

Type	Description
OperationFuture<Instance,OperationMetadata>

createInstanceAsync(String parent, Instance instance, String instanceId)

public final OperationFuture<Instance,OperationMetadata> createInstanceAsync(String parent, Instance instance, String instanceId)

Creates a new Data Fusion instance in the specified project and location.

Sample code:


 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

Name	Description
parent	`String` Required. The instance's project and location in the format projects/{project}/locations/{location}.
instance	`Instance` An instance resource.
instanceId	`String` Required. The name of the instance to create.

Returns

Type	Description
OperationFuture<Instance,OperationMetadata>

createInstanceCallable()

public final UnaryCallable<CreateInstanceRequest,Operation> createInstanceCallable()

Creates a new Data Fusion instance in the specified project and location.

Sample code:


 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();
 }

Returns

Type	Description
UnaryCallable<CreateInstanceRequest,Operation>

createInstanceOperationCallable()

public final OperationCallable<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationCallable()

Creates a new Data Fusion instance in the specified project and location.

Sample code:


 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();
 }

Returns

Type	Description
OperationCallable<CreateInstanceRequest,Instance,OperationMetadata>

deleteInstanceAsync(DeleteInstanceRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(DeleteInstanceRequest request)

Deletes a single Data Fusion instance.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   DeleteInstanceRequest request =
       DeleteInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   dataFusionClient.deleteInstanceAsync(request).get();
 }

Parameter

Name	Description
request	`DeleteInstanceRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteInstanceAsync(InstanceName name)

public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(InstanceName name)

Deletes a single Data Fusion instance.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   dataFusionClient.deleteInstanceAsync(name).get();
 }

Parameter

Name	Description
name	`InstanceName` Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteInstanceAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteInstanceAsync(String name)

Deletes a single Data Fusion instance.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   String name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   dataFusionClient.deleteInstanceAsync(name).get();
 }

Parameter

Name	Description
name	`String` Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteInstanceCallable()

public final UnaryCallable<DeleteInstanceRequest,Operation> deleteInstanceCallable()

Deletes a single Data Fusion instance.

Sample code:


 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();
 }

Returns

Type	Description
UnaryCallable<DeleteInstanceRequest,Operation>

deleteInstanceOperationCallable()

public final OperationCallable<DeleteInstanceRequest,Empty,OperationMetadata> deleteInstanceOperationCallable()

Deletes a single Data Fusion instance.

Sample code:


 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();
 }

Returns

Type	Description
OperationCallable<DeleteInstanceRequest,Empty,OperationMetadata>

getInstance(GetInstanceRequest request)

public final Instance getInstance(GetInstanceRequest request)

Gets details of a single Data Fusion instance.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   Instance response = dataFusionClient.getInstance(request);
 }

Parameter

Name	Description
request	`GetInstanceRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
Instance

getInstanceCallable()

public final UnaryCallable<GetInstanceRequest,Instance> getInstanceCallable()

Gets details of a single Data Fusion instance.

Sample code:


 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();
 }

Returns

Type	Description
UnaryCallable<GetInstanceRequest,Instance>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getSettings()

public final DataFusionSettings getSettings()

Returns

Type	Description
DataFusionSettings

getStub()

public DataFusionStub getStub()

Returns

Type	Description
DataFusionStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listAvailableVersions(ListAvailableVersionsRequest request)

public final DataFusionClient.ListAvailableVersionsPagedResponse listAvailableVersions(ListAvailableVersionsRequest request)

Lists possible versions for Data Fusion instances in the specified project and location.

Sample code:


 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);
   }
 }

Parameter

Name	Description
request	`ListAvailableVersionsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
DataFusionClient.ListAvailableVersionsPagedResponse

listAvailableVersions(LocationName parent)

public final DataFusionClient.ListAvailableVersionsPagedResponse listAvailableVersions(LocationName parent)

Lists possible versions for Data Fusion instances in the specified project and location.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Version element : dataFusionClient.listAvailableVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`LocationName` Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}.

Returns

Type	Description
DataFusionClient.ListAvailableVersionsPagedResponse

listAvailableVersions(String parent)

public final DataFusionClient.ListAvailableVersionsPagedResponse listAvailableVersions(String parent)

Lists possible versions for Data Fusion instances in the specified project and location.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Version element : dataFusionClient.listAvailableVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}.

Returns

Type	Description
DataFusionClient.ListAvailableVersionsPagedResponse

listAvailableVersionsCallable()

public final UnaryCallable<ListAvailableVersionsRequest,ListAvailableVersionsResponse> listAvailableVersionsCallable()

Lists possible versions for Data Fusion instances in the specified project and location.

Sample code:


 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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListAvailableVersionsRequest,ListAvailableVersionsResponse>

listAvailableVersionsPagedCallable()

public final UnaryCallable<ListAvailableVersionsRequest,DataFusionClient.ListAvailableVersionsPagedResponse> listAvailableVersionsPagedCallable()

Lists possible versions for Data Fusion instances in the specified project and location.

Sample code:


 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);
   }
 }

Returns

Type	Description
UnaryCallable<ListAvailableVersionsRequest,ListAvailableVersionsPagedResponse>

listDnsPeerings(InstanceName parent)

public final DataFusionClient.ListDnsPeeringsPagedResponse listDnsPeerings(InstanceName parent)

List DNS peering for a given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   for (DnsPeering element : dataFusionClient.listDnsPeerings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`InstanceName` Required. The resource on which dns peering will be listed.

Returns

Type	Description
DataFusionClient.ListDnsPeeringsPagedResponse

listDnsPeerings(ListDnsPeeringsRequest request)

public final DataFusionClient.ListDnsPeeringsPagedResponse listDnsPeerings(ListDnsPeeringsRequest request)

List DNS peering for a given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   ListDnsPeeringsRequest request =
       ListDnsPeeringsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DnsPeering element : dataFusionClient.listDnsPeerings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`ListDnsPeeringsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
DataFusionClient.ListDnsPeeringsPagedResponse

listDnsPeerings(String parent)

public final DataFusionClient.ListDnsPeeringsPagedResponse listDnsPeerings(String parent)

List DNS peering for a given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   for (DnsPeering element : dataFusionClient.listDnsPeerings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource on which dns peering will be listed.

Returns

Type	Description
DataFusionClient.ListDnsPeeringsPagedResponse

listDnsPeeringsCallable()

public final UnaryCallable<ListDnsPeeringsRequest,ListDnsPeeringsResponse> listDnsPeeringsCallable()

List DNS peering for a given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   ListDnsPeeringsRequest request =
       ListDnsPeeringsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDnsPeeringsResponse response = dataFusionClient.listDnsPeeringsCallable().call(request);
     for (DnsPeering element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListDnsPeeringsRequest,ListDnsPeeringsResponse>

listDnsPeeringsPagedCallable()

public final UnaryCallable<ListDnsPeeringsRequest,DataFusionClient.ListDnsPeeringsPagedResponse> listDnsPeeringsPagedCallable()

List DNS peering for a given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   ListDnsPeeringsRequest request =
       ListDnsPeeringsRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DnsPeering> future =
       dataFusionClient.listDnsPeeringsPagedCallable().futureCall(request);
   // Do something.
   for (DnsPeering element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListDnsPeeringsRequest,ListDnsPeeringsPagedResponse>

listInstances(ListInstancesRequest request)

public final DataFusionClient.ListInstancesPagedResponse listInstances(ListInstancesRequest request)

Lists Data Fusion instances in the specified project and location.

Sample code:


 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);
   }
 }

Parameter

Name	Description
request	`ListInstancesRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
DataFusionClient.ListInstancesPagedResponse

listInstancesCallable()

public final UnaryCallable<ListInstancesRequest,ListInstancesResponse> listInstancesCallable()

Lists Data Fusion instances in the specified project and location.

Sample code:


 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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListInstancesRequest,ListInstancesResponse>

listInstancesPagedCallable()

public final UnaryCallable<ListInstancesRequest,DataFusionClient.ListInstancesPagedResponse> listInstancesPagedCallable()

Lists Data Fusion instances in the specified project and location.

Sample code:


 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);
   }
 }

Returns

Type	Description
UnaryCallable<ListInstancesRequest,ListInstancesPagedResponse>

listNamespaces(InstanceName parent)

public final DataFusionClient.ListNamespacesPagedResponse listNamespaces(InstanceName parent)

List namespaces in a given instance

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   for (Namespace element : dataFusionClient.listNamespaces(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`InstanceName` Required. The instance to list its namespaces.

Returns

Type	Description
DataFusionClient.ListNamespacesPagedResponse

listNamespaces(ListNamespacesRequest request)

public final DataFusionClient.ListNamespacesPagedResponse listNamespaces(ListNamespacesRequest request)

List namespaces in a given instance

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   ListNamespacesRequest request =
       ListNamespacesRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(NamespaceView.forNumber(0))
           .build();
   for (Namespace element : dataFusionClient.listNamespaces(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
request	`ListNamespacesRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
DataFusionClient.ListNamespacesPagedResponse

listNamespaces(String parent)

public final DataFusionClient.ListNamespacesPagedResponse listNamespaces(String parent)

List namespaces in a given instance

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   for (Namespace element : dataFusionClient.listNamespaces(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The instance to list its namespaces.

Returns

Type	Description
DataFusionClient.ListNamespacesPagedResponse

listNamespacesCallable()

public final UnaryCallable<ListNamespacesRequest,ListNamespacesResponse> listNamespacesCallable()

List namespaces in a given instance

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   ListNamespacesRequest request =
       ListNamespacesRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(NamespaceView.forNumber(0))
           .build();
   while (true) {
     ListNamespacesResponse response = dataFusionClient.listNamespacesCallable().call(request);
     for (Namespace element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListNamespacesRequest,ListNamespacesResponse>

listNamespacesPagedCallable()

public final UnaryCallable<ListNamespacesRequest,DataFusionClient.ListNamespacesPagedResponse> listNamespacesPagedCallable()

List namespaces in a given instance

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   ListNamespacesRequest request =
       ListNamespacesRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(NamespaceView.forNumber(0))
           .build();
   ApiFuture<Namespace> future =
       dataFusionClient.listNamespacesPagedCallable().futureCall(request);
   // Do something.
   for (Namespace element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListNamespacesRequest,ListNamespacesPagedResponse>

removeDnsPeering(InstanceName parent)

public final RemoveDnsPeeringResponse removeDnsPeering(InstanceName parent)

Remove DNS peering on the given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   InstanceName parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
   RemoveDnsPeeringResponse response = dataFusionClient.removeDnsPeering(parent);
 }

Parameter

Name	Description
parent	`InstanceName` Required. The resource on which DNS peering will be removed.

Returns

Type	Description
RemoveDnsPeeringResponse

removeDnsPeering(RemoveDnsPeeringRequest request)

public final RemoveDnsPeeringResponse removeDnsPeering(RemoveDnsPeeringRequest request)

Remove DNS peering on the given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   RemoveDnsPeeringRequest request =
       RemoveDnsPeeringRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setZone("zone3744684")
           .build();
   RemoveDnsPeeringResponse response = dataFusionClient.removeDnsPeering(request);
 }

Parameter

Name	Description
request	`RemoveDnsPeeringRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
RemoveDnsPeeringResponse

removeDnsPeering(String parent)

public final RemoveDnsPeeringResponse removeDnsPeering(String parent)

Remove DNS peering on the given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   String parent = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString();
   RemoveDnsPeeringResponse response = dataFusionClient.removeDnsPeering(parent);
 }

Parameter

Name	Description
parent	`String` Required. The resource on which DNS peering will be removed.

Returns

Type	Description
RemoveDnsPeeringResponse

removeDnsPeeringCallable()

public final UnaryCallable<RemoveDnsPeeringRequest,RemoveDnsPeeringResponse> removeDnsPeeringCallable()

Remove DNS peering on the given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   RemoveDnsPeeringRequest request =
       RemoveDnsPeeringRequest.newBuilder()
           .setParent(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .setZone("zone3744684")
           .build();
   ApiFuture<RemoveDnsPeeringResponse> future =
       dataFusionClient.removeDnsPeeringCallable().futureCall(request);
   // Do something.
   RemoveDnsPeeringResponse response = future.get();
 }

Returns

Type	Description
UnaryCallable<RemoveDnsPeeringRequest,RemoveDnsPeeringResponse>

removeIamPolicy(RemoveIamPolicyRequest request)

public final RemoveIamPolicyResponse removeIamPolicy(RemoveIamPolicyRequest request)

Remove IAM policy that is currently set on the given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   RemoveIamPolicyRequest request =
       RemoveIamPolicyRequest.newBuilder().setResource("resource-341064690").build();
   RemoveIamPolicyResponse response = dataFusionClient.removeIamPolicy(request);
 }

Parameter

Name	Description
request	`RemoveIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
RemoveIamPolicyResponse

removeIamPolicyCallable()

public final UnaryCallable<RemoveIamPolicyRequest,RemoveIamPolicyResponse> removeIamPolicyCallable()

Remove IAM policy that is currently set on the given resource.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   RemoveIamPolicyRequest request =
       RemoveIamPolicyRequest.newBuilder().setResource("resource-341064690").build();
   ApiFuture<RemoveIamPolicyResponse> future =
       dataFusionClient.removeIamPolicyCallable().futureCall(request);
   // Do something.
   RemoveIamPolicyResponse response = future.get();
 }

Returns

Type	Description
UnaryCallable<RemoveIamPolicyRequest,RemoveIamPolicyResponse>

restartInstanceAsync(RestartInstanceRequest request)

public final OperationFuture<Instance,OperationMetadata> restartInstanceAsync(RestartInstanceRequest request)

Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   RestartInstanceRequest request =
       RestartInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   Instance response = dataFusionClient.restartInstanceAsync(request).get();
 }

Parameter

Name	Description
request	`RestartInstanceRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Instance,OperationMetadata>

restartInstanceCallable()

public final UnaryCallable<RestartInstanceRequest,Operation> restartInstanceCallable()

Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.

Sample code:


 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();
 }

Returns

Type	Description
UnaryCallable<RestartInstanceRequest,Operation>

restartInstanceOperationCallable()

public final OperationCallable<RestartInstanceRequest,Instance,OperationMetadata> restartInstanceOperationCallable()

Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.

Sample code:


 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();
 }

Returns

Type	Description
OperationCallable<RestartInstanceRequest,Instance,OperationMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateInstanceAsync(Instance instance, FieldMask updateMask)

public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(Instance instance, FieldMask updateMask)

Updates a single Data Fusion instance.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   Instance instance = Instance.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Instance response = dataFusionClient.updateInstanceAsync(instance, updateMask).get();
 }

Parameters

Name	Description
instance	`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	`FieldMask` 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 and options currently) will be overwritten.

Returns

Type	Description
OperationFuture<Instance,OperationMetadata>

updateInstanceAsync(UpdateInstanceRequest request)

public final OperationFuture<Instance,OperationMetadata> updateInstanceAsync(UpdateInstanceRequest request)

Updates a single Data Fusion instance.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   UpdateInstanceRequest request =
       UpdateInstanceRequest.newBuilder()
           .setInstance(Instance.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Instance response = dataFusionClient.updateInstanceAsync(request).get();
 }

Parameter

Name	Description
request	`UpdateInstanceRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Instance,OperationMetadata>

updateInstanceCallable()

public final UnaryCallable<UpdateInstanceRequest,Operation> updateInstanceCallable()

Updates a single Data Fusion instance.

Sample code:


 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();
 }

Returns

Type	Description
UnaryCallable<UpdateInstanceRequest,Operation>

updateInstanceOperationCallable()

public final OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationCallable()

Updates a single Data Fusion instance.

Sample code:


 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();
 }

Returns

Type	Description
OperationCallable<UpdateInstanceRequest,Instance,OperationMetadata>

upgradeInstanceAsync(UpgradeInstanceRequest request)

public final OperationFuture<Instance,OperationMetadata> upgradeInstanceAsync(UpgradeInstanceRequest request)

Upgrade a single Data Fusion instance. At the end of an operation instance is fully upgraded.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   UpgradeInstanceRequest request =
       UpgradeInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   Instance response = dataFusionClient.upgradeInstanceAsync(request).get();
 }

Parameter

Name	Description
request	`UpgradeInstanceRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Instance,OperationMetadata>

upgradeInstanceCallable()

public final UnaryCallable<UpgradeInstanceRequest,Operation> upgradeInstanceCallable()

Upgrade a single Data Fusion instance. At the end of an operation instance is fully upgraded.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   UpgradeInstanceRequest request =
       UpgradeInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   ApiFuture<Operation> future = dataFusionClient.upgradeInstanceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<UpgradeInstanceRequest,Operation>

upgradeInstanceOperationCallable()

public final OperationCallable<UpgradeInstanceRequest,Instance,OperationMetadata> upgradeInstanceOperationCallable()

Upgrade a single Data Fusion instance. At the end of an operation instance is fully upgraded.

Sample code:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   UpgradeInstanceRequest request =
       UpgradeInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   OperationFuture<Instance, OperationMetadata> future =
       dataFusionClient.upgradeInstanceOperationCallable().futureCall(request);
   // Do something.
   Instance response = future.get();
 }

Returns

Type	Description
OperationCallable<UpgradeInstanceRequest,Instance,OperationMetadata>