Module model 

The messages and enums that are part of this client library.

Modules

action

Defines additional types related to Action.

aspect_type

Defines additional types related to AspectType.

asset

Defines additional types related to Asset.

business_glossary_event

Defines additional types related to BusinessGlossaryEvent.

content

Defines additional types related to Content.

data_attribute_binding

Defines additional types related to DataAttributeBinding.

data_discovery_result

Defines additional types related to DataDiscoveryResult.

data_discovery_spec

Defines additional types related to DataDiscoverySpec.

data_documentation_result

Defines additional types related to DataDocumentationResult.

data_profile_result

Defines additional types related to DataProfileResult.

data_profile_spec

Defines additional types related to DataProfileSpec.

data_quality_result

Defines additional types related to DataQualityResult.

data_quality_rule

Defines additional types related to DataQualityRule.

data_quality_scan_rule_result

Defines additional types related to DataQualityScanRuleResult.

data_quality_spec

Defines additional types related to DataQualitySpec.

data_scan

Defines additional types related to DataScan.

data_scan_catalog_publishing_status

Defines additional types related to DataScanCatalogPublishingStatus.

data_scan_event

Defines additional types related to DataScanEvent.

data_scan_job

Defines additional types related to DataScanJob.

data_source

Defines additional types related to DataSource.

discovery_event

Defines additional types related to DiscoveryEvent.

encryption_config

Defines additional types related to EncryptionConfig.

entity

Defines additional types related to Entity.

entry_link

Defines additional types related to EntryLink.

entry_link_event

Defines additional types related to EntryLinkEvent.

entry_source

Defines additional types related to EntrySource.

entry_type

Defines additional types related to EntryType.

environment

Defines additional types related to Environment.

get_content_request

Defines additional types related to GetContentRequest.

get_data_scan_job_request

Defines additional types related to GetDataScanJobRequest.

get_data_scan_request

Defines additional types related to GetDataScanRequest.

get_entity_request

Defines additional types related to GetEntityRequest.

governance_event

Defines additional types related to GovernanceEvent.

job

Defines additional types related to Job.

job_event

Defines additional types related to JobEvent.

lake

Defines additional types related to Lake.

list_entities_request

Defines additional types related to ListEntitiesRequest.

metadata_job

Defines additional types related to MetadataJob.

scanned_data

Defines additional types related to ScannedData.

schema

Defines additional types related to Schema.

search_entries_result

Defines additional types related to SearchEntriesResult.

session_event

Defines additional types related to SessionEvent.

storage_access

Defines additional types related to StorageAccess.

storage_format

Defines additional types related to StorageFormat.

task

Defines additional types related to Task.

trigger

Defines additional types related to Trigger.

zone

Defines additional types related to Zone.

Structs

Action

Action represents an issue requiring administrator action for resolution.

Aspect

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

AspectSource

Information related to the source system of the aspect.

AspectType

AspectType is a template for creating Aspects, and represents the JSON-schema for a given Entry, for example, BigQuery Table Schema.

Asset

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

AssetStatus

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

BusinessGlossaryEvent

Payload associated with Business Glossary related log events.

CancelJobRequest

Cancel task jobs.

CancelMetadataJobRequest

Cancel metadata job request.

Content

Content represents a user-visible notebook or a 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.

CreateDataTaxonomyRequestDeprecated

Create DataTaxonomy request.

CreateEncryptionConfigRequest

Create EncryptionConfig Request

CreateEntityRequest

Create a metadata entity request.

CreateEntryGroupRequest

Create EntryGroup Request.

CreateEntryLinkRequest

Request message for CreateEntryLink.

CreateEntryRequest

Create Entry request.

CreateEntryTypeRequest

Create EntryType Request.

CreateEnvironmentRequest

Create environment request.

CreateGlossaryCategoryRequest

Creates a new GlossaryCategory under the specified Glossary.

CreateGlossaryRequest

Create Glossary Request

CreateGlossaryTermRequest

Creates a new GlossaryTerm under the specified Glossary.

CreateLakeRequest

Create lake request.

CreateMetadataJobRequest

Create metadata job 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.

DataAttributeDeprecated

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

DataAttributeBindingDeprecated

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

DataDiscoveryResult

The output of a data discovery scan.

DataDiscoverySpec

Spec for a data discovery scan.

DataDocumentationResult

The output of a DataDocumentation scan.

DataDocumentationSpec

DataDocumentation scan related spec.

DataProfileResult

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

DataProfileSpec

DataProfileScan related setting.

DataQualityColumnResult

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

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.

DataQualityResult

The output of a DataQualityScan.

DataQualityRule

A rule captures data quality intent about a data source.

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

DataQualitySpec

DataQualityScan related setting.

DataScan

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

DataScanCatalogPublishingStatus

The status of publishing the data scan result as Dataplex Universal Catalog metadata.

DataScanEvent

These messages contain information about the execution of a datascan. The monitored resource is ‘DataScan’

DataScanJob

A DataScanJob represents an instance of DataScan execution.

DataSource

The data source for DataScan.

DataTaxonomyDeprecated

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.

DeleteAspectTypeRequest

Delete AspectType Request.

DeleteAssetRequest

Delete asset request.

DeleteContentRequest

Delete content request.

DeleteDataAttributeBindingRequest

Delete DataAttributeBinding request.

DeleteDataAttributeRequest

Delete DataAttribute request.

DeleteDataScanRequest

Delete dataScan request.

DeleteDataTaxonomyRequestDeprecated

