Class DataplexServiceClient (1.0.1)

public class DataplexServiceClient implements BackgroundResource

Service Description: Dataplex service provides data lakes as a service. The primary resources offered by this service are Lakes, Zones and Assets which collectively allow a data adminstrator to organize, manage, secure and catalog data across their organization located across cloud projects in a variety of storage systems including Cloud Storage and BigQuery.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   LakeName name = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   Lake response = dataplexServiceClient.getLake(name);
 }

Note: close() needs to be called on the DataplexServiceClient 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 DataplexServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 DataplexServiceSettings dataplexServiceSettings =
     DataplexServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataplexServiceClient dataplexServiceClient =
     DataplexServiceClient.create(dataplexServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 DataplexServiceSettings dataplexServiceSettings =
     DataplexServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataplexServiceClient dataplexServiceClient =
     DataplexServiceClient.create(dataplexServiceSettings);

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

Inheritance

java.lang.Object > DataplexServiceClient

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 DataplexServiceClient create()

Constructs an instance of DataplexServiceClient with default settings.

Returns

Type	Description
DataplexServiceClient

Exceptions

Type	Description
IOException

create(DataplexServiceSettings settings)

public static final DataplexServiceClient create(DataplexServiceSettings settings)

Constructs an instance of DataplexServiceClient, 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	`DataplexServiceSettings`

Returns

Type	Description
DataplexServiceClient

Exceptions

Type	Description
IOException

create(DataplexServiceStub stub)

public static final DataplexServiceClient create(DataplexServiceStub stub)

Constructs an instance of DataplexServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DataplexServiceSettings).

Parameter

Name	Description
stub	`DataplexServiceStub`

Returns

Type	Description
DataplexServiceClient

Constructors

DataplexServiceClient(DataplexServiceSettings settings)

protected DataplexServiceClient(DataplexServiceSettings settings)

Constructs an instance of DataplexServiceClient, 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	`DataplexServiceSettings`

DataplexServiceClient(DataplexServiceStub stub)

protected DataplexServiceClient(DataplexServiceStub stub)

Parameter

Name	Description
stub	`DataplexServiceStub`

Methods

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

cancelJob(CancelJobRequest request)

public final void cancelJob(CancelJobRequest request)

Cancel jobs running for the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CancelJobRequest request =
       CancelJobRequest.newBuilder()
           .setName(
               JobName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]", "[JOB]").toString())
           .build();
   dataplexServiceClient.cancelJob(request);
 }

Parameter

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

cancelJob(JobName name)

public final void cancelJob(JobName name)

Cancel jobs running for the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]", "[JOB]");
   dataplexServiceClient.cancelJob(name);
 }

Parameter

Name	Description
name	`JobName` Required. The resource name of the job: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{job_id}`.

cancelJob(String name)

public final void cancelJob(String name)

Cancel jobs running for the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String name = JobName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]", "[JOB]").toString();
   dataplexServiceClient.cancelJob(name);
 }

Parameter

Name	Description
name	`String` Required. The resource name of the job: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{job_id}`.

cancelJobCallable()

public final UnaryCallable<CancelJobRequest,Empty> cancelJobCallable()

Cancel jobs running for the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CancelJobRequest request =
       CancelJobRequest.newBuilder()
           .setName(
               JobName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]", "[JOB]").toString())
           .build();
   ApiFuture<Empty> future = dataplexServiceClient.cancelJobCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
UnaryCallable<CancelJobRequest,Empty>

close()

public final void close()

createAssetAsync(CreateAssetRequest request)

public final OperationFuture<Asset,OperationMetadata> createAssetAsync(CreateAssetRequest request)

Creates an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateAssetRequest request =
       CreateAssetRequest.newBuilder()
           .setParent(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .setAssetId("assetId-704776149")
           .setAsset(Asset.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Asset response = dataplexServiceClient.createAssetAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Asset,OperationMetadata>

createAssetAsync(ZoneName parent, Asset asset, String assetId)

public final OperationFuture<Asset,OperationMetadata> createAssetAsync(ZoneName parent, Asset asset, String assetId)

Creates an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ZoneName parent = ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]");
   Asset asset = Asset.newBuilder().build();
   String assetId = "assetId-704776149";
   Asset response = dataplexServiceClient.createAssetAsync(parent, asset, assetId).get();
 }

Parameters

Name	Description
parent	`ZoneName` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`
asset	`Asset` Required. Asset resource.
assetId	`String` Required. Asset identifier. This ID will be used to generate names such as table names when publishing metadata to Hive Metastore and BigQuery. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the zone.

Returns

Type	Description
OperationFuture<Asset,OperationMetadata>

createAssetAsync(String parent, Asset asset, String assetId)

public final OperationFuture<Asset,OperationMetadata> createAssetAsync(String parent, Asset asset, String assetId)

Creates an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString();
   Asset asset = Asset.newBuilder().build();
   String assetId = "assetId-704776149";
   Asset response = dataplexServiceClient.createAssetAsync(parent, asset, assetId).get();
 }

Parameters

Name	Description
parent	`String` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`
asset	`Asset` Required. Asset resource.
assetId	`String` Required. Asset identifier. This ID will be used to generate names such as table names when publishing metadata to Hive Metastore and BigQuery. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the zone.

Returns

Type	Description
OperationFuture<Asset,OperationMetadata>

createAssetCallable()

public final UnaryCallable<CreateAssetRequest,Operation> createAssetCallable()

