Cloud Dataplex v1 API - Class DataProductService.DataProductServiceClient (3.13.0)

3.13.0 (latest) 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.0.0

public class DataProductService.DataProductServiceClient : ClientBase<DataProductService.DataProductServiceClient>

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

Client for DataProductService

Inheritance

object > ClientBase > ClientBaseDataProductServiceDataProductServiceClient > DataProductService.DataProductServiceClient

Inherited Members

ClientBase<DataProductService.DataProductServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataProductServiceClient()

protected DataProductServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DataProductServiceClient(CallInvoker)

public DataProductServiceClient(CallInvoker callInvoker)

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

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

DataProductServiceClient(ChannelBase)

public DataProductServiceClient(ChannelBase channel)

Creates a new client for DataProductService

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

DataProductServiceClient(ClientBaseConfiguration)

protected DataProductServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateDataAsset(CreateDataAssetRequest, CallOptions)

public virtual Operation CreateDataAsset(CreateDataAssetRequest request, CallOptions options)

Creates a data asset.

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

Returns
Type	Description
Operation	The response received from the server.

CreateDataAsset(CreateDataAssetRequest, Metadata, DateTime?, CancellationToken)

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

Creates a data asset.

Parameters
Name	Description
request	CreateDataAssetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.

CreateDataAssetAsync(CreateDataAssetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateDataAssetAsync(CreateDataAssetRequest request, CallOptions options)

Creates a data asset.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateDataAssetAsync(CreateDataAssetRequest, Metadata, DateTime?, CancellationToken)

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

Creates a data asset.

Parameters
Name	Description
request	CreateDataAssetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallOperation	The call object.

CreateDataProduct(CreateDataProductRequest, CallOptions)

public virtual Operation CreateDataProduct(CreateDataProductRequest request, CallOptions options)

Creates a data product.

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

Returns
Type	Description
Operation	The response received from the server.

CreateDataProduct(CreateDataProductRequest, Metadata, DateTime?, CancellationToken)

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

Creates a data product.

Parameters
Name	Description
request	CreateDataProductRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.

CreateDataProductAsync(CreateDataProductRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateDataProductAsync(CreateDataProductRequest request, CallOptions options)

Creates a data product.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateDataProductAsync(CreateDataProductRequest, Metadata, DateTime?, CancellationToken)

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

Creates a data product.

Parameters
Name	Description
request	CreateDataProductRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
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
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

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

Returns
Type	Description
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
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteDataAsset(DeleteDataAssetRequest, CallOptions)

public virtual Operation DeleteDataAsset(DeleteDataAssetRequest request, CallOptions options)

Deletes a data asset.

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

Returns
Type	Description
Operation	The response received from the server.

DeleteDataAsset(DeleteDataAssetRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a data asset.

Parameters
Name	Description
request	DeleteDataAssetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.

DeleteDataAssetAsync(DeleteDataAssetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteDataAssetAsync(DeleteDataAssetRequest request, CallOptions options)

Deletes a data asset.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteDataAssetAsync(DeleteDataAssetRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a data asset.

Parameters
Name	Description
request	DeleteDataAssetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallOperation	The call object.

DeleteDataProduct(DeleteDataProductRequest, CallOptions)

public virtual Operation DeleteDataProduct(DeleteDataProductRequest request, CallOptions options)

Deletes a data product. The deletion will fail if the data product is not empty (i.e. contains at least one data asset).

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

Returns
Type	Description
Operation	The response received from the server.

DeleteDataProduct(DeleteDataProductRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a data product. The deletion will fail if the data product is not empty (i.e. contains at least one data asset).

Parameters
Name	Description
request	DeleteDataProductRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.

DeleteDataProductAsync(DeleteDataProductRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteDataProductAsync(DeleteDataProductRequest request, CallOptions options)

Deletes a data product. The deletion will fail if the data product is not empty (i.e. contains at least one data asset).

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteDataProductAsync(DeleteDataProductRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a data product. The deletion will fail if the data product is not empty (i.e. contains at least one data asset).

Parameters
Name	Description
request	DeleteDataProductRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallOperation	The call object.

GetDataAsset(GetDataAssetRequest, CallOptions)

public virtual DataAsset GetDataAsset(GetDataAssetRequest request, CallOptions options)

Gets a data asset.

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

Returns
Type	Description
DataAsset	The response received from the server.

GetDataAsset(GetDataAssetRequest, Metadata, DateTime?, CancellationToken)

public virtual DataAsset GetDataAsset(GetDataAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a data asset.

Parameters
Name	Description
request	GetDataAssetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
DataAsset	The response received from the server.

GetDataAssetAsync(GetDataAssetRequest, CallOptions)

public virtual AsyncUnaryCall<DataAsset> GetDataAssetAsync(GetDataAssetRequest request, CallOptions options)

Gets a data asset.

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

Returns
Type	Description
AsyncUnaryCallDataAsset	The call object.

GetDataAssetAsync(GetDataAssetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataAsset> GetDataAssetAsync(GetDataAssetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a data asset.

Parameters
Name	Description
request	GetDataAssetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallDataAsset	The call object.

GetDataProduct(GetDataProductRequest, CallOptions)

public virtual DataProduct GetDataProduct(GetDataProductRequest request, CallOptions options)

Gets a data product.

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

Returns
Type	Description
DataProduct	The response received from the server.

GetDataProduct(GetDataProductRequest, Metadata, DateTime?, CancellationToken)

public virtual DataProduct GetDataProduct(GetDataProductRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a data product.

Parameters
Name	Description
request	GetDataProductRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
DataProduct	The response received from the server.

GetDataProductAsync(GetDataProductRequest, CallOptions)

public virtual AsyncUnaryCall<DataProduct> GetDataProductAsync(GetDataProductRequest request, CallOptions options)

Gets a data product.

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

Returns
Type	Description
AsyncUnaryCallDataProduct	The call object.

GetDataProductAsync(GetDataProductRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataProduct> GetDataProductAsync(GetDataProductRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a data product.

Parameters
Name	Description
request	GetDataProductRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallDataProduct	The call object.

ListDataAssets(ListDataAssetsRequest, CallOptions)

public virtual ListDataAssetsResponse ListDataAssets(ListDataAssetsRequest request, CallOptions options)

Lists data assets for a given data product.

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

Returns
Type	Description
ListDataAssetsResponse	The response received from the server.

ListDataAssets(ListDataAssetsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDataAssetsResponse ListDataAssets(ListDataAssetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists data assets for a given data product.

Parameters
Name	Description
request	ListDataAssetsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
ListDataAssetsResponse	The response received from the server.

ListDataAssetsAsync(ListDataAssetsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDataAssetsResponse> ListDataAssetsAsync(ListDataAssetsRequest request, CallOptions options)

Lists data assets for a given data product.

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

Returns
Type	Description
AsyncUnaryCallListDataAssetsResponse	The call object.

ListDataAssetsAsync(ListDataAssetsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDataAssetsResponse> ListDataAssetsAsync(ListDataAssetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists data assets for a given data product.

Parameters
Name	Description
request	ListDataAssetsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallListDataAssetsResponse	The call object.

ListDataProducts(ListDataProductsRequest, CallOptions)

public virtual ListDataProductsResponse ListDataProducts(ListDataProductsRequest request, CallOptions options)

Lists data products for a given project.

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

Returns
Type	Description
ListDataProductsResponse	The response received from the server.

ListDataProducts(ListDataProductsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDataProductsResponse ListDataProducts(ListDataProductsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists data products for a given project.

Parameters
Name	Description
request	ListDataProductsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
ListDataProductsResponse	The response received from the server.

ListDataProductsAsync(ListDataProductsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDataProductsResponse> ListDataProductsAsync(ListDataProductsRequest request, CallOptions options)

Lists data products for a given project.

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

Returns
Type	Description
AsyncUnaryCallListDataProductsResponse	The call object.

ListDataProductsAsync(ListDataProductsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDataProductsResponse> ListDataProductsAsync(ListDataProductsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists data products for a given project.

Parameters
Name	Description
request	ListDataProductsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallListDataProductsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override DataProductService.DataProductServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
DataProductServiceDataProductServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Dataplex.V1.DataProductService.DataProductServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateDataAsset(UpdateDataAssetRequest, CallOptions)

public virtual Operation UpdateDataAsset(UpdateDataAssetRequest request, CallOptions options)

Updates a data asset.

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

Returns
Type	Description
Operation	The response received from the server.

UpdateDataAsset(UpdateDataAssetRequest, Metadata, DateTime?, CancellationToken)

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

Updates a data asset.

Parameters
Name	Description
request	UpdateDataAssetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.

UpdateDataAssetAsync(UpdateDataAssetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateDataAssetAsync(UpdateDataAssetRequest request, CallOptions options)

Updates a data asset.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateDataAssetAsync(UpdateDataAssetRequest, Metadata, DateTime?, CancellationToken)

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

Updates a data asset.

Parameters
Name	Description
request	UpdateDataAssetRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallOperation	The call object.

UpdateDataProduct(UpdateDataProductRequest, CallOptions)

public virtual Operation UpdateDataProduct(UpdateDataProductRequest request, CallOptions options)

Updates a data product.

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

Returns
Type	Description
Operation	The response received from the server.

UpdateDataProduct(UpdateDataProductRequest, Metadata, DateTime?, CancellationToken)

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

Updates a data product.

Parameters
Name	Description
request	UpdateDataProductRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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.

UpdateDataProductAsync(UpdateDataProductRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateDataProductAsync(UpdateDataProductRequest request, CallOptions options)

Updates a data product.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateDataProductAsync(UpdateDataProductRequest, Metadata, DateTime?, CancellationToken)

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

Updates a data product.

Parameters
Name	Description
request	UpdateDataProductRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.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
AsyncUnaryCallOperation	The call object.