Cloud Dataplex v1 API - Class DataplexService.DataplexServiceClient (2.8.0)

public class DataplexService.DataplexServiceClient : ClientBase<DataplexService.DataplexServiceClient>

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

Client for DataplexService

Inheritance

object > ClientBase > ClientBaseDataplexServiceDataplexServiceClient > DataplexService.DataplexServiceClient

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataplexServiceClient()

protected DataplexServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DataplexServiceClient(CallInvoker)

public DataplexServiceClient(CallInvoker callInvoker)

Creates a new client for DataplexService that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

DataplexServiceClient(ChannelBase)

public DataplexServiceClient(ChannelBase channel)

Creates a new client for DataplexService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

DataplexServiceClient(ClientBaseConfiguration)

protected DataplexServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CancelJob(CancelJobRequest, CallOptions)

public virtual Empty CancelJob(CancelJobRequest request, CallOptions options)

Cancel jobs running for the task resource.

Parameters
NameDescription
requestCancelJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

CancelJob(CancelJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty CancelJob(CancelJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancel jobs running for the task resource.

Parameters
NameDescription
requestCancelJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

CancelJobAsync(CancelJobRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> CancelJobAsync(CancelJobRequest request, CallOptions options)

Cancel jobs running for the task resource.

Parameters
NameDescription
requestCancelJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

CancelJobAsync(CancelJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> CancelJobAsync(CancelJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancel jobs running for the task resource.

Parameters
NameDescription
requestCancelJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

CreateAsset(CreateAssetRequest, CallOptions)

public virtual Operation CreateAsset(CreateAssetRequest request, CallOptions options)

Creates an asset resource.

Parameters
NameDescription
requestCreateAssetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateAsset(CreateAssetRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateAsset(CreateAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an asset resource.

Parameters
NameDescription
requestCreateAssetRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateAssetAsync(CreateAssetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateAssetAsync(CreateAssetRequest request, CallOptions options)

Creates an asset resource.

Parameters
NameDescription
requestCreateAssetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateAssetAsync(CreateAssetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateAssetAsync(CreateAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an asset resource.

Parameters
NameDescription
requestCreateAssetRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateEnvironment(CreateEnvironmentRequest, CallOptions)

public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, CallOptions options)

Create an environment resource.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateEnvironment(CreateEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create an environment resource.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateEnvironmentAsync(CreateEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallOptions options)

Create an environment resource.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateEnvironmentAsync(CreateEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create an environment resource.

Parameters
NameDescription
requestCreateEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
TypeDescription
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLake(CreateLakeRequest, CallOptions)

public virtual Operation CreateLake(CreateLakeRequest request, CallOptions options)

Creates a lake resource.

Parameters
NameDescription
requestCreateLakeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateLake(CreateLakeRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateLake(CreateLakeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a lake resource.

Parameters
NameDescription
requestCreateLakeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateLakeAsync(CreateLakeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateLakeAsync(CreateLakeRequest request, CallOptions options)

Creates a lake resource.

Parameters
NameDescription
requestCreateLakeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateLakeAsync(CreateLakeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateLakeAsync(CreateLakeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a lake resource.

Parameters
NameDescription
requestCreateLakeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
TypeDescription
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateTask(CreateTaskRequest, CallOptions)

public virtual Operation CreateTask(CreateTaskRequest request, CallOptions options)

Creates a task resource within a lake.

Parameters
NameDescription
requestCreateTaskRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateTask(CreateTaskRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateTask(CreateTaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a task resource within a lake.

Parameters
NameDescription
requestCreateTaskRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateTaskAsync(CreateTaskRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateTaskAsync(CreateTaskRequest request, CallOptions options)

Creates a task resource within a lake.

Parameters
NameDescription
requestCreateTaskRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateTaskAsync(CreateTaskRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateTaskAsync(CreateTaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a task resource within a lake.

Parameters
NameDescription
requestCreateTaskRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateZone(CreateZoneRequest, CallOptions)

public virtual Operation CreateZone(CreateZoneRequest request, CallOptions options)

Creates a zone resource within a lake.

Parameters
NameDescription
requestCreateZoneRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateZone(CreateZoneRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateZone(CreateZoneRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a zone resource within a lake.

Parameters
NameDescription
requestCreateZoneRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateZoneAsync(CreateZoneRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateZoneAsync(CreateZoneRequest request, CallOptions options)

Creates a zone resource within a lake.

Parameters
NameDescription
requestCreateZoneRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateZoneAsync(CreateZoneRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateZoneAsync(CreateZoneRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a zone resource within a lake.

Parameters
NameDescription
requestCreateZoneRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteAsset(DeleteAssetRequest, CallOptions)

public virtual Operation DeleteAsset(DeleteAssetRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteAssetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAsset(DeleteAssetRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteAsset(DeleteAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeleteAssetRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteAssetAsync(DeleteAssetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAssetAsync(DeleteAssetRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteAssetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteAssetAsync(DeleteAssetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteAssetAsync(DeleteAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeleteAssetRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteEnvironment(DeleteEnvironmentRequest, CallOptions)

public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteEnvironment(DeleteEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeleteEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteLake(DeleteLakeRequest, CallOptions)

public virtual Operation DeleteLake(DeleteLakeRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteLakeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteLake(DeleteLakeRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteLake(DeleteLakeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeleteLakeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteLakeAsync(DeleteLakeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteLakeAsync(DeleteLakeRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteLakeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteLakeAsync(DeleteLakeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteLakeAsync(DeleteLakeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeleteLakeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteTask(DeleteTaskRequest, CallOptions)

public virtual Operation DeleteTask(DeleteTaskRequest request, CallOptions options)

Delete the task resource.

Parameters
NameDescription
requestDeleteTaskRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteTask(DeleteTaskRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteTask(DeleteTaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete the task resource.

Parameters
NameDescription
requestDeleteTaskRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteTaskAsync(DeleteTaskRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteTaskAsync(DeleteTaskRequest request, CallOptions options)

Delete the task resource.

Parameters
NameDescription
requestDeleteTaskRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteTaskAsync(DeleteTaskRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteTaskAsync(DeleteTaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete the task resource.

Parameters
NameDescription
requestDeleteTaskRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteZone(DeleteZoneRequest, CallOptions)

public virtual Operation DeleteZone(DeleteZoneRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteZoneRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteZone(DeleteZoneRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteZone(DeleteZoneRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeleteZoneRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteZoneAsync(DeleteZoneRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteZoneAsync(DeleteZoneRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteZoneRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteZoneAsync(DeleteZoneRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteZoneAsync(DeleteZoneRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeleteZoneRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

GetAsset(GetAssetRequest, CallOptions)

public virtual Asset GetAsset(GetAssetRequest request, CallOptions options)

Retrieves an asset resource.

Parameters
NameDescription
requestGetAssetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Asset

The response received from the server.

GetAsset(GetAssetRequest, Metadata, DateTime?, CancellationToken)

public virtual Asset GetAsset(GetAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves an asset resource.

Parameters
NameDescription
requestGetAssetRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Asset

The response received from the server.

GetAssetAsync(GetAssetRequest, CallOptions)

public virtual AsyncUnaryCall<Asset> GetAssetAsync(GetAssetRequest request, CallOptions options)

Retrieves an asset resource.

Parameters
NameDescription
requestGetAssetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallAsset

The call object.

GetAssetAsync(GetAssetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Asset> GetAssetAsync(GetAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves an asset resource.

Parameters
NameDescription
requestGetAssetRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallAsset

The call object.

GetEnvironment(GetEnvironmentRequest, CallOptions)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, CallOptions options)

Get environment resource.

Parameters
NameDescription
requestGetEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Environment

The response received from the server.

GetEnvironment(GetEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Environment GetEnvironment(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get environment resource.

Parameters
NameDescription
requestGetEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Environment

The response received from the server.

GetEnvironmentAsync(GetEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallOptions options)

Get environment resource.

Parameters
NameDescription
requestGetEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEnvironment

The call object.

GetEnvironmentAsync(GetEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get environment resource.

Parameters
NameDescription
requestGetEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEnvironment

The call object.

GetJob(GetJobRequest, CallOptions)

public virtual Job GetJob(GetJobRequest request, CallOptions options)

Get job resource.

Parameters
NameDescription
requestGetJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Job

The response received from the server.

GetJob(GetJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Job GetJob(GetJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get job resource.

Parameters
NameDescription
requestGetJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Job

The response received from the server.

GetJobAsync(GetJobRequest, CallOptions)

public virtual AsyncUnaryCall<Job> GetJobAsync(GetJobRequest request, CallOptions options)

Get job resource.

Parameters
NameDescription
requestGetJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallJob

The call object.

GetJobAsync(GetJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Job> GetJobAsync(GetJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get job resource.

Parameters
NameDescription
requestGetJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallJob

The call object.

GetLake(GetLakeRequest, CallOptions)

public virtual Lake GetLake(GetLakeRequest request, CallOptions options)

Retrieves a lake resource.

Parameters
NameDescription
requestGetLakeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Lake

The response received from the server.

GetLake(GetLakeRequest, Metadata, DateTime?, CancellationToken)

public virtual Lake GetLake(GetLakeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a lake resource.

Parameters
NameDescription
requestGetLakeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Lake

The response received from the server.

GetLakeAsync(GetLakeRequest, CallOptions)

public virtual AsyncUnaryCall<Lake> GetLakeAsync(GetLakeRequest request, CallOptions options)

Retrieves a lake resource.

Parameters
NameDescription
requestGetLakeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallLake

The call object.

GetLakeAsync(GetLakeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Lake> GetLakeAsync(GetLakeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a lake resource.

Parameters
NameDescription
requestGetLakeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallLake

The call object.

GetTask(GetTaskRequest, CallOptions)

public virtual Task GetTask(GetTaskRequest request, CallOptions options)

Get task resource.

Parameters
NameDescription
requestGetTaskRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Task

The response received from the server.

GetTask(GetTaskRequest, Metadata, DateTime?, CancellationToken)

public virtual Task GetTask(GetTaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get task resource.

Parameters
NameDescription
requestGetTaskRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Task

The response received from the server.

GetTaskAsync(GetTaskRequest, CallOptions)

public virtual AsyncUnaryCall<Task> GetTaskAsync(GetTaskRequest request, CallOptions options)

Get task resource.

Parameters
NameDescription
requestGetTaskRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTask

The call object.

GetTaskAsync(GetTaskRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Task> GetTaskAsync(GetTaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get task resource.

Parameters
NameDescription
requestGetTaskRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTask

The call object.

GetZone(GetZoneRequest, CallOptions)

public virtual Zone GetZone(GetZoneRequest request, CallOptions options)

Retrieves a zone resource.

Parameters
NameDescription
requestGetZoneRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Zone

The response received from the server.

GetZone(GetZoneRequest, Metadata, DateTime?, CancellationToken)

public virtual Zone GetZone(GetZoneRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a zone resource.

Parameters
NameDescription
requestGetZoneRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Zone

The response received from the server.

GetZoneAsync(GetZoneRequest, CallOptions)

public virtual AsyncUnaryCall<Zone> GetZoneAsync(GetZoneRequest request, CallOptions options)

Retrieves a zone resource.

Parameters
NameDescription
requestGetZoneRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallZone

The call object.

GetZoneAsync(GetZoneRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Zone> GetZoneAsync(GetZoneRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a zone resource.

Parameters
NameDescription
requestGetZoneRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallZone

The call object.

ListAssetActions(ListAssetActionsRequest, CallOptions)

public virtual ListActionsResponse ListAssetActions(ListAssetActionsRequest request, CallOptions options)

Lists action resources in an asset.

Parameters
NameDescription
requestListAssetActionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListActionsResponse

The response received from the server.

ListAssetActions(ListAssetActionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListActionsResponse ListAssetActions(ListAssetActionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists action resources in an asset.

Parameters
NameDescription
requestListAssetActionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListActionsResponse

The response received from the server.

ListAssetActionsAsync(ListAssetActionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListActionsResponse> ListAssetActionsAsync(ListAssetActionsRequest request, CallOptions options)

Lists action resources in an asset.

Parameters
NameDescription
requestListAssetActionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListActionsResponse

The call object.

ListAssetActionsAsync(ListAssetActionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListActionsResponse> ListAssetActionsAsync(ListAssetActionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists action resources in an asset.

Parameters
NameDescription
requestListAssetActionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListActionsResponse

The call object.

ListAssets(ListAssetsRequest, CallOptions)

public virtual ListAssetsResponse ListAssets(ListAssetsRequest request, CallOptions options)

Lists asset resources in a zone.

Parameters
NameDescription
requestListAssetsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListAssetsResponse

The response received from the server.

ListAssets(ListAssetsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListAssetsResponse ListAssets(ListAssetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists asset resources in a zone.

Parameters
NameDescription
requestListAssetsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListAssetsResponse

The response received from the server.

ListAssetsAsync(ListAssetsRequest, CallOptions)

public virtual AsyncUnaryCall<ListAssetsResponse> ListAssetsAsync(ListAssetsRequest request, CallOptions options)

Lists asset resources in a zone.

Parameters
NameDescription
requestListAssetsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListAssetsResponse

The call object.

ListAssetsAsync(ListAssetsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListAssetsResponse> ListAssetsAsync(ListAssetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists asset resources in a zone.

Parameters
NameDescription
requestListAssetsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListAssetsResponse

The call object.

ListEnvironments(ListEnvironmentsRequest, CallOptions)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, CallOptions options)

Lists environments under the given lake.

Parameters
NameDescription
requestListEnvironmentsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListEnvironmentsResponse

The response received from the server.

ListEnvironments(ListEnvironmentsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists environments under the given lake.

Parameters
NameDescription
requestListEnvironmentsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListEnvironmentsResponse

The response received from the server.

ListEnvironmentsAsync(ListEnvironmentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallOptions options)

Lists environments under the given lake.

Parameters
NameDescription
requestListEnvironmentsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListEnvironmentsResponse

The call object.

ListEnvironmentsAsync(ListEnvironmentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists environments under the given lake.

Parameters
NameDescription
requestListEnvironmentsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListEnvironmentsResponse

The call object.

ListJobs(ListJobsRequest, CallOptions)

public virtual ListJobsResponse ListJobs(ListJobsRequest request, CallOptions options)

Lists Jobs under the given task.

Parameters
NameDescription
requestListJobsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListJobsResponse

The response received from the server.

ListJobs(ListJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListJobsResponse ListJobs(ListJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Jobs under the given task.

Parameters
NameDescription
requestListJobsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListJobsResponse

The response received from the server.

ListJobsAsync(ListJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListJobsResponse> ListJobsAsync(ListJobsRequest request, CallOptions options)

Lists Jobs under the given task.

Parameters
NameDescription
requestListJobsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListJobsResponse

The call object.

ListJobsAsync(ListJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListJobsResponse> ListJobsAsync(ListJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Jobs under the given task.

Parameters
NameDescription
requestListJobsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListJobsResponse

The call object.

ListLakeActions(ListLakeActionsRequest, CallOptions)

public virtual ListActionsResponse ListLakeActions(ListLakeActionsRequest request, CallOptions options)

Lists action resources in a lake.

Parameters
NameDescription
requestListLakeActionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListActionsResponse

The response received from the server.

ListLakeActions(ListLakeActionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListActionsResponse ListLakeActions(ListLakeActionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists action resources in a lake.

Parameters
NameDescription
requestListLakeActionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListActionsResponse

The response received from the server.

ListLakeActionsAsync(ListLakeActionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListActionsResponse> ListLakeActionsAsync(ListLakeActionsRequest request, CallOptions options)

Lists action resources in a lake.

Parameters
NameDescription
requestListLakeActionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListActionsResponse

The call object.

ListLakeActionsAsync(ListLakeActionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListActionsResponse> ListLakeActionsAsync(ListLakeActionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists action resources in a lake.

Parameters
NameDescription
requestListLakeActionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListActionsResponse

The call object.

ListLakes(ListLakesRequest, CallOptions)

public virtual ListLakesResponse ListLakes(ListLakesRequest request, CallOptions options)

Lists lake resources in a project and location.

Parameters
NameDescription
requestListLakesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListLakesResponse

The response received from the server.

ListLakes(ListLakesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListLakesResponse ListLakes(ListLakesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists lake resources in a project and location.

Parameters
NameDescription
requestListLakesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListLakesResponse

The response received from the server.

ListLakesAsync(ListLakesRequest, CallOptions)

public virtual AsyncUnaryCall<ListLakesResponse> ListLakesAsync(ListLakesRequest request, CallOptions options)

Lists lake resources in a project and location.

Parameters
NameDescription
requestListLakesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListLakesResponse

The call object.

ListLakesAsync(ListLakesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListLakesResponse> ListLakesAsync(ListLakesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists lake resources in a project and location.

Parameters
NameDescription
requestListLakesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListLakesResponse

The call object.

ListSessions(ListSessionsRequest, CallOptions)

public virtual ListSessionsResponse ListSessions(ListSessionsRequest request, CallOptions options)

Lists session resources in an environment.

Parameters
NameDescription
requestListSessionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListSessionsResponse

The response received from the server.

ListSessions(ListSessionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSessionsResponse ListSessions(ListSessionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists session resources in an environment.

Parameters
NameDescription
requestListSessionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListSessionsResponse

The response received from the server.

ListSessionsAsync(ListSessionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListSessionsResponse> ListSessionsAsync(ListSessionsRequest request, CallOptions options)

Lists session resources in an environment.

Parameters
NameDescription
requestListSessionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListSessionsResponse

The call object.

ListSessionsAsync(ListSessionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSessionsResponse> ListSessionsAsync(ListSessionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists session resources in an environment.

Parameters
NameDescription
requestListSessionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListSessionsResponse

The call object.

ListTasks(ListTasksRequest, CallOptions)

public virtual ListTasksResponse ListTasks(ListTasksRequest request, CallOptions options)

Lists tasks under the given lake.

Parameters
NameDescription
requestListTasksRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListTasksResponse

The response received from the server.

ListTasks(ListTasksRequest, Metadata, DateTime?, CancellationToken)

public virtual ListTasksResponse ListTasks(ListTasksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists tasks under the given lake.

Parameters
NameDescription
requestListTasksRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListTasksResponse

The response received from the server.

ListTasksAsync(ListTasksRequest, CallOptions)

public virtual AsyncUnaryCall<ListTasksResponse> ListTasksAsync(ListTasksRequest request, CallOptions options)

Lists tasks under the given lake.

Parameters
NameDescription
requestListTasksRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListTasksResponse

The call object.

ListTasksAsync(ListTasksRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListTasksResponse> ListTasksAsync(ListTasksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists tasks under the given lake.

Parameters
NameDescription
requestListTasksRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListTasksResponse

The call object.

ListZoneActions(ListZoneActionsRequest, CallOptions)

public virtual ListActionsResponse ListZoneActions(ListZoneActionsRequest request, CallOptions options)

Lists action resources in a zone.

Parameters
NameDescription
requestListZoneActionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListActionsResponse

The response received from the server.

ListZoneActions(ListZoneActionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListActionsResponse ListZoneActions(ListZoneActionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists action resources in a zone.

Parameters
NameDescription
requestListZoneActionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListActionsResponse

The response received from the server.

ListZoneActionsAsync(ListZoneActionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListActionsResponse> ListZoneActionsAsync(ListZoneActionsRequest request, CallOptions options)

Lists action resources in a zone.

Parameters
NameDescription
requestListZoneActionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListActionsResponse

The call object.

ListZoneActionsAsync(ListZoneActionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListActionsResponse> ListZoneActionsAsync(ListZoneActionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists action resources in a zone.

Parameters
NameDescription
requestListZoneActionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListActionsResponse

The call object.

ListZones(ListZonesRequest, CallOptions)

public virtual ListZonesResponse ListZones(ListZonesRequest request, CallOptions options)

Lists zone resources in a lake.

Parameters
NameDescription
requestListZonesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListZonesResponse

The response received from the server.

ListZones(ListZonesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListZonesResponse ListZones(ListZonesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists zone resources in a lake.

Parameters
NameDescription
requestListZonesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListZonesResponse

The response received from the server.

ListZonesAsync(ListZonesRequest, CallOptions)

public virtual AsyncUnaryCall<ListZonesResponse> ListZonesAsync(ListZonesRequest request, CallOptions options)

Lists zone resources in a lake.

Parameters
NameDescription
requestListZonesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListZonesResponse

The call object.

ListZonesAsync(ListZonesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListZonesResponse> ListZonesAsync(ListZonesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists zone resources in a lake.

Parameters
NameDescription
requestListZonesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListZonesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override DataplexService.DataplexServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
DataplexServiceDataplexServiceClient
Overrides

RunTask(RunTaskRequest, CallOptions)

public virtual RunTaskResponse RunTask(RunTaskRequest request, CallOptions options)

Run an on demand execution of a Task.

Parameters
NameDescription
requestRunTaskRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
RunTaskResponse

The response received from the server.

RunTask(RunTaskRequest, Metadata, DateTime?, CancellationToken)

public virtual RunTaskResponse RunTask(RunTaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Run an on demand execution of a Task.

Parameters
NameDescription
requestRunTaskRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
RunTaskResponse

The response received from the server.

RunTaskAsync(RunTaskRequest, CallOptions)

public virtual AsyncUnaryCall<RunTaskResponse> RunTaskAsync(RunTaskRequest request, CallOptions options)

Run an on demand execution of a Task.

Parameters
NameDescription
requestRunTaskRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallRunTaskResponse

The call object.

RunTaskAsync(RunTaskRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RunTaskResponse> RunTaskAsync(RunTaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Run an on demand execution of a Task.

Parameters
NameDescription
requestRunTaskRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallRunTaskResponse

The call object.

UpdateAsset(UpdateAssetRequest, CallOptions)

public virtual Operation UpdateAsset(UpdateAssetRequest request, CallOptions options)

Updates an asset resource.

Parameters
NameDescription
requestUpdateAssetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateAsset(UpdateAssetRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateAsset(UpdateAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an asset resource.

Parameters
NameDescription
requestUpdateAssetRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateAssetAsync(UpdateAssetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAssetAsync(UpdateAssetRequest request, CallOptions options)

Updates an asset resource.

Parameters
NameDescription
requestUpdateAssetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateAssetAsync(UpdateAssetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateAssetAsync(UpdateAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an asset resource.

Parameters
NameDescription
requestUpdateAssetRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateEnvironment(UpdateEnvironmentRequest, CallOptions)

public virtual Operation UpdateEnvironment(UpdateEnvironmentRequest request, CallOptions options)

Update the environment resource.

Parameters
NameDescription
requestUpdateEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateEnvironment(UpdateEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateEnvironment(UpdateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update the environment resource.

Parameters
NameDescription
requestUpdateEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CallOptions options)

Update the environment resource.

Parameters
NameDescription
requestUpdateEnvironmentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateEnvironmentAsync(UpdateEnvironmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update the environment resource.

Parameters
NameDescription
requestUpdateEnvironmentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateLake(UpdateLakeRequest, CallOptions)

public virtual Operation UpdateLake(UpdateLakeRequest request, CallOptions options)

Updates a lake resource.

Parameters
NameDescription
requestUpdateLakeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateLake(UpdateLakeRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateLake(UpdateLakeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a lake resource.

Parameters
NameDescription
requestUpdateLakeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateLakeAsync(UpdateLakeRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateLakeAsync(UpdateLakeRequest request, CallOptions options)

Updates a lake resource.

Parameters
NameDescription
requestUpdateLakeRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateLakeAsync(UpdateLakeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateLakeAsync(UpdateLakeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a lake resource.

Parameters
NameDescription
requestUpdateLakeRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateTask(UpdateTaskRequest, CallOptions)

public virtual Operation UpdateTask(UpdateTaskRequest request, CallOptions options)

Update the task resource.

Parameters
NameDescription
requestUpdateTaskRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateTask(UpdateTaskRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateTask(UpdateTaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update the task resource.

Parameters
NameDescription
requestUpdateTaskRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateTaskAsync(UpdateTaskRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateTaskAsync(UpdateTaskRequest request, CallOptions options)

Update the task resource.

Parameters
NameDescription
requestUpdateTaskRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateTaskAsync(UpdateTaskRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateTaskAsync(UpdateTaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update the task resource.

Parameters
NameDescription
requestUpdateTaskRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateZone(UpdateZoneRequest, CallOptions)

public virtual Operation UpdateZone(UpdateZoneRequest request, CallOptions options)

Updates a zone resource.

Parameters
NameDescription
requestUpdateZoneRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateZone(UpdateZoneRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateZone(UpdateZoneRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a zone resource.

Parameters
NameDescription
requestUpdateZoneRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateZoneAsync(UpdateZoneRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateZoneAsync(UpdateZoneRequest request, CallOptions options)

Updates a zone resource.

Parameters
NameDescription
requestUpdateZoneRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateZoneAsync(UpdateZoneRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateZoneAsync(UpdateZoneRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a zone resource.

Parameters
NameDescription
requestUpdateZoneRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.