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

public class DataplexServiceClient : ClientBase<DataplexService.DataplexServiceClient>

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

Client for DataplexService

Inheritance

Object > ClientBase > ClientBase<DataplexService.DataplexServiceClient> > DataplexService.DataplexServiceClient

Inherited Members

ClientBase<DataplexService.DataplexServiceClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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

Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

DataplexServiceClient(ChannelBase)

public DataplexServiceClient(ChannelBase channel)

Creates a new client for DataplexService

Parameter

Name	Description
channel	ChannelBase The channel to use to make remote calls.

DataplexServiceClient(ClientBase.ClientBaseConfiguration)

protected DataplexServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter

Name	Description
configuration	ClientBase.ClientBaseConfiguration The client configuration.

Methods

CancelJob(CancelJobRequest, CallOptions)

public virtual Empty CancelJob(CancelJobRequest request, CallOptions options)

Cancel jobs running for the task resource.

Parameters

Name	Description
request	CancelJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
Empty	The response received from the server.

CancelJob(CancelJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Cancel jobs running for the task resource.

Parameters

Name	Description
request	CancelJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
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

Name	Description
request	CancelJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
AsyncUnaryCall<Empty>	The call object.

CancelJobAsync(CancelJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Cancel jobs running for the task resource.

Parameters

Name	Description
request	CancelJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Empty>	The call object.

CreateAsset(CreateAssetRequest, CallOptions)

public virtual Operation CreateAsset(CreateAssetRequest request, CallOptions options)

Creates an asset resource.

Parameters

Name	Description
request	CreateAssetRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
Operation	The response received from the server.

CreateAsset(CreateAssetRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates an asset resource.

Parameters

Name	Description
request	CreateAssetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
Operation	The response received from the server.

CreateAssetAsync(CreateAssetRequest, CallOptions)

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

Creates an asset resource.

Parameters

Name	Description
request	CreateAssetRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateAssetAsync(CreateAssetRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates an asset resource.

Parameters

Name	Description
request	CreateAssetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateEnvironment(CreateEnvironmentRequest, CallOptions)

public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, CallOptions options)

Create an environment resource.

Parameters

Name	Description
request	CreateEnvironmentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
Operation	The response received from the server.

CreateEnvironment(CreateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Create an environment resource.

Parameters

Name	Description
request	CreateEnvironmentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
Operation	The response received from the server.

CreateEnvironmentAsync(CreateEnvironmentRequest, CallOptions)

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

Create an environment resource.

Parameters

Name	Description
request	CreateEnvironmentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateEnvironmentAsync(CreateEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Create an environment resource.

Parameters

Name	Description
request	CreateEnvironmentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	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

Type	Description
IAMPolicy.IAMPolicyClient	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

Name	Description
request	CreateLakeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
Operation	The response received from the server.

CreateLake(CreateLakeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a lake resource.

Parameters

Name	Description
request	CreateLakeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
Operation	The response received from the server.

CreateLakeAsync(CreateLakeRequest, CallOptions)

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

Creates a lake resource.

Parameters

Name	Description
request	CreateLakeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateLakeAsync(CreateLakeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a lake resource.

Parameters

Name	Description
request	CreateLakeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	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

Type	Description
Locations.LocationsClient	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

Type	Description
Operations.OperationsClient	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

Name	Description
request	CreateTaskRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
Operation	The response received from the server.

CreateTask(CreateTaskRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a task resource within a lake.

Parameters

Name	Description
request	CreateTaskRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
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

Name	Description
request	CreateTaskRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateTaskAsync(CreateTaskRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a task resource within a lake.

Parameters

Name	Description
request	CreateTaskRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateZone(CreateZoneRequest, CallOptions)

public virtual Operation CreateZone(CreateZoneRequest request, CallOptions options)

Creates a zone resource within a lake.

Parameters

Name	Description
request	CreateZoneRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
Operation	The response received from the server.

CreateZone(CreateZoneRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a zone resource within a lake.

Parameters

Name	Description
request	CreateZoneRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
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

Name	Description
request	CreateZoneRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateZoneAsync(CreateZoneRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a zone resource within a lake.

Parameters

Name	Description
request	CreateZoneRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	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

Name	Description
request	DeleteAssetRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
Operation	The response received from the server.

DeleteAsset(DeleteAssetRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
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

Name	Description
request	DeleteAssetRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

DeleteAssetAsync(DeleteAssetRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	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

Name	Description
request	DeleteEnvironmentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
Operation	The response received from the server.

DeleteEnvironment(DeleteEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
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

Name	Description
request	DeleteEnvironmentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

DeleteEnvironmentAsync(DeleteEnvironmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	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

Name	Description
request	DeleteLakeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns

Type	Description
Operation	The response received from the server.

DeleteLake(DeleteLakeRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns

Type	Description
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

Name	Description
request