Package Classes (2.3.1)

Summary of entries of Classes for dataplex.

Classes

CatalogServiceAsyncClient

The primary resources offered by this service are EntryGroups, EntryTypes, AspectTypes, Entry and Aspect which collectively allow a data administrator 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.

CatalogServiceClient

ListAspectTypesAsyncPager

A pager for iterating through list_aspect_types requests.

This class thinly wraps an initial ListAspectTypesResponse object, and provides an __aiter__ method to iterate through its aspect_types field.

If there are more pages, the __aiter__ method will make additional ListAspectTypes requests and continue to iterate through the aspect_types field on the corresponding responses.

All the usual ListAspectTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAspectTypesPager

A pager for iterating through list_aspect_types requests.

This class thinly wraps an initial ListAspectTypesResponse object, and provides an __iter__ method to iterate through its aspect_types field.

If there are more pages, the __iter__ method will make additional ListAspectTypes requests and continue to iterate through the aspect_types field on the corresponding responses.

All the usual ListAspectTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEntriesAsyncPager

A pager for iterating through list_entries requests.

This class thinly wraps an initial ListEntriesResponse object, and provides an __aiter__ method to iterate through its entries field.

If there are more pages, the __aiter__ method will make additional ListEntries requests and continue to iterate through the entries field on the corresponding responses.

All the usual ListEntriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEntriesPager

A pager for iterating through list_entries requests.

This class thinly wraps an initial ListEntriesResponse object, and provides an __iter__ method to iterate through its entries field.

If there are more pages, the __iter__ method will make additional ListEntries requests and continue to iterate through the entries field on the corresponding responses.

All the usual ListEntriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEntryGroupsAsyncPager

A pager for iterating through list_entry_groups requests.

This class thinly wraps an initial ListEntryGroupsResponse object, and provides an __aiter__ method to iterate through its entry_groups field.

If there are more pages, the __aiter__ method will make additional ListEntryGroups requests and continue to iterate through the entry_groups field on the corresponding responses.

All the usual ListEntryGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEntryGroupsPager

A pager for iterating through list_entry_groups requests.

This class thinly wraps an initial ListEntryGroupsResponse object, and provides an __iter__ method to iterate through its entry_groups field.

If there are more pages, the __iter__ method will make additional ListEntryGroups requests and continue to iterate through the entry_groups field on the corresponding responses.

All the usual ListEntryGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEntryTypesAsyncPager

A pager for iterating through list_entry_types requests.

This class thinly wraps an initial ListEntryTypesResponse object, and provides an __aiter__ method to iterate through its entry_types field.

If there are more pages, the __aiter__ method will make additional ListEntryTypes requests and continue to iterate through the entry_types field on the corresponding responses.

All the usual ListEntryTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEntryTypesPager

A pager for iterating through list_entry_types requests.

This class thinly wraps an initial ListEntryTypesResponse object, and provides an __iter__ method to iterate through its entry_types field.

If there are more pages, the __iter__ method will make additional ListEntryTypes requests and continue to iterate through the entry_types field on the corresponding responses.

All the usual ListEntryTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchEntriesAsyncPager

A pager for iterating through search_entries requests.

This class thinly wraps an initial SearchEntriesResponse object, and provides an __aiter__ method to iterate through its results field.

If there are more pages, the __aiter__ method will make additional SearchEntries requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchEntriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchEntriesPager

A pager for iterating through search_entries requests.

This class thinly wraps an initial SearchEntriesResponse object, and provides an __iter__ method to iterate through its results field.

If there are more pages, the __iter__ method will make additional SearchEntries requests and continue to iterate through the results field on the corresponding responses.

All the usual SearchEntriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ContentServiceAsyncClient

ContentService manages Notebook and SQL Scripts for Dataplex.

ContentServiceClient

ContentService manages Notebook and SQL Scripts for Dataplex.

ListContentAsyncPager

A pager for iterating through list_content requests.

This class thinly wraps an initial ListContentResponse object, and provides an __aiter__ method to iterate through its content field.

If there are more pages, the __aiter__ method will make additional ListContent requests and continue to iterate through the content field on the corresponding responses.

All the usual ListContentResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListContentPager

A pager for iterating through list_content requests.

This class thinly wraps an initial ListContentResponse object, and provides an __iter__ method to iterate through its content field.

If there are more pages, the __iter__ method will make additional ListContent requests and continue to iterate through the content field on the corresponding responses.

All the usual ListContentResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

DataScanServiceAsyncClient

DataScanService manages DataScan resources which can be configured to run various types of data scanning workload and generate enriched metadata (e.g. Data Profile, Data Quality) for the data source.

