Vertex AI v1 API - Class DatasetServiceClientImpl (3.50.0) 

public sealed class DatasetServiceClientImpl : DatasetServiceClient

Reference documentation and code samples for the Vertex AI v1 API class DatasetServiceClientImpl.

DatasetService client wrapper implementation, for convenient use.

Inheritance

object > DatasetServiceClient > DatasetServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

The service that manages Vertex AI Dataset and its child resources.

Constructors

DatasetServiceClientImpl(DatasetServiceClient, DatasetServiceSettings, ILogger)

public DatasetServiceClientImpl(DatasetService.DatasetServiceClient grpcClient, DatasetServiceSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient DatasetServiceDatasetServiceClient

The underlying gRPC client.
settings DatasetServiceSettings

The base DatasetServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateDatasetOperationsClient

public override OperationsClient CreateDatasetOperationsClient { get; }

The long-running operations client for CreateDataset.

Property Value
Type Description
OperationsClient
Overrides

CreateDatasetVersionOperationsClient

public override OperationsClient CreateDatasetVersionOperationsClient { get; }

The long-running operations client for CreateDatasetVersion.

Property Value
Type Description
OperationsClient
Overrides

DeleteDatasetOperationsClient

public override OperationsClient DeleteDatasetOperationsClient { get; }

The long-running operations client for DeleteDataset.

Property Value
Type Description
OperationsClient
Overrides

DeleteDatasetVersionOperationsClient

public override OperationsClient DeleteDatasetVersionOperationsClient { get; }

The long-running operations client for DeleteDatasetVersion.

Property Value
Type Description
OperationsClient
Overrides

DeleteSavedQueryOperationsClient

public override OperationsClient DeleteSavedQueryOperationsClient { get; }

The long-running operations client for DeleteSavedQuery.

Property Value
Type Description
OperationsClient
Overrides

ExportDataOperationsClient

public override OperationsClient ExportDataOperationsClient { get; }

The long-running operations client for ExportData.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override DatasetService.DatasetServiceClient GrpcClient { get; }

The underlying gRPC DatasetService client

Property Value
Type Description
DatasetServiceDatasetServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

ImportDataOperationsClient

public override OperationsClient ImportDataOperationsClient { get; }

The long-running operations client for ImportData.

Property Value
Type Description
OperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

RestoreDatasetVersionOperationsClient

public override OperationsClient RestoreDatasetVersionOperationsClient { get; }

The long-running operations client for RestoreDatasetVersion.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateDataset(CreateDatasetRequest, CallSettings)

public override Operation<Dataset, CreateDatasetOperationMetadata> CreateDataset(CreateDatasetRequest request, CallSettings callSettings = null)

Creates a Dataset.

Parameters
Name Description
request CreateDatasetRequest

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

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

The RPC response.
Overrides

CreateDatasetAsync(CreateDatasetRequest, CallSettings)

public override Task<Operation<Dataset, CreateDatasetOperationMetadata>> CreateDatasetAsync(CreateDatasetRequest request, CallSettings callSettings = null)

Creates a Dataset.

Parameters
Name Description
request CreateDatasetRequest

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

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

A Task containing the RPC response.
Overrides

CreateDatasetVersion(CreateDatasetVersionRequest, CallSettings)

public override Operation<DatasetVersion, CreateDatasetVersionOperationMetadata> CreateDatasetVersion(CreateDatasetVersionRequest request, CallSettings callSettings = null)

Create a version from a Dataset.

Parameters
Name Description
request CreateDatasetVersionRequest

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

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

The RPC response.
Overrides

CreateDatasetVersionAsync(CreateDatasetVersionRequest, CallSettings)

public override Task<Operation<DatasetVersion, CreateDatasetVersionOperationMetadata>> CreateDatasetVersionAsync(CreateDatasetVersionRequest request, CallSettings callSettings = null)

Create a version from a Dataset.

Parameters
Name Description
request CreateDatasetVersionRequest

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

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

A Task containing the RPC response.
Overrides

DeleteDataset(DeleteDatasetRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteDataset(DeleteDatasetRequest request, CallSettings callSettings = null)

Deletes a Dataset.

Parameters
Name Description
request DeleteDatasetRequest

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

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

The RPC response.
Overrides

DeleteDatasetAsync(DeleteDatasetRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteDatasetAsync(DeleteDatasetRequest request, CallSettings callSettings = null)

Deletes a Dataset.

Parameters
Name Description
request DeleteDatasetRequest

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

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

A Task containing the RPC response.
Overrides

DeleteDatasetVersion(DeleteDatasetVersionRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteDatasetVersion(DeleteDatasetVersionRequest request, CallSettings callSettings = null)

Deletes a Dataset version.

Parameters
Name Description
request DeleteDatasetVersionRequest

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

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

The RPC response.
Overrides

DeleteDatasetVersionAsync(DeleteDatasetVersionRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteDatasetVersionAsync(DeleteDatasetVersionRequest request, CallSettings callSettings = null)

Deletes a Dataset version.

Parameters
Name Description
request DeleteDatasetVersionRequest

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

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

A Task containing the RPC response.
Overrides

DeleteSavedQuery(DeleteSavedQueryRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteSavedQuery(DeleteSavedQueryRequest request, CallSettings callSettings = null)

Deletes a SavedQuery.

Parameters
Name Description
request DeleteSavedQueryRequest

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

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

The RPC response.
Overrides

DeleteSavedQueryAsync(DeleteSavedQueryRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteSavedQueryAsync(DeleteSavedQueryRequest request, CallSettings callSettings = null)

Deletes a SavedQuery.

Parameters
Name Description
request DeleteSavedQueryRequest

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

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

A Task containing the RPC response.
Overrides

ExportData(ExportDataRequest, CallSettings)

public override Operation<ExportDataResponse, ExportDataOperationMetadata> ExportData(ExportDataRequest request, CallSettings callSettings = null)

Exports data from a Dataset.

Parameters
Name Description
request ExportDataRequest

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

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

The RPC response.
Overrides

ExportDataAsync(ExportDataRequest, CallSettings)

public override Task<Operation<ExportDataResponse, ExportDataOperationMetadata>> ExportDataAsync(ExportDataRequest request, CallSettings callSettings = null)

Exports data from a Dataset.

Parameters
Name Description
request ExportDataRequest

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

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

A Task containing the RPC response.
Overrides

GetAnnotationSpec(GetAnnotationSpecRequest, CallSettings)

public override AnnotationSpec GetAnnotationSpec(GetAnnotationSpecRequest request, CallSettings callSettings = null)

Gets an AnnotationSpec.

Parameters
Name Description
request GetAnnotationSpecRequest

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

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

The RPC response.
Overrides

GetAnnotationSpecAsync(GetAnnotationSpecRequest, CallSettings)

public override Task<AnnotationSpec> GetAnnotationSpecAsync(GetAnnotationSpecRequest request, CallSettings callSettings = null)

Gets an AnnotationSpec.

Parameters
Name Description
request GetAnnotationSpecRequest

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

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

A Task containing the RPC response.
Overrides

GetDataset(GetDatasetRequest, CallSettings)

public override Dataset GetDataset(GetDatasetRequest request, CallSettings callSettings = null)

Gets a Dataset.

Parameters
Name Description
request GetDatasetRequest

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

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

The RPC response.
Overrides

GetDatasetAsync(GetDatasetRequest, CallSettings)

public override Task<Dataset> GetDatasetAsync(GetDatasetRequest request, CallSettings callSettings = null)

Gets a Dataset.

Parameters
Name Description
request GetDatasetRequest

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

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

A Task containing the RPC response.
Overrides

GetDatasetVersion(GetDatasetVersionRequest, CallSettings)

public override DatasetVersion GetDatasetVersion(GetDatasetVersionRequest request, CallSettings callSettings = null)

Gets a Dataset version.

Parameters
Name Description
request GetDatasetVersionRequest

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

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

The RPC response.
Overrides

GetDatasetVersionAsync(GetDatasetVersionRequest, CallSettings)

public override Task<DatasetVersion> GetDatasetVersionAsync(GetDatasetVersionRequest request, CallSettings callSettings = null)

Gets a Dataset version.

Parameters
Name Description
request GetDatasetVersionRequest

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

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

A Task containing the RPC response.
Overrides

ImportData(ImportDataRequest, CallSettings)

public override Operation<ImportDataResponse, ImportDataOperationMetadata> ImportData(ImportDataRequest request, CallSettings callSettings = null)

Imports data into a Dataset.

Parameters
Name Description
request ImportDataRequest

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

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

The RPC response.
Overrides

ImportDataAsync(ImportDataRequest, CallSettings)

public override Task<Operation<ImportDataResponse, ImportDataOperationMetadata>> ImportDataAsync(ImportDataRequest request, CallSettings callSettings = null)

Imports data into a Dataset.

Parameters
Name Description
request ImportDataRequest

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

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

A Task containing the RPC response.
Overrides

ListAnnotations(ListAnnotationsRequest, CallSettings)

public override PagedEnumerable<ListAnnotationsResponse, Annotation> ListAnnotations(ListAnnotationsRequest request, CallSettings callSettings = null)

Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.

Parameters
Name Description
request ListAnnotationsRequest

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

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

A pageable sequence of Annotation resources.
Overrides

ListAnnotationsAsync(ListAnnotationsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAnnotationsResponse, Annotation> ListAnnotationsAsync(ListAnnotationsRequest request, CallSettings callSettings = null)

Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.

Parameters
Name Description
request ListAnnotationsRequest

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

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

A pageable asynchronous sequence of Annotation resources.
Overrides

ListDataItems(ListDataItemsRequest, CallSettings)

public override PagedEnumerable<ListDataItemsResponse, DataItem> ListDataItems(ListDataItemsRequest request, CallSettings callSettings = null)

Lists DataItems in a Dataset.

Parameters
Name Description
request ListDataItemsRequest

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

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

A pageable sequence of DataItem resources.
Overrides

ListDataItemsAsync(ListDataItemsRequest, CallSettings)

public override PagedAsyncEnumerable<ListDataItemsResponse, DataItem> ListDataItemsAsync(ListDataItemsRequest request, CallSettings callSettings = null)

Lists DataItems in a Dataset.

Parameters
Name Description
request ListDataItemsRequest

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

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

A pageable asynchronous sequence of DataItem resources.
Overrides

ListDatasetVersions(ListDatasetVersionsRequest, CallSettings)

public override PagedEnumerable<ListDatasetVersionsResponse, DatasetVersion> ListDatasetVersions(ListDatasetVersionsRequest request, CallSettings callSettings = null)

Lists DatasetVersions in a Dataset.

Parameters
Name Description
request ListDatasetVersionsRequest

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

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

A pageable sequence of DatasetVersion resources.
Overrides

ListDatasetVersionsAsync(ListDatasetVersionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListDatasetVersionsResponse, DatasetVersion> ListDatasetVersionsAsync(ListDatasetVersionsRequest request, CallSettings callSettings = null)

Lists DatasetVersions in a Dataset.

Parameters
Name Description
request ListDatasetVersionsRequest

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

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

A pageable asynchronous sequence of DatasetVersion resources.
Overrides

ListDatasets(ListDatasetsRequest, CallSettings)

public override PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(ListDatasetsRequest request, CallSettings callSettings = null)

Lists Datasets in a Location.

Parameters
Name Description
request ListDatasetsRequest

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

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

A pageable sequence of Dataset resources.
Overrides

ListDatasetsAsync(ListDatasetsRequest, CallSettings)

public override PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(ListDatasetsRequest request, CallSettings callSettings = null)

Lists Datasets in a Location.

Parameters
Name Description
request ListDatasetsRequest

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

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

A pageable asynchronous sequence of Dataset resources.
Overrides

ListSavedQueries(ListSavedQueriesRequest, CallSettings)

public override PagedEnumerable<ListSavedQueriesResponse, SavedQuery> ListSavedQueries(ListSavedQueriesRequest request, CallSettings callSettings = null)

Lists SavedQueries in a Dataset.

Parameters
Name Description
request ListSavedQueriesRequest

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

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

A pageable sequence of SavedQuery resources.
Overrides

ListSavedQueriesAsync(ListSavedQueriesRequest, CallSettings)

public override PagedAsyncEnumerable<ListSavedQueriesResponse, SavedQuery> ListSavedQueriesAsync(ListSavedQueriesRequest request, CallSettings callSettings = null)

Lists SavedQueries in a Dataset.

Parameters
Name Description
request ListSavedQueriesRequest

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

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

A pageable asynchronous sequence of SavedQuery resources.
Overrides

RestoreDatasetVersion(RestoreDatasetVersionRequest, CallSettings)

public override Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata> RestoreDatasetVersion(RestoreDatasetVersionRequest request, CallSettings callSettings = null)

Restores a dataset version.

Parameters
Name Description
request RestoreDatasetVersionRequest

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

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

The RPC response.
Overrides

RestoreDatasetVersionAsync(RestoreDatasetVersionRequest, CallSettings)

public override Task<Operation<DatasetVersion, RestoreDatasetVersionOperationMetadata>> RestoreDatasetVersionAsync(RestoreDatasetVersionRequest request, CallSettings callSettings = null)

Restores a dataset version.

Parameters
Name Description
request RestoreDatasetVersionRequest

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

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

A Task containing the RPC response.
Overrides

SearchDataItems(SearchDataItemsRequest, CallSettings)

public override PagedEnumerable<SearchDataItemsResponse, DataItemView> SearchDataItems(SearchDataItemsRequest request, CallSettings callSettings = null)

Searches DataItems in a Dataset.

Parameters
Name Description
request SearchDataItemsRequest

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

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

A pageable sequence of DataItemView resources.
Overrides

SearchDataItemsAsync(SearchDataItemsRequest, CallSettings)

public override PagedAsyncEnumerable<SearchDataItemsResponse, DataItemView> SearchDataItemsAsync(SearchDataItemsRequest request, CallSettings callSettings = null)

Searches DataItems in a Dataset.

Parameters
Name Description
request SearchDataItemsRequest

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

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

A pageable asynchronous sequence of DataItemView resources.
Overrides

UpdateDataset(UpdateDatasetRequest, CallSettings)

public override Dataset UpdateDataset(UpdateDatasetRequest request, CallSettings callSettings = null)

Updates a Dataset.

Parameters
Name Description
request UpdateDatasetRequest

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

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

The RPC response.
Overrides

UpdateDatasetAsync(UpdateDatasetRequest, CallSettings)

public override Task<Dataset> UpdateDatasetAsync(UpdateDatasetRequest request, CallSettings callSettings = null)

Updates a Dataset.

Parameters
Name Description
request UpdateDatasetRequest

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

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

A Task containing the RPC response.
Overrides

UpdateDatasetVersion(UpdateDatasetVersionRequest, CallSettings)

public override DatasetVersion UpdateDatasetVersion(UpdateDatasetVersionRequest request, CallSettings callSettings = null)

Updates a DatasetVersion.

Parameters
Name Description
request UpdateDatasetVersionRequest

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

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

The RPC response.
Overrides

UpdateDatasetVersionAsync(UpdateDatasetVersionRequest, CallSettings)

public override Task<DatasetVersion> UpdateDatasetVersionAsync(UpdateDatasetVersionRequest request, CallSettings callSettings = null)

Updates a DatasetVersion.

Parameters
Name Description
request UpdateDatasetVersionRequest

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

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

A Task containing the RPC response.
Overrides