Cloud Dataplex v1 API - Class DataplexService.DataplexServiceBase (2.11.0)

[BindServiceMethod(typeof(DataplexService), "BindService")]
public abstract class DataplexService.DataplexServiceBase

Reference documentation and code samples for the Cloud Dataplex v1 API class DataplexService.DataplexServiceBase.

Base class for server-side implementations of DataplexService

Inheritance

object > DataplexService.DataplexServiceBase

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Methods

CancelJob(CancelJobRequest, ServerCallContext)

public virtual Task<Empty> CancelJob(CancelJobRequest request, ServerCallContext context)

Cancel jobs running for the task resource.

Parameters
NameDescription
requestCancelJobRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

CreateAsset(CreateAssetRequest, ServerCallContext)

public virtual Task<Operation> CreateAsset(CreateAssetRequest request, ServerCallContext context)

Creates an asset resource.

Parameters
NameDescription
requestCreateAssetRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

CreateEnvironment(CreateEnvironmentRequest, ServerCallContext)

public virtual Task<Operation> CreateEnvironment(CreateEnvironmentRequest request, ServerCallContext context)

Create an environment resource.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

CreateLake(CreateLakeRequest, ServerCallContext)

public virtual Task<Operation> CreateLake(CreateLakeRequest request, ServerCallContext context)

Creates a lake resource.

Parameters
NameDescription
requestCreateLakeRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

CreateTask(CreateTaskRequest, ServerCallContext)

public virtual Task<Operation> CreateTask(CreateTaskRequest request, ServerCallContext context)

Creates a task resource within a lake.

Parameters
NameDescription
requestCreateTaskRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

CreateZone(CreateZoneRequest, ServerCallContext)

public virtual Task<Operation> CreateZone(CreateZoneRequest request, ServerCallContext context)

Creates a zone resource within a lake.

Parameters
NameDescription
requestCreateZoneRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteAsset(DeleteAssetRequest, ServerCallContext)

