Class DatasetServiceClient (1.4.3) 

DatasetServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.aiplatform_v1.services.dataset_service.transports.base.DatasetServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The service that handles the CRUD of Vertex AI Dataset and its child resources.

Inheritance

builtins.object > DatasetServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns
Type Description
DatasetServiceTransport The transport used by the client instance.

Methods

DatasetServiceClient

DatasetServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.aiplatform_v1.services.dataset_service.transports.base.DatasetServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the dataset service client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Union[str, DatasetServiceTransport]

The transport to use. If set to None, a transport is chosen automatically.
client_options google.api_core.client_options.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

annotation_path

annotation_path(
    project: str, location: str, dataset: str, data_item: str, annotation: str
)

Returns a fully-qualified annotation string.

annotation_spec_path

annotation_spec_path(
    project: str, location: str, dataset: str, annotation_spec: str
)

Returns a fully-qualified annotation_spec string.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_dataset

create_dataset(request: Optional[google.cloud.aiplatform_v1.types.dataset_service.CreateDatasetRequest] = None, *, parent: Optional[str] = None, dataset: Optional[google.cloud.aiplatform_v1.types.dataset.Dataset] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a Dataset.

Parameters
Name Description
request google.cloud.aiplatform_v1.types.CreateDatasetRequest

The request object. Request message for DatasetService.CreateDataset.
parent str

Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
dataset google.cloud.aiplatform_v1.types.Dataset

Required. The Dataset to create. This corresponds to the dataset field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be Dataset A collection of DataItems and Annotations on them.

data_item_path

data_item_path(project: str, location: str, dataset: str, data_item: str)

Returns a fully-qualified data_item string.

dataset_path

dataset_path(project: str, location: str, dataset: str)

Returns a fully-qualified dataset string.

delete_dataset

delete_dataset(request: Optional[google.cloud.aiplatform_v1.types.dataset_service.DeleteDatasetRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a Dataset.

Parameters
Name Description
request google.cloud.aiplatform_v1.types.DeleteDatasetRequest

The request object. Request message for DatasetService.DeleteDataset.
name str

Required. The resource name of the Dataset to delete. Format: projects/{project}/locations/{location}/datasets/{dataset} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

export_data

export_data(request: Optional[google.cloud.aiplatform_v1.types.dataset_service.ExportDataRequest] = None, *, name: Optional[str] = None, export_config: Optional[google.cloud.aiplatform_v1.types.dataset.ExportDataConfig] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Exports data from a Dataset.

Parameters
Name Description
request google.cloud.aiplatform_v1.types.ExportDataRequest

The request object. Request message for DatasetService.ExportData.
name str

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset} This corresponds to the name field on the request instance; if request is provided, this should not be set.
export_config google.cloud.aiplatform_v1.types.ExportDataConfig

Required. The desired output location. This corresponds to the export_config field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be ExportDataResponse Response message for DatasetService.ExportData.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
DatasetServiceClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
DatasetServiceClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
DatasetServiceClient The constructed client.

get_annotation_spec

get_annotation_spec(request: Optional[google.cloud.aiplatform_v1.types.dataset_service.GetAnnotationSpecRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an AnnotationSpec.

Parameters
Name Description
request google.cloud.aiplatform_v1.types.GetAnnotationSpecRequest

The request object. Request message for DatasetService.GetAnnotationSpec.
name str

Required. The name of the AnnotationSpec resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1.types.AnnotationSpec Identifies a concept with which DataItems may be annotated with.

get_dataset

get_dataset(request: Optional[google.cloud.aiplatform_v1.types.dataset_service.GetDatasetRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a Dataset.

Parameters
Name Description
request google.cloud.aiplatform_v1.types.GetDatasetRequest

The request object. Request message for DatasetService.GetDataset.
name str

Required. The name of the Dataset resource. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1.types.Dataset A collection of DataItems and Annotations on them.

import_data

import_data(request: Optional[google.cloud.aiplatform_v1.types.dataset_service.ImportDataRequest] = None, *, name: Optional[str] = None, import_configs: Optional[Sequence[google.cloud.aiplatform_v1.types.dataset.ImportDataConfig]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Imports data into a Dataset.

Parameters
Name Description
request google.cloud.aiplatform_v1.types.ImportDataRequest

The request object. Request message for DatasetService.ImportData.
name str

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset} This corresponds to the name field on the request instance; if request is provided, this should not be set.
import_configs Sequence[google.cloud.aiplatform_v1.types.ImportDataConfig]

Required. The desired input locations. The contents of all input locations will be imported in one batch. This corresponds to the import_configs field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be ImportDataResponse Response message for DatasetService.ImportData.

list_annotations

list_annotations(request: Optional[google.cloud.aiplatform_v1.types.dataset_service.ListAnnotationsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Annotations belongs to a dataitem

Parameters
Name Description
request google.cloud.aiplatform_v1.types.ListAnnotationsRequest

The request object. Request message for DatasetService.ListAnnotations.
parent str

Required. The resource name of the DataItem to list Annotations from. Format: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListAnnotationsPager Response message for DatasetService.ListAnnotations. Iterating over this object will yield results and resolve additional pages automatically.

list_data_items

list_data_items(request: Optional[google.cloud.aiplatform_v1.types.dataset_service.ListDataItemsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists DataItems in a Dataset.

Parameters
Name Description
request google.cloud.aiplatform_v1.types.ListDataItemsRequest

The request object. Request message for DatasetService.ListDataItems.
parent str

Required. The resource name of the Dataset to list DataItems from. Format: projects/{project}/locations/{location}/datasets/{dataset} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDataItemsPager Response message for DatasetService.ListDataItems. Iterating over this object will yield results and resolve additional pages automatically.

list_datasets

list_datasets(request: Optional[google.cloud.aiplatform_v1.types.dataset_service.ListDatasetsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Datasets in a Location.

Parameters
Name Description
request google.cloud.aiplatform_v1.types.ListDatasetsRequest

The request object. Request message for DatasetService.ListDatasets.
parent str

Required. The name of the Dataset's parent resource. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1.services.dataset_service.pagers.ListDatasetsPager Response message for DatasetService.ListDatasets. Iterating over this object will yield results and resolve additional pages automatically.

parse_annotation_path

parse_annotation_path(path: str)

Parses a annotation path into its component segments.

parse_annotation_spec_path

parse_annotation_spec_path(path: str)

Parses a annotation_spec path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_data_item_path

parse_data_item_path(path: str)

Parses a data_item path into its component segments.

parse_dataset_path

parse_dataset_path(path: str)

Parses a dataset path into its component segments.

update_dataset

update_dataset(request: Optional[google.cloud.aiplatform_v1.types.dataset_service.UpdateDatasetRequest] = None, *, dataset: Optional[google.cloud.aiplatform_v1.types.dataset.Dataset] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a Dataset.

Parameters
Name Description
request google.cloud.aiplatform_v1.types.UpdateDatasetRequest

The request object. Request message for DatasetService.UpdateDataset.
dataset google.cloud.aiplatform_v1.types.Dataset

Required. The Dataset which replaces the resource on the server. This corresponds to the dataset field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields: - display_name - description - labels This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.aiplatform_v1.types.Dataset A collection of DataItems and Annotations on them.