dataplex.v1 library Null safety
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:
- ProjectsResource
- ProjectsLocationsResource
- ProjectsLocationsLakesResource
- ProjectsLocationsOperationsResource
- ProjectsLocationsResource
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.
- 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
- 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
- GoogleCloudDataplexV1EnvironmentSessionStatus
- 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.
- 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.
- 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.
- GoogleCloudDataplexV1StorageFormat
- Describes the format of the data within its storage location.
- GoogleCloudDataplexV1StorageFormatCsvOptions
- Describes CSV and similar semi-structured data formats.
- 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.
- GoogleCloudDataplexV1TaskSparkTaskConfig
- User-specified config for running a Spark task.
- GoogleCloudDataplexV1TaskTriggerSpec
- Task scheduling and trigger settings.
- 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.
- 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.
- 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.
- GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptions = $DiscoverySpecCsvOptions
- Describe CSV and similar semi-structured data formats.
- GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptions = $DiscoverySpecJsonOptions
- Describe JSON data format.
- GoogleCloudLocationLocation = $Location01
- A resource that represents Google Cloud Platform 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.