Cloud Dataplex v1 API - Class DataplexServiceClientImpl (3.4.0) 

public sealed class DataplexServiceClientImpl : DataplexServiceClient

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

DataplexService client wrapper implementation, for convenient use.

Inheritance

object > DataplexServiceClient > DataplexServiceClientImpl

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Remarks

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.

Constructors

DataplexServiceClientImpl(DataplexServiceClient, DataplexServiceSettings, ILogger)

public DataplexServiceClientImpl(DataplexService.DataplexServiceClient grpcClient, DataplexServiceSettings settings, ILogger logger)

Constructs a client wrapper for the DataplexService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient DataplexServiceDataplexServiceClient

The underlying gRPC client.
settings DataplexServiceSettings

The base DataplexServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateAssetOperationsClient

public override OperationsClient CreateAssetOperationsClient { get; }

The long-running operations client for CreateAsset.

Property Value
Type Description
OperationsClient
Overrides

CreateEnvironmentOperationsClient

public override OperationsClient CreateEnvironmentOperationsClient { get; }

The long-running operations client for CreateEnvironment.

Property Value
Type Description
OperationsClient
Overrides

CreateLakeOperationsClient

public override OperationsClient CreateLakeOperationsClient { get; }

The long-running operations client for CreateLake.

Property Value
Type Description
OperationsClient
Overrides

CreateTaskOperationsClient

public override OperationsClient CreateTaskOperationsClient { get; }

The long-running operations client for CreateTask.

Property Value
Type Description
OperationsClient
Overrides

CreateZoneOperationsClient

public override OperationsClient CreateZoneOperationsClient { get; }

The long-running operations client for CreateZone.

Property Value
Type Description
OperationsClient
Overrides

DeleteAssetOperationsClient

public override OperationsClient DeleteAssetOperationsClient { get; }

The long-running operations client for DeleteAsset.

Property Value
Type Description
OperationsClient
Overrides

DeleteEnvironmentOperationsClient

public override OperationsClient DeleteEnvironmentOperationsClient { get; }

The long-running operations client for DeleteEnvironment.

Property Value
Type Description
OperationsClient
Overrides

DeleteLakeOperationsClient

public override OperationsClient DeleteLakeOperationsClient { get; }

The long-running operations client for DeleteLake.

Property Value
Type Description
OperationsClient
Overrides

DeleteTaskOperationsClient

public override OperationsClient DeleteTaskOperationsClient { get; }

The long-running operations client for DeleteTask.

Property Value
Type Description
OperationsClient
Overrides

DeleteZoneOperationsClient

public override OperationsClient DeleteZoneOperationsClient { get; }

The long-running operations client for DeleteZone.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override DataplexService.DataplexServiceClient GrpcClient { get; }

The underlying gRPC DataplexService client

Property Value
Type Description
DataplexServiceDataplexServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateAssetOperationsClient

public override OperationsClient UpdateAssetOperationsClient { get; }

The long-running operations client for UpdateAsset.

Property Value
Type Description
OperationsClient
Overrides

UpdateEnvironmentOperationsClient

public override OperationsClient UpdateEnvironmentOperationsClient { get; }

The long-running operations client for UpdateEnvironment.

Property Value
Type Description
OperationsClient
Overrides

UpdateLakeOperationsClient

public override OperationsClient UpdateLakeOperationsClient { get; }

The long-running operations client for UpdateLake.

Property Value
Type Description
OperationsClient
Overrides

UpdateTaskOperationsClient

public override OperationsClient UpdateTaskOperationsClient { get; }

The long-running operations client for UpdateTask.

Property Value
Type Description
OperationsClient
Overrides

UpdateZoneOperationsClient

public override OperationsClient UpdateZoneOperationsClient { get; }

The long-running operations client for UpdateZone.

Property Value
Type Description
OperationsClient
Overrides

Methods

CancelJob(CancelJobRequest, CallSettings)

public override void CancelJob(CancelJobRequest request, CallSettings callSettings = null)

Cancel jobs running for the task resource.

Parameters
Name Description
request CancelJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

CancelJobAsync(CancelJobRequest, CallSettings)

public override Task CancelJobAsync(CancelJobRequest request, CallSettings callSettings = null)

Cancel jobs running for the task resource.

Parameters
Name Description
request CancelJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

CreateAsset(CreateAssetRequest, CallSettings)

public override Operation<Asset, OperationMetadata> CreateAsset(CreateAssetRequest request, CallSettings callSettings = null)

