airflow.providers.google.cloud.hooks.dataplex

This module contains Google Dataplex hook.

Attributes

PATH_DATA_SCAN

Exceptions

AirflowDataQualityScanException

Raised when data quality scan rules fail.

AirflowDataQualityScanResultTimeoutException

Raised when no result found after specified amount of seconds.

Classes

DataplexHook

Hook for Google Dataplex.

DataplexAsyncHook

Asynchronous Hook for Google Cloud Dataplex APIs.

Module Contents

airflow.providers.google.cloud.hooks.dataplex.PATH_DATA_SCAN = 'projects/{project_id}/locations/{region}/dataScans/{data_scan_id}'[source]
exception airflow.providers.google.cloud.hooks.dataplex.AirflowDataQualityScanException[source]

Bases: airflow.exceptions.AirflowException

Raised when data quality scan rules fail.

exception airflow.providers.google.cloud.hooks.dataplex.AirflowDataQualityScanResultTimeoutException[source]

Bases: airflow.exceptions.AirflowException

Raised when no result found after specified amount of seconds.

class airflow.providers.google.cloud.hooks.dataplex.DataplexHook(api_version='v1', gcp_conn_id='google_cloud_default', impersonation_chain=None, location=None, **kwargs)[source]

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

Hook for Google Dataplex.

Parameters:

  • api_version (str) – The version of the api that will be requested for example ‘v3’.

  • gcp_conn_id (str) – The connection ID to use when fetching connection info.

  • impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

api_version = 'v1'[source]
location = None[source]
get_dataplex_client()[source]

Return DataplexServiceClient.

get_dataplex_data_scan_client()[source]

Return DataScanServiceClient.

get_dataplex_catalog_client()[source]

Return CatalogServiceClient.

wait_for_operation(timeout, operation)[source]

Wait for long-lasting operation to complete.