Creates an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateAssetRequest request =
       CreateAssetRequest.newBuilder()
           .setParent(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .setAssetId("assetId-704776149")
           .setAsset(Asset.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = dataplexServiceClient.createAssetCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<CreateAssetRequest,Operation>

createAssetOperationCallable()

public final OperationCallable<CreateAssetRequest,Asset,OperationMetadata> createAssetOperationCallable()

Creates an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateAssetRequest request =
       CreateAssetRequest.newBuilder()
           .setParent(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .setAssetId("assetId-704776149")
           .setAsset(Asset.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<Asset, OperationMetadata> future =
       dataplexServiceClient.createAssetOperationCallable().futureCall(request);
   // Do something.
   Asset response = future.get();
 }

Returns

Type	Description
OperationCallable<CreateAssetRequest,Asset,OperationMetadata>

createEnvironmentAsync(CreateEnvironmentRequest request)

public final OperationFuture<Environment,OperationMetadata> createEnvironmentAsync(CreateEnvironmentRequest request)

Create an environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateEnvironmentRequest request =
       CreateEnvironmentRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setEnvironmentId("environmentId-950205810")
           .setEnvironment(Environment.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Environment response = dataplexServiceClient.createEnvironmentAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Environment,OperationMetadata>

createEnvironmentAsync(LakeName parent, Environment environment, String environmentId)

public final OperationFuture<Environment,OperationMetadata> createEnvironmentAsync(LakeName parent, Environment environment, String environmentId)

Create an environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   Environment environment = Environment.newBuilder().build();
   String environmentId = "environmentId-950205810";
   Environment response =
       dataplexServiceClient.createEnvironmentAsync(parent, environment, environmentId).get();
 }

Parameters

Name	Description
parent	`LakeName` Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
environment	`Environment` Required. Environment resource.
environmentId	`String` Required. Environment identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must be between 1-63 characters. Must end with a number or a letter. Must be unique within the lake.

Returns

Type	Description
OperationFuture<Environment,OperationMetadata>

createEnvironmentAsync(String parent, Environment environment, String environmentId)

public final OperationFuture<Environment,OperationMetadata> createEnvironmentAsync(String parent, Environment environment, String environmentId)

Create an environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString();
   Environment environment = Environment.newBuilder().build();
   String environmentId = "environmentId-950205810";
   Environment response =
       dataplexServiceClient.createEnvironmentAsync(parent, environment, environmentId).get();
 }

Parameters

Name	Description
parent	`String` Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}
environment	`Environment` Required. Environment resource.
environmentId	`String` Required. Environment identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must be between 1-63 characters. Must end with a number or a letter. Must be unique within the lake.

Returns

Type	Description
OperationFuture<Environment,OperationMetadata>

createEnvironmentCallable()

public final UnaryCallable<CreateEnvironmentRequest,Operation> createEnvironmentCallable()

Create an environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateEnvironmentRequest request =
       CreateEnvironmentRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setEnvironmentId("environmentId-950205810")
           .setEnvironment(Environment.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       dataplexServiceClient.createEnvironmentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<CreateEnvironmentRequest,Operation>

createEnvironmentOperationCallable()

public final OperationCallable<CreateEnvironmentRequest,Environment,OperationMetadata> createEnvironmentOperationCallable()

Create an environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateEnvironmentRequest request =
       CreateEnvironmentRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setEnvironmentId("environmentId-950205810")
           .setEnvironment(Environment.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<Environment, OperationMetadata> future =
       dataplexServiceClient.createEnvironmentOperationCallable().futureCall(request);
   // Do something.
   Environment response = future.get();
 }

Returns

Type	Description
OperationCallable<CreateEnvironmentRequest,Environment,OperationMetadata>

createLakeAsync(CreateLakeRequest request)

public final OperationFuture<Lake,OperationMetadata> createLakeAsync(CreateLakeRequest request)

Creates a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateLakeRequest request =
       CreateLakeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setLakeId("lakeId-1110150390")
           .setLake(Lake.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Lake response = dataplexServiceClient.createLakeAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Lake,OperationMetadata>

createLakeAsync(LocationName parent, Lake lake, String lakeId)

public final OperationFuture<Lake,OperationMetadata> createLakeAsync(LocationName parent, Lake lake, String lakeId)

Creates a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Lake lake = Lake.newBuilder().build();
   String lakeId = "lakeId-1110150390";
   Lake response = dataplexServiceClient.createLakeAsync(parent, lake, lakeId).get();
 }

Parameters

Name	Description
parent	`LocationName` Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where `location_id` refers to a GCP region.
lake	`Lake` Required. Lake resource
lakeId	`String` Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location.

Returns

Type	Description
OperationFuture<Lake,OperationMetadata>

createLakeAsync(String parent, Lake lake, String lakeId)

public final OperationFuture<Lake,OperationMetadata> createLakeAsync(String parent, Lake lake, String lakeId)

Creates a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Lake lake = Lake.newBuilder().build();
   String lakeId = "lakeId-1110150390";
   Lake response = dataplexServiceClient.createLakeAsync(parent, lake, lakeId).get();
 }

Parameters

Name	Description
parent	`String` Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where `location_id` refers to a GCP region.
lake	`Lake` Required. Lake resource
lakeId	`String` Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location.

Returns

Type	Description
OperationFuture<Lake,OperationMetadata>

createLakeCallable()

public final UnaryCallable<CreateLakeRequest,Operation> createLakeCallable()

Creates a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateLakeRequest request =
       CreateLakeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setLakeId("lakeId-1110150390")
           .setLake(Lake.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = dataplexServiceClient.createLakeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<CreateLakeRequest,Operation>

createLakeOperationCallable()

public final OperationCallable<CreateLakeRequest,Lake,OperationMetadata> createLakeOperationCallable()

Creates a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateLakeRequest request =
       CreateLakeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setLakeId("lakeId-1110150390")
           .setLake(Lake.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<Lake, OperationMetadata> future =
       dataplexServiceClient.createLakeOperationCallable().futureCall(request);
   // Do something.
   Lake response = future.get();
 }

Returns

Type	Description
OperationCallable<CreateLakeRequest,Lake,OperationMetadata>

createTaskAsync(CreateTaskRequest request)

public final OperationFuture<Task,OperationMetadata> createTaskAsync(CreateTaskRequest request)

Creates a task resource within a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateTaskRequest request =
       CreateTaskRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setTaskId("taskId-880873088")
           .setTask(Task.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Task response = dataplexServiceClient.createTaskAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Task,OperationMetadata>

createTaskAsync(LakeName parent, Task task, String taskId)

public final OperationFuture<Task,OperationMetadata> createTaskAsync(LakeName parent, Task task, String taskId)

Creates a task resource within a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   Task task = Task.newBuilder().build();
   String taskId = "taskId-880873088";
   Task response = dataplexServiceClient.createTaskAsync(parent, task, taskId).get();
 }

Parameters

Name	Description
parent	`LakeName` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
task	`Task` Required. Task resource.
taskId	`String` Required. Task identifier.

Returns

Type	Description
OperationFuture<Task,OperationMetadata>

createTaskAsync(String parent, Task task, String taskId)

public final OperationFuture<Task,OperationMetadata> createTaskAsync(String parent, Task task, String taskId)

Creates a task resource within a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString();
   Task task = Task.newBuilder().build();
   String taskId = "taskId-880873088";
   Task response = dataplexServiceClient.createTaskAsync(parent, task, taskId).get();
 }

Parameters

Name	Description
parent	`String` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
task	`Task` Required. Task resource.
taskId	`String` Required. Task identifier.

Returns

Type	Description
OperationFuture<Task,OperationMetadata>

createTaskCallable()

public final UnaryCallable<CreateTaskRequest,Operation> createTaskCallable()

Creates a task resource within a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateTaskRequest request =
       CreateTaskRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setTaskId("taskId-880873088")
           .setTask(Task.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = dataplexServiceClient.createTaskCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<CreateTaskRequest,Operation>

createTaskOperationCallable()

public final OperationCallable<CreateTaskRequest,Task,OperationMetadata> createTaskOperationCallable()

Creates a task resource within a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateTaskRequest request =
       CreateTaskRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setTaskId("taskId-880873088")
           .setTask(Task.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<Task, OperationMetadata> future =
       dataplexServiceClient.createTaskOperationCallable().futureCall(request);
   // Do something.
   Task response = future.get();
 }

Returns

Type	Description
OperationCallable<CreateTaskRequest,Task,OperationMetadata>

createZoneAsync(CreateZoneRequest request)

public final OperationFuture<Zone,OperationMetadata> createZoneAsync(CreateZoneRequest request)

Creates a zone resource within a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateZoneRequest request =
       CreateZoneRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setZoneId("zoneId-696323609")
           .setZone(Zone.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Zone response = dataplexServiceClient.createZoneAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Zone,OperationMetadata>

createZoneAsync(LakeName parent, Zone zone, String zoneId)

public final OperationFuture<Zone,OperationMetadata> createZoneAsync(LakeName parent, Zone zone, String zoneId)

Creates a zone resource within a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   Zone zone = Zone.newBuilder().build();
   String zoneId = "zoneId-696323609";
   Zone response = dataplexServiceClient.createZoneAsync(parent, zone, zoneId).get();
 }

Parameters

Name	Description
parent	`LakeName` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
zone	`Zone` Required. Zone resource.
zoneId	`String` Required. Zone identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique across all lakes from all locations in a project. Must not be one of the reserved IDs (i.e. "default", "global-temp")

Returns

Type	Description
OperationFuture<Zone,OperationMetadata>

createZoneAsync(String parent, Zone zone, String zoneId)

public final OperationFuture<Zone,OperationMetadata> createZoneAsync(String parent, Zone zone, String zoneId)

Creates a zone resource within a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString();
   Zone zone = Zone.newBuilder().build();
   String zoneId = "zoneId-696323609";
   Zone response = dataplexServiceClient.createZoneAsync(parent, zone, zoneId).get();
 }

Parameters

Name	Description
parent	`String` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.
zone	`Zone` Required. Zone resource.
zoneId	`String` Required. Zone identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique across all lakes from all locations in a project. Must not be one of the reserved IDs (i.e. "default", "global-temp")

Returns

Type	Description
OperationFuture<Zone,OperationMetadata>

createZoneCallable()

public final UnaryCallable<CreateZoneRequest,Operation> createZoneCallable()

Creates a zone resource within a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateZoneRequest request =
       CreateZoneRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setZoneId("zoneId-696323609")
           .setZone(Zone.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = dataplexServiceClient.createZoneCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<CreateZoneRequest,Operation>

createZoneOperationCallable()

public final OperationCallable<CreateZoneRequest,Zone,OperationMetadata> createZoneOperationCallable()

Creates a zone resource within a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   CreateZoneRequest request =
       CreateZoneRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setZoneId("zoneId-696323609")
           .setZone(Zone.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<Zone, OperationMetadata> future =
       dataplexServiceClient.createZoneOperationCallable().futureCall(request);
   // Do something.
   Zone response = future.get();
 }

Returns

Type	Description
OperationCallable<CreateZoneRequest,Zone,OperationMetadata>

deleteAssetAsync(AssetName name)

public final OperationFuture<Empty,OperationMetadata> deleteAssetAsync(AssetName name)

Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   AssetName name = AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]");
   dataplexServiceClient.deleteAssetAsync(name).get();
 }

