Cloud Dataplex v1 API - Namespace Google.Cloud.Dataplex.V1 (3.4.0)

Classes

Action

Action represents an issue requiring administrator action for resolution.

Action.Types

Container for nested types declared in the Action message type.

Action.Types.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.

Action.Types.IncompatibleDataSchema

Action details for incompatible schemas detected by discovery.

Action.Types.IncompatibleDataSchema.Types

Container for nested types declared in the IncompatibleDataSchema message type.

Action.Types.InvalidDataFormat

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

Action.Types.InvalidDataOrganization

Action details for invalid data arrangement.

Action.Types.InvalidDataPartition

Action details for invalid or unsupported partitions detected by discovery.

Action.Types.InvalidDataPartition.Types

Container for nested types declared in the InvalidDataPartition message type.

Action.Types.MissingData

Action details for absence of data detected by discovery.

Action.Types.MissingResource

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

Action.Types.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.

ActionName

Resource name for the Action resource.

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.

AspectType.Types

Container for nested types declared in the AspectType message type.

AspectType.Types.Authorization

Autorization for an AspectType.

AspectType.Types.MetadataTemplate

MetadataTemplate definition for an AspectType.

AspectType.Types.MetadataTemplate.Types

Container for nested types declared in the MetadataTemplate message type.

AspectType.Types.MetadataTemplate.Types.Annotations

Definition of the annotations of a field.

AspectType.Types.MetadataTemplate.Types.Constraints

Definition of the constraints of a field.

AspectType.Types.MetadataTemplate.Types.EnumValue

Definition of Enumvalue, to be used for enum fields.

AspectTypeName

Resource name for the AspectType resource.

Asset

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

Asset.Types

Container for nested types declared in the Asset message type.

Asset.Types.DiscoverySpec

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

Asset.Types.DiscoverySpec.Types

Container for nested types declared in the DiscoverySpec message type.

Asset.Types.DiscoverySpec.Types.CsvOptions

Describe CSV and similar semi-structured data formats.

Asset.Types.DiscoverySpec.Types.JsonOptions

Describe JSON data format.

Asset.Types.DiscoveryStatus

Status of discovery for an asset.

Asset.Types.DiscoveryStatus.Types

Container for nested types declared in the DiscoveryStatus message type.

Asset.Types.DiscoveryStatus.Types.Stats

The aggregated data statistics for the asset reported by discovery.

Asset.Types.ResourceSpec

Identifies the cloud resource that is referenced by this asset.

Asset.Types.ResourceSpec.Types

Container for nested types declared in the ResourceSpec message type.

Asset.Types.ResourceStatus

Status of the resource referenced by an asset.

Asset.Types.ResourceStatus.Types

Container for nested types declared in the ResourceStatus message type.

Asset.Types.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.

Asset.Types.SecurityStatus.Types

Container for nested types declared in the SecurityStatus message type.

AssetName

Resource name for the Asset resource.

AssetStatus

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

CancelJobRequest

Cancel task jobs.

CancelMetadataJobRequest

Cancel metadata job request.

CatalogService

The primary resources offered by this service are EntryGroups, EntryTypes, AspectTypes, and Entries. They collectively let data administrators organize, manage, secure, and catalog data located across cloud projects in their organization in a variety of storage systems, including Cloud Storage and BigQuery.

CatalogService.CatalogServiceBase

Base class for server-side implementations of CatalogService

CatalogService.CatalogServiceClient

Client for CatalogService

CatalogServiceClient

CatalogService client wrapper, for convenient use.

CatalogServiceClientBuilder

Builder class for CatalogServiceClient to provide simple configuration of credentials, endpoint etc.

CatalogServiceClientImpl

CatalogService client wrapper implementation, for convenient use.

CatalogServiceSettings

Settings for CatalogServiceClient instances.

ConnectionName

Resource name for the Connection resource.

Content

Content represents a user-visible notebook or a sql script

Content.Types

Container for nested types declared in the Content message type.

Content.Types.Notebook

Configuration for Notebook content.

Content.Types.Notebook.Types

Container for nested types declared in the Notebook message type.

Content.Types.SqlScript

Configuration for the Sql Script content.

Content.Types.SqlScript.Types

Container for nested types declared in the SqlScript message type.

ContentName

Resource name for the Content resource.

ContentService

ContentService manages Notebook and SQL Scripts for Dataplex.

ContentService.ContentServiceBase

Base class for server-side implementations of ContentService

ContentService.ContentServiceClient

Client for ContentService

ContentServiceClient

