Interface DataplexServiceGrpc.AsyncService (1.41.0)

public static interface DataplexServiceGrpc.AsyncService

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

Methods

cancelJob(CancelJobRequest request, StreamObserver<Empty> responseObserver)

public default void cancelJob(CancelJobRequest request, StreamObserver<Empty> responseObserver)

Cancel jobs running for the task resource.

Parameters
Name Description
request CancelJobRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

createAsset(CreateAssetRequest request, StreamObserver<Operation> responseObserver)

public default void createAsset(CreateAssetRequest request, StreamObserver<Operation> responseObserver)

Creates an asset resource.

Parameters
Name Description
request CreateAssetRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createEnvironment(CreateEnvironmentRequest request, StreamObserver<Operation> responseObserver)

public default void createEnvironment(CreateEnvironmentRequest request, StreamObserver<Operation> responseObserver)

Create an environment resource.

Parameters
Name Description
request CreateEnvironmentRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createLake(CreateLakeRequest request, StreamObserver<Operation> responseObserver)

public default void createLake(CreateLakeRequest request, StreamObserver<Operation> responseObserver)

Creates a lake resource.

Parameters
Name Description
request CreateLakeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createTask(CreateTaskRequest request, StreamObserver<Operation> responseObserver)

public default void createTask(CreateTaskRequest request, StreamObserver<Operation> responseObserver)

Creates a task resource within a lake.

Parameters
Name Description
request CreateTaskRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createZone(CreateZoneRequest request, StreamObserver<Operation> responseObserver)

public default void createZone(CreateZoneRequest request, StreamObserver<Operation> responseObserver)

Creates a zone resource within a lake.

Parameters
Name Description
request CreateZoneRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteAsset(DeleteAssetRequest request, StreamObserver<Operation> responseObserver)