Parameter

Name	Description
name	`AssetName` Required. The resource name of the asset: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteAssetAsync(DeleteAssetRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteAssetAsync(DeleteAssetRequest request)

Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteAssetRequest request =
       DeleteAssetRequest.newBuilder()
           .setName(
               AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]").toString())
           .build();
   dataplexServiceClient.deleteAssetAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteAssetAsync(String name)

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

Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String name =
       AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]").toString();
   dataplexServiceClient.deleteAssetAsync(name).get();
 }

Parameter

Name	Description
name	`String` Required. The resource name of the asset: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteAssetCallable()

public final UnaryCallable<DeleteAssetRequest,Operation> deleteAssetCallable()

Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteAssetRequest request =
       DeleteAssetRequest.newBuilder()
           .setName(
               AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]").toString())
           .build();
   ApiFuture<Operation> future = dataplexServiceClient.deleteAssetCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
UnaryCallable<DeleteAssetRequest,Operation>

deleteAssetOperationCallable()

public final OperationCallable<DeleteAssetRequest,Empty,OperationMetadata> deleteAssetOperationCallable()

Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteAssetRequest request =
       DeleteAssetRequest.newBuilder()
           .setName(
               AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       dataplexServiceClient.deleteAssetOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
OperationCallable<DeleteAssetRequest,Empty,OperationMetadata>

deleteEnvironmentAsync(DeleteEnvironmentRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteEnvironmentAsync(DeleteEnvironmentRequest request)

Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteEnvironmentRequest request =
       DeleteEnvironmentRequest.newBuilder()
           .setName(
               EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]")
                   .toString())
           .build();
   dataplexServiceClient.deleteEnvironmentAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteEnvironmentAsync(EnvironmentName name)

public final OperationFuture<Empty,OperationMetadata> deleteEnvironmentAsync(EnvironmentName name)

Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   EnvironmentName name =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]");
   dataplexServiceClient.deleteEnvironmentAsync(name).get();
 }

Parameter

Name	Description
name	`EnvironmentName` Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}`

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteEnvironmentAsync(String name)

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

Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String name =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]").toString();
   dataplexServiceClient.deleteEnvironmentAsync(name).get();
 }

Parameter

Name	Description
name	`String` Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}`

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteEnvironmentCallable()

public final UnaryCallable<DeleteEnvironmentRequest,Operation> deleteEnvironmentCallable()

Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteEnvironmentRequest request =
       DeleteEnvironmentRequest.newBuilder()
           .setName(
               EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       dataplexServiceClient.deleteEnvironmentCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
UnaryCallable<DeleteEnvironmentRequest,Operation>

deleteEnvironmentOperationCallable()

public final OperationCallable<DeleteEnvironmentRequest,Empty,OperationMetadata> deleteEnvironmentOperationCallable()

Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteEnvironmentRequest request =
       DeleteEnvironmentRequest.newBuilder()
           .setName(
               EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]")
                   .toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       dataplexServiceClient.deleteEnvironmentOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
OperationCallable<DeleteEnvironmentRequest,Empty,OperationMetadata>

deleteLakeAsync(DeleteLakeRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteLakeAsync(DeleteLakeRequest request)

Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteLakeRequest request =
       DeleteLakeRequest.newBuilder()
           .setName(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .build();
   dataplexServiceClient.deleteLakeAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteLakeAsync(LakeName name)

public final OperationFuture<Empty,OperationMetadata> deleteLakeAsync(LakeName name)

Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   LakeName name = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   dataplexServiceClient.deleteLakeAsync(name).get();
 }

Parameter

Name	Description
name	`LakeName` Required. The resource name of the lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteLakeAsync(String name)

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

Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String name = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString();
   dataplexServiceClient.deleteLakeAsync(name).get();
 }

Parameter

Name	Description
name	`String` Required. The resource name of the lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteLakeCallable()

public final UnaryCallable<DeleteLakeRequest,Operation> deleteLakeCallable()

Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteLakeRequest request =
       DeleteLakeRequest.newBuilder()
           .setName(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .build();
   ApiFuture<Operation> future = dataplexServiceClient.deleteLakeCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
UnaryCallable<DeleteLakeRequest,Operation>

deleteLakeOperationCallable()

public final OperationCallable<DeleteLakeRequest,Empty,OperationMetadata> deleteLakeOperationCallable()

Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteLakeRequest request =
       DeleteLakeRequest.newBuilder()
           .setName(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       dataplexServiceClient.deleteLakeOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
OperationCallable<DeleteLakeRequest,Empty,OperationMetadata>

deleteTaskAsync(DeleteTaskRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteTaskAsync(DeleteTaskRequest request)

Delete the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteTaskRequest request =
       DeleteTaskRequest.newBuilder()
           .setName(TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]").toString())
           .build();
   dataplexServiceClient.deleteTaskAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteTaskAsync(TaskName name)

public final OperationFuture<Empty,OperationMetadata> deleteTaskAsync(TaskName name)

Delete the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   TaskName name = TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]");
   dataplexServiceClient.deleteTaskAsync(name).get();
 }

Parameter

Name	Description
name	`TaskName` Required. The resource name of the task: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}`.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteTaskAsync(String name)

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

Delete the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String name = TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]").toString();
   dataplexServiceClient.deleteTaskAsync(name).get();
 }

Parameter

Name	Description
name	`String` Required. The resource name of the task: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}`.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteTaskCallable()

public final UnaryCallable<DeleteTaskRequest,Operation> deleteTaskCallable()

Delete the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteTaskRequest request =
       DeleteTaskRequest.newBuilder()
           .setName(TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]").toString())
           .build();
   ApiFuture<Operation> future = dataplexServiceClient.deleteTaskCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
UnaryCallable<DeleteTaskRequest,Operation>

deleteTaskOperationCallable()

public final OperationCallable<DeleteTaskRequest,Empty,OperationMetadata> deleteTaskOperationCallable()

Delete the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteTaskRequest request =
       DeleteTaskRequest.newBuilder()
           .setName(TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       dataplexServiceClient.deleteTaskOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
OperationCallable<DeleteTaskRequest,Empty,OperationMetadata>

deleteZoneAsync(DeleteZoneRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteZoneAsync(DeleteZoneRequest request)

Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteZoneRequest request =
       DeleteZoneRequest.newBuilder()
           .setName(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .build();
   dataplexServiceClient.deleteZoneAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteZoneAsync(ZoneName name)

public final OperationFuture<Empty,OperationMetadata> deleteZoneAsync(ZoneName name)

Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ZoneName name = ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]");
   dataplexServiceClient.deleteZoneAsync(name).get();
 }

Parameter

Name	Description
name	`ZoneName` Required. The resource name of the zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteZoneAsync(String name)

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

Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String name = ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString();
   dataplexServiceClient.deleteZoneAsync(name).get();
 }

Parameter

Name	Description
name	`String` Required. The resource name of the zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteZoneCallable()

public final UnaryCallable<DeleteZoneRequest,Operation> deleteZoneCallable()

Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteZoneRequest request =
       DeleteZoneRequest.newBuilder()
           .setName(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .build();
   ApiFuture<Operation> future = dataplexServiceClient.deleteZoneCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
UnaryCallable<DeleteZoneRequest,Operation>

deleteZoneOperationCallable()

public final OperationCallable<DeleteZoneRequest,Empty,OperationMetadata> deleteZoneOperationCallable()

Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   DeleteZoneRequest request =
       DeleteZoneRequest.newBuilder()
           .setName(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       dataplexServiceClient.deleteZoneOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
OperationCallable<DeleteZoneRequest,Empty,OperationMetadata>

getAsset(AssetName name)

public final Asset getAsset(AssetName name)

Retrieves an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   AssetName name = AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]");
   Asset response = dataplexServiceClient.getAsset(name);
 }

Parameter

Name	Description
name	`AssetName` Required. The resource name of the asset: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`.

Returns

Type	Description
Asset

getAsset(GetAssetRequest request)

public final Asset getAsset(GetAssetRequest request)

Retrieves an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   GetAssetRequest request =
       GetAssetRequest.newBuilder()
           .setName(
               AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]").toString())
           .build();
   Asset response = dataplexServiceClient.getAsset(request);
 }

Parameter

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

Returns

Type	Description
Asset

getAsset(String name)

public final Asset getAsset(String name)

Retrieves an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String name =
       AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]").toString();
   Asset response = dataplexServiceClient.getAsset(name);
 }

Parameter

Name	Description
name	`String` Required. The resource name of the asset: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`.

Returns

Type	Description
Asset

getAssetCallable()

public final UnaryCallable<GetAssetRequest,Asset> getAssetCallable()

Retrieves an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   GetAssetRequest request =
       GetAssetRequest.newBuilder()
           .setName(
               AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]").toString())
           .build();
   ApiFuture<Asset> future = dataplexServiceClient.getAssetCallable().futureCall(request);
   // Do something.
   Asset response = future.get();
 }

