dataplex/v1 library

Cloud Dataplex API - v1

Dataplex API is used to manage the lifecycle of data lakes.

For more information, see cloud.google.com/dataplex/docs

Create an instance of CloudDataplexApi to access these resources:

Classes

CloudDataplexApi
Dataplex API is used to manage the lifecycle of data lakes.
GoogleCloudDataplexV1Action
Action represents an issue requiring administrator action for resolution.
GoogleCloudDataplexV1ActionFailedSecurityPolicyApply
Failed to apply security policy to the managed resource(s) under a lake, zone or an asset.
GoogleCloudDataplexV1ActionIncompatibleDataSchema
Action details for incompatible schemas detected by discovery.
GoogleCloudDataplexV1ActionInvalidDataFormat
Action details for invalid or unsupported data files detected by discovery.
GoogleCloudDataplexV1ActionInvalidDataPartition
Action details for invalid or unsupported partitions detected by discovery.
GoogleCloudDataplexV1Asset
An asset represents a cloud resource that is being managed within a lake as a member of a zone.
GoogleCloudDataplexV1AssetDiscoverySpec
Settings to manage the metadata discovery and publishing for an asset.
GoogleCloudDataplexV1AssetDiscoveryStatus
Status of discovery for an asset.
GoogleCloudDataplexV1AssetDiscoveryStatusStats
The aggregated data statistics for the asset reported by discovery.
GoogleCloudDataplexV1AssetResourceSpec
Identifies the cloud resource that is referenced by this asset.
GoogleCloudDataplexV1AssetResourceStatus
Status of the resource referenced by an asset.
GoogleCloudDataplexV1AssetSecurityStatus
Security policy status of the asset.
GoogleCloudDataplexV1AssetStatus
Aggregated status of the underlying assets of a lake or zone.
GoogleCloudDataplexV1Content
Content represents a user-visible notebook or a sql script
GoogleCloudDataplexV1ContentNotebook
Configuration for Notebook content.
GoogleCloudDataplexV1ContentSqlScript
Configuration for the Sql Script content.
GoogleCloudDataplexV1DataAccessSpec
DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables).
GoogleCloudDataplexV1DataAttribute
Denotes one dataAttribute in a dataTaxonomy, for example, PII.
GoogleCloudDataplexV1DataAttributeBinding
DataAttributeBinding represents binding of attributes to resources.
GoogleCloudDataplexV1DataAttributeBindingPath
Represents a subresource of the given resource, and associated bindings with it.
GoogleCloudDataplexV1DataProfileResult
DataProfileResult defines the output of DataProfileScan.
GoogleCloudDataplexV1DataProfileResultPostScanActionsResult
The result of post scan actions of DataProfileScan job.
GoogleCloudDataplexV1DataProfileResultProfile
Contains name, type, mode and field type specific profile information.
GoogleCloudDataplexV1DataProfileResultProfileField
A field within a table.
GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo
The profile information for each field type.
GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo
The profile information for a double type field.
GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo
The profile information for an integer type field.
GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo
The profile information for a string type field.
GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue
Top N non-null values in the scanned data.
GoogleCloudDataplexV1DataProfileSpec
DataProfileScan related setting.
GoogleCloudDataplexV1DataProfileSpecPostScanActions
The configuration of post scan actions of DataProfileScan job.
GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport
The configuration of BigQuery export post scan action.
GoogleCloudDataplexV1DataProfileSpecSelectedFields
The specification for fields to include or exclude in data profile scan.
GoogleCloudDataplexV1DataQualityColumnResult
DataQualityColumnResult provides a more detailed, per-column view of the results.
GoogleCloudDataplexV1DataQualityDimension
A dimension captures data quality intent about a defined subset of the rules specified.
GoogleCloudDataplexV1DataQualityDimensionResult
DataQualityDimensionResult provides a more detailed, per-dimension view of the results.
GoogleCloudDataplexV1DataQualityResult
The output of a DataQualityScan.
GoogleCloudDataplexV1DataQualityResultPostScanActionsResult
The result of post scan actions of DataQualityScan job.
GoogleCloudDataplexV1DataQualityRule
A rule captures data quality intent about a data source.
GoogleCloudDataplexV1DataQualityRuleRangeExpectation
Evaluates whether each column value lies between a specified range.
GoogleCloudDataplexV1DataQualityRuleRegexExpectation
Evaluates whether each column value matches a specified regex.
GoogleCloudDataplexV1DataQualityRuleResult
DataQualityRuleResult provides a more detailed, per-rule view of the results.
GoogleCloudDataplexV1DataQualityRuleSetExpectation
Evaluates whether each column value is contained by a specified set.
GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation
Evaluates whether the column aggregate statistic lies between a specified range.
GoogleCloudDataplexV1DataQualitySpec
DataQualityScan related setting.
GoogleCloudDataplexV1DataQualitySpecPostScanActions
The configuration of post scan actions of DataQualityScan.
GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport
The configuration of BigQuery export post scan action.
GoogleCloudDataplexV1DataScan
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.
GoogleCloudDataplexV1DataScanExecutionSpec
DataScan execution settings.
GoogleCloudDataplexV1DataScanExecutionStatus
Status of the data scan execution.
GoogleCloudDataplexV1DataScanJob
A DataScanJob represents an instance of DataScan execution.
GoogleCloudDataplexV1DataSource
The data source for DataScan.
GoogleCloudDataplexV1DataTaxonomy
DataTaxonomy represents a set of hierarchical DataAttributes resources, grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have attributes to manage PII data.
GoogleCloudDataplexV1Entity
Represents tables and fileset metadata contained within a zone.
GoogleCloudDataplexV1EntityCompatibilityStatus
Provides compatibility information for various metadata stores.
GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility
Provides compatibility information for a specific metadata store.
GoogleCloudDataplexV1Environment
Environment represents a user-visible compute infrastructure for analytics within a lake.
GoogleCloudDataplexV1EnvironmentEndpoints
URI Endpoints to access sessions associated with the Environment.
GoogleCloudDataplexV1EnvironmentInfrastructureSpec
Configuration for the underlying infrastructure used to run workloads.
GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources
Compute resources associated with the analyze interactive workloads.
GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime
Software Runtime Configuration to run Analyze.
GoogleCloudDataplexV1EnvironmentSessionSpec
Configuration for sessions created for this environment.
GoogleCloudDataplexV1EnvironmentSessionStatus
Status of sessions created for this environment.
GoogleCloudDataplexV1Job
A job represents an instance of a task.
GoogleCloudDataplexV1Lake
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.
GoogleCloudDataplexV1LakeMetastore
Settings to manage association of Dataproc Metastore with a lake.
GoogleCloudDataplexV1LakeMetastoreStatus
Status of Lake and Dataproc Metastore service instance association.
GoogleCloudDataplexV1ListActionsResponse
List actions response.
GoogleCloudDataplexV1ListAssetsResponse
List assets response.
GoogleCloudDataplexV1ListContentResponse
List content response.
GoogleCloudDataplexV1ListDataAttributeBindingsResponse
List DataAttributeBindings response.
GoogleCloudDataplexV1ListDataAttributesResponse
List DataAttributes response.
GoogleCloudDataplexV1ListDataScanJobsResponse
List DataScanJobs response.
GoogleCloudDataplexV1ListDataScansResponse
List dataScans response.
GoogleCloudDataplexV1ListDataTaxonomiesResponse
List DataTaxonomies response.
GoogleCloudDataplexV1ListEntitiesResponse
List metadata entities response.
GoogleCloudDataplexV1ListEnvironmentsResponse
List environments response.
GoogleCloudDataplexV1ListJobsResponse
List jobs response.
GoogleCloudDataplexV1ListLakesResponse
List lakes response.
GoogleCloudDataplexV1ListPartitionsResponse
List metadata partitions response.
GoogleCloudDataplexV1ListSessionsResponse
List sessions response.
GoogleCloudDataplexV1ListTasksResponse
List tasks response.
GoogleCloudDataplexV1ListZonesResponse
List zones response.
GoogleCloudDataplexV1Partition
Represents partition metadata contained within entity instances.
GoogleCloudDataplexV1ResourceAccessSpec
ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table.
GoogleCloudDataplexV1RunDataScanResponse
Run DataScan Response.
GoogleCloudDataplexV1RunTaskRequest
GoogleCloudDataplexV1RunTaskResponse
GoogleCloudDataplexV1ScannedData
The data scanned during processing (e.g. in incremental DataScan)
GoogleCloudDataplexV1ScannedDataIncrementalField
A data range denoted by a pair of start/end values of a field.
GoogleCloudDataplexV1Schema
Schema information describing the structure and layout of the data.
GoogleCloudDataplexV1SchemaPartitionField
Represents a key field within the entity's partition structure.
GoogleCloudDataplexV1SchemaSchemaField
Represents a column field within a table schema.
GoogleCloudDataplexV1Session
Represents an active analyze session running for a user.
GoogleCloudDataplexV1StorageAccess
Describes the access mechanism of the data within its storage location.
GoogleCloudDataplexV1StorageFormat
Describes the format of the data within its storage location.
GoogleCloudDataplexV1StorageFormatCsvOptions
Describes CSV and similar semi-structured data formats.
GoogleCloudDataplexV1StorageFormatIcebergOptions
Describes Iceberg data format.
GoogleCloudDataplexV1StorageFormatJsonOptions
Describes JSON data format.
GoogleCloudDataplexV1Task
A task represents a user-visible job.
GoogleCloudDataplexV1TaskExecutionSpec
Execution related settings, like retry and service_account.
GoogleCloudDataplexV1TaskExecutionStatus
Status of the task execution (e.g. Jobs).
GoogleCloudDataplexV1TaskInfrastructureSpec
Configuration for the underlying infrastructure used to run workloads.
GoogleCloudDataplexV1TaskInfrastructureSpecBatchComputeResources
Batch compute resources associated with the task.
GoogleCloudDataplexV1TaskInfrastructureSpecContainerImageRuntime
Container Image Runtime Configuration used with Batch execution.
GoogleCloudDataplexV1TaskInfrastructureSpecVpcNetwork
Cloud VPC Network used to run the infrastructure.
GoogleCloudDataplexV1TaskNotebookTaskConfig
Config for running scheduled notebooks.
GoogleCloudDataplexV1TaskSparkTaskConfig
User-specified config for running a Spark task.
GoogleCloudDataplexV1TaskTriggerSpec
Task scheduling and trigger settings.
GoogleCloudDataplexV1Trigger
DataScan scheduling and trigger settings.
GoogleCloudDataplexV1TriggerSchedule
The scan is scheduled to run periodically.
GoogleCloudDataplexV1Zone
A zone represents a logical group of related assets within a lake.
GoogleCloudDataplexV1ZoneDiscoverySpec
Settings to manage the metadata discovery and publishing in a zone.
GoogleCloudDataplexV1ZoneResourceSpec
Settings for resources attached as assets within a zone.
GoogleCloudLocationListLocationsResponse
The response message for Locations.ListLocations.
GoogleIamV1AuditConfig
Specifies the audit configuration for a service.
GoogleIamV1Binding
Associates members, or principals, with a role.
GoogleIamV1Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings.
GoogleIamV1SetIamPolicyRequest
Request message for SetIamPolicy method.
GoogleLongrunningListOperationsResponse
The response message for Operations.ListOperations.
GoogleLongrunningOperation
This resource represents a long-running operation that is the result of a network API call.
ProjectsLocationsAspectTypesResource
ProjectsLocationsDataAttributeBindingsResource
ProjectsLocationsDataScansJobsResource
ProjectsLocationsDataScansResource
ProjectsLocationsDataTaxonomiesAttributesResource
ProjectsLocationsDataTaxonomiesResource
ProjectsLocationsEntryGroupsResource
ProjectsLocationsEntryTypesResource
ProjectsLocationsGovernanceRulesResource
ProjectsLocationsLakesActionsResource
ProjectsLocationsLakesContentitemsResource
ProjectsLocationsLakesContentResource
ProjectsLocationsLakesEnvironmentsResource
ProjectsLocationsLakesEnvironmentsSessionsResource
ProjectsLocationsLakesResource
ProjectsLocationsLakesTasksJobsResource
ProjectsLocationsLakesTasksResource
ProjectsLocationsLakesZonesActionsResource
ProjectsLocationsLakesZonesAssetsActionsResource
ProjectsLocationsLakesZonesAssetsResource
ProjectsLocationsLakesZonesEntitiesPartitionsResource
ProjectsLocationsLakesZonesEntitiesResource
ProjectsLocationsLakesZonesResource
ProjectsLocationsOperationsResource
ProjectsLocationsResource
ProjectsResource

