Package types (1.13.0)

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

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.

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

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

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

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

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

DataProfileScan related setting.

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

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

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

DataQualityScan related setting.

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

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

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

The type of DataScan.

Values: DATA_SCAN_TYPE_UNSPECIFIED (0): The DataScan type is unspecified. DATA_QUALITY (1): Data Quality scan. DATA_PROFILE (2): Data Profile scan.

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.

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

Represents tables and fileset metadata contained within a zone.

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

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

EntrySource contains source system related information for the entry.

Entry Type is a template for creating Entries.

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

Values: ENTRY_VIEW_UNSPECIFIED (0): Unspecified EntryView. Defaults to FULL. BASIC (1): Returns entry only, without aspects. FULL (2): Returns all required aspects as well as the keys of all non-required aspects. CUSTOM (3): Returns aspects matching custom fields in GetEntryRequest. If the number of aspects would exceed 100, the first 100 will be returned. ALL (4): Returns all aspects. If the number of aspects would exceed 100, the first 100 will be returned.

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

Generate recommended DataQualityRules request.

Generate recommended DataQualityRules response.

Get AspectType request

Get asset request.

Get content request.

Get DataAttributeBinding request.

Get DataAttribute request.

Get DataScanJob request.

Get dataScan request.

Get DataTaxonomy request.

Get metadata entity request.

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

A job represents an instance of a task.

The payload associated with Job logs that contains events describing jobs that have run within a 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.

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.

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 data scanned during processing (e.g. in incremental DataScan)

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

Schema information describing the structure and layout of the data.

A single result of a SearchEntries request.

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

State of a resource.

Values: STATE_UNSPECIFIED (0): State is not specified. ACTIVE (1): Resource is active, i.e., ready to use. CREATING (2): Resource is under creation. DELETING (3): Resource is under deletion. ACTION_REQUIRED (4): Resource is active but has unresolved actions.

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

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

Identifies the cloud system that manages the data storage.

Values: STORAGE_SYSTEM_UNSPECIFIED (0): Storage system unspecified. CLOUD_STORAGE (1): The entity data is contained within a Cloud Storage bucket. BIGQUERY (2): The entity data is contained within a BigQuery dataset.

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

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

Values: TRANSFER_STATUS_UNSPECIFIED (0): The default value. It is set for resources that were not subject for migration from Data Catalog service. TRANSFER_STATUS_MIGRATED (1): Indicates that a resource was migrated from Data Catalog service but it hasn't been transferred yet. In particular the resource cannot be updated from Dataplex API. TRANSFER_STATUS_TRANSFERRED (2): Indicates that a resource was transferred from Data Catalog service. The resource can only be updated 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

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.