Returns

Type	Description
UnaryCallable<GetAssetRequest,Asset>

getEnvironment(EnvironmentName name)

public final Environment getEnvironment(EnvironmentName name)

Get environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   EnvironmentName name =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]");
   Environment response = dataplexServiceClient.getEnvironment(name);
 }

Parameter

Name	Description
name	`EnvironmentName` Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}

Returns

Type	Description
Environment

getEnvironment(GetEnvironmentRequest request)

public final Environment getEnvironment(GetEnvironmentRequest request)

Get environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   GetEnvironmentRequest request =
       GetEnvironmentRequest.newBuilder()
           .setName(
               EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]")
                   .toString())
           .build();
   Environment response = dataplexServiceClient.getEnvironment(request);
 }

Parameter

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

Returns

Type	Description
Environment

getEnvironment(String name)

public final Environment getEnvironment(String name)

Get environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String name =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]").toString();
   Environment response = dataplexServiceClient.getEnvironment(name);
 }

Parameter

Name	Description
name	`String` Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}

Returns

Type	Description
Environment

getEnvironmentCallable()

public final UnaryCallable<GetEnvironmentRequest,Environment> getEnvironmentCallable()

Get environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   GetEnvironmentRequest request =
       GetEnvironmentRequest.newBuilder()
           .setName(
               EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]")
                   .toString())
           .build();
   ApiFuture<Environment> future =
       dataplexServiceClient.getEnvironmentCallable().futureCall(request);
   // Do something.
   Environment response = future.get();
 }

Returns

Type	Description
UnaryCallable<GetEnvironmentRequest,Environment>

getJob(GetJobRequest request)

public final Job getJob(GetJobRequest request)

Get job resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   GetJobRequest request =
       GetJobRequest.newBuilder()
           .setName(
               JobName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]", "[JOB]").toString())
           .build();
   Job response = dataplexServiceClient.getJob(request);
 }

Parameter

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

Returns

Type	Description
Job

getJob(JobName name)

public final Job getJob(JobName name)

Get job resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   JobName name = JobName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]", "[JOB]");
   Job response = dataplexServiceClient.getJob(name);
 }

Parameter

Name	Description
name	`JobName` Required. The resource name of the job: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}`.

Returns

Type	Description
Job

getJob(String name)

public final Job getJob(String name)

Get job resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String name = JobName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]", "[JOB]").toString();
   Job response = dataplexServiceClient.getJob(name);
 }

Parameter

Name	Description
name	`String` Required. The resource name of the job: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}`.

Returns

Type	Description
Job

getJobCallable()

public final UnaryCallable<GetJobRequest,Job> getJobCallable()

Get job resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   GetJobRequest request =
       GetJobRequest.newBuilder()
           .setName(
               JobName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]", "[JOB]").toString())
           .build();
   ApiFuture<Job> future = dataplexServiceClient.getJobCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }

Returns

Type	Description
UnaryCallable<GetJobRequest,Job>

getLake(GetLakeRequest request)

public final Lake getLake(GetLakeRequest request)

Retrieves a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   GetLakeRequest request =
       GetLakeRequest.newBuilder()
           .setName(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .build();
   Lake response = dataplexServiceClient.getLake(request);
 }

Parameter

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

Returns

Type	Description
Lake

getLake(LakeName name)

public final Lake getLake(LakeName name)

Retrieves a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   LakeName name = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   Lake response = dataplexServiceClient.getLake(name);
 }

Parameter

Name	Description
name	`LakeName` Required. The resource name of the lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.

Returns

Type	Description
Lake

getLake(String name)

public final Lake getLake(String name)

Retrieves a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String name = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString();
   Lake response = dataplexServiceClient.getLake(name);
 }

Parameter

Name	Description
name	`String` Required. The resource name of the lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.

Returns

Type	Description
Lake

getLakeCallable()

public final UnaryCallable<GetLakeRequest,Lake> getLakeCallable()

Retrieves a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   GetLakeRequest request =
       GetLakeRequest.newBuilder()
           .setName(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .build();
   ApiFuture<Lake> future = dataplexServiceClient.getLakeCallable().futureCall(request);
   // Do something.
   Lake response = future.get();
 }

Returns

Type	Description
UnaryCallable<GetLakeRequest,Lake>

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 DataplexServiceSettings getSettings()

Returns

Type	Description
DataplexServiceSettings

getStub()

public DataplexServiceStub getStub()

Returns

Type	Description
DataplexServiceStub

getTask(GetTaskRequest request)

public final Task getTask(GetTaskRequest request)