DataScanServiceClient

DataScanService manages DataScan resources which can be configured to run various types of data scanning workload and generate enriched metadata (e.g. Data Profile, Data Quality) for the data source.

ListDataScanJobsAsyncPager

A pager for iterating through list_data_scan_jobs requests.

This class thinly wraps an initial ListDataScanJobsResponse object, and provides an __aiter__ method to iterate through its data_scan_jobs field.

If there are more pages, the __aiter__ method will make additional ListDataScanJobs requests and continue to iterate through the data_scan_jobs field on the corresponding responses.

All the usual ListDataScanJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataScanJobsPager

A pager for iterating through list_data_scan_jobs requests.

This class thinly wraps an initial ListDataScanJobsResponse object, and provides an __iter__ method to iterate through its data_scan_jobs field.

If there are more pages, the __iter__ method will make additional ListDataScanJobs requests and continue to iterate through the data_scan_jobs field on the corresponding responses.

All the usual ListDataScanJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataScansAsyncPager

A pager for iterating through list_data_scans requests.

This class thinly wraps an initial ListDataScansResponse object, and provides an __aiter__ method to iterate through its data_scans field.

If there are more pages, the __aiter__ method will make additional ListDataScans requests and continue to iterate through the data_scans field on the corresponding responses.

All the usual ListDataScansResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataScansPager

A pager for iterating through list_data_scans requests.

This class thinly wraps an initial ListDataScansResponse object, and provides an __iter__ method to iterate through its data_scans field.

If there are more pages, the __iter__ method will make additional ListDataScans requests and continue to iterate through the data_scans field on the corresponding responses.

All the usual ListDataScansResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

DataTaxonomyServiceAsyncClient

DataTaxonomyService enables attribute-based governance. The resources currently offered include DataTaxonomy and DataAttribute.

DataTaxonomyServiceClient

DataTaxonomyService enables attribute-based governance. The resources currently offered include DataTaxonomy and DataAttribute.

ListDataAttributeBindingsAsyncPager

A pager for iterating through list_data_attribute_bindings requests.

This class thinly wraps an initial ListDataAttributeBindingsResponse object, and provides an __aiter__ method to iterate through its data_attribute_bindings field.

If there are more pages, the __aiter__ method will make additional ListDataAttributeBindings requests and continue to iterate through the data_attribute_bindings field on the corresponding responses.

All the usual ListDataAttributeBindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataAttributeBindingsPager

A pager for iterating through list_data_attribute_bindings requests.

This class thinly wraps an initial ListDataAttributeBindingsResponse object, and provides an __iter__ method to iterate through its data_attribute_bindings field.

If there are more pages, the __iter__ method will make additional ListDataAttributeBindings requests and continue to iterate through the data_attribute_bindings field on the corresponding responses.

All the usual ListDataAttributeBindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataAttributesAsyncPager

A pager for iterating through list_data_attributes requests.

This class thinly wraps an initial ListDataAttributesResponse object, and provides an __aiter__ method to iterate through its data_attributes field.

If there are more pages, the __aiter__ method will make additional ListDataAttributes requests and continue to iterate through the data_attributes field on the corresponding responses.

All the usual ListDataAttributesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataAttributesPager

A pager for iterating through list_data_attributes requests.

This class thinly wraps an initial ListDataAttributesResponse object, and provides an __iter__ method to iterate through its data_attributes field.

If there are more pages, the __iter__ method will make additional ListDataAttributes requests and continue to iterate through the data_attributes field on the corresponding responses.

All the usual ListDataAttributesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataTaxonomiesAsyncPager

A pager for iterating through list_data_taxonomies requests.

This class thinly wraps an initial ListDataTaxonomiesResponse object, and provides an __aiter__ method to iterate through its data_taxonomies field.

If there are more pages, the __aiter__ method will make additional ListDataTaxonomies requests and continue to iterate through the data_taxonomies field on the corresponding responses.

All the usual ListDataTaxonomiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataTaxonomiesPager

A pager for iterating through list_data_taxonomies requests.

This class thinly wraps an initial ListDataTaxonomiesResponse object, and provides an __iter__ method to iterate through its data_taxonomies field.

If there are more pages, the __iter__ method will make additional ListDataTaxonomies requests and continue to iterate through the data_taxonomies field on the corresponding responses.

All the usual ListDataTaxonomiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

DataplexServiceAsyncClient

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

DataplexServiceClient

ListAssetActionsAsyncPager

A pager for iterating through list_asset_actions requests.

