Package Classes (2.3.0)

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

ContentService manages Notebook and SQL Scripts for Dataplex.

ContentService manages Notebook and SQL Scripts for Dataplex.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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.

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.

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.

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

The category of issues.

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.

Action details for incompatible schemas detected by discovery.

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

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

Action details for invalid data arrangement.

Action details for invalid or unsupported partitions detected by discovery.

The expected partition structure.

Action details for absence of data detected by discovery.

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

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.

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

AspectSource contains source system related information for the aspect.

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

Autorization for an Aspect Type.

The abstract base class for a message.

MetadataTemplate definition for AspectType

Definition of the annotations of a field

Definition of the constraints of a field

Definition of Enumvalue (to be used by enum fields)

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

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

Describe CSV and similar semi-structured data formats.

Describe JSON data format.

Status of discovery for an asset.

Current state of discovery.

The aggregated data statistics for the asset reported by discovery.

The abstract base class for a message.

Identifies the cloud resource that is referenced by this asset.

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

Type of resource.

Status of the resource referenced by an asset.

The state of a resource.

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

The state of the security policy.

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

Cancel task jobs.

Content represents a user-visible notebook or a sql script

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

The abstract base class for a message.

Configuration for Notebook content.

Kernel Type of the Jupyter notebook.

Configuration for the Sql Script content.

Query Engine Type of the SQL Script.

Create AspectType Request

Create asset request.

Create content request.

Create DataAttributeBinding request.

Create DataAttribute request.

Create dataScan request.

Create DataTaxonomy request.

Create a metadata entity request.

Create EntryGroup Request

Create EntryType Request

Create environment request.

Create lake request.

Create metadata partition request.

Create task request.

Create zone request.

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.

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

The abstract base class for a message.

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

The abstract base class for a message.

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 defines the output of DataProfileScan. Each field of the table will have field type specific profile result.

The result of post scan actions of DataProfileScan job.

The result of BigQuery export post scan action.

Execution state for the exporting.

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

A field within a table.

The profile information for each field type.

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

The profile information for a double type field.

The profile information for an integer type field.

The profile information for a string type field.

Top N non-null values in the scanned data.

DataProfileScan related setting.

The configuration of post scan actions of DataProfileScan job.

The configuration of BigQuery export post scan action.

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

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

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

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

The output of a DataQualityScan.

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

The result of post scan actions of DataQualityScan job.

The result of BigQuery export post scan action.

Execution state for the exporting.

A rule captures data quality intent about a data source.

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

Evaluates whether each column value is null.

Evaluates whether each column value lies between a specified range.

Evaluates whether each column value matches a specified regex.

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

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

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

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

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

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

Evaluates whether the column has duplicates.

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

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

The evaluation type of the data quality rule.

Whether the data quality rule passed or failed.

The type of the data quality rule.

DataQualityScan related setting.

The configuration of post scan actions of DataQualityScan.

The configuration of BigQuery export post scan action.

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

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

The configuration of notification report post scan action.

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

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

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

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

DataScan execution settings.

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

Status of the data scan execution.

The abstract base class for a message.

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

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

Applied configs for data profile type data scan job.

Data profile result for data scan job.

Applied configs for data quality type data scan job.

Data quality result for data scan job.

The abstract base class for a message.

The abstract base class for a message.

The abstract base class for a message.

Post scan actions result for data scan job.

The result of BigQuery export post scan action.

Execution state for the exporting.

The type of the data scan.

The scope of job for the data scan.

The job state of the data scan.

The trigger type for the data scan.

A DataScanJob represents an instance of DataScan execution.

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

Execution state for the DataScanJob.

The type of DataScan.

The data source for DataScan.

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

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.

The abstract base class for a message.

Delele AspectType Request

Delete asset request.

Delete content request.

Delete DataAttributeBinding request.

Delete DataAttribute request.

Delete dataScan request.

Delete DataTaxonomy request.

Delete a metadata entity request.

Delele EntryGroup Request

Delele EntryType Request

Delete environment request.

Delete lake request.

Delete metadata partition request.

Delete task request.

Delete zone request.

The payload associated with Discovery data processing.

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

Details about the action.

Details about configuration events.

The abstract base class for a message.

Details about the entity.

The type of the entity.

The type of the event.

Details about the partition.

Represents tables and fileset metadata contained within a zone.

Provides compatibility information for various metadata stores.

Provides compatibility information for a specific metadata store.

The type of entity.

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

The abstract base class for a message.

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

The abstract base class for a message.

EntrySource contains source system related information for the entry.

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

The abstract base class for a message.

Entry Type is a template for creating Entries.

Authorization for an Entry Type.