ContentService client wrapper, for convenient use.

ContentServiceClientBuilder

Builder class for ContentServiceClient to provide simple configuration of credentials, endpoint etc.

ContentServiceClientImpl

ContentService client wrapper implementation, for convenient use.

ContentServiceSettings

Settings for ContentServiceClient instances.

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

Create Entry request.

CreateEntryTypeRequest

Create EntryType Request.

CreateEnvironmentRequest

Create environment request.

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.

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

DataAttributeBinding

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

DataAttributeBinding.Types

Container for nested types declared in the DataAttributeBinding message type.

DataAttributeBinding.Types.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.

DataAttributeBindingName

Resource name for the DataAttributeBinding resource.

DataAttributeName

Resource name for the DataAttribute resource.

DataDiscoveryResult

The output of a data discovery scan.

DataDiscoveryResult.Types

Container for nested types declared in the DataDiscoveryResult message type.

DataDiscoveryResult.Types.BigQueryPublishing

Describes BigQuery publishing configurations.

DataDiscoverySpec

Spec for a data discovery scan.

DataDiscoverySpec.Types

Container for nested types declared in the DataDiscoverySpec message type.

DataDiscoverySpec.Types.BigQueryPublishingConfig

Describes BigQuery publishing configurations.

DataDiscoverySpec.Types.BigQueryPublishingConfig.Types

Container for nested types declared in the BigQueryPublishingConfig message type.

DataDiscoverySpec.Types.StorageConfig

Configurations related to Cloud Storage as the data source.

DataDiscoverySpec.Types.StorageConfig.Types

Container for nested types declared in the StorageConfig message type.

DataDiscoverySpec.Types.StorageConfig.Types.CsvOptions

Describes CSV and similar semi-structured data formats.

DataDiscoverySpec.Types.StorageConfig.Types.JsonOptions

Describes JSON data format.

DataProfileResult

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

DataProfileResult.Types

Container for nested types declared in the DataProfileResult message type.

DataProfileResult.Types.PostScanActionsResult

The result of post scan actions of DataProfileScan job.

DataProfileResult.Types.PostScanActionsResult.Types

Container for nested types declared in the PostScanActionsResult message type.

DataProfileResult.Types.PostScanActionsResult.Types.BigQueryExportResult

The result of BigQuery export post scan action.

DataProfileResult.Types.PostScanActionsResult.Types.BigQueryExportResult.Types

Container for nested types declared in the BigQueryExportResult message type.

DataProfileResult.Types.Profile

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

DataProfileResult.Types.Profile.Types

Container for nested types declared in the Profile message type.

DataProfileResult.Types.Profile.Types.Field

A field within a table.

DataProfileResult.Types.Profile.Types.Field.Types

Container for nested types declared in the Field message type.

DataProfileResult.Types.Profile.Types.Field.Types.ProfileInfo

The profile information for each field type.

DataProfileResult.Types.Profile.Types.Field.Types.ProfileInfo.Types

Container for nested types declared in the ProfileInfo message type.

DataProfileResult.Types.Profile.Types.Field.Types.ProfileInfo.Types.DoubleFieldInfo

The profile information for a double type field.

DataProfileResult.Types.Profile.Types.Field.Types.ProfileInfo.Types.IntegerFieldInfo

The profile information for an integer type field.

DataProfileResult.Types.Profile.Types.Field.Types.ProfileInfo.Types.StringFieldInfo

The profile information for a string type field.

DataProfileResult.Types.Profile.Types.Field.Types.ProfileInfo.Types.TopNValue

Top N non-null values in the scanned data.

DataProfileSpec

DataProfileScan related setting.

DataProfileSpec.Types

Container for nested types declared in the DataProfileSpec message type.

DataProfileSpec.Types.PostScanActions

The configuration of post scan actions of DataProfileScan job.

DataProfileSpec.Types.PostScanActions.Types

Container for nested types declared in the PostScanActions message type.

DataProfileSpec.Types.PostScanActions.Types.BigQueryExport

The configuration of BigQuery export post scan action.

DataProfileSpec.Types.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.

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.

DataQualityResult.Types

Container for nested types declared in the DataQualityResult message type.

DataQualityResult.Types.PostScanActionsResult

The result of post scan actions of DataQualityScan job.

DataQualityResult.Types.PostScanActionsResult.Types

Container for nested types declared in the PostScanActionsResult message type.

DataQualityResult.Types.PostScanActionsResult.Types.BigQueryExportResult

The result of BigQuery export post scan action.