Get task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   GetTaskRequest request =
       GetTaskRequest.newBuilder()
           .setName(TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]").toString())
           .build();
   Task response = dataplexServiceClient.getTask(request);
 }

Parameter

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

Returns

Type	Description
Task

getTask(TaskName name)

public final Task getTask(TaskName name)

Get task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   TaskName name = TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]");
   Task response = dataplexServiceClient.getTask(name);
 }

Parameter

Name	Description
name	`TaskName` Required. The resource name of the task: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}`

Returns

Type	Description
Task

getTask(String name)

public final Task getTask(String name)

Get task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String name = TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]").toString();
   Task response = dataplexServiceClient.getTask(name);
 }

Parameter

Name	Description
name	`String` Required. The resource name of the task: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}`

Returns

Type	Description
Task

getTaskCallable()

public final UnaryCallable<GetTaskRequest,Task> getTaskCallable()

Get task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   GetTaskRequest request =
       GetTaskRequest.newBuilder()
           .setName(TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]").toString())
           .build();
   ApiFuture<Task> future = dataplexServiceClient.getTaskCallable().futureCall(request);
   // Do something.
   Task response = future.get();
 }

Returns

Type	Description
UnaryCallable<GetTaskRequest,Task>

getZone(GetZoneRequest request)

public final Zone getZone(GetZoneRequest request)

Retrieves a zone resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   GetZoneRequest request =
       GetZoneRequest.newBuilder()
           .setName(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .build();
   Zone response = dataplexServiceClient.getZone(request);
 }

Parameter

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

Returns

Type	Description
Zone

getZone(ZoneName name)

public final Zone getZone(ZoneName name)

Retrieves a zone resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ZoneName name = ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]");
   Zone response = dataplexServiceClient.getZone(name);
 }

Parameter

Name	Description
name	`ZoneName` Required. The resource name of the zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.

Returns

Type	Description
Zone

getZone(String name)

public final Zone getZone(String name)

Retrieves a zone resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String name = ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString();
   Zone response = dataplexServiceClient.getZone(name);
 }

Parameter

Name	Description
name	`String` Required. The resource name of the zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.

Returns

Type	Description
Zone

getZoneCallable()

public final UnaryCallable<GetZoneRequest,Zone> getZoneCallable()

Retrieves a zone resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   GetZoneRequest request =
       GetZoneRequest.newBuilder()
           .setName(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .build();
   ApiFuture<Zone> future = dataplexServiceClient.getZoneCallable().futureCall(request);
   // Do something.
   Zone response = future.get();
 }

Returns

Type	Description
UnaryCallable<GetZoneRequest,Zone>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listAssetActions(AssetName parent)

public final DataplexServiceClient.ListAssetActionsPagedResponse listAssetActions(AssetName parent)