public default void deleteAsset(DeleteAssetRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request DeleteAssetRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteEnvironment(DeleteEnvironmentRequest request, StreamObserver<Operation> responseObserver)

public default void deleteEnvironment(DeleteEnvironmentRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request DeleteEnvironmentRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteLake(DeleteLakeRequest request, StreamObserver<Operation> responseObserver)

public default void deleteLake(DeleteLakeRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request DeleteLakeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteTask(DeleteTaskRequest request, StreamObserver<Operation> responseObserver)

public default void deleteTask(DeleteTaskRequest request, StreamObserver<Operation> responseObserver)

Delete the task resource.

Parameters
Name Description
request DeleteTaskRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteZone(DeleteZoneRequest request, StreamObserver<Operation> responseObserver)

public default void deleteZone(DeleteZoneRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name Description
request DeleteZoneRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getAsset(GetAssetRequest request, StreamObserver<Asset> responseObserver)

public default void getAsset(GetAssetRequest request, StreamObserver<Asset> responseObserver)

Retrieves an asset resource.

Parameters
Name Description
request GetAssetRequest
responseObserver io.grpc.stub.StreamObserver<Asset>

getEnvironment(GetEnvironmentRequest request, StreamObserver<Environment> responseObserver)

public default void getEnvironment(GetEnvironmentRequest request, StreamObserver<Environment> responseObserver)

Get environment resource.

Parameters
Name Description
request GetEnvironmentRequest
responseObserver io.grpc.stub.StreamObserver<Environment>

getJob(GetJobRequest request, StreamObserver<Job> responseObserver)

public default void getJob(GetJobRequest request, StreamObserver<Job> responseObserver)

Get job resource.

Parameters
Name Description
request GetJobRequest
responseObserver io.grpc.stub.StreamObserver<Job>

getLake(GetLakeRequest request, StreamObserver<Lake> responseObserver)

public default void getLake(GetLakeRequest request, StreamObserver<Lake> responseObserver)

Retrieves a lake resource.

Parameters
Name Description
request GetLakeRequest
responseObserver io.grpc.stub.StreamObserver<Lake>

getTask(GetTaskRequest request, StreamObserver<Task> responseObserver)

public default void getTask(GetTaskRequest request, StreamObserver<Task> responseObserver)

Get task resource.

Parameters
Name Description
request GetTaskRequest
responseObserver io.grpc.stub.StreamObserver<Task>

getZone(GetZoneRequest request, StreamObserver<Zone> responseObserver)

public default void getZone(GetZoneRequest request, StreamObserver<Zone> responseObserver)

Retrieves a zone resource.

Parameters
Name Description
request GetZoneRequest
responseObserver io.grpc.stub.StreamObserver<Zone>

listAssetActions(ListAssetActionsRequest request, StreamObserver<ListActionsResponse> responseObserver)

public default void listAssetActions(ListAssetActionsRequest request, StreamObserver<ListActionsResponse> responseObserver)

Lists action resources in an asset.

Parameters
Name Description
request ListAssetActionsRequest
responseObserver io.grpc.stub.StreamObserver<ListActionsResponse>

listAssets(ListAssetsRequest request, StreamObserver<ListAssetsResponse> responseObserver)

public default void listAssets(ListAssetsRequest request, StreamObserver<ListAssetsResponse> responseObserver)

Lists asset resources in a zone.

Parameters
Name Description
request ListAssetsRequest
responseObserver io.grpc.stub.StreamObserver<ListAssetsResponse>

listEnvironments(ListEnvironmentsRequest request, StreamObserver<ListEnvironmentsResponse> responseObserver)

public default void listEnvironments(ListEnvironmentsRequest request, StreamObserver<ListEnvironmentsResponse> responseObserver)

Lists environments under the given lake.

Parameters
Name Description
request ListEnvironmentsRequest
responseObserver io.grpc.stub.StreamObserver<ListEnvironmentsResponse>

listJobs(ListJobsRequest request, StreamObserver<ListJobsResponse> responseObserver)

public default void listJobs(ListJobsRequest request, StreamObserver<ListJobsResponse> responseObserver)

Lists Jobs under the given task.

Parameters
Name Description
request ListJobsRequest
responseObserver io.grpc.stub.StreamObserver<ListJobsResponse>

listLakeActions(ListLakeActionsRequest request, StreamObserver<ListActionsResponse> responseObserver)

public default void listLakeActions(ListLakeActionsRequest request, StreamObserver<ListActionsResponse> responseObserver)

Lists action resources in a lake.

Parameters
Name Description
request ListLakeActionsRequest
responseObserver io.grpc.stub.StreamObserver<ListActionsResponse>

listLakes(ListLakesRequest request, StreamObserver<ListLakesResponse> responseObserver)

public default void listLakes(ListLakesRequest request, StreamObserver<ListLakesResponse> responseObserver)

Lists lake resources in a project and location.

Parameters
Name Description
request ListLakesRequest
responseObserver io.grpc.stub.StreamObserver<ListLakesResponse>

listSessions(ListSessionsRequest request, StreamObserver<ListSessionsResponse> responseObserver)

public default void listSessions(ListSessionsRequest request, StreamObserver<ListSessionsResponse> responseObserver)

Lists session resources in an environment.

Parameters
Name Description
request ListSessionsRequest
responseObserver io.grpc.stub.StreamObserver<ListSessionsResponse>

listTasks(ListTasksRequest request, StreamObserver<ListTasksResponse> responseObserver)

public default void listTasks(ListTasksRequest request, StreamObserver<ListTasksResponse> responseObserver)

Lists tasks under the given lake.

Parameters
Name Description
request ListTasksRequest
responseObserver io.grpc.stub.StreamObserver<ListTasksResponse>

listZoneActions(ListZoneActionsRequest request, StreamObserver<ListActionsResponse> responseObserver)

public default void listZoneActions(ListZoneActionsRequest request, StreamObserver<ListActionsResponse> responseObserver)

Lists action resources in a zone.

Parameters
Name Description
request ListZoneActionsRequest
responseObserver io.grpc.stub.StreamObserver<ListActionsResponse>

listZones(ListZonesRequest request, StreamObserver<ListZonesResponse> responseObserver)

public default void listZones(ListZonesRequest request, StreamObserver<ListZonesResponse> responseObserver)

Lists zone resources in a lake.

Parameters
Name Description
request ListZonesRequest
responseObserver io.grpc.stub.StreamObserver<ListZonesResponse>

runTask(RunTaskRequest request, StreamObserver<RunTaskResponse> responseObserver)

public default void runTask(RunTaskRequest request, StreamObserver<RunTaskResponse> responseObserver)

Run an on demand execution of a Task.

Parameters
Name Description
request RunTaskRequest
responseObserver io.grpc.stub.StreamObserver<RunTaskResponse>

updateAsset(UpdateAssetRequest request, StreamObserver<Operation> responseObserver)

public default void updateAsset(UpdateAssetRequest request, StreamObserver<Operation> responseObserver)

Updates an asset resource.

Parameters
Name Description
request UpdateAssetRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateEnvironment(UpdateEnvironmentRequest request, StreamObserver<Operation> responseObserver)

public default void updateEnvironment(UpdateEnvironmentRequest request, StreamObserver<Operation> responseObserver)

Update the environment resource.

Parameters
Name Description
request UpdateEnvironmentRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateLake(UpdateLakeRequest request, StreamObserver<Operation> responseObserver)

public default void updateLake(UpdateLakeRequest request, StreamObserver<Operation> responseObserver)

Updates a lake resource.

Parameters
Name Description
request UpdateLakeRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateTask(UpdateTaskRequest request, StreamObserver<Operation> responseObserver)

public default void updateTask(UpdateTaskRequest request, StreamObserver<Operation> responseObserver)

Update the task resource.

Parameters
Name Description
request UpdateTaskRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateZone(UpdateZoneRequest request, StreamObserver<Operation> responseObserver)

public default void updateZone(UpdateZoneRequest request, StreamObserver<Operation> responseObserver)

Updates a zone resource.

Parameters
Name Description
request UpdateZoneRequest
responseObserver io.grpc.stub.StreamObserver<Operation>