DataQualityResult.Types.PostScanActionsResult.Types.BigQueryExportResult.Types

Container for nested types declared in the BigQueryExportResult message type.

DataQualityRule

A rule captures data quality intent about a data source.

DataQualityRule.Types

Container for nested types declared in the DataQualityRule message type.

DataQualityRule.Types.NonNullExpectation

Evaluates whether each column value is null.

DataQualityRule.Types.RangeExpectation

Evaluates whether each column value lies between a specified range.

DataQualityRule.Types.RegexExpectation

Evaluates whether each column value matches a specified regex.

DataQualityRule.Types.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

DataQualityRule.Types.SetExpectation

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

DataQualityRule.Types.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.

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

DataQualityRule.Types.StatisticRangeExpectation

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

DataQualityRule.Types.StatisticRangeExpectation.Types

Container for nested types declared in the StatisticRangeExpectation message type.

DataQualityRule.Types.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

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

DataQualityScanRuleResult.Types

Container for nested types declared in the DataQualityScanRuleResult message type.

DataQualitySpec

DataQualityScan related setting.

DataQualitySpec.Types

Container for nested types declared in the DataQualitySpec message type.

DataQualitySpec.Types.PostScanActions

The configuration of post scan actions of DataQualityScan.

DataQualitySpec.Types.PostScanActions.Types

Container for nested types declared in the PostScanActions message type.

DataQualitySpec.Types.PostScanActions.Types.BigQueryExport

The configuration of BigQuery export post scan action.

DataQualitySpec.Types.PostScanActions.Types.JobEndTrigger

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

DataQualitySpec.Types.PostScanActions.Types.JobFailureTrigger

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

DataQualitySpec.Types.PostScanActions.Types.NotificationReport

The configuration of notification report post scan action.

DataQualitySpec.Types.PostScanActions.Types.Recipients

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

DataQualitySpec.Types.PostScanActions.Types.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).

DataScan.Types

Container for nested types declared in the DataScan message type.

DataScan.Types.ExecutionSpec

DataScan execution settings.

DataScan.Types.ExecutionStatus

Status of the data scan execution.

DataScanEvent

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

DataScanEvent.Types

Container for nested types declared in the DataScanEvent message type.

DataScanEvent.Types.DataProfileAppliedConfigs

Applied configs for data profile type data scan job.

DataScanEvent.Types.DataProfileResult

Data profile result for data scan job.

DataScanEvent.Types.DataQualityAppliedConfigs

Applied configs for data quality type data scan job.

DataScanEvent.Types.DataQualityResult

Data quality result for data scan job.

DataScanEvent.Types.PostScanActionsResult

Post scan actions result for data scan job.

DataScanEvent.Types.PostScanActionsResult.Types

Container for nested types declared in the PostScanActionsResult message type.

DataScanEvent.Types.PostScanActionsResult.Types.BigQueryExportResult

The result of BigQuery export post scan action.

DataScanEvent.Types.PostScanActionsResult.Types.BigQueryExportResult.Types

Container for nested types declared in the BigQueryExportResult message type.

DataScanJob

A DataScanJob represents an instance of DataScan execution.

DataScanJob.Types

Container for nested types declared in the DataScanJob message type.

DataScanJobName

Resource name for the DataScanJob resource.

DataScanName

Resource name for the DataScan resource.

DataScanService

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

Base class for server-side implementations of DataScanService

DataScanService.DataScanServiceClient

Client for DataScanService

DataScanServiceClient

DataScanService client wrapper, for convenient use.

DataScanServiceClientBuilder

Builder class for DataScanServiceClient to provide simple configuration of credentials, endpoint etc.

DataScanServiceClientImpl

DataScanService client wrapper implementation, for convenient use.

DataScanServiceSettings

Settings for DataScanServiceClient instances.

DataSource

The data source for DataScan.

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.

DataTaxonomyName

Resource name for the DataTaxonomy resource.

DataTaxonomyService

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

DataTaxonomyService.DataTaxonomyServiceBase

Base class for server-side implementations of DataTaxonomyService

DataTaxonomyService.DataTaxonomyServiceClient

Client for DataTaxonomyService

DataTaxonomyServiceClient

DataTaxonomyService client wrapper, for convenient use.

DataTaxonomyServiceClientBuilder

Builder class for DataTaxonomyServiceClient to provide simple configuration of credentials, endpoint etc.

DataTaxonomyServiceClientImpl

DataTaxonomyService client wrapper implementation, for convenient use.

DataTaxonomyServiceSettings

Settings for DataTaxonomyServiceClient instances.

