Class DataplexServiceAsyncClient (0.1.0)

DataplexServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dataplex_v1.services.dataplex_service.transports.base.DataplexServiceTransport] = 'grpc_asyncio', 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>)

Dataplex service provides data lakes as a service. The primary resources offered by this service are Lakes, Zones and Assets which collectively allow a data adminstrator to organize, manage, secure and catalog data across their organization located across cloud projects in a variety of storage systems including Cloud Storage and BigQuery.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`DataplexServiceTransport`	The transport used by the client instance.

Methods

DataplexServiceAsyncClient

DataplexServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.dataplex_v1.services.dataplex_service.transports.base.DataplexServiceTransport] = 'grpc_asyncio', 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 dataplex 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, .DataplexServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`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.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

action_path

action_path(project: str, location: str, lake: str, action: str)

Returns a fully-qualified action string.

asset_path

asset_path(project: str, location: str, lake: str, zone: str, asset: str)

Returns a fully-qualified asset string.

cancel_job

cancel_job(request: Optional[Union[google.cloud.dataplex_v1.types.service.CancelJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Cancel jobs running for the task resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.CancelJobRequest, dict]` The request object. Cancel task jobs.
`name`	`str` Required. The resource name of the job: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{job_id}`. 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.

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_asset

create_asset(request: Optional[Union[google.cloud.dataplex_v1.types.service.CreateAssetRequest, dict]] = None, *, parent: Optional[str] = None, asset: Optional[google.cloud.dataplex_v1.types.resources.Asset] = None, asset_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an asset resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.CreateAssetRequest, dict]` The request object. Create asset request.
`parent`	`str` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`asset`	`Asset` Required. Asset resource. This corresponds to the `asset` field on the `request` instance; if `request` is provided, this should not be set.
`asset_id`	`str` Required. Asset identifier. This ID will be used to generate names such as table names when publishing metadata to Hive Metastore and BigQuery. - Must contain only lowercase letters, numbers and hyphens. - Must start with a letter. - Must end with a number or a letter. - Must be between 1-63 characters. - Must be unique within the zone. This corresponds to the `asset_id` 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_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Asset An asset represents a cloud resource that is being managed within a lake as a member of a zone.

create_lake

create_lake(request: Optional[Union[google.cloud.dataplex_v1.types.service.CreateLakeRequest, dict]] = None, *, parent: Optional[str] = None, lake: Optional[google.cloud.dataplex_v1.types.resources.Lake] = None, lake_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a lake resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.CreateLakeRequest, dict]` The request object. Create lake request.
`parent`	`str` Required. The resource name of the lake location, of the form: `projects/{project_number}/locations/{location_id}` where `location_id` refers to a GCP region. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`lake`	`Lake` Required. Lake resource This corresponds to the `lake` field on the `request` instance; if `request` is provided, this should not be set.
`lake_id`	`str` Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. - Must contain only lowercase letters, numbers and hyphens. - Must start with a letter. - Must end with a number or a letter. - Must be between 1-63 characters. - Must be unique within the customer project / location. This corresponds to the `lake_id` 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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be Lake A lake is a centralized repository for managing enterprise data across the organization distributed across many cloud projects, and stored in a variety of storage services such as Google Cloud Storage and BigQuery. The resources attached to a lake are referred to as managed resources. Data within these managed resources can be structured or unstructured. A lake provides data admins with tools to organize, secure and manage their data at scale, and provides data scientists and data engineers an integrated experience to easily search, discover, analyze and transform data and associated metadata.

create_task

create_task(request: Optional[Union[google.cloud.dataplex_v1.types.service.CreateTaskRequest, dict]] = None, *, parent: Optional[str] = None, task: Optional[google.cloud.dataplex_v1.types.tasks.Task] = None, task_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a task resource within a lake.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.CreateTaskRequest, dict]` The request object. Create task request.
`parent`	`str` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`task`	`Task` Required. Task resource. This corresponds to the `task` field on the `request` instance; if `request` is provided, this should not be set.
`task_id`	`str` Required. Task identifier. This corresponds to the `task_id` 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_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Task A task represents a user-visible job.

create_zone

create_zone(request: Optional[Union[google.cloud.dataplex_v1.types.service.CreateZoneRequest, dict]] = None, *, parent: Optional[str] = None, zone: Optional[google.cloud.dataplex_v1.types.resources.Zone] = None, zone_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a zone resource within a lake.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.CreateZoneRequest, dict]` The request object. Create zone request.
`parent`	`str` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`zone`	`Zone` Required. Zone resource. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`zone_id`	`str` Required. Zone identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. - Must contain only lowercase letters, numbers and hyphens. - Must start with a letter. - Must end with a number or a letter. - Must be between 1-63 characters. - Must be unique across all lakes from all locations in a project. - Must not be one of the reserved IDs (i.e. "default", "global-temp") This corresponds to the `zone_id` 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_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Zone A zone represents a logical group of related assets within a lake. A zone can be used to map to organizational structure or represent stages of data readiness from raw to curated. It provides managing behavior that is shared or inherited by all contained assets.

delete_asset

delete_asset(request: Optional[Union[google.cloud.dataplex_v1.types.service.DeleteAssetRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.DeleteAssetRequest, dict]` The request object. Delete asset request.
`name`	`str` Required. The resource name of the asset: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. 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_async.AsyncOperation 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 {}.