Creates an asset resource.

Parameters
Name Description
request CreateAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAssetOperationMetadata

The RPC response.
Overrides

CreateAssetAsync(CreateAssetRequest, CallSettings)

public override Task<Operation<Asset, OperationMetadata>> CreateAssetAsync(CreateAssetRequest request, CallSettings callSettings = null)

Creates an asset resource.

Parameters
Name Description
request CreateAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAssetOperationMetadata

A Task containing the RPC response.
Overrides

CreateEnvironment(CreateEnvironmentRequest, CallSettings)

public override Operation<Environment, OperationMetadata> CreateEnvironment(CreateEnvironmentRequest request, CallSettings callSettings = null)

Create an environment resource.

Parameters
Name Description
request CreateEnvironmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEnvironmentOperationMetadata

The RPC response.
Overrides

CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)

public override Task<Operation<Environment, OperationMetadata>> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallSettings callSettings = null)

Create an environment resource.

Parameters
Name Description
request CreateEnvironmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEnvironmentOperationMetadata

A Task containing the RPC response.
Overrides

CreateLake(CreateLakeRequest, CallSettings)

public override Operation<Lake, OperationMetadata> CreateLake(CreateLakeRequest request, CallSettings callSettings = null)

Creates a lake resource.

Parameters
Name Description
request CreateLakeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationLakeOperationMetadata

The RPC response.
Overrides

CreateLakeAsync(CreateLakeRequest, CallSettings)

public override Task<Operation<Lake, OperationMetadata>> CreateLakeAsync(CreateLakeRequest request, CallSettings callSettings = null)

Creates a lake resource.

Parameters
Name Description
request CreateLakeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationLakeOperationMetadata

A Task containing the RPC response.
Overrides

CreateTask(CreateTaskRequest, CallSettings)

public override Operation<Task, OperationMetadata> CreateTask(CreateTaskRequest request, CallSettings callSettings = null)

Creates a task resource within a lake.

Parameters
Name Description
request CreateTaskRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationTaskOperationMetadata

The RPC response.
Overrides

CreateTaskAsync(CreateTaskRequest, CallSettings)

public override Task<Operation<Task, OperationMetadata>> CreateTaskAsync(CreateTaskRequest request, CallSettings callSettings = null)

Creates a task resource within a lake.

Parameters
Name Description
request CreateTaskRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationTaskOperationMetadata

A Task containing the RPC response.
Overrides

CreateZone(CreateZoneRequest, CallSettings)

public override Operation<Zone, OperationMetadata> CreateZone(CreateZoneRequest request, CallSettings callSettings = null)

Creates a zone resource within a lake.

Parameters
Name Description
request CreateZoneRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationZoneOperationMetadata

The RPC response.
Overrides

CreateZoneAsync(CreateZoneRequest, CallSettings)

public override Task<Operation<Zone, OperationMetadata>> CreateZoneAsync(CreateZoneRequest request, CallSettings callSettings = null)

Creates a zone resource within a lake.

Parameters
Name Description
request CreateZoneRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationZoneOperationMetadata

A Task containing the RPC response.
Overrides