DataplexService

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.

DataplexService.DataplexServiceBase

Base class for server-side implementations of DataplexService

DataplexService.DataplexServiceClient

Client for DataplexService

DataplexServiceClient

DataplexService client wrapper, for convenient use.

DataplexServiceClientBuilder

Builder class for DataplexServiceClient to provide simple configuration of credentials, endpoint etc.

DataplexServiceClientImpl

DataplexService client wrapper implementation, for convenient use.

DataplexServiceSettings

Settings for DataplexServiceClient instances.

DatasetName

Resource name for the Dataset resource.

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

Delete EntryGroup Request.

DeleteEntryRequest

Delete Entry request.

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.

DiscoveryEvent.Types

Container for nested types declared in the DiscoveryEvent message type.

DiscoveryEvent.Types.ActionDetails

Details about the action.

DiscoveryEvent.Types.ConfigDetails

Details about configuration events.

DiscoveryEvent.Types.EntityDetails

Details about the entity.

DiscoveryEvent.Types.PartitionDetails

Details about the partition.

DiscoveryEvent.Types.TableDetails

Details about the published table.

Entity

Represents tables and fileset metadata contained within a zone.

Entity.Types

Container for nested types declared in the Entity message type.

Entity.Types.CompatibilityStatus

Provides compatibility information for various metadata stores.

Entity.Types.CompatibilityStatus.Types

Container for nested types declared in the CompatibilityStatus message type.

Entity.Types.CompatibilityStatus.Types.Compatibility

Provides compatibility information for a specific metadata store.

EntityName

Resource name for the Entity resource.

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.

EntryGroupName

Resource name for the EntryGroup resource.

EntryName

Resource name for the Entry resource.

EntrySource

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

EntrySource.Types

Container for nested types declared in the EntrySource message type.

EntrySource.Types.Ancestor

Information about individual items in the hierarchy that is associated with the data resource.

EntryType

Entry Type is a template for creating Entries.

EntryType.Types

Container for nested types declared in the EntryType message type.

EntryType.Types.AspectInfo

EntryType.Types.Authorization

Authorization for an Entry Type.

EntryTypeName

Resource name for the EntryType resource.

Environment

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

Environment.Types

Container for nested types declared in the Environment message type.

Environment.Types.Endpoints

URI Endpoints to access sessions associated with the Environment.

Environment.Types.InfrastructureSpec

Configuration for the underlying infrastructure used to run workloads.

Environment.Types.InfrastructureSpec.Types

Container for nested types declared in the InfrastructureSpec message type.

Environment.Types.InfrastructureSpec.Types.ComputeResources

Compute resources associated with the analyze interactive workloads.

Environment.Types.InfrastructureSpec.Types.OsImageRuntime

Software Runtime Configuration to run Analyze.

Environment.Types.SessionSpec

Configuration for sessions created for this environment.

Environment.Types.SessionStatus

Status of sessions created for this environment.

EnvironmentName

Resource name for the Environment resource.

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.

GetContentRequest.Types

Container for nested types declared in the GetContentRequest message type.

GetDataAttributeBindingRequest

Get DataAttributeBinding request.

GetDataAttributeRequest

Get DataAttribute request.

GetDataScanJobRequest

Get DataScanJob request.

GetDataScanJobRequest.Types

Container for nested types declared in the GetDataScanJobRequest message type.

GetDataScanRequest

Get dataScan request.

GetDataScanRequest.Types

Container for nested types declared in the GetDataScanRequest message type.

GetDataTaxonomyRequest

Get DataTaxonomy request.

GetEntityRequest

Get metadata entity request.

GetEntityRequest.Types

Container for nested types declared in the GetEntityRequest message type.

GetEntryGroupRequest

Get EntryGroup request.

GetEntryRequest

Get Entry request.

GetEntryTypeRequest

Get EntryType request.

GetEnvironmentRequest

Get environment 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.

GovernanceEvent

Payload associated with Governance related log events.

GovernanceEvent.Types

Container for nested types declared in the GovernanceEvent message type.

GovernanceEvent.Types.Entity

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

GovernanceEvent.Types.Entity.Types

Container for nested types declared in the Entity message type.

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][google.cloud.dataplex.v1.CatalogService.CreateMetadataJob].

You provide a collection of import items in a metadata import file. For more information about how to create a metadata import file, see Metadata import file.

Job

A job represents an instance of a task.

Job.Types

Container for nested types declared in the Job message type.

JobEvent

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

JobEvent.Types

Container for nested types declared in the JobEvent message type.

