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

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
`request`	`CancelJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`CreateAssetRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`CreateEnvironmentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`CreateLakeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`CreateTaskRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`CreateZoneRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`DeleteAssetRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`DeleteEnvironmentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`DeleteLakeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`DeleteTaskRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`DeleteZoneRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetAssetRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetEnvironmentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetLakeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetTaskRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetZoneRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListAssetActionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListAssetsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListEnvironmentsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListJobsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListLakeActionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListLakesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListSessionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListTasksRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListZoneActionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListZonesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`RunTaskRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`UpdateAssetRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`UpdateEnvironmentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`UpdateLakeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`UpdateTaskRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`UpdateZoneRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).