This class thinly wraps an initial ListActionsResponse object, and provides an __aiter__ method to iterate through its actions field.

If there are more pages, the __aiter__ method will make additional ListAssetActions requests and continue to iterate through the actions field on the corresponding responses.

All the usual ListActionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAssetActionsPager

A pager for iterating through list_asset_actions requests.

This class thinly wraps an initial ListActionsResponse object, and provides an __iter__ method to iterate through its actions field.

If there are more pages, the __iter__ method will make additional ListAssetActions requests and continue to iterate through the actions field on the corresponding responses.

All the usual ListActionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAssetsAsyncPager

A pager for iterating through list_assets requests.

This class thinly wraps an initial ListAssetsResponse object, and provides an __aiter__ method to iterate through its assets field.

If there are more pages, the __aiter__ method will make additional ListAssets requests and continue to iterate through the assets field on the corresponding responses.

All the usual ListAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAssetsPager

A pager for iterating through list_assets requests.

This class thinly wraps an initial ListAssetsResponse object, and provides an __iter__ method to iterate through its assets field.

If there are more pages, the __iter__ method will make additional ListAssets requests and continue to iterate through the assets field on the corresponding responses.

All the usual ListAssetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEnvironmentsAsyncPager

A pager for iterating through list_environments requests.

This class thinly wraps an initial ListEnvironmentsResponse object, and provides an __aiter__ method to iterate through its environments field.

If there are more pages, the __aiter__ method will make additional ListEnvironments requests and continue to iterate through the environments field on the corresponding responses.

All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEnvironmentsPager

A pager for iterating through list_environments requests.

This class thinly wraps an initial ListEnvironmentsResponse object, and provides an __iter__ method to iterate through its environments field.

If there are more pages, the __iter__ method will make additional ListEnvironments requests and continue to iterate through the environments field on the corresponding responses.

All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListJobsAsyncPager

A pager for iterating through list_jobs requests.

This class thinly wraps an initial ListJobsResponse object, and provides an __aiter__ method to iterate through its jobs field.

If there are more pages, the __aiter__ method will make additional ListJobs requests and continue to iterate through the jobs field on the corresponding responses.

All the usual ListJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListJobsPager

A pager for iterating through list_jobs requests.

This class thinly wraps an initial ListJobsResponse object, and provides an __iter__ method to iterate through its jobs field.

If there are more pages, the __iter__ method will make additional ListJobs requests and continue to iterate through the jobs field on the corresponding responses.

All the usual ListJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListLakeActionsAsyncPager

A pager for iterating through list_lake_actions requests.

This class thinly wraps an initial ListActionsResponse object, and provides an __aiter__ method to iterate through its actions field.

If there are more pages, the __aiter__ method will make additional ListLakeActions requests and continue to iterate through the actions field on the corresponding responses.

All the usual ListActionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListLakeActionsPager

A pager for iterating through list_lake_actions requests.

This class thinly wraps an initial ListActionsResponse object, and provides an __iter__ method to iterate through its actions field.

If there are more pages, the __iter__ method will make additional ListLakeActions requests and continue to iterate through the actions field on the corresponding responses.

All the usual ListActionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListLakesAsyncPager

A pager for iterating through list_lakes requests.

This class thinly wraps an initial ListLakesResponse object, and provides an __aiter__ method to iterate through its lakes field.

If there are more pages, the __aiter__ method will make additional ListLakes requests and continue to iterate through the lakes field on the corresponding responses.

All the usual ListLakesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListLakesPager

A pager for iterating through list_lakes requests.

This class thinly wraps an initial ListLakesResponse object, and provides an __iter__ method to iterate through its lakes field.

If there are more pages, the __iter__ method will make additional ListLakes requests and continue to iterate through the lakes field on the corresponding responses.

All the usual ListLakesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSessionsAsyncPager

A pager for iterating through list_sessions requests.

This class thinly wraps an initial ListSessionsResponse object, and provides an __aiter__ method to iterate through its sessions field.

If there are more pages, the __aiter__ method will make additional ListSessions requests and continue to iterate through the sessions field on the corresponding responses.

All the usual ListSessionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSessionsPager

A pager for iterating through list_sessions requests.

This class thinly wraps an initial ListSessionsResponse object, and provides an __iter__ method to iterate through its sessions field.

If there are more pages, the __iter__ method will make additional ListSessions requests and continue to iterate through the sessions field on the corresponding responses.

All the usual ListSessionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTasksAsyncPager

A pager for iterating through list_tasks requests.

This class thinly wraps an initial ListTasksResponse object, and provides an __aiter__ method to iterate through its tasks field.