delete_lake

delete_lake(request: Optional[Union[google.cloud.dataplex_v1.types.service.DeleteLakeRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.DeleteLakeRequest, dict]` The request object. Delete lake request.
`name`	`str` Required. The resource name of the lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}` 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

delete_task

delete_task(request: Optional[Union[google.cloud.dataplex_v1.types.service.DeleteTaskRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Delete the task resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.DeleteTaskRequest, dict]` The request object. Delete task request.
`name`	`str` Required. The resource name of the task: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}`. 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

delete_zone

delete_zone(request: Optional[Union[google.cloud.dataplex_v1.types.service.DeleteZoneRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.DeleteZoneRequest, dict]` The request object. Delete zone request.
`name`	`str` Required. The resource name of the zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. 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

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
`DataplexServiceAsyncClient`	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
`DataplexServiceAsyncClient`	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
`DataplexServiceAsyncClient`	The constructed client.

get_asset

get_asset(request: Optional[Union[google.cloud.dataplex_v1.types.service.GetAssetRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves an asset resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.GetAssetRequest, dict]` The request object. Get asset request.
`name`	`str` Required. The resource name of the asset: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. 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.dataplex_v1.types.Asset`	An asset represents a cloud resource that is being managed within a lake as a member of a zone.

get_job

get_job(request: Optional[Union[google.cloud.dataplex_v1.types.service.GetJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Get job resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.GetJobRequest, dict]` The request object. Get job request.
`name`	`str` Required. The resource name of the job: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}`. 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.dataplex_v1.types.Job`	A job represents an instance of a task.

get_lake

get_lake(request: Optional[Union[google.cloud.dataplex_v1.types.service.GetLakeRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves a lake resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.GetLakeRequest, dict]` The request object. Get lake request.
`name`	`str` Required. The resource name of the lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. 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.dataplex_v1.types.Lake A lake is a centralized repository for managing enterprise data across the organization distributed across many cloud projects, and stored in a variety of storage services such as Google Cloud Storage and BigQuery. The resources attached to a lake are referred to as managed resources. Data within these managed resources can be structured or unstructured. A lake provides data admins with tools to organize, secure and manage their data at scale, and provides data scientists and data engineers an integrated experience to easily search, discover, analyze and transform data and associated metadata.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

get_task

get_task(request: Optional[Union[google.cloud.dataplex_v1.types.service.GetTaskRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Get task resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.GetTaskRequest, dict]` The request object. Get task request.
`name`	`str` Required. The resource name of the task: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}` 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.dataplex_v1.types.Task`	A task represents a user-visible job.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

get_zone

get_zone(request: Optional[Union[google.cloud.dataplex_v1.types.service.GetZoneRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves a zone resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.GetZoneRequest, dict]` The request object. Get zone request.
`name`	`str` Required. The resource name of the zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. 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.dataplex_v1.types.Zone`	A zone represents a logical group of related assets within a lake. A zone can be used to map to organizational structure or represent stages of data readiness from raw to curated. It provides managing behavior that is shared or inherited by all contained assets.

job_path

job_path(project: str, location: str, lake: str, task: str, job: str)

Returns a fully-qualified job string.

lake_path

lake_path(project: str, location: str, lake: str)

Returns a fully-qualified lake string.

list_asset_actions

list_asset_actions(request: Optional[Union[google.cloud.dataplex_v1.types.service.ListAssetActionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists action resources in an asset.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.ListAssetActionsRequest, dict]` The request object. List asset actions request.
`parent`	`str` Required. The resource name of the parent asset: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}`. 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.dataplex_v1.services.dataplex_service.pagers.ListAssetActionsAsyncPager`	List actions response. Iterating over this object will yield results and resolve additional pages automatically.

list_assets

list_assets(request: Optional[Union[google.cloud.dataplex_v1.types.service.ListAssetsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists asset resources in a zone.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.ListAssetsRequest, dict]` The request object. List assets request.
`parent`	`str` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. 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.dataplex_v1.services.dataplex_service.pagers.ListAssetsAsyncPager`	List assets response. Iterating over this object will yield results and resolve additional pages automatically.

list_jobs

list_jobs(request: Optional[Union[google.cloud.dataplex_v1.types.service.ListJobsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Jobs under the given task.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.ListJobsRequest, dict]` The request object. List jobs request.
`parent`	`str` Required. The resource name of the parent environment: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`. 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.dataplex_v1.services.dataplex_service.pagers.ListJobsAsyncPager`	List jobs response. Iterating over this object will yield results and resolve additional pages automatically.

list_lake_actions

list_lake_actions(request: Optional[Union[google.cloud.dataplex_v1.types.service.ListLakeActionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists action resources in a lake.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.ListLakeActionsRequest, dict]` The request object. List lake actions request.
`parent`	`str` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}` 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.dataplex_v1.services.dataplex_service.pagers.ListLakeActionsAsyncPager`	List actions response. Iterating over this object will yield results and resolve additional pages automatically.

list_lakes

list_lakes(request: Optional[Union[google.cloud.dataplex_v1.types.service.ListLakesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists lake resources in a project and location.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.ListLakesRequest, dict]` The request object. List lakes request.
`parent`	`str` Required. The resource name of the lake location, of the form: `projects/{project_number}/locations/{location_id}` where `location_id` refers to a GCP region. 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.dataplex_v1.services.dataplex_service.pagers.ListLakesAsyncPager`	List lakes response. Iterating over this object will yield results and resolve additional pages automatically.

list_tasks

list_tasks(request: Optional[Union[google.cloud.dataplex_v1.types.service.ListTasksRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists tasks under the given lake.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.ListTasksRequest, dict]` The request object. List tasks request.
`parent`	`str` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. 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.dataplex_v1.services.dataplex_service.pagers.ListTasksAsyncPager`	List tasks response. Iterating over this object will yield results and resolve additional pages automatically.

list_zone_actions

list_zone_actions(request: Optional[Union[google.cloud.dataplex_v1.types.service.ListZoneActionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists action resources in a zone.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.ListZoneActionsRequest, dict]` The request object. List zone actions request.
`parent`	`str` Required. The resource name of the parent zone: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`. 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.dataplex_v1.services.dataplex_service.pagers.ListZoneActionsAsyncPager`	List actions response. Iterating over this object will yield results and resolve additional pages automatically.

list_zones

list_zones(request: Optional[Union[google.cloud.dataplex_v1.types.service.ListZonesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists zone resources in a lake.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.ListZonesRequest, dict]` The request object. List zones request.
`parent`	`str` Required. The resource name of the parent lake: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. 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.dataplex_v1.services.dataplex_service.pagers.ListZonesAsyncPager`	List zones response. Iterating over this object will yield results and resolve additional pages automatically.

parse_action_path

parse_action_path(path: str)

Parses a action path into its component segments.

parse_asset_path

parse_asset_path(path: str)

Parses a asset 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_job_path

parse_job_path(path: str)

Parses a job path into its component segments.

parse_lake_path

parse_lake_path(path: str)

Parses a lake path into its component segments.

parse_task_path

parse_task_path(path: str)

Parses a task path into its component segments.

parse_zone_path

parse_zone_path(path: str)

Parses a zone path into its component segments.

task_path

task_path(project: str, location: str, lake: str, task: str)

Returns a fully-qualified task string.

update_asset

update_asset(request: Optional[Union[google.cloud.dataplex_v1.types.service.UpdateAssetRequest, dict]] = None, *, asset: Optional[google.cloud.dataplex_v1.types.resources.Asset] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an asset resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.UpdateAssetRequest, dict]` The request object. Update asset request.
`asset`	`Asset` Required. Update description. Only fields specified in `update_mask` are updated. This corresponds to the `asset` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. Mask of fields to update. 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.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Asset An asset represents a cloud resource that is being managed within a lake as a member of a zone.

update_lake

update_lake(request: Optional[Union[google.cloud.dataplex_v1.types.service.UpdateLakeRequest, dict]] = None, *, lake: Optional[google.cloud.dataplex_v1.types.resources.Lake] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a lake resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.UpdateLakeRequest, dict]` The request object. Update lake request.
`lake`	`Lake` Required. Update description. Only fields specified in `update_mask` are updated. This corresponds to the `lake` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. Mask of fields to update. 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

update_task

update_task(request: Optional[Union[google.cloud.dataplex_v1.types.service.UpdateTaskRequest, dict]] = None, *, task: Optional[google.cloud.dataplex_v1.types.tasks.Task] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Update the task resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.UpdateTaskRequest, dict]` The request object. Update task request.
`task`	`Task` Required. Update description. Only fields specified in `update_mask` are updated. This corresponds to the `task` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. Mask of fields to update. 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.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Task A task represents a user-visible job.

update_zone

update_zone(request: Optional[Union[google.cloud.dataplex_v1.types.service.UpdateZoneRequest, dict]] = None, *, zone: Optional[google.cloud.dataplex_v1.types.resources.Zone] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a zone resource.

Parameters
Name	Description
`request`	`Union[google.cloud.dataplex_v1.types.UpdateZoneRequest, dict]` The request object. Update zone request.
`zone`	`Zone` Required. Update description. Only fields specified in `update_mask` are updated. This corresponds to the `zone` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. Mask of fields to update. 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.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Zone A zone represents a logical group of related assets within a lake. A zone can be used to map to organizational structure or represent stages of data readiness from raw to curated. It provides managing behavior that is shared or inherited by all contained assets.

zone_path

zone_path(project: str, location: str, lake: str, zone: str)

Returns a fully-qualified zone string.