airflow.providers.google.cloud.hooks.vertex_ai.dataset

This module contains a Google Cloud Vertex AI hook.

Module Contents

Classes

DatasetHook

Hook for Google Cloud Vertex AI Dataset APIs.
class airflow.providers.google.cloud.hooks.vertex_ai.dataset.DatasetHook(gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None)[source]

Bases: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

Hook for Google Cloud Vertex AI Dataset APIs.

get_dataset_service_client(self, region=None)[source]

Returns DatasetServiceClient.

wait_for_operation(self, operation, timeout=None)[source]

Waits for long-lasting operation to complete.

static extract_dataset_id(obj)[source]

Returns unique id of the dataset.

create_dataset(self, project_id, region, dataset, retry=DEFAULT, timeout=None, metadata=())[source]

Creates a Dataset.

Parameters

  • project_id (str) -- Required. The ID of the Google Cloud project that the service belongs to.

  • region (str) -- Required. The ID of the Google Cloud region that the service belongs to.

  • dataset (Union[google.cloud.aiplatform_v1.types.Dataset, Dict]) -- Required. The Dataset to create.

  • retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) -- Designation of what errors, if any, should be retried.

  • timeout (Optional[float]) -- The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) -- Strings which should be sent along with the request as metadata.

delete_dataset(self, project_id, region, dataset, retry=DEFAULT, timeout=None, metadata=())[source]

Deletes a Dataset.

Parameters

  • project_id (str) -- Required. The ID of the Google Cloud project that the service belongs to.

  • region (str) -- Required. The ID of the Google Cloud region that the service belongs to.

  • dataset (str) -- Required. The ID of the Dataset to delete.

  • retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) -- Designation of what errors, if any, should be retried.

  • timeout (Optional[float]) -- The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) -- Strings which should be sent along with the request as metadata.

export_data(self, project_id, region, dataset, export_config, retry=DEFAULT, timeout=None, metadata=())[source]

Exports data from a Dataset.

Parameters

  • project_id (str) -- Required. The ID of the Google Cloud project that the service belongs to.

  • region (str) -- Required. The ID of the Google Cloud region that the service belongs to.

  • dataset (str) -- Required. The ID of the Dataset to export.

  • export_config (Union[google.cloud.aiplatform_v1.types.ExportDataConfig, Dict]) -- Required. The desired output location.

  • retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) -- Designation of what errors, if any, should be retried.

  • timeout (Optional[float]) -- The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) -- Strings which should be sent along with the request as metadata.

get_annotation_spec(self, project_id, region, dataset, annotation_spec, read_mask=None, retry=DEFAULT, timeout=None, metadata=())[source]

Gets an AnnotationSpec.

Parameters

  • project_id (str) -- Required. The ID of the Google Cloud project that the service belongs to.

  • region (str) -- Required. The ID of the Google Cloud region that the service belongs to.

  • dataset (str) -- Required. The ID of the Dataset.

  • annotation_spec (str) -- The ID of the AnnotationSpec resource.

  • read_mask (Optional[str]) -- Optional. Mask specifying which fields to read.

  • retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) -- Designation of what errors, if any, should be retried.

  • timeout (Optional[float]) -- The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) -- Strings which should be sent along with the request as metadata.

get_dataset(self, project_id, region, dataset, read_mask=None, retry=DEFAULT, timeout=None, metadata=())[source]

Gets a Dataset.

Parameters

  • project_id (str) -- Required. The ID of the Google Cloud project that the service belongs to.

  • region (str) -- Required. The ID of the Google Cloud region that the service belongs to.

  • dataset (str) -- Required. The ID of the Dataset to export.

  • read_mask (Optional[str]) -- Optional. Mask specifying which fields to read.

  • retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) -- Designation of what errors, if any, should be retried.

  • timeout (Optional[float]) -- The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) -- Strings which should be sent along with the request as metadata.

import_data(self, project_id, region, dataset, import_configs, retry=DEFAULT, timeout=None, metadata=())[source]

Imports data into a Dataset.