If there are more pages, the __aiter__ method will make additional ListTasks requests and continue to iterate through the tasks field on the corresponding responses.

All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTasksPager

A pager for iterating through list_tasks requests.

This class thinly wraps an initial ListTasksResponse object, and provides an __iter__ method to iterate through its tasks field.

If there are more pages, the __iter__ method will make additional ListTasks requests and continue to iterate through the tasks field on the corresponding responses.

All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListZoneActionsAsyncPager

A pager for iterating through list_zone_actions requests.

This class thinly wraps an initial ListActionsResponse object, and provides an __aiter__ method to iterate through its actions field.

If there are more pages, the __aiter__ method will make additional ListZoneActions requests and continue to iterate through the actions field on the corresponding responses.

All the usual ListActionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListZoneActionsPager

A pager for iterating through list_zone_actions requests.

This class thinly wraps an initial ListActionsResponse object, and provides an __iter__ method to iterate through its actions field.

If there are more pages, the __iter__ method will make additional ListZoneActions requests and continue to iterate through the actions field on the corresponding responses.

All the usual ListActionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListZonesAsyncPager

A pager for iterating through list_zones requests.

This class thinly wraps an initial ListZonesResponse object, and provides an __aiter__ method to iterate through its zones field.

If there are more pages, the __aiter__ method will make additional ListZones requests and continue to iterate through the zones field on the corresponding responses.

All the usual ListZonesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListZonesPager

A pager for iterating through list_zones requests.

This class thinly wraps an initial ListZonesResponse object, and provides an __iter__ method to iterate through its zones field.

If there are more pages, the __iter__ method will make additional ListZones requests and continue to iterate through the zones field on the corresponding responses.

All the usual ListZonesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

MetadataServiceAsyncClient

Metadata service manages metadata resources such as tables, filesets and partitions.

MetadataServiceClient

Metadata service manages metadata resources such as tables, filesets and partitions.

ListEntitiesAsyncPager

A pager for iterating through list_entities requests.

This class thinly wraps an initial ListEntitiesResponse object, and provides an __aiter__ method to iterate through its entities field.

If there are more pages, the __aiter__ method will make additional ListEntities requests and continue to iterate through the entities field on the corresponding responses.

All the usual ListEntitiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEntitiesPager

A pager for iterating through list_entities requests.

This class thinly wraps an initial ListEntitiesResponse object, and provides an __iter__ method to iterate through its entities field.

If there are more pages, the __iter__ method will make additional ListEntities requests and continue to iterate through the entities field on the corresponding responses.

All the usual ListEntitiesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPartitionsAsyncPager

A pager for iterating through list_partitions requests.

This class thinly wraps an initial ListPartitionsResponse object, and provides an __aiter__ method to iterate through its partitions field.

If there are more pages, the __aiter__ method will make additional ListPartitions requests and continue to iterate through the partitions field on the corresponding responses.

All the usual ListPartitionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPartitionsPager

A pager for iterating through list_partitions requests.

This class thinly wraps an initial ListPartitionsResponse object, and provides an __iter__ method to iterate through its partitions field.

If there are more pages, the __iter__ method will make additional ListPartitions requests and continue to iterate through the partitions field on the corresponding responses.

All the usual ListPartitionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Action

Action represents an issue requiring administrator action for resolution.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FailedSecurityPolicyApply

Failed to apply security policy to the managed resource(s) under a lake, zone or an asset. For a lake or zone resource, one or more underlying assets has a failure applying security policy to the associated managed resource.

IncompatibleDataSchema

Action details for incompatible schemas detected by discovery.

SchemaChange

Whether the action relates to a schema that is incompatible or modified.

InvalidDataFormat

Action details for invalid or unsupported data files detected by discovery.

InvalidDataOrganization

Action details for invalid data arrangement.

InvalidDataPartition

Action details for invalid or unsupported partitions detected by discovery.

PartitionStructure

The expected partition structure.

MissingData

Action details for absence of data detected by discovery.

MissingResource

Action details for resource references in assets that cannot be located.

UnauthorizedResource

Action details for unauthorized resource issues raised to indicate that the service account associated with the lake instance is not authorized to access or manage the resource associated with an asset.

Aspect

An aspect is a single piece of metadata describing an entry.

AspectSource

AspectSource contains source system related information for the aspect.

AspectType

Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema.

Authorization

Autorization for an Aspect Type.

LabelsEntry

The abstract base class for a message.

MetadataTemplate

MetadataTemplate definition for AspectType

Annotations

Definition of the annotations of a field

Constraints

Definition of the constraints of a field

EnumValue