public virtual Task<Operation> DeleteAsset(DeleteAssetRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestDeleteAssetRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteEnvironment(DeleteEnvironmentRequest, ServerCallContext)

public virtual Task<Operation> DeleteEnvironment(DeleteEnvironmentRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteLake(DeleteLakeRequest, ServerCallContext)

public virtual Task<Operation> DeleteLake(DeleteLakeRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestDeleteLakeRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteTask(DeleteTaskRequest, ServerCallContext)

public virtual Task<Operation> DeleteTask(DeleteTaskRequest request, ServerCallContext context)

Delete the task resource.

Parameters
NameDescription
requestDeleteTaskRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteZone(DeleteZoneRequest, ServerCallContext)

public virtual Task<Operation> DeleteZone(DeleteZoneRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestDeleteZoneRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

GetAsset(GetAssetRequest, ServerCallContext)

public virtual Task<Asset> GetAsset(GetAssetRequest request, ServerCallContext context)

Retrieves an asset resource.

Parameters
NameDescription
requestGetAssetRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskAsset

The response to send back to the client (wrapped by a task).

GetEnvironment(GetEnvironmentRequest, ServerCallContext)

public virtual Task<Environment> GetEnvironment(GetEnvironmentRequest request, ServerCallContext context)

Get environment resource.

Parameters
NameDescription
requestGetEnvironmentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEnvironment

The response to send back to the client (wrapped by a task).

GetJob(GetJobRequest, ServerCallContext)

public virtual Task<Job> GetJob(GetJobRequest request, ServerCallContext context)

Get job resource.

Parameters
NameDescription
requestGetJobRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskJob

The response to send back to the client (wrapped by a task).

GetLake(GetLakeRequest, ServerCallContext)

public virtual Task<Lake> GetLake(GetLakeRequest request, ServerCallContext context)

Retrieves a lake resource.

Parameters
NameDescription
requestGetLakeRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskLake

The response to send back to the client (wrapped by a task).

GetTask(GetTaskRequest, ServerCallContext)

public virtual Task<Task> GetTask(GetTaskRequest request, ServerCallContext context)

Get task resource.

Parameters
NameDescription
requestGetTaskRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskTask

The response to send back to the client (wrapped by a task).

GetZone(GetZoneRequest, ServerCallContext)

public virtual Task<Zone> GetZone(GetZoneRequest request, ServerCallContext context)

Retrieves a zone resource.

Parameters
NameDescription
requestGetZoneRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskZone

The response to send back to the client (wrapped by a task).

ListAssetActions(ListAssetActionsRequest, ServerCallContext)

public virtual Task<ListActionsResponse> ListAssetActions(ListAssetActionsRequest request, ServerCallContext context)

Lists action resources in an asset.

Parameters
NameDescription
requestListAssetActionsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListActionsResponse

The response to send back to the client (wrapped by a task).

ListAssets(ListAssetsRequest, ServerCallContext)

public virtual Task<ListAssetsResponse> ListAssets(ListAssetsRequest request, ServerCallContext context)

Lists asset resources in a zone.

Parameters
NameDescription
requestListAssetsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListAssetsResponse

The response to send back to the client (wrapped by a task).

ListEnvironments(ListEnvironmentsRequest, ServerCallContext)

public virtual Task<ListEnvironmentsResponse> ListEnvironments(ListEnvironmentsRequest request, ServerCallContext context)

Lists environments under the given lake.

Parameters
NameDescription
requestListEnvironmentsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListEnvironmentsResponse

The response to send back to the client (wrapped by a task).

ListJobs(ListJobsRequest, ServerCallContext)

public virtual Task<ListJobsResponse> ListJobs(ListJobsRequest request, ServerCallContext context)

Lists Jobs under the given task.

Parameters
NameDescription
requestListJobsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListJobsResponse

The response to send back to the client (wrapped by a task).

ListLakeActions(ListLakeActionsRequest, ServerCallContext)

public virtual Task<ListActionsResponse> ListLakeActions(ListLakeActionsRequest request, ServerCallContext context)

Lists action resources in a lake.

Parameters
NameDescription
requestListLakeActionsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListActionsResponse

The response to send back to the client (wrapped by a task).

ListLakes(ListLakesRequest, ServerCallContext)

public virtual Task<ListLakesResponse> ListLakes(ListLakesRequest request, ServerCallContext context)

Lists lake resources in a project and location.

Parameters
NameDescription
requestListLakesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListLakesResponse

The response to send back to the client (wrapped by a task).

ListSessions(ListSessionsRequest, ServerCallContext)

public virtual Task<ListSessionsResponse> ListSessions(ListSessionsRequest request, ServerCallContext context)

Lists session resources in an environment.

Parameters
NameDescription
requestListSessionsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListSessionsResponse

The response to send back to the client (wrapped by a task).

ListTasks(ListTasksRequest, ServerCallContext)

public virtual Task<ListTasksResponse> ListTasks(ListTasksRequest request, ServerCallContext context)

Lists tasks under the given lake.

Parameters
NameDescription
requestListTasksRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListTasksResponse

The response to send back to the client (wrapped by a task).

ListZoneActions(ListZoneActionsRequest, ServerCallContext)

public virtual Task<ListActionsResponse> ListZoneActions(ListZoneActionsRequest request, ServerCallContext context)

Lists action resources in a zone.

Parameters
NameDescription
requestListZoneActionsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListActionsResponse

The response to send back to the client (wrapped by a task).

ListZones(ListZonesRequest, ServerCallContext)

public virtual Task<ListZonesResponse> ListZones(ListZonesRequest request, ServerCallContext context)

Lists zone resources in a lake.

Parameters
NameDescription
requestListZonesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListZonesResponse

The response to send back to the client (wrapped by a task).

RunTask(RunTaskRequest, ServerCallContext)

public virtual Task<RunTaskResponse> RunTask(RunTaskRequest request, ServerCallContext context)

Run an on demand execution of a Task.

Parameters
NameDescription
requestRunTaskRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskRunTaskResponse

The response to send back to the client (wrapped by a task).

UpdateAsset(UpdateAssetRequest, ServerCallContext)

public virtual Task<Operation> UpdateAsset(UpdateAssetRequest request, ServerCallContext context)

Updates an asset resource.

Parameters
NameDescription
requestUpdateAssetRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateEnvironment(UpdateEnvironmentRequest, ServerCallContext)

public virtual Task<Operation> UpdateEnvironment(UpdateEnvironmentRequest request, ServerCallContext context)

Update the environment resource.

Parameters
NameDescription
requestUpdateEnvironmentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateLake(UpdateLakeRequest, ServerCallContext)

public virtual Task<Operation> UpdateLake(UpdateLakeRequest request, ServerCallContext context)

Updates a lake resource.

Parameters
NameDescription
requestUpdateLakeRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateTask(UpdateTaskRequest, ServerCallContext)

public virtual Task<Operation> UpdateTask(UpdateTaskRequest request, ServerCallContext context)

Update the task resource.

Parameters
NameDescription
requestUpdateTaskRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateZone(UpdateZoneRequest, ServerCallContext)

public virtual Task<Operation> UpdateZone(UpdateZoneRequest request, ServerCallContext context)

Updates a zone resource.

Parameters
NameDescription
requestUpdateZoneRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).