Delete DataTaxonomy request.

DeleteEncryptionConfigRequest

Delete EncryptionConfig Request

DeleteEntityRequest

Delete a metadata entity request.

DeleteEntryGroupRequest

Delete EntryGroup Request.

DeleteEntryLinkRequest

Request message for DeleteEntryLink.

DeleteEntryRequest

Delete Entry request.

DeleteEntryTypeRequest

Delete EntryType Request.

DeleteEnvironmentRequest

Delete environment request.

DeleteGlossaryCategoryRequest

Delete GlossaryCategory Request

DeleteGlossaryRequest

Delete Glossary Request

DeleteGlossaryTermRequest

Delete GlossaryTerm 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.

EncryptionConfig

A Resource designed to manage encryption configurations for customers to support Customer Managed Encryption Keys (CMEK).

Entity

Represents tables and fileset metadata contained within a zone.

Entry

An entry is a representation of a data resource that can be described by various metadata.

EntryGroup

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

EntryLink

EntryLink represents a link between two Entries.

EntryLinkEvent

Payload associated with Entry related log events.

EntrySource

Information related to the source system of the data resource that is represented by the entry.

EntryType

Entry Type is a template for creating Entries.

Environment

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

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.

GetDataAttributeBindingRequest

Get DataAttributeBinding request.

GetDataAttributeRequest

Get DataAttribute request.

GetDataScanJobRequest

Get DataScanJob request.

GetDataScanRequest

Get dataScan request.

GetDataTaxonomyRequestDeprecated

Get DataTaxonomy request.

GetEncryptionConfigRequest

Get EncryptionConfig Request

GetEntityRequest

Get metadata entity request.

GetEntryGroupRequest

Get EntryGroup request.

GetEntryLinkRequest

Request message for GetEntryLink.

GetEntryRequest

Get Entry request.

GetEntryTypeRequest

Get EntryType request.

GetEnvironmentRequest

Get environment request.

GetGlossaryCategoryRequest

Get GlossaryCategory Request

GetGlossaryRequest

Get Glossary Request

GetGlossaryTermRequest

Get GlossaryTerm Request

GetJobRequest

Get job request.

GetLakeRequest

Get lake request.

GetMetadataJobRequest

Get metadata job request.

GetPartitionRequest

Get metadata partition request.

GetTaskRequest

Get task request.

GetZoneRequest

Get zone request.

Glossary

A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it.

GlossaryCategory

A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other.

GlossaryTerm

GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them.

GovernanceEvent

Payload associated with Governance related log events.

ImportItem

An object that describes the values that you want to set for an entry and its attached aspects when you import metadata. Used when you run a metadata import job. See CreateMetadataJob.

Job

A job represents an instance of a task.

JobEvent

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

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.

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.

ListEncryptionConfigsRequest

List EncryptionConfigs Request

ListEncryptionConfigsResponse

List EncryptionConfigs Response

ListEntitiesRequest

List metadata entities request.

ListEntitiesResponse

List metadata entities response.

ListEntriesRequest

List Entries request.

ListEntriesResponse

List Entries response.

ListEntryGroupsRequest

List entryGroups request.

ListEntryGroupsResponse

List entry groups response.

ListEntryTypesRequest

List EntryTypes request

ListEntryTypesResponse

List EntryTypes response.

ListEnvironmentsRequest

List environments request.

ListEnvironmentsResponse

List environments response.

ListGlossariesRequest

List Glossaries Request

ListGlossariesResponse

List Glossaries Response

ListGlossaryCategoriesRequest

List GlossaryCategories Request

ListGlossaryCategoriesResponse

List GlossaryCategories Response

ListGlossaryTermsRequest

List GlossaryTerms Request

ListGlossaryTermsResponse

List GlossaryTerms Response

ListJobsRequest

List jobs request.

ListJobsResponse

List jobs response.

ListLakeActionsRequest

List lake actions request.

ListLakesRequest

List lakes request.

ListLakesResponse

List lakes response.

ListMetadataJobsRequest

List metadata jobs request.

ListMetadataJobsResponse

List metadata jobs 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

Lookup Entry request using permissions in the source system.

MetadataJob

A metadata job resource.

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

RunTaskResponse

ScannedData

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

Schema

Schema information describing the structure and layout of the data.

SearchEntriesRequest

SearchEntriesResponse

SearchEntriesResult

A single result of a SearchEntries request.

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

StorageAccess

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

StorageFormat

Describes the format of the data within its storage location.

Task

A task represents a user-visible job.

Trigger

DataScan scheduling and trigger settings.

UpdateAspectTypeRequest

Update AspectType Request

UpdateAssetRequest

Update asset request.

UpdateContentRequest

Update content request.

UpdateDataAttributeBindingRequest

Update DataAttributeBinding request.

UpdateDataAttributeRequest

Update DataAttribute request.

UpdateDataScanRequest

Update dataScan request.

UpdateDataTaxonomyRequestDeprecated

Update DataTaxonomy request.

UpdateEncryptionConfigRequest

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

Update Entry request.

UpdateEntryTypeRequest

Update EntryType Request.

UpdateEnvironmentRequest

Update environment request.

UpdateGlossaryCategoryRequest

Update GlossaryCategory Request

UpdateGlossaryRequest

Update Glossary Request

UpdateGlossaryTermRequest

Update GlossaryTerm 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.

Enums

DataScanType

The type of data scan.

EntryView

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

State

State of a resource.

StorageSystem

Identifies the cloud system that manages the data storage.

TransferStatus

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