Definition of Enumvalue (to be used by enum fields)

Asset

An asset represents a cloud resource that is being managed within a lake as a member of a zone.

DiscoverySpec

Settings to manage the metadata discovery and publishing for an asset.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CsvOptions

Describe CSV and similar semi-structured data formats.

JsonOptions

Describe JSON data format.

DiscoveryStatus

Status of discovery for an asset.

State

Current state of discovery.

Stats

The aggregated data statistics for the asset reported by discovery.

LabelsEntry

The abstract base class for a message.

ResourceSpec

Identifies the cloud resource that is referenced by this asset.

AccessMode

Access Mode determines how data stored within the resource is read. This is only applicable to storage bucket assets.

Type

Type of resource.

ResourceStatus

Status of the resource referenced by an asset.

State

The state of a resource.

SecurityStatus

Security policy status of the asset. Data security policy, i.e., readers, writers & owners, should be specified in the lake/zone/asset IAM policy.

State

The state of the security policy.

AssetStatus

Aggregated status of the underlying assets of a lake or zone.

CancelJobRequest

Cancel task jobs.

Content

Content represents a user-visible notebook or a sql script

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LabelsEntry

The abstract base class for a message.

Notebook

Configuration for Notebook content.

KernelType

Kernel Type of the Jupyter notebook.

SqlScript

Configuration for the Sql Script content.

QueryEngine

Query Engine Type of the SQL Script.

CreateAspectTypeRequest

Create AspectType Request

CreateAssetRequest

Create asset request.

CreateContentRequest

Create content request.

CreateDataAttributeBindingRequest

Create DataAttributeBinding request.

CreateDataAttributeRequest

Create DataAttribute request.

CreateDataScanRequest

Create dataScan request.

CreateDataTaxonomyRequest

Create DataTaxonomy request.

CreateEntityRequest

Create a metadata entity request.

CreateEntryGroupRequest

Create EntryGroup Request

CreateEntryRequest

CreateEntryTypeRequest

Create EntryType Request

CreateEnvironmentRequest

Create environment request.

CreateLakeRequest

Create lake request.

CreatePartitionRequest

Create metadata partition request.

CreateTaskRequest

Create task request.

CreateZoneRequest

Create zone request.

DataAccessSpec

DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access.

DataAttribute

Denotes one dataAttribute in a dataTaxonomy, for example, PII. DataAttribute resources can be defined in a hierarchy. A single dataAttribute resource can contain specs of multiple types

PII

ResourceAccessSpec :
- readers :foo@bar.com
DataAccessSpec :
- readers :bar@foo.com

LabelsEntry

The abstract base class for a message.

DataAttributeBinding

DataAttributeBinding represents binding of attributes to resources. Eg: Bind 'CustomerInfo' entity with 'PII' attribute.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LabelsEntry

The abstract base class for a message.

Path

Represents a subresource of the given resource, and associated bindings with it. Currently supported subresources are column and partition schema fields within a table.

DataProfileResult

DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result.

PostScanActionsResult

The result of post scan actions of DataProfileScan job.

BigQueryExportResult

The result of BigQuery export post scan action.

State

Execution state for the exporting.

Profile

Contains name, type, mode and field type specific profile information.

Field

A field within a table.

ProfileInfo

The profile information for each field type.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DoubleFieldInfo

The profile information for a double type field.

IntegerFieldInfo

The profile information for an integer type field.

StringFieldInfo

The profile information for a string type field.

TopNValue

Top N non-null values in the scanned data.

DataProfileSpec

DataProfileScan related setting.

PostScanActions

The configuration of post scan actions of DataProfileScan job.

BigQueryExport

The configuration of BigQuery export post scan action.

SelectedFields

The specification for fields to include or exclude in data profile scan.

DataQualityColumnResult

DataQualityColumnResult provides a more detailed, per-column view of the results.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DataQualityDimension

A dimension captures data quality intent about a defined subset of the rules specified.

DataQualityDimensionResult

DataQualityDimensionResult provides a more detailed, per-dimension view of the results.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DataQualityResult

The output of a DataQualityScan.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PostScanActionsResult

The result of post scan actions of DataQualityScan job.

BigQueryExportResult

The result of BigQuery export post scan action.

State

Execution state for the exporting.

DataQualityRule

A rule captures data quality intent about a data source.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NonNullExpectation

Evaluates whether each column value is null.

RangeExpectation

Evaluates whether each column value lies between a specified range.

RegexExpectation

Evaluates whether each column value matches a specified regex.

RowConditionExpectation

Evaluates whether each row passes the specified condition.

The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean value per row as the result.