JobName

Resource name for the Job resource.

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.

Lake.Types

Container for nested types declared in the Lake message type.

Lake.Types.Metastore

Settings to manage association of Dataproc Metastore with a lake.

Lake.Types.MetastoreStatus

Status of Lake and Dataproc Metastore service instance association.

Lake.Types.MetastoreStatus.Types

Container for nested types declared in the MetastoreStatus message type.

LakeName

Resource name for the Lake resource.

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.

ListEntitiesRequest.Types

Container for nested types declared in the ListEntitiesRequest message type.

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.

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.

MetadataJob.Types

Container for nested types declared in the MetadataJob message type.

MetadataJob.Types.ImportJobResult

Results from a metadata import job.

MetadataJob.Types.ImportJobSpec

Job specification for a metadata import job

MetadataJob.Types.ImportJobSpec.Types

Container for nested types declared in the ImportJobSpec message type.

MetadataJob.Types.ImportJobSpec.Types.ImportJobScope

A boundary on the scope of impact that the metadata import job can have.

MetadataJob.Types.Status

Metadata job status.

MetadataJob.Types.Status.Types

Container for nested types declared in the Status message type.

MetadataJobName

Resource name for the MetadataJob resource.

MetadataService

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

MetadataService.MetadataServiceBase

Base class for server-side implementations of MetadataService

MetadataService.MetadataServiceClient

Client for MetadataService

MetadataServiceClient

MetadataService client wrapper, for convenient use.

MetadataServiceClientBuilder

Builder class for MetadataServiceClient to provide simple configuration of credentials, endpoint etc.

MetadataServiceClientImpl

MetadataService client wrapper implementation, for convenient use.

MetadataServiceSettings

Settings for MetadataServiceClient instances.

OperationMetadata

Represents the metadata of a long-running operation.

Partition

Represents partition metadata contained within entity instances.

PartitionName

Resource name for the Partition resource.

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)

ScannedData.Types

Container for nested types declared in the ScannedData message type.

ScannedData.Types.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.

Schema.Types

Container for nested types declared in the Schema message type.

Schema.Types.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.

Schema.Types.SchemaField

Represents a column field within a table schema.

SearchEntriesRequest

SearchEntriesResponse

SearchEntriesResult

A single result of a SearchEntries request.

SearchEntriesResult.Types

Container for nested types declared in the SearchEntriesResult message type.

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

SessionEvent.Types

Container for nested types declared in the SessionEvent message type.

SessionEvent.Types.QueryDetail

Execution details of the query.

SessionEvent.Types.QueryDetail.Types

Container for nested types declared in the QueryDetail message type.

SessionName

Resource name for the Session resource.

StorageAccess

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

StorageAccess.Types

Container for nested types declared in the StorageAccess message type.

StorageFormat

Describes the format of the data within its storage location.

StorageFormat.Types

Container for nested types declared in the StorageFormat message type.

StorageFormat.Types.CsvOptions

Describes CSV and similar semi-structured data formats.

StorageFormat.Types.IcebergOptions

Describes Iceberg data format.

StorageFormat.Types.JsonOptions

Describes JSON data format.

TableName

Resource name for the Table resource.

Task

A task represents a user-visible job.

Task.Types

Container for nested types declared in the Task message type.

Task.Types.ExecutionSpec

Execution related settings, like retry and service_account.

Task.Types.ExecutionStatus

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

Task.Types.InfrastructureSpec

Configuration for the underlying infrastructure used to run workloads.

Task.Types.InfrastructureSpec.Types

Container for nested types declared in the InfrastructureSpec message type.

Task.Types.InfrastructureSpec.Types.BatchComputeResources

Batch compute resources associated with the task.

Task.Types.InfrastructureSpec.Types.ContainerImageRuntime

Container Image Runtime Configuration used with Batch execution.

Task.Types.InfrastructureSpec.Types.VpcNetwork

Cloud VPC Network used to run the infrastructure.

Task.Types.NotebookTaskConfig

Config for running scheduled notebooks.

Task.Types.SparkTaskConfig

User-specified config for running a Spark task.

Task.Types.TriggerSpec

Task scheduling and trigger settings.

Task.Types.TriggerSpec.Types

Container for nested types declared in the TriggerSpec message type.

TaskName

Resource name for the Task resource.

Trigger

DataScan scheduling and trigger settings.

Trigger.Types

Container for nested types declared in the Trigger message type.

Trigger.Types.OnDemand

The scan runs once via RunDataScan API.

Trigger.Types.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

Update Entry request.

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.