create_entry(location, entry_id, entry_group_id, entry_configuration, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Create an EntryType resource.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • entry_id (str) –

    Required. Entry identifier. It has to be unique within an Entry Group. Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names. The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.

    For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.

    It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud. The maximum size of the field is 4000 characters.

  • entry_group_id (str) – Required. EntryGroup resource name to which created Entry belongs to.

  • entry_configuration (google.cloud.dataplex_v1.types.Entry | dict) – Required. Entry configuration body.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

get_entry(location, entry_id, entry_group_id, view=None, aspect_types=None, paths=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Get an Entry resource.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • entry_id (str) –

    Required. Entry identifier. It has to be unique within an Entry Group. Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names. The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.

    For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.

    It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud. The maximum size of the field is 4000 characters.

  • entry_group_id (str) – Required. EntryGroup resource name to which created Entry belongs to.

  • view (google.cloud.dataplex_v1.types.EntryView | str | None) – Optional. View to control which parts of an entry the service should return.

  • aspect_types (collections.abc.MutableSequence[str] | None) – Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view.

  • paths (collections.abc.MutableSequence[str] | None) – Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

delete_entry(location, entry_id, entry_group_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Delete an AspectType resource.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • entry_id (str) –

    Required. Entry identifier. It has to be unique within an Entry Group. Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names. The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.

    For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.

    It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud. The maximum size of the field is 4000 characters.

  • entry_group_id (str) – Required. EntryGroup resource name to which created Entry belongs to.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

list_entries(location, entry_group_id, filter_by=None, page_size=None, page_token=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

List Entries resources from specific location.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • entry_group_id (str) – Required. EntryGroup resource name to which created Entry belongs to.

  • filter_by (str | None) –

    Optional. A filter on the entries to return. Filters are case-sensitive. You can filter the request by the following fields:

    • entry_type

    • entry_source.display_name

    The comparison operators are =, !=, <, >, <=, >=. The service compares strings according to lexical order. You can use the logical operators AND, OR, NOT in the filter. You can use Wildcard “*”, but for entry_type you need to provide the full project id or number. Example filter expressions:

    • ”entry_source.display_name=AnExampleDisplayName”

    • ”entry_type=projects/example-project/locations/global/entryTypes/example-entry_type”

    • ”entry_type=projects/example-project/locations/us/entryTypes/a*

      OR entry_type=projects/another-project/locations/*”

    • ”NOT entry_source.display_name=AnotherExampleDisplayName”.

  • page_size (int | None) – Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100.

  • page_token (str | None) – Optional. Page token received from a previous ListEntries call. Provide this to retrieve the subsequent page.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

search_entries(location, query, order_by=None, scope=None, page_size=None, page_token=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Search for Entries matching the given query and scope.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • query (str) – Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog.

  • order_by (str | None) –

    Optional. Specifies the ordering of results. Supported values are:

    • relevance (default)

    • last_modified_timestamp

    • last_modified_timestamp asc

  • scope (str | None) – Optional. The scope under which the search should be operating. It must either be organizations/<org_id> or projects/<project_ref>. If it is unspecified, it defaults to the organization where the project provided in name is located.

  • page_size (int | None) – Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100.

  • page_token (str | None) – Optional. Page token received from a previous ListEntries call. Provide this to retrieve the subsequent page.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

lookup_entry(location, entry_id, entry_group_id, view=None, aspect_types=None, paths=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Look up a single Entry by name using the permission on the source system.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • entry_id (str) – Required. Entry identifier. It has to be unique within an Entry Group. Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names. The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name. For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2. It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud. The maximum size of the field is 4000 characters.

  • entry_group_id (str) – Required. EntryGroup resource name to which created Entry belongs to.

  • view (google.cloud.dataplex_v1.types.EntryView | str | None) – Optional. View to control which parts of an entry the service should return.

  • aspect_types (collections.abc.MutableSequence[str] | None) – Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view.

  • paths (collections.abc.MutableSequence[str] | None) – Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

update_entry(location, entry_id, entry_group_id, entry_configuration, allow_missing=False, delete_missing_aspects=False, aspect_keys=None, update_mask=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Update an Entry resource.

Parameters:

  • entry_id (str) – Required. Entry identifier. It has to be unique within an Entry Group. Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names. The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name. For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2. It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud. The maximum size of the field is 4000 characters.

  • entry_group_id (str) – Required. EntryGroup resource name to which created Entry belongs to.

  • entry_configuration (dict | google.cloud.dataplex_v1.types.Entry) – Required. The updated configuration body of the Entry.

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • update_mask (list[str] | google.protobuf.field_mask_pb2.FieldMask | None) – Optional. Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.

  • allow_missing (bool | None) – Optional. If set to true and entry doesn’t exist, the service will create it.

  • delete_missing_aspects (bool | None) – Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren’t provided in the request.

  • aspect_keys (collections.abc.MutableSequence[str] | None) –

    Optional. The map keys of the Aspects which the service should modify. It supports the following syntax:

    • <aspect_type_reference> - matches an aspect of the given type and empty path.

    • <aspect_type_reference>@path - matches an aspect of the given type and specified path.

      For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.<field_name>.

    • <aspect_type_reference>@* - matches aspects of the given type for all paths.

    • *@path - matches aspects of all types on the given path.

    The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true. If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

create_aspect_type(location, aspect_type_id, aspect_type_configuration, project_id=PROVIDE_PROJECT_ID, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

Create an EntryType resource.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • aspect_type_id (str) – Required. AspectType identifier.

  • aspect_type_configuration (google.cloud.dataplex_v1.types.AspectType | dict) – Required. AspectType configuration body.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • validate_only (bool) – Optional. If set, performs request validation, but does not actually execute the create request.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

get_aspect_type(location, aspect_type_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Get an AspectType resource.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • aspect_type_id (str) – Required. AspectType identifier.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

create_entry_type(location, entry_type_id, entry_type_configuration, project_id=PROVIDE_PROJECT_ID, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

Create an EntryType resource.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • entry_type_id (str) – Required. EntryType identifier.

  • entry_type_configuration (google.cloud.dataplex_v1.types.EntryType | dict) – Required. EntryType configuration body.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • validate_only (bool) – Optional. If set, performs request validation, but does not actually execute the create request.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

get_entry_type(location, entry_type_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Get an EntryType resource.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • entry_type_id (str) – Required. EntryGroup identifier.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

delete_aspect_type(location, aspect_type_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Delete an AspectType resource.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • aspect_type_id (str) – Required. AspectType identifier.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

list_aspect_types(location, filter_by=None, order_by=None, page_size=None, page_token=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

List AspectTypes resources from specific location.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • filter_by (str | None) – Optional. Filter to apply on the list results.

  • order_by (str | None) – Optional. Fields to order the results by.

  • page_size (int | None) – Optional. Maximum number of EntryGroups to return on one page.

  • page_token (str | None) – Optional. Token to retrieve the next page of results.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

update_aspect_type(location, aspect_type_id, aspect_type_configuration, project_id=PROVIDE_PROJECT_ID, update_mask=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

Update an AspectType resource.

Parameters:

  • aspect_type_id (str) – Required. ID of the AspectType to update.

  • aspect_type_configuration (dict | google.cloud.dataplex_v1.types.AspectType) – Required. The updated configuration body of the AspectType.

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • update_mask (list[str] | google.protobuf.field_mask_pb2.FieldMask | None) – Optional. Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • validate_only (bool | None) – Optional. The service validates the request without performing any mutations.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

delete_entry_type(location, entry_type_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Delete an EntryType resource.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • entry_type_id (str) – Required. EntryType identifier.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

list_entry_types(location, filter_by=None, order_by=None, page_size=None, page_token=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

List EntryTypes resources from specific location.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • filter_by (str | None) – Optional. Filter to apply on the list results.

  • order_by (str | None) – Optional. Fields to order the results by.

  • page_size (int | None) – Optional. Maximum number of EntryGroups to return on one page.

  • page_token (str | None) – Optional. Token to retrieve the next page of results.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

update_entry_type(location, entry_type_id, entry_type_configuration, project_id=PROVIDE_PROJECT_ID, update_mask=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

Update an EntryType resource.

Parameters:

  • entry_type_id (str) – Required. ID of the EntryType to update.

  • entry_type_configuration (dict | google.cloud.dataplex_v1.types.EntryType) – Required. The updated configuration body of the EntryType.

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • update_mask (list[str] | google.protobuf.field_mask_pb2.FieldMask | None) – Optional. Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • validate_only (bool | None) – Optional. The service validates the request without performing any mutations.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

create_entry_group(location, entry_group_id, entry_group_configuration, project_id=PROVIDE_PROJECT_ID, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

Create an Entry resource.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • entry_group_id (str) – Required. EntryGroup identifier.

  • entry_group_configuration (google.cloud.dataplex_v1.types.EntryGroup | dict) – Required. EntryGroup configuration body.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • validate_only (bool) – Optional. If set, performs request validation, but does not actually execute the create request.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

get_entry_group(location, entry_group_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Get an EntryGroup resource.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • entry_group_id (str) – Required. EntryGroup identifier.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

delete_entry_group(location, entry_group_id, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

Delete an EntryGroup resource.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • entry_group_id (str) – Required. EntryGroup identifier.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

list_entry_groups(location, filter_by=None, order_by=None, page_size=None, page_token=None, project_id=PROVIDE_PROJECT_ID, retry=DEFAULT, timeout=None, metadata=())[source]

List EntryGroups resources from specific location.

Parameters:

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • filter_by (str | None) – Optional. Filter to apply on the list results.

  • order_by (str | None) – Optional. Fields to order the results by.

  • page_size (int | None) – Optional. Maximum number of EntryGroups to return on one page.

  • page_token (str | None) – Optional. Token to retrieve the next page of results.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

update_entry_group(location, entry_group_id, entry_group_configuration, project_id=PROVIDE_PROJECT_ID, update_mask=None, validate_only=False, retry=DEFAULT, timeout=None, metadata=())[source]

Update an EntryGroup resource.

Parameters:

  • entry_group_id (str) – Required. ID of the EntryGroup to update.

  • entry_group_configuration (dict | google.cloud.dataplex_v1.types.EntryGroup) – Required. The updated configuration body of the EntryGroup.

  • location (str) – Required. The ID of the Google Cloud location that the task belongs to.

  • update_mask (list[str] | google.protobuf.field_mask_pb2.FieldMask | None) – Optional. Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.

  • project_id (str) – Optional. The ID of the Google Cloud project that the task belongs to.

  • validate_only (bool | None) – Optional. The service validates the request without performing any mutations.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – Optional. A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – Optional. The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Optional. Additional metadata that is provided to the method.

create_task(project_id, region, lake_id, body, dataplex_task_id, validate_only=None, retry=DEFAULT, timeout=None, metadata=())[source]

Create a task resource within a lake.

Parameters:

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

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

  • lake_id (str) – Required. The ID of the Google Cloud lake that the task belongs to.

  • body (dict[str, Any] | google.cloud.dataplex_v1.types.Task) – Required. The Request body contains an instance of Task.

  • dataplex_task_id (str) – Required. Task identifier.

  • validate_only (bool | None) – Optional. Only validate the request, but do not perform mutations. The default is false.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

delete_task(project_id, region, lake_id, dataplex_task_id, retry=DEFAULT, timeout=None, metadata=())[source]

Delete the task resource.

Parameters:

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

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

  • lake_id (str) – Required. The ID of the Google Cloud lake that the task belongs to.

  • dataplex_task_id (str) – Required. The ID of the Google Cloud task to be deleted.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

list_tasks(project_id, region, lake_id, page_size=None, page_token=None, filter=None, order_by=None, retry=DEFAULT, timeout=None, metadata=())[source]

List tasks under the given lake.

Parameters:

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

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

  • lake_id (str) – Required. The ID of the Google Cloud lake that the task belongs to.

  • page_size (int | None) – Optional. Maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (str | None) – Optional. Page token received from a previous ListZones call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZones must match the call that provided the page token.

  • filter (str | None) – Optional. Filter request.

  • order_by (str | None) – Optional. Order by fields for the result.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

get_task(project_id, region, lake_id, dataplex_task_id, retry=DEFAULT, timeout=None, metadata=())[source]

Get task resource.

Parameters:

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

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

  • lake_id (str) – Required. The ID of the Google Cloud lake that the task belongs to.

  • dataplex_task_id (str) – Required. The ID of the Google Cloud task to be retrieved.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

delete_lake(project_id, region, lake_id, retry=DEFAULT, timeout=None, metadata=())[source]

Delete the lake resource.

Parameters:

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

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

  • lake_id (str) – Required. The ID of the Google Cloud lake to be deleted.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

create_lake(project_id, region, lake_id, body, validate_only=None, retry=DEFAULT, timeout=None, metadata=())[source]

Create a lake resource.

Parameters:

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

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

  • lake_id (str) – Required. Lake identifier.

  • body (dict[str, Any] | google.cloud.dataplex_v1.types.Lake) – Required. The Request body contains an instance of Lake.

  • validate_only (bool | None) – Optional. Only validate the request, but do not perform mutations. The default is false.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

get_lake(project_id, region, lake_id, retry=DEFAULT, timeout=None, metadata=())[source]

Get lake resource.

Parameters:

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

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

  • lake_id (str) – Required. The ID of the Google Cloud lake to be retrieved.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

create_zone(project_id, region, lake_id, zone_id, body, retry=DEFAULT, timeout=None, metadata=())[source]

Create a zone resource within a lake.

Parameters:

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

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

  • lake_id (str) – Required. The ID of the Google Cloud lake to be retrieved.

  • body (dict[str, Any] | google.cloud.dataplex_v1.types.Zone) – Required. The Request body contains an instance of Zone.

  • zone_id (str) – Required. Zone identifier.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

delete_zone(project_id, region, lake_id, zone_id, retry=DEFAULT, timeout=None, metadata=())[source]

Delete a zone resource. All assets within a zone must be deleted before the zone can be deleted.

Parameters:

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

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

  • lake_id (str) – Required. The ID of the Google Cloud lake to be retrieved.

  • zone_id (str) – Required. Zone identifier.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

create_asset(project_id, region, lake_id, zone_id, asset_id, body, retry=DEFAULT, timeout=None, metadata=())[source]

Create an asset resource.

Parameters:

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

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

  • lake_id (str) – Required. The ID of the Google Cloud lake to be retrieved.

  • zone_id (str) – Required. Zone identifier.

  • asset_id (str) – Required. Asset identifier.

  • body (dict[str, Any] | google.cloud.dataplex_v1.types.Asset) – Required. The Request body contains an instance of Asset.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

delete_asset(project_id, region, lake_id, asset_id, zone_id, retry=DEFAULT, timeout=None, metadata=())[source]

Delete an asset resource.

Parameters:

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

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

  • lake_id (str) – Required. The ID of the Google Cloud lake to be retrieved.

  • zone_id (str) – Required. Zone identifier.

  • asset_id (str) – Required. Asset identifier.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

create_data_scan(project_id, region, body, data_scan_id=None, retry=DEFAULT, timeout=None, metadata=())[source]

Create a DataScan resource.

Parameters:

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

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

  • data_scan_id (str | None) – Required. Data Quality scan identifier.

  • body (dict[str, Any] | google.cloud.dataplex_v1.types.DataScan) – Required. The Request body contains an instance of DataScan.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

run_data_scan(project_id, region, data_scan_id, retry=DEFAULT, timeout=None, metadata=())[source]

Run an on-demand execution of a DataScan.

Parameters:

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

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

  • data_scan_id (str) – Required. Data Quality scan identifier.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

get_data_scan_job(project_id, region, data_scan_id=None, job_id=None, retry=DEFAULT, timeout=None, metadata=())[source]

Get a DataScan Job resource.

Parameters:

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

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

  • data_scan_id (str | None) – Required. Data Quality scan identifier.

  • job_id (str | None) – Required. The resource name of the DataScanJob: projects/{project_id}/locations/{region}/dataScans/{data_scan_id}/jobs/{data_scan_job_id}

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

wait_for_data_scan_job(data_scan_id, job_id=None, project_id=PROVIDE_PROJECT_ID, region=None, wait_time=10, result_timeout=None)[source]

Wait for Dataplex data scan job.

Parameters:

  • job_id (str | None) – Required. The job_id to wait for.

  • data_scan_id (str) – Required. Data Quality scan identifier.

  • region (str | None) – Required. The ID of the Google Cloud region that the lake belongs to.

  • project_id (str) – Optional. Google Cloud project ID.

  • wait_time (int) – Number of seconds between checks.

  • result_timeout (float | None) – Value in seconds for which operator will wait for the Data Quality scan result. Throws exception if there is no result found after specified amount of seconds.

get_data_scan(project_id, region, data_scan_id, retry=DEFAULT, timeout=None, metadata=())[source]

Get a DataScan resource.

Parameters:

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

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

  • data_scan_id (str) – Required. Data Quality scan identifier.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

update_data_scan(project_id, region, data_scan_id, body, update_mask=None, retry=DEFAULT, timeout=None, metadata=())[source]

Update a DataScan resource.

Parameters:

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

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

  • data_scan_id (str) – Required. Data Quality scan identifier.

  • body (dict[str, Any] | google.cloud.dataplex_v1.types.DataScan) – Required. The Request body contains an instance of DataScan.

  • update_mask (dict | google.protobuf.field_mask_pb2.FieldMask | None) – Required. Mask of fields to update.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

delete_data_scan(project_id, region, data_scan_id, retry=DEFAULT, timeout=None, metadata=())[source]

Delete a DataScan resource.

Parameters:

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

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

  • data_scan_id (str) – Required. Data Quality scan identifier.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

list_data_scan_jobs(project_id, region, data_scan_id, retry=DEFAULT, timeout=None, metadata=())[source]

List DataScanJobs under the given DataScan.

Parameters:

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

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

  • data_scan_id (str) – Required. Data Quality scan identifier.

  • retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

class airflow.providers.google.cloud.hooks.dataplex.DataplexAsyncHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]

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

Asynchronous Hook for Google Cloud Dataplex APIs.

All the methods in the hook where project_id is used must be called with keyword arguments rather than positional.

sync_hook_class[source]
async get_dataplex_data_scan_client()[source]

Return DataScanServiceAsyncClient.

async get_data_scan_job(project_id, region, data_scan_id=None, job_id=None, retry=DEFAULT, timeout=None, metadata=())[source]

Get a DataScan Job resource.

Parameters:

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

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

  • data_scan_id (str | None) – Required. DataScan identifier.

  • job_id (str | None) – Required. The resource name of the DataScanJob: projects/{project_id}/locations/{region}/dataScans/{data_scan_id}/jobs/{data_scan_job_id}

  • retry (google.api_core.retry_async.AsyncRetry | google.api_core.gapic_v1.method._MethodDefault) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (float | None) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (collections.abc.Sequence[tuple[str, str]]) – Additional metadata that is provided to the method.

Was this entry helpful?