Example: col1 >= 0 AND col2 < 10

SetExpectation

Evaluates whether each column value is contained by a specified set.

SqlAssertion

A SQL statement that is evaluated to return rows that match an invalid state. If any rows are are returned, this rule fails.

The SQL statement must use BigQuery standard SQL syntax, and must not contain any semicolons.

You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter <https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter>__.

Example: SELECT * FROM ${data()} WHERE price < 0

StatisticRangeExpectation

Evaluates whether the column aggregate statistic lies between a specified range.

ColumnStatistic

The list of aggregate metrics a rule can be evaluated against.

TableConditionExpectation

Evaluates whether the provided expression is true.

The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.

Example: MIN(col1) >= 0

UniquenessExpectation

Evaluates whether the column has duplicates.

DataQualityRuleResult

DataQualityRuleResult provides a more detailed, per-rule view of the results.

DataQualityScanRuleResult

Information about the result of a data quality rule for data quality scan. The monitored resource is 'DataScan'.

EvaluationType

The evaluation type of the data quality rule.

Result

Whether the data quality rule passed or failed.

RuleType

The type of the data quality rule.

DataQualitySpec

DataQualityScan related setting.

PostScanActions

The configuration of post scan actions of DataQualityScan.

BigQueryExport

The configuration of BigQuery export post scan action.

JobEndTrigger

This trigger is triggered whenever a scan job run ends, regardless of the result.

JobFailureTrigger

This trigger is triggered when the scan job itself fails, regardless of the result.

NotificationReport

The configuration of notification report post scan action.

Recipients

The individuals or groups who are designated to receive notifications upon triggers.

ScoreThresholdTrigger

This trigger is triggered when the DQ score in the job result is less than a specified input score.

DataScan

Represents a user-visible job which provides the insights for the related data source.

For example:

Data Quality: generates queries based on the rules and runs against the data to get data quality check results.
Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExecutionSpec

DataScan execution settings.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExecutionStatus

Status of the data scan execution.

LabelsEntry

The abstract base class for a message.

DataScanEvent

These messages contain information about the execution of a datascan. The monitored resource is 'DataScan' Next ID: 13

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DataProfileAppliedConfigs

Applied configs for data profile type data scan job.

DataProfileResult

Data profile result for data scan job.

DataQualityAppliedConfigs

Applied configs for data quality type data scan job.

DataQualityResult

Data quality result for data scan job.

ColumnScoreEntry

The abstract base class for a message.

DimensionPassedEntry

The abstract base class for a message.

DimensionScoreEntry

The abstract base class for a message.

PostScanActionsResult

Post scan actions result for data scan job.

BigQueryExportResult

The result of BigQuery export post scan action.

State

Execution state for the exporting.

ScanType

The type of the data scan.

Scope

The scope of job for the data scan.

State

The job state of the data scan.

Trigger

The trigger type for the data scan.

DataScanJob

A DataScanJob represents an instance of DataScan execution.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

Execution state for the DataScanJob.

DataScanType

The type of DataScan.

DataSource

The data source for DataScan.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DataTaxonomy

DataTaxonomy represents a set of hierarchical DataAttributes resources, grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have attributes to manage PII data. It is defined at project level.

LabelsEntry

The abstract base class for a message.

DeleteAspectTypeRequest

Delele AspectType Request

DeleteAssetRequest

Delete asset request.

DeleteContentRequest

Delete content request.

DeleteDataAttributeBindingRequest

Delete DataAttributeBinding request.

DeleteDataAttributeRequest

Delete DataAttribute request.

DeleteDataScanRequest

Delete dataScan request.

DeleteDataTaxonomyRequest

Delete DataTaxonomy request.

DeleteEntityRequest

Delete a metadata entity request.

DeleteEntryGroupRequest

Delele EntryGroup Request

DeleteEntryRequest

DeleteEntryTypeRequest

Delele EntryType Request

DeleteEnvironmentRequest

Delete environment request.

DeleteLakeRequest

Delete lake request.

DeletePartitionRequest

Delete metadata partition request.

DeleteTaskRequest

Delete task request.

DeleteZoneRequest

Delete zone request.

DiscoveryEvent

The payload associated with Discovery data processing.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ActionDetails

Details about the action.

ConfigDetails

Details about configuration events.

ParametersEntry

The abstract base class for a message.

EntityDetails

Details about the entity.

EntityType

The type of the entity.

EventType

The type of the event.

PartitionDetails

Details about the partition.

Entity

Represents tables and fileset metadata contained within a zone.

CompatibilityStatus

Provides compatibility information for various metadata stores.

Compatibility