DeleteAsset(DeleteAssetRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteAsset(DeleteAssetRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteAssetAsync(DeleteAssetRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteAssetAsync(DeleteAssetRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteEnvironment(DeleteEnvironmentRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteLake(DeleteLakeRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteLake(DeleteLakeRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteLakeAsync(DeleteLakeRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteLakeAsync(DeleteLakeRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteTask(DeleteTaskRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteTask(DeleteTaskRequest request, CallSettings callSettings = null)

Delete the task resource.

Parameters
Name Description
request DeleteTaskRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteTaskAsync(DeleteTaskRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteTaskAsync(DeleteTaskRequest request, CallSettings callSettings = null)

Delete the task resource.

Parameters
Name Description
request DeleteTaskRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteZone(DeleteZoneRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteZone(DeleteZoneRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteZoneAsync(DeleteZoneRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteZoneAsync(DeleteZoneRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

GetAsset(GetAssetRequest, CallSettings)

public override Asset GetAsset(GetAssetRequest request, CallSettings callSettings = null)

Retrieves an asset resource.

Parameters
Name Description
request GetAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Asset

The RPC response.
Overrides

GetAssetAsync(GetAssetRequest, CallSettings)

public override Task<Asset> GetAssetAsync(GetAssetRequest request, CallSettings callSettings = null)

Retrieves an asset resource.

Parameters
Name Description
request GetAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAsset

A Task containing the RPC response.
Overrides

GetEnvironment(GetEnvironmentRequest, CallSettings)

public override Environment GetEnvironment(GetEnvironmentRequest request, CallSettings callSettings = null)

Get environment resource.

Parameters
Name Description
request GetEnvironmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Environment

The RPC response.
Overrides

GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)

public override Task<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallSettings callSettings = null)

Get environment resource.

Parameters
Name Description
request GetEnvironmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskEnvironment

A Task containing the RPC response.
Overrides

GetJob(GetJobRequest, CallSettings)

public override Job GetJob(GetJobRequest request, CallSettings callSettings = null)

Get job resource.

Parameters
Name Description
request GetJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Job

The RPC response.
Overrides

GetJobAsync(GetJobRequest, CallSettings)

public override Task<Job> GetJobAsync(GetJobRequest request, CallSettings callSettings = null)

Get job resource.

Parameters
Name Description
request GetJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskJob

A Task containing the RPC response.
Overrides

GetLake(GetLakeRequest, CallSettings)

public override Lake GetLake(GetLakeRequest request, CallSettings callSettings = null)

Retrieves a lake resource.

Parameters
Name Description
request GetLakeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Lake

The RPC response.
Overrides

GetLakeAsync(GetLakeRequest, CallSettings)

public override Task<Lake> GetLakeAsync(GetLakeRequest request, CallSettings callSettings = null)

Retrieves a lake resource.

Parameters
Name Description
request GetLakeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskLake

A Task containing the RPC response.
Overrides

GetTask(GetTaskRequest, CallSettings)

public override Task GetTask(GetTaskRequest request, CallSettings callSettings = null)

Get task resource.

Parameters
Name Description
request GetTaskRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

The RPC response.
Overrides

GetTaskAsync(GetTaskRequest, CallSettings)

public override Task<Task> GetTaskAsync(GetTaskRequest request, CallSettings callSettings = null)

Get task resource.

Parameters
Name Description
request GetTaskRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTask

A Task containing the RPC response.
Overrides

GetZone(GetZoneRequest, CallSettings)

public override Zone GetZone(GetZoneRequest request, CallSettings callSettings = null)

Retrieves a zone resource.

Parameters
Name Description
request GetZoneRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Zone

The RPC response.
Overrides

GetZoneAsync(GetZoneRequest, CallSettings)

public override Task<Zone> GetZoneAsync(GetZoneRequest request, CallSettings callSettings = null)

Retrieves a zone resource.

Parameters
Name Description
request GetZoneRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskZone

A Task containing the RPC response.
Overrides

ListAssetActions(ListAssetActionsRequest, CallSettings)

public override PagedEnumerable<ListActionsResponse, Action> ListAssetActions(ListAssetActionsRequest request, CallSettings callSettings = null)

Lists action resources in an asset.

Parameters
Name Description
request ListAssetActionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListActionsResponseAction

A pageable sequence of Action resources.
Overrides

ListAssetActionsAsync(ListAssetActionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListActionsResponse, Action> ListAssetActionsAsync(ListAssetActionsRequest request, CallSettings callSettings = null)

Lists action resources in an asset.

Parameters
Name Description
request ListAssetActionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListActionsResponseAction

A pageable asynchronous sequence of Action resources.
Overrides

ListAssets(ListAssetsRequest, CallSettings)

public override PagedEnumerable<ListAssetsResponse, Asset> ListAssets(ListAssetsRequest request, CallSettings callSettings = null)

Lists asset resources in a zone.

Parameters
Name Description
request ListAssetsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListAssetsResponseAsset

A pageable sequence of Asset resources.
Overrides

ListAssetsAsync(ListAssetsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAssetsResponse, Asset> ListAssetsAsync(ListAssetsRequest request, CallSettings callSettings = null)

Lists asset resources in a zone.

Parameters
Name Description
request ListAssetsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListAssetsResponseAsset

A pageable asynchronous sequence of Asset resources.
Overrides

ListEnvironments(ListEnvironmentsRequest, CallSettings)

public override PagedEnumerable<ListEnvironmentsResponse, Environment> ListEnvironments(ListEnvironmentsRequest request, CallSettings callSettings = null)

Lists environments under the given lake.

Parameters
Name Description
request ListEnvironmentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListEnvironmentsResponseEnvironment

A pageable sequence of Environment resources.
Overrides

ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)

public override PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallSettings callSettings = null)

Lists environments under the given lake.

Parameters
Name Description
request ListEnvironmentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListEnvironmentsResponseEnvironment

A pageable asynchronous sequence of Environment resources.
Overrides

ListJobs(ListJobsRequest, CallSettings)

public override PagedEnumerable<ListJobsResponse, Job> ListJobs(ListJobsRequest request, CallSettings callSettings = null)

Lists Jobs under the given task.

Parameters
Name Description
request ListJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListJobsResponseJob

A pageable sequence of Job resources.
Overrides

ListJobsAsync(ListJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListJobsResponse, Job> ListJobsAsync(ListJobsRequest request, CallSettings callSettings = null)

Lists Jobs under the given task.

Parameters
Name Description
request ListJobsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListJobsResponseJob

A pageable asynchronous sequence of Job resources.
Overrides

ListLakeActions(ListLakeActionsRequest, CallSettings)

public override PagedEnumerable<ListActionsResponse, Action> ListLakeActions(ListLakeActionsRequest request, CallSettings callSettings = null)

Lists action resources in a lake.

Parameters
Name Description
request ListLakeActionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListActionsResponseAction

A pageable sequence of Action resources.
Overrides

ListLakeActionsAsync(ListLakeActionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListActionsResponse, Action> ListLakeActionsAsync(ListLakeActionsRequest request, CallSettings callSettings = null)

Lists action resources in a lake.

Parameters
Name Description
request ListLakeActionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListActionsResponseAction

A pageable asynchronous sequence of Action resources.
Overrides

ListLakes(ListLakesRequest, CallSettings)

public override PagedEnumerable<ListLakesResponse, Lake> ListLakes(ListLakesRequest request, CallSettings callSettings = null)

Lists lake resources in a project and location.

Parameters
Name Description
request ListLakesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListLakesResponseLake

A pageable sequence of Lake resources.
Overrides

ListLakesAsync(ListLakesRequest, CallSettings)

public override PagedAsyncEnumerable<ListLakesResponse, Lake> ListLakesAsync(ListLakesRequest request, CallSettings callSettings = null)

Lists lake resources in a project and location.

Parameters
Name Description
request ListLakesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListLakesResponseLake

A pageable asynchronous sequence of Lake resources.
Overrides

ListSessions(ListSessionsRequest, CallSettings)

public override PagedEnumerable<ListSessionsResponse, Session> ListSessions(ListSessionsRequest request, CallSettings callSettings = null)

Lists session resources in an environment.

Parameters
Name Description
request ListSessionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListSessionsResponseSession

A pageable sequence of Session resources.
Overrides

ListSessionsAsync(ListSessionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSessionsResponse, Session> ListSessionsAsync(ListSessionsRequest request, CallSettings callSettings = null)

Lists session resources in an environment.

Parameters
Name Description
request ListSessionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListSessionsResponseSession

A pageable asynchronous sequence of Session resources.
Overrides

ListTasks(ListTasksRequest, CallSettings)

public override PagedEnumerable<ListTasksResponse, Task> ListTasks(ListTasksRequest request, CallSettings callSettings = null)

Lists tasks under the given lake.

Parameters
Name Description
request ListTasksRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTasksResponseTask

A pageable sequence of Task resources.
Overrides

ListTasksAsync(ListTasksRequest, CallSettings)

public override PagedAsyncEnumerable<ListTasksResponse, Task> ListTasksAsync(ListTasksRequest request, CallSettings callSettings = null)

Lists tasks under the given lake.

Parameters
Name Description
request ListTasksRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTasksResponseTask

A pageable asynchronous sequence of Task resources.
Overrides

ListZoneActions(ListZoneActionsRequest, CallSettings)

public override PagedEnumerable<ListActionsResponse, Action> ListZoneActions(ListZoneActionsRequest request, CallSettings callSettings = null)

Lists action resources in a zone.

Parameters
Name Description
request ListZoneActionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListActionsResponseAction

A pageable sequence of Action resources.
Overrides

ListZoneActionsAsync(ListZoneActionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListActionsResponse, Action> ListZoneActionsAsync(ListZoneActionsRequest request, CallSettings callSettings = null)

Lists action resources in a zone.

Parameters
Name Description
request ListZoneActionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListActionsResponseAction

A pageable asynchronous sequence of Action resources.
Overrides

ListZones(ListZonesRequest, CallSettings)

public override PagedEnumerable<ListZonesResponse, Zone> ListZones(ListZonesRequest request, CallSettings callSettings = null)

Lists zone resources in a lake.

Parameters
Name Description
request ListZonesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListZonesResponseZone

A pageable sequence of Zone resources.
Overrides

ListZonesAsync(ListZonesRequest, CallSettings)

public override PagedAsyncEnumerable<ListZonesResponse, Zone> ListZonesAsync(ListZonesRequest request, CallSettings callSettings = null)

Lists zone resources in a lake.

Parameters
Name Description
request ListZonesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListZonesResponseZone

A pageable asynchronous sequence of Zone resources.
Overrides

RunTask(RunTaskRequest, CallSettings)

public override RunTaskResponse RunTask(RunTaskRequest request, CallSettings callSettings = null)

Run an on demand execution of a Task.

Parameters
Name Description
request RunTaskRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RunTaskResponse

The RPC response.
Overrides

RunTaskAsync(RunTaskRequest, CallSettings)

public override Task<RunTaskResponse> RunTaskAsync(RunTaskRequest request, CallSettings callSettings = null)

Run an on demand execution of a Task.

Parameters
Name Description
request RunTaskRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRunTaskResponse

A Task containing the RPC response.
Overrides

UpdateAsset(UpdateAssetRequest, CallSettings)

public override Operation<Asset, OperationMetadata> UpdateAsset(UpdateAssetRequest request, CallSettings callSettings = null)

Updates an asset resource.

Parameters
Name Description
request UpdateAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAssetOperationMetadata

The RPC response.
Overrides

UpdateAssetAsync(UpdateAssetRequest, CallSettings)

public override Task<Operation<Asset, OperationMetadata>> UpdateAssetAsync(UpdateAssetRequest request, CallSettings callSettings = null)

Updates an asset resource.

Parameters
Name Description
request UpdateAssetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAssetOperationMetadata

A Task containing the RPC response.
Overrides

UpdateEnvironment(UpdateEnvironmentRequest, CallSettings)

public override Operation<Environment, OperationMetadata> UpdateEnvironment(UpdateEnvironmentRequest request, CallSettings callSettings = null)

Update the environment resource.

Parameters
Name Description
request UpdateEnvironmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEnvironmentOperationMetadata

The RPC response.
Overrides

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallSettings)

public override Task<Operation<Environment, OperationMetadata>> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CallSettings callSettings = null)

Update the environment resource.

Parameters
Name Description
request UpdateEnvironmentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEnvironmentOperationMetadata

A Task containing the RPC response.
Overrides

UpdateLake(UpdateLakeRequest, CallSettings)

public override Operation<Lake, OperationMetadata> UpdateLake(UpdateLakeRequest request, CallSettings callSettings = null)

Updates a lake resource.

Parameters
Name Description
request UpdateLakeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationLakeOperationMetadata

The RPC response.
Overrides

UpdateLakeAsync(UpdateLakeRequest, CallSettings)

public override Task<Operation<Lake, OperationMetadata>> UpdateLakeAsync(UpdateLakeRequest request, CallSettings callSettings = null)

Updates a lake resource.

Parameters
Name Description
request UpdateLakeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationLakeOperationMetadata

A Task containing the RPC response.
Overrides

UpdateTask(UpdateTaskRequest, CallSettings)

public override Operation<Task, OperationMetadata> UpdateTask(UpdateTaskRequest request, CallSettings callSettings = null)

Update the task resource.

Parameters
Name Description
request UpdateTaskRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationTaskOperationMetadata

The RPC response.
Overrides

UpdateTaskAsync(UpdateTaskRequest, CallSettings)

public override Task<Operation<Task, OperationMetadata>> UpdateTaskAsync(UpdateTaskRequest request, CallSettings callSettings = null)

Update the task resource.

Parameters
Name Description
request UpdateTaskRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationTaskOperationMetadata

A Task containing the RPC response.
Overrides

UpdateZone(UpdateZoneRequest, CallSettings)

public override Operation<Zone, OperationMetadata> UpdateZone(UpdateZoneRequest request, CallSettings callSettings = null)

Updates a zone resource.

Parameters
Name Description
request UpdateZoneRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationZoneOperationMetadata

The RPC response.
Overrides

UpdateZoneAsync(UpdateZoneRequest, CallSettings)

public override Task<Operation<Zone, OperationMetadata>> UpdateZoneAsync(UpdateZoneRequest request, CallSettings callSettings = null)

Updates a zone resource.

Parameters
Name Description
request UpdateZoneRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationZoneOperationMetadata

A Task containing the RPC response.
Overrides