Parameters

  • project_id (str) -- Required. The ID of the Google Cloud project that the service belongs to.

  • region (str) -- Required. The ID of the Google Cloud region that the service belongs to.

  • dataset (str) -- Required. The ID of the Dataset to import.

  • 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.

  • retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) -- Designation of what errors, if any, should be retried.

  • timeout (Optional[float]) -- The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) -- Strings which should be sent along with the request as metadata.

list_annotations(self, project_id, region, dataset, data_item, filter=None, page_size=None, page_token=None, read_mask=None, order_by=None, retry=DEFAULT, timeout=None, metadata=())[source]

Lists Annotations belongs to a data item

Parameters

  • project_id (str) -- Required. The ID of the Google Cloud project that the service belongs to.

  • region (str) -- Required. The ID of the Google Cloud region that the service belongs to.

  • dataset (str) -- Required. The ID of the Dataset.

  • data_item (str) -- Required. The ID of the DataItem to list Annotations from.

  • filter (Optional[str]) -- The standard list filter.

  • page_size (Optional[int]) -- The standard list page size.

  • page_token (Optional[str]) -- The standard list page token.

  • read_mask (Optional[str]) -- Mask specifying which fields to read.

  • order_by (Optional[str]) -- A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

  • retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) -- Designation of what errors, if any, should be retried.

  • timeout (Optional[float]) -- The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) -- Strings which should be sent along with the request as metadata.

list_data_items(self, project_id, region, dataset, filter=None, page_size=None, page_token=None, read_mask=None, order_by=None, retry=DEFAULT, timeout=None, metadata=())[source]

Lists DataItems in a Dataset.

Parameters

  • project_id (str) -- Required. The ID of the Google Cloud project that the service belongs to.

  • region (str) -- Required. The ID of the Google Cloud region that the service belongs to.

  • dataset (str) -- Required. The ID of the Dataset.

  • filter (Optional[str]) -- The standard list filter.

  • page_size (Optional[int]) -- The standard list page size.

  • page_token (Optional[str]) -- The standard list page token.

  • read_mask (Optional[str]) -- Mask specifying which fields to read.

  • order_by (Optional[str]) -- A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

  • retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) -- Designation of what errors, if any, should be retried.

  • timeout (Optional[float]) -- The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) -- Strings which should be sent along with the request as metadata.

list_datasets(self, project_id, region, filter=None, page_size=None, page_token=None, read_mask=None, order_by=None, retry=DEFAULT, timeout=None, metadata=())[source]

Lists Datasets in a Location.

Parameters

  • project_id (str) -- Required. The ID of the Google Cloud project that the service belongs to.

  • region (str) -- Required. The ID of the Google Cloud region that the service belongs to.

  • filter (Optional[str]) -- The standard list filter.

  • page_size (Optional[int]) -- The standard list page size.

  • page_token (Optional[str]) -- The standard list page token.

  • read_mask (Optional[str]) -- Mask specifying which fields to read.

  • order_by (Optional[str]) -- A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

  • retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) -- Designation of what errors, if any, should be retried.

  • timeout (Optional[float]) -- The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) -- Strings which should be sent along with the request as metadata.

update_dataset(self, project_id, region, dataset_id, dataset, update_mask, retry=DEFAULT, timeout=None, metadata=())[source]

Updates a Dataset.

Parameters

  • project_id (str) -- Required. The ID of the Google Cloud project that the service belongs to.

  • region (str) -- Required. The ID of the Google Cloud region that the service belongs to.

  • dataset_id (str) -- Required. The ID of the Dataset.

  • dataset (Union[google.cloud.aiplatform_v1.types.Dataset, Dict]) -- Required. The Dataset which replaces the resource on the server.

  • update_mask (Union[google.protobuf.field_mask_pb2.FieldMask, Dict]) -- Required. The update mask applies to the resource.

  • retry (Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault]) -- Designation of what errors, if any, should be retried.

  • timeout (Optional[float]) -- The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) -- Strings which should be sent along with the request as metadata.

Was this entry helpful?