Provides compatibility information for a specific metadata store.

Type

The type of entity.

Entry

An entry is a representation of a data asset which can be described by various metadata.

AspectsEntry

The abstract base class for a message.

EntryGroup

An Entry Group represents a logical grouping of one or more Entries.

LabelsEntry

The abstract base class for a message.

EntrySource

EntrySource contains source system related information for the entry.

Ancestor

Ancestor contains information about individual items in the hierarchy of an Entry.

LabelsEntry

The abstract base class for a message.

EntryType

Entry Type is a template for creating Entries.

AspectInfo

Authorization

Authorization for an Entry Type.

LabelsEntry

The abstract base class for a message.

EntryView

View for controlling which parts of an entry are to be returned.

Environment

Environment represents a user-visible compute infrastructure for analytics within a lake.

Endpoints

URI Endpoints to access sessions associated with the Environment.

InfrastructureSpec

Configuration for the underlying infrastructure used to run workloads.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ComputeResources

Compute resources associated with the analyze interactive workloads.

OsImageRuntime

Software Runtime Configuration to run Analyze.

PropertiesEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

SessionSpec

Configuration for sessions created for this environment.

SessionStatus

Status of sessions created for this environment.

GenerateDataQualityRulesRequest

Request details for generating data quality rule recommendations.

GenerateDataQualityRulesResponse

Response details for data quality rule recommendations.

GetAspectTypeRequest

Get AspectType request

GetAssetRequest

Get asset request.

GetContentRequest

Get content request.

ContentView

Specifies whether the request should return the full or the partial representation.

GetDataAttributeBindingRequest

Get DataAttributeBinding request.

GetDataAttributeRequest

Get DataAttribute request.

GetDataScanJobRequest

Get DataScanJob request.

DataScanJobView

DataScanJob view options.

GetDataScanRequest

Get dataScan request.

DataScanView

DataScan view options.

GetDataTaxonomyRequest

Get DataTaxonomy request.

GetEntityRequest

Get metadata entity request.

EntityView

Entity views for get entity partial result.

GetEntryGroupRequest

Get EntryGroup request.

GetEntryRequest

GetEntryTypeRequest

Get EntryType request

GetEnvironmentRequest

Get environment request.

GetJobRequest

Get job request.

GetLakeRequest

Get lake request.

GetPartitionRequest

Get metadata partition request.

GetTaskRequest

Get task request.

GetZoneRequest

Get zone request.

GovernanceEvent

Payload associated with Governance related log events.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Entity

Information about Entity resource that the log event is associated with.

EntityType

Type of entity.

EventType

Type of governance log event.

Job

A job represents an instance of a task.

LabelsEntry

The abstract base class for a message.

Service

State

Trigger

Job execution trigger.

JobEvent

The payload associated with Job logs that contains events describing jobs that have run within a Lake.

ExecutionTrigger

Job Execution trigger.

Service

The service used to execute the job.

State

The completion status of the job.

Type

The type of the job.

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.

LabelsEntry

The abstract base class for a message.

Metastore

Settings to manage association of Dataproc Metastore with a lake.

MetastoreStatus

Status of Lake and Dataproc Metastore service instance association.

State

Current state of association.

ListActionsResponse

List actions response.

ListAspectTypesRequest

List AspectTypes request

ListAspectTypesResponse

List AspectTypes response

ListAssetActionsRequest

List asset actions request.

ListAssetsRequest

List assets request.

ListAssetsResponse

List assets response.

ListContentRequest

List content request. Returns the BASIC Content view.

ListContentResponse

List content response.

ListDataAttributeBindingsRequest

List DataAttributeBindings request.

ListDataAttributeBindingsResponse

List DataAttributeBindings response.

ListDataAttributesRequest

List DataAttributes request.

ListDataAttributesResponse

List DataAttributes response.

ListDataScanJobsRequest

List DataScanJobs request.

ListDataScanJobsResponse

List DataScanJobs response.

ListDataScansRequest

List dataScans request.

ListDataScansResponse

List dataScans response.

ListDataTaxonomiesRequest

List DataTaxonomies request.

ListDataTaxonomiesResponse

List DataTaxonomies response.

ListEntitiesRequest

List metadata entities request.

EntityView

Entity views.

ListEntitiesResponse

List metadata entities response.

ListEntriesRequest

ListEntriesResponse

ListEntryGroupsRequest

List entryGroups request.

ListEntryGroupsResponse

List ListEntryGroups response.

ListEntryTypesRequest

List EntryTypes request

ListEntryTypesResponse

List EntryTypes response

ListEnvironmentsRequest

List environments request.