Typedefs

Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
GoogleCloudDataplexV1ActionInvalidDataOrganization = $Empty
Action details for invalid data arrangement.
GoogleCloudDataplexV1ActionMissingData = $Empty
Action details for absence of data detected by discovery.
GoogleCloudDataplexV1ActionMissingResource = $Empty
Action details for resource references in assets that cannot be located.
GoogleCloudDataplexV1ActionUnauthorizedResource = $Empty
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.
GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions = $DiscoverySpecCsvOptions
Describe CSV and similar semi-structured data formats.
GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions = $DiscoverySpecJsonOptions
Describe JSON data format.
GoogleCloudDataplexV1CancelJobRequest = $Empty
Cancel task jobs.
GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult = $ResultPostScanActionsResultBigQueryExportResult
The result of BigQuery export post scan action.
GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult = $ResultPostScanActionsResultBigQueryExportResult
The result of BigQuery export post scan action.
GoogleCloudDataplexV1DataQualityRuleNonNullExpectation = $Empty
Evaluates whether each column value is null.
GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation = $ConditionExpectation
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
GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation = $ConditionExpectation
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
GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation = $Empty
Evaluates whether the column has duplicates.
GoogleCloudDataplexV1RunDataScanRequest = $Empty
Run DataScan Request
GoogleCloudDataplexV1TriggerOnDemand = $Empty
The scan runs once via RunDataScan API.
GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptions = $DiscoverySpecCsvOptions
Describe CSV and similar semi-structured data formats.
GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions = $DiscoverySpecJsonOptions
Describe JSON data format.
GoogleCloudLocationLocation = $Location01
A resource that represents a Google Cloud location.
GoogleIamV1AuditLogConfig = $AuditLogConfig
Provides the configuration for logging a type of permissions.
GoogleIamV1TestIamPermissionsRequest = $TestIamPermissionsRequest01
Request message for TestIamPermissions method.
GoogleIamV1TestIamPermissionsResponse = $TestIamPermissionsResponse
Response message for TestIamPermissions method.
GoogleLongrunningCancelOperationRequest = $Empty
The request message for Operations.CancelOperation.
GoogleRpcStatus = $Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
GoogleTypeExpr = $Expr
Represents a textual expression in the Common Expression Language (CEL) syntax.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.