Lists action resources in an asset.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   AssetName parent = AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]");
   for (Action element : dataplexServiceClient.listAssetActions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`AssetName` Required. The resource name of the parent asset: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`.

Returns

Type	Description
DataplexServiceClient.ListAssetActionsPagedResponse

listAssetActions(ListAssetActionsRequest request)

public final DataplexServiceClient.ListAssetActionsPagedResponse listAssetActions(ListAssetActionsRequest request)

Lists action resources in an asset.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListAssetActionsRequest request =
       ListAssetActionsRequest.newBuilder()
           .setParent(
               AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Action element : dataplexServiceClient.listAssetActions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
DataplexServiceClient.ListAssetActionsPagedResponse

listAssetActions(String parent)

public final DataplexServiceClient.ListAssetActionsPagedResponse listAssetActions(String parent)

Lists action resources in an asset.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent =
       AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]").toString();
   for (Action element : dataplexServiceClient.listAssetActions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource name of the parent asset: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`.

Returns

Type	Description
DataplexServiceClient.ListAssetActionsPagedResponse

listAssetActionsCallable()

public final UnaryCallable<ListAssetActionsRequest,ListActionsResponse> listAssetActionsCallable()

Lists action resources in an asset.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListAssetActionsRequest request =
       ListAssetActionsRequest.newBuilder()
           .setParent(
               AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListActionsResponse response =
         dataplexServiceClient.listAssetActionsCallable().call(request);
     for (Action element : response.getActionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListAssetActionsRequest,ListActionsResponse>

listAssetActionsPagedCallable()

public final UnaryCallable<ListAssetActionsRequest,DataplexServiceClient.ListAssetActionsPagedResponse> listAssetActionsPagedCallable()

Lists action resources in an asset.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListAssetActionsRequest request =
       ListAssetActionsRequest.newBuilder()
           .setParent(
               AssetName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]", "[ASSET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Action> future =
       dataplexServiceClient.listAssetActionsPagedCallable().futureCall(request);
   // Do something.
   for (Action element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListAssetActionsRequest,ListAssetActionsPagedResponse>

listAssets(ListAssetsRequest request)

public final DataplexServiceClient.ListAssetsPagedResponse listAssets(ListAssetsRequest request)

Lists asset resources in a zone.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListAssetsRequest request =
       ListAssetsRequest.newBuilder()
           .setParent(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Asset element : dataplexServiceClient.listAssets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
DataplexServiceClient.ListAssetsPagedResponse

listAssets(ZoneName parent)

public final DataplexServiceClient.ListAssetsPagedResponse listAssets(ZoneName parent)

Lists asset resources in a zone.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ZoneName parent = ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]");
   for (Asset element : dataplexServiceClient.listAssets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`ZoneName` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.

Returns

Type	Description
DataplexServiceClient.ListAssetsPagedResponse

listAssets(String parent)

public final DataplexServiceClient.ListAssetsPagedResponse listAssets(String parent)

Lists asset resources in a zone.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString();
   for (Asset element : dataplexServiceClient.listAssets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.

Returns

Type	Description
DataplexServiceClient.ListAssetsPagedResponse

listAssetsCallable()

public final UnaryCallable<ListAssetsRequest,ListAssetsResponse> listAssetsCallable()

Lists asset resources in a zone.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListAssetsRequest request =
       ListAssetsRequest.newBuilder()
           .setParent(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListAssetsResponse response = dataplexServiceClient.listAssetsCallable().call(request);
     for (Asset element : response.getAssetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListAssetsRequest,ListAssetsResponse>

listAssetsPagedCallable()

public final UnaryCallable<ListAssetsRequest,DataplexServiceClient.ListAssetsPagedResponse> listAssetsPagedCallable()

Lists asset resources in a zone.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListAssetsRequest request =
       ListAssetsRequest.newBuilder()
           .setParent(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Asset> future = dataplexServiceClient.listAssetsPagedCallable().futureCall(request);
   // Do something.
   for (Asset element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListAssetsRequest,ListAssetsPagedResponse>

listEnvironments(LakeName parent)

public final DataplexServiceClient.ListEnvironmentsPagedResponse listEnvironments(LakeName parent)

Lists environments under the given lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   for (Environment element : dataplexServiceClient.listEnvironments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`LakeName` Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}

Returns

Type	Description
DataplexServiceClient.ListEnvironmentsPagedResponse

listEnvironments(ListEnvironmentsRequest request)

public final DataplexServiceClient.ListEnvironmentsPagedResponse listEnvironments(ListEnvironmentsRequest request)

Lists environments under the given lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListEnvironmentsRequest request =
       ListEnvironmentsRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Environment element : dataplexServiceClient.listEnvironments(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
DataplexServiceClient.ListEnvironmentsPagedResponse

listEnvironments(String parent)

public final DataplexServiceClient.ListEnvironmentsPagedResponse listEnvironments(String parent)

Lists environments under the given lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString();
   for (Environment element : dataplexServiceClient.listEnvironments(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}

Returns

Type	Description
DataplexServiceClient.ListEnvironmentsPagedResponse

listEnvironmentsCallable()

public final UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsResponse> listEnvironmentsCallable()

Lists environments under the given lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListEnvironmentsRequest request =
       ListEnvironmentsRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListEnvironmentsResponse response =
         dataplexServiceClient.listEnvironmentsCallable().call(request);
     for (Environment element : response.getEnvironmentsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsResponse>

listEnvironmentsPagedCallable()

public final UnaryCallable<ListEnvironmentsRequest,DataplexServiceClient.ListEnvironmentsPagedResponse> listEnvironmentsPagedCallable()

Lists environments under the given lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListEnvironmentsRequest request =
       ListEnvironmentsRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Environment> future =
       dataplexServiceClient.listEnvironmentsPagedCallable().futureCall(request);
   // Do something.
   for (Environment element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListEnvironmentsRequest,ListEnvironmentsPagedResponse>

listJobs(ListJobsRequest request)

public final DataplexServiceClient.ListJobsPagedResponse listJobs(ListJobsRequest request)

Lists Jobs under the given task.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setParent(TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Job element : dataplexServiceClient.listJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
DataplexServiceClient.ListJobsPagedResponse

listJobs(TaskName parent)

public final DataplexServiceClient.ListJobsPagedResponse listJobs(TaskName parent)

Lists Jobs under the given task.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   TaskName parent = TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]");
   for (Job element : dataplexServiceClient.listJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`TaskName` Required. The resource name of the parent environment: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`.

Returns

Type	Description
DataplexServiceClient.ListJobsPagedResponse

listJobs(String parent)

public final DataplexServiceClient.ListJobsPagedResponse listJobs(String parent)

Lists Jobs under the given task.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]").toString();
   for (Job element : dataplexServiceClient.listJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource name of the parent environment: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`.

Returns

Type	Description
DataplexServiceClient.ListJobsPagedResponse

listJobsCallable()

public final UnaryCallable<ListJobsRequest,ListJobsResponse> listJobsCallable()

Lists Jobs under the given task.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setParent(TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListJobsResponse response = dataplexServiceClient.listJobsCallable().call(request);
     for (Job element : response.getJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListJobsRequest,ListJobsResponse>

listJobsPagedCallable()

public final UnaryCallable<ListJobsRequest,DataplexServiceClient.ListJobsPagedResponse> listJobsPagedCallable()

Lists Jobs under the given task.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListJobsRequest request =
       ListJobsRequest.newBuilder()
           .setParent(TaskName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[TASK]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Job> future = dataplexServiceClient.listJobsPagedCallable().futureCall(request);
   // Do something.
   for (Job element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListJobsRequest,ListJobsPagedResponse>

listLakeActions(LakeName parent)

public final DataplexServiceClient.ListLakeActionsPagedResponse listLakeActions(LakeName parent)

Lists action resources in a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   for (Action element : dataplexServiceClient.listLakeActions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`LakeName` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`

Returns

Type	Description
DataplexServiceClient.ListLakeActionsPagedResponse

listLakeActions(ListLakeActionsRequest request)

public final DataplexServiceClient.ListLakeActionsPagedResponse listLakeActions(ListLakeActionsRequest request)

Lists action resources in a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListLakeActionsRequest request =
       ListLakeActionsRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Action element : dataplexServiceClient.listLakeActions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
DataplexServiceClient.ListLakeActionsPagedResponse

listLakeActions(String parent)

public final DataplexServiceClient.ListLakeActionsPagedResponse listLakeActions(String parent)

Lists action resources in a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString();
   for (Action element : dataplexServiceClient.listLakeActions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`

Returns

Type	Description
DataplexServiceClient.ListLakeActionsPagedResponse

listLakeActionsCallable()

public final UnaryCallable<ListLakeActionsRequest,ListActionsResponse> listLakeActionsCallable()

Lists action resources in a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListLakeActionsRequest request =
       ListLakeActionsRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListActionsResponse response =
         dataplexServiceClient.listLakeActionsCallable().call(request);
     for (Action element : response.getActionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListLakeActionsRequest,ListActionsResponse>

listLakeActionsPagedCallable()

public final UnaryCallable<ListLakeActionsRequest,DataplexServiceClient.ListLakeActionsPagedResponse> listLakeActionsPagedCallable()

Lists action resources in a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListLakeActionsRequest request =
       ListLakeActionsRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Action> future =
       dataplexServiceClient.listLakeActionsPagedCallable().futureCall(request);
   // Do something.
   for (Action element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListLakeActionsRequest,ListLakeActionsPagedResponse>

listLakes(ListLakesRequest request)

public final DataplexServiceClient.ListLakesPagedResponse listLakes(ListLakesRequest request)

Lists lake resources in a project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListLakesRequest request =
       ListLakesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Lake element : dataplexServiceClient.listLakes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
DataplexServiceClient.ListLakesPagedResponse

listLakes(LocationName parent)

public final DataplexServiceClient.ListLakesPagedResponse listLakes(LocationName parent)

Lists lake resources in a project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Lake element : dataplexServiceClient.listLakes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`LocationName` Required. The resource name of the lake location, of the form: `projects/{project_number}/locations/{location_id}` where `location_id` refers to a GCP region.

Returns

Type	Description
DataplexServiceClient.ListLakesPagedResponse

listLakes(String parent)

public final DataplexServiceClient.ListLakesPagedResponse listLakes(String parent)

Lists lake resources in a project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Lake element : dataplexServiceClient.listLakes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource name of the lake location, of the form: `projects/{project_number}/locations/{location_id}` where `location_id` refers to a GCP region.

Returns

Type	Description
DataplexServiceClient.ListLakesPagedResponse

listLakesCallable()

public final UnaryCallable<ListLakesRequest,ListLakesResponse> listLakesCallable()

Lists lake resources in a project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListLakesRequest request =
       ListLakesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListLakesResponse response = dataplexServiceClient.listLakesCallable().call(request);
     for (Lake element : response.getLakesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListLakesRequest,ListLakesResponse>

listLakesPagedCallable()

public final UnaryCallable<ListLakesRequest,DataplexServiceClient.ListLakesPagedResponse> listLakesPagedCallable()

Lists lake resources in a project and location.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListLakesRequest request =
       ListLakesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Lake> future = dataplexServiceClient.listLakesPagedCallable().futureCall(request);
   // Do something.
   for (Lake element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListLakesRequest,ListLakesPagedResponse>

listSessions(EnvironmentName parent)

public final DataplexServiceClient.ListSessionsPagedResponse listSessions(EnvironmentName parent)

Lists session resources in an environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   EnvironmentName parent =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]");
   for (Session element : dataplexServiceClient.listSessions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`EnvironmentName` Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}

Returns

Type	Description
DataplexServiceClient.ListSessionsPagedResponse

listSessions(ListSessionsRequest request)

public final DataplexServiceClient.ListSessionsPagedResponse listSessions(ListSessionsRequest request)

Lists session resources in an environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListSessionsRequest request =
       ListSessionsRequest.newBuilder()
           .setParent(
               EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Session element : dataplexServiceClient.listSessions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
DataplexServiceClient.ListSessionsPagedResponse

listSessions(String parent)

public final DataplexServiceClient.ListSessionsPagedResponse listSessions(String parent)

Lists session resources in an environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent =
       EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]").toString();
   for (Session element : dataplexServiceClient.listSessions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}

Returns

Type	Description
DataplexServiceClient.ListSessionsPagedResponse

listSessionsCallable()

public final UnaryCallable<ListSessionsRequest,ListSessionsResponse> listSessionsCallable()

Lists session resources in an environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListSessionsRequest request =
       ListSessionsRequest.newBuilder()
           .setParent(
               EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSessionsResponse response = dataplexServiceClient.listSessionsCallable().call(request);
     for (Session element : response.getSessionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListSessionsRequest,ListSessionsResponse>

listSessionsPagedCallable()

public final UnaryCallable<ListSessionsRequest,DataplexServiceClient.ListSessionsPagedResponse> listSessionsPagedCallable()

Lists session resources in an environment.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListSessionsRequest request =
       ListSessionsRequest.newBuilder()
           .setParent(
               EnvironmentName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ENVIRONMENT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Session> future =
       dataplexServiceClient.listSessionsPagedCallable().futureCall(request);
   // Do something.
   for (Session element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListSessionsRequest,ListSessionsPagedResponse>

listTasks(LakeName parent)

public final DataplexServiceClient.ListTasksPagedResponse listTasks(LakeName parent)

Lists tasks under the given lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   for (Task element : dataplexServiceClient.listTasks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`LakeName` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.

Returns

Type	Description
DataplexServiceClient.ListTasksPagedResponse

listTasks(ListTasksRequest request)

public final DataplexServiceClient.ListTasksPagedResponse listTasks(ListTasksRequest request)

Lists tasks under the given lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListTasksRequest request =
       ListTasksRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Task element : dataplexServiceClient.listTasks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
DataplexServiceClient.ListTasksPagedResponse

listTasks(String parent)

public final DataplexServiceClient.ListTasksPagedResponse listTasks(String parent)

Lists tasks under the given lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString();
   for (Task element : dataplexServiceClient.listTasks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.

Returns

Type	Description
DataplexServiceClient.ListTasksPagedResponse

listTasksCallable()

public final UnaryCallable<ListTasksRequest,ListTasksResponse> listTasksCallable()

Lists tasks under the given lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListTasksRequest request =
       ListTasksRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListTasksResponse response = dataplexServiceClient.listTasksCallable().call(request);
     for (Task element : response.getTasksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListTasksRequest,ListTasksResponse>

listTasksPagedCallable()

public final UnaryCallable<ListTasksRequest,DataplexServiceClient.ListTasksPagedResponse> listTasksPagedCallable()

Lists tasks under the given lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListTasksRequest request =
       ListTasksRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Task> future = dataplexServiceClient.listTasksPagedCallable().futureCall(request);
   // Do something.
   for (Task element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListTasksRequest,ListTasksPagedResponse>

listZoneActions(ListZoneActionsRequest request)

public final DataplexServiceClient.ListZoneActionsPagedResponse listZoneActions(ListZoneActionsRequest request)

Lists action resources in a zone.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListZoneActionsRequest request =
       ListZoneActionsRequest.newBuilder()
           .setParent(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Action element : dataplexServiceClient.listZoneActions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
DataplexServiceClient.ListZoneActionsPagedResponse

listZoneActions(ZoneName parent)

public final DataplexServiceClient.ListZoneActionsPagedResponse listZoneActions(ZoneName parent)

Lists action resources in a zone.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ZoneName parent = ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]");
   for (Action element : dataplexServiceClient.listZoneActions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`ZoneName` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.

Returns

Type	Description
DataplexServiceClient.ListZoneActionsPagedResponse

listZoneActions(String parent)

public final DataplexServiceClient.ListZoneActionsPagedResponse listZoneActions(String parent)

Lists action resources in a zone.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString();
   for (Action element : dataplexServiceClient.listZoneActions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.

Returns

Type	Description
DataplexServiceClient.ListZoneActionsPagedResponse

listZoneActionsCallable()

public final UnaryCallable<ListZoneActionsRequest,ListActionsResponse> listZoneActionsCallable()

Lists action resources in a zone.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListZoneActionsRequest request =
       ListZoneActionsRequest.newBuilder()
           .setParent(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListActionsResponse response =
         dataplexServiceClient.listZoneActionsCallable().call(request);
     for (Action element : response.getActionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListZoneActionsRequest,ListActionsResponse>

listZoneActionsPagedCallable()

public final UnaryCallable<ListZoneActionsRequest,DataplexServiceClient.ListZoneActionsPagedResponse> listZoneActionsPagedCallable()

Lists action resources in a zone.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListZoneActionsRequest request =
       ListZoneActionsRequest.newBuilder()
           .setParent(ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Action> future =
       dataplexServiceClient.listZoneActionsPagedCallable().futureCall(request);
   // Do something.
   for (Action element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListZoneActionsRequest,ListZoneActionsPagedResponse>

listZones(LakeName parent)

public final DataplexServiceClient.ListZonesPagedResponse listZones(LakeName parent)

Lists zone resources in a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
   for (Zone element : dataplexServiceClient.listZones(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`LakeName` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.

Returns

Type	Description
DataplexServiceClient.ListZonesPagedResponse

listZones(ListZonesRequest request)

public final DataplexServiceClient.ListZonesPagedResponse listZones(ListZonesRequest request)

Lists zone resources in a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListZonesRequest request =
       ListZonesRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Zone element : dataplexServiceClient.listZones(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
DataplexServiceClient.ListZonesPagedResponse

listZones(String parent)

public final DataplexServiceClient.ListZonesPagedResponse listZones(String parent)

Lists zone resources in a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   String parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString();
   for (Zone element : dataplexServiceClient.listZones(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`.

Returns

Type	Description
DataplexServiceClient.ListZonesPagedResponse

listZonesCallable()

public final UnaryCallable<ListZonesRequest,ListZonesResponse> listZonesCallable()

Lists zone resources in a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListZonesRequest request =
       ListZonesRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListZonesResponse response = dataplexServiceClient.listZonesCallable().call(request);
     for (Zone element : response.getZonesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListZonesRequest,ListZonesResponse>

listZonesPagedCallable()

public final UnaryCallable<ListZonesRequest,DataplexServiceClient.ListZonesPagedResponse> listZonesPagedCallable()

Lists zone resources in a lake.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   ListZonesRequest request =
       ListZonesRequest.newBuilder()
           .setParent(LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Zone> future = dataplexServiceClient.listZonesPagedCallable().futureCall(request);
   // Do something.
   for (Zone element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListZonesRequest,ListZonesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAssetAsync(Asset asset, FieldMask updateMask)

public final OperationFuture<Asset,OperationMetadata> updateAssetAsync(Asset asset, FieldMask updateMask)

Updates an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   Asset asset = Asset.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Asset response = dataplexServiceClient.updateAssetAsync(asset, updateMask).get();
 }

Parameters

Name	Description
asset	`Asset` Required. Update description. Only fields specified in `update_mask` are updated.
updateMask	`FieldMask` Required. Mask of fields to update.

Returns

Type	Description
OperationFuture<Asset,OperationMetadata>

updateAssetAsync(UpdateAssetRequest request)

public final OperationFuture<Asset,OperationMetadata> updateAssetAsync(UpdateAssetRequest request)

Updates an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateAssetRequest request =
       UpdateAssetRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAsset(Asset.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Asset response = dataplexServiceClient.updateAssetAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Asset,OperationMetadata>

updateAssetCallable()

public final UnaryCallable<UpdateAssetRequest,Operation> updateAssetCallable()

Updates an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateAssetRequest request =
       UpdateAssetRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAsset(Asset.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = dataplexServiceClient.updateAssetCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<UpdateAssetRequest,Operation>

updateAssetOperationCallable()

public final OperationCallable<UpdateAssetRequest,Asset,OperationMetadata> updateAssetOperationCallable()

Updates an asset resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateAssetRequest request =
       UpdateAssetRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAsset(Asset.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<Asset, OperationMetadata> future =
       dataplexServiceClient.updateAssetOperationCallable().futureCall(request);
   // Do something.
   Asset response = future.get();
 }

Returns

Type	Description
OperationCallable<UpdateAssetRequest,Asset,OperationMetadata>

updateEnvironmentAsync(Environment environment, FieldMask updateMask)

public final OperationFuture<Environment,OperationMetadata> updateEnvironmentAsync(Environment environment, FieldMask updateMask)

Update the environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   Environment environment = Environment.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Environment response =
       dataplexServiceClient.updateEnvironmentAsync(environment, updateMask).get();
 }

Parameters

Name	Description
environment	`Environment` Required. Update description. Only fields specified in `update_mask` are updated.
updateMask	`FieldMask` Required. Mask of fields to update.

Returns

Type	Description
OperationFuture<Environment,OperationMetadata>

updateEnvironmentAsync(UpdateEnvironmentRequest request)

public final OperationFuture<Environment,OperationMetadata> updateEnvironmentAsync(UpdateEnvironmentRequest request)

Update the environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateEnvironmentRequest request =
       UpdateEnvironmentRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setEnvironment(Environment.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Environment response = dataplexServiceClient.updateEnvironmentAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Environment,OperationMetadata>

updateEnvironmentCallable()

public final UnaryCallable<UpdateEnvironmentRequest,Operation> updateEnvironmentCallable()

Update the environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateEnvironmentRequest request =
       UpdateEnvironmentRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setEnvironment(Environment.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       dataplexServiceClient.updateEnvironmentCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<UpdateEnvironmentRequest,Operation>

updateEnvironmentOperationCallable()

public final OperationCallable<UpdateEnvironmentRequest,Environment,OperationMetadata> updateEnvironmentOperationCallable()

Update the environment resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateEnvironmentRequest request =
       UpdateEnvironmentRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setEnvironment(Environment.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<Environment, OperationMetadata> future =
       dataplexServiceClient.updateEnvironmentOperationCallable().futureCall(request);
   // Do something.
   Environment response = future.get();
 }

Returns

Type	Description
OperationCallable<UpdateEnvironmentRequest,Environment,OperationMetadata>

updateLakeAsync(Lake lake, FieldMask updateMask)

public final OperationFuture<Lake,OperationMetadata> updateLakeAsync(Lake lake, FieldMask updateMask)

Updates a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   Lake lake = Lake.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Lake response = dataplexServiceClient.updateLakeAsync(lake, updateMask).get();
 }

Parameters

Name	Description
lake	`Lake` Required. Update description. Only fields specified in `update_mask` are updated.
updateMask	`FieldMask` Required. Mask of fields to update.

Returns

Type	Description
OperationFuture<Lake,OperationMetadata>

updateLakeAsync(UpdateLakeRequest request)

public final OperationFuture<Lake,OperationMetadata> updateLakeAsync(UpdateLakeRequest request)

Updates a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateLakeRequest request =
       UpdateLakeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setLake(Lake.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Lake response = dataplexServiceClient.updateLakeAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Lake,OperationMetadata>

updateLakeCallable()

public final UnaryCallable<UpdateLakeRequest,Operation> updateLakeCallable()

Updates a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateLakeRequest request =
       UpdateLakeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setLake(Lake.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = dataplexServiceClient.updateLakeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<UpdateLakeRequest,Operation>

updateLakeOperationCallable()

public final OperationCallable<UpdateLakeRequest,Lake,OperationMetadata> updateLakeOperationCallable()

Updates a lake resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateLakeRequest request =
       UpdateLakeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setLake(Lake.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<Lake, OperationMetadata> future =
       dataplexServiceClient.updateLakeOperationCallable().futureCall(request);
   // Do something.
   Lake response = future.get();
 }

Returns

Type	Description
OperationCallable<UpdateLakeRequest,Lake,OperationMetadata>

updateTaskAsync(Task task, FieldMask updateMask)

public final OperationFuture<Task,OperationMetadata> updateTaskAsync(Task task, FieldMask updateMask)

Update the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   Task task = Task.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Task response = dataplexServiceClient.updateTaskAsync(task, updateMask).get();
 }

Parameters

Name	Description
task	`Task` Required. Update description. Only fields specified in `update_mask` are updated.
updateMask	`FieldMask` Required. Mask of fields to update.

Returns

Type	Description
OperationFuture<Task,OperationMetadata>

updateTaskAsync(UpdateTaskRequest request)

public final OperationFuture<Task,OperationMetadata> updateTaskAsync(UpdateTaskRequest request)

Update the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateTaskRequest request =
       UpdateTaskRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTask(Task.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Task response = dataplexServiceClient.updateTaskAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Task,OperationMetadata>

updateTaskCallable()

public final UnaryCallable<UpdateTaskRequest,Operation> updateTaskCallable()

Update the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateTaskRequest request =
       UpdateTaskRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTask(Task.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = dataplexServiceClient.updateTaskCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<UpdateTaskRequest,Operation>

updateTaskOperationCallable()

public final OperationCallable<UpdateTaskRequest,Task,OperationMetadata> updateTaskOperationCallable()

Update the task resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateTaskRequest request =
       UpdateTaskRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTask(Task.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<Task, OperationMetadata> future =
       dataplexServiceClient.updateTaskOperationCallable().futureCall(request);
   // Do something.
   Task response = future.get();
 }

Returns

Type	Description
OperationCallable<UpdateTaskRequest,Task,OperationMetadata>

updateZoneAsync(UpdateZoneRequest request)

public final OperationFuture<Zone,OperationMetadata> updateZoneAsync(UpdateZoneRequest request)

Updates a zone resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateZoneRequest request =
       UpdateZoneRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setZone(Zone.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Zone response = dataplexServiceClient.updateZoneAsync(request).get();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Zone,OperationMetadata>

updateZoneAsync(Zone zone, FieldMask updateMask)

public final OperationFuture<Zone,OperationMetadata> updateZoneAsync(Zone zone, FieldMask updateMask)

Updates a zone resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   Zone zone = Zone.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Zone response = dataplexServiceClient.updateZoneAsync(zone, updateMask).get();
 }

Parameters

Name	Description
zone	`Zone` Required. Update description. Only fields specified in `update_mask` are updated.
updateMask	`FieldMask` Required. Mask of fields to update.

Returns

Type	Description
OperationFuture<Zone,OperationMetadata>

updateZoneCallable()

public final UnaryCallable<UpdateZoneRequest,Operation> updateZoneCallable()

Updates a zone resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateZoneRequest request =
       UpdateZoneRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setZone(Zone.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future = dataplexServiceClient.updateZoneCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns

Type	Description
UnaryCallable<UpdateZoneRequest,Operation>

updateZoneOperationCallable()

public final OperationCallable<UpdateZoneRequest,Zone,OperationMetadata> updateZoneOperationCallable()

Updates a zone resource.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
   UpdateZoneRequest request =
       UpdateZoneRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setZone(Zone.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture<Zone, OperationMetadata> future =
       dataplexServiceClient.updateZoneOperationCallable().futureCall(request);
   // Do something.
   Zone response = future.get();
 }

Returns

Type	Description
OperationCallable<UpdateZoneRequest,Zone,OperationMetadata>