ListEnvironmentsResponse

List environments response.

ListJobsRequest

List jobs request.

ListJobsResponse

List jobs response.

ListLakeActionsRequest

List lake actions request.

ListLakesRequest

List lakes request.

ListLakesResponse

List lakes response.

ListPartitionsRequest

List metadata partitions request.

ListPartitionsResponse

List metadata partitions response.

ListSessionsRequest

List sessions request.

ListSessionsResponse

List sessions response.

ListTasksRequest

List tasks request.

ListTasksResponse

List tasks response.

ListZoneActionsRequest

List zone actions request.

ListZonesRequest

List zones request.

ListZonesResponse

List zones response.

LookupEntryRequest

OperationMetadata

Represents the metadata of a long-running operation.

Partition

Represents partition metadata contained within entity instances.

ResourceAccessSpec

ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table.

RunDataScanRequest

Run DataScan Request

RunDataScanResponse

Run DataScan Response.

RunTaskRequest

ArgsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

RunTaskResponse

ScannedData

The data scanned during processing (e.g. in incremental DataScan)

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

IncrementalField

A data range denoted by a pair of start/end values of a field.

Schema

Schema information describing the structure and layout of the data.

Mode

Additional qualifiers to define field semantics.

PartitionField

Represents a key field within the entity's partition structure. You could have up to 20 partition fields, but only the first 10 partitions have the filtering ability due to performance consideration. Note: Partition fields are immutable.

PartitionStyle

The structure of paths within the entity, which represent partitions.

SchemaField

Represents a column field within a table schema.

Type

Type information for fields in schemas and partition schemas.

SearchEntriesRequest

SearchEntriesResponse

SearchEntriesResult

A single result of a SearchEntries request.

Snippets

Snippets for the entry, contains HTML-style highlighting for matched tokens, will be used in UI.

Session

Represents an active analyze session running for a user.

SessionEvent

These messages contain information about sessions within an environment. The monitored resource is 'Environment'.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EventType

The type of the event.

QueryDetail

Execution details of the query.

Engine

Query Execution engine.

State

State of a resource.

StorageAccess

Describes the access mechanism of the data within its storage location.

AccessMode

Access Mode determines how data stored within the Entity is read.

StorageFormat

Describes the format of the data within its storage location.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CompressionFormat

The specific compressed file format of the data.

CsvOptions

Describes CSV and similar semi-structured data formats.

Format

The specific file format of the data.

IcebergOptions

Describes Iceberg data format.

JsonOptions

Describes JSON data format.

StorageSystem

Identifies the cloud system that manages the data storage.

Task

A task represents a user-visible job.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExecutionSpec

Execution related settings, like retry and service_account.

ArgsEntry

The abstract base class for a message.

ExecutionStatus

Status of the task execution (e.g. Jobs).

InfrastructureSpec

Configuration for the underlying infrastructure used to run workloads.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BatchComputeResources

Batch compute resources associated with the task.

ContainerImageRuntime

Container Image Runtime Configuration used with Batch execution.

PropertiesEntry

The abstract base class for a message.

VpcNetwork

Cloud VPC Network used to run the infrastructure.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LabelsEntry

The abstract base class for a message.

NotebookTaskConfig

Config for running scheduled notebooks.

SparkTaskConfig

User-specified config for running a Spark task.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TriggerSpec

Task scheduling and trigger settings.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Type

Determines how often and when the job will run.

TransferStatus

Denotes the transfer status of a resource. It is unspecified for resources created from Dataplex API.

Trigger

DataScan scheduling and trigger settings.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

OnDemand

The scan runs once via RunDataScan API.

Schedule

The scan is scheduled to run periodically.

UpdateAspectTypeRequest

Update AspectType Request

UpdateAssetRequest

Update asset request.

UpdateContentRequest

Update content request.

UpdateDataAttributeBindingRequest

Update DataAttributeBinding request.

UpdateDataAttributeRequest

Update DataAttribute request.

UpdateDataScanRequest

Update dataScan request.

UpdateDataTaxonomyRequest

Update DataTaxonomy request.

UpdateEntityRequest

Update a metadata entity request. The exiting entity will be fully replaced by the entity in the request. The entity ID is mutable. To modify the ID, use the current entity ID in the request URL and specify the new ID in the request body.

UpdateEntryGroupRequest

Update EntryGroup Request

UpdateEntryRequest

UpdateEntryTypeRequest

Update EntryType Request

UpdateEnvironmentRequest

Update environment request.

UpdateLakeRequest

Update lake request.

UpdateTaskRequest

Update task request.

UpdateZoneRequest

Update zone request.

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.