The abstract base class for a message.

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

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

URI Endpoints to access sessions associated with the Environment.

Configuration for the underlying infrastructure used to run workloads.

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

Compute resources associated with the analyze interactive workloads.

Software Runtime Configuration to run Analyze.

The abstract base class for a message.

The abstract base class for a message.

Configuration for sessions created for this environment.

Status of sessions created for this environment.

Request details for generating data quality rule recommendations.

Response details for data quality rule recommendations.

Get AspectType request

Get asset request.

Get content request.

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

Get DataAttributeBinding request.

Get DataAttribute request.

Get DataScanJob request.

DataScanJob view options.

Get dataScan request.

DataScan view options.

Get DataTaxonomy request.

Get metadata entity request.

Entity views for get entity partial result.

Get EntryGroup request.

Get EntryType request

Get environment request.

Get job request.

Get lake request.

Get metadata partition request.

Get task request.

Get zone request.

Payload associated with Governance related log events.

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

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

Type of entity.

Type of governance log event.

A job represents an instance of a task.

The abstract base class for a message.

Job execution trigger.

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

Job Execution trigger.

The service used to execute the job.

The completion status of the job.

The type of the job.

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.

The abstract base class for a message.

Settings to manage association of Dataproc Metastore with a lake.

Status of Lake and Dataproc Metastore service instance association.

Current state of association.

List actions response.

List AspectTypes request

List AspectTypes response

List asset actions request.

List assets request.

List assets response.

List content request. Returns the BASIC Content view.

List content response.

List DataAttributeBindings request.

List DataAttributeBindings response.

List DataAttributes request.

List DataAttributes response.

List DataScanJobs request.

List DataScanJobs response.

List dataScans request.

List dataScans response.

List DataTaxonomies request.

List DataTaxonomies response.

List metadata entities request.

Entity views.

List metadata entities response.

List entryGroups request.

List ListEntryGroups response.

List EntryTypes request

List EntryTypes response

List environments request.

List environments response.

List jobs request.

List jobs response.

List lake actions request.

List lakes request.

List lakes response.

List metadata partitions request.

List metadata partitions response.

List sessions request.

List sessions response.

List tasks request.

List tasks response.

List zone actions request.

List zones request.

List zones response.

Represents the metadata of a long-running operation.

Represents partition metadata contained within entity instances.

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

Run DataScan Request

Run DataScan Response.

The abstract base class for a message.

The abstract base class for a message.

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

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

Schema information describing the structure and layout of the data.

Additional qualifiers to define field semantics.

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.

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

Represents a column field within a table schema.

Type information for fields in schemas and partition schemas.

A single result of a SearchEntries request.

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

Represents an active analyze session running for a user.

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

The type of the event.

Execution details of the query.

Query Execution engine.

State of a resource.

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

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

Describes the format of the data within its storage location.

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

The specific compressed file format of the data.

Describes CSV and similar semi-structured data formats.

The specific file format of the data.

Describes Iceberg data format.

Describes JSON data format.

Identifies the cloud system that manages the data storage.

A task represents a user-visible job.

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

Execution related settings, like retry and service_account.

The abstract base class for a message.

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

Configuration for the underlying infrastructure used to run workloads.

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

Batch compute resources associated with the task.

Container Image Runtime Configuration used with Batch execution.

The abstract base class for a message.

Cloud VPC Network used to run the infrastructure.

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

The abstract base class for a message.

Config for running scheduled notebooks.

User-specified config for running a Spark task.

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

Task scheduling and trigger settings.

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

Determines how often and when the job will run.

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

DataScan scheduling and trigger settings.

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

The scan runs once via RunDataScan API.

The scan is scheduled to run periodically.

Update AspectType Request

Update asset request.

Update content request.

Update DataAttributeBinding request.

Update DataAttribute request.

Update dataScan request.

Update DataTaxonomy request.

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.

Update EntryGroup Request

Update EntryType Request

Update environment request.

Update lake request.

Update task request.

Update zone request.

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.

Settings to manage the metadata discovery and publishing in a zone.

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

Describe CSV and similar semi-structured data formats.

Describe JSON data format.

The abstract base class for a message.

Settings for resources attached as assets within a zone.

Location type of the resources attached to a zone.

Type of zone.

API documentation for dataplex_v1.services.catalog_service.pagers module.

API documentation for dataplex_v1.services.content_service.pagers module.

API documentation for dataplex_v1.services.data_scan_service.pagers module.

API documentation for dataplex_v1.services.data_taxonomy_service.pagers module.

API documentation for dataplex_v1.services.dataplex_service.pagers module.

API documentation for dataplex_v1.services.metadata_service.pagers module.