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.
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.
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.
CreateAssetRequest
Create asset request.
CreateContentRequest
Create content request.
CreateEntityRequest
Create a metadata entity request.
CreateEnvironmentRequest
Create environment request.
CreateLakeRequest
Create lake request.
CreatePartitionRequest
Create metadata partition request.
CreateTaskRequest
Create task request.
CreateZoneRequest
Create zone request.
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 adminstrator 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.
DeleteAssetRequest
Delete asset request.
DeleteContentRequest
Delete content request.
DeleteEntityRequest
Delete a metadata entity 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.
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.
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
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
Environment.Types.SessionStatus
EnvironmentName
Resource name for the Environment
resource.
GetAssetRequest
Get asset request.
GetContentRequest
Get content request.
GetContentRequest.Types
Container for nested types declared in the GetContentRequest message type.
GetEntityRequest
Get metadata entity request.
GetEntityRequest.Types
Container for nested types declared in the GetEntityRequest message type.
GetEnvironmentRequest
Get environment request.
GetJobRequest
Get job request.
GetLakeRequest
Get lake request.
GetPartitionRequest
Get metadata partition request.
GetTaskRequest
Get task request.
GetZoneRequest
Get zone request.
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.
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.
ListEntitiesRequest
List metadata entities request.
ListEntitiesRequest.Types
Container for nested types declared in the ListEntitiesRequest message type.
ListEntitiesResponse
List metadata entities 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.
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.
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.
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.
Schema.Types.SchemaField
Represents a column field within a table schema.
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.
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.JsonOptions
Describes JSON data format.
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.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.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.
UpdateAssetRequest
Update asset request.
UpdateContentRequest
Update content 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.
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.
Zone.Types
Container for nested types declared in the Zone message type.
Zone.Types.DiscoverySpec
Settings to manage the metadata discovery and publishing in a zone.
Zone.Types.DiscoverySpec.Types
Container for nested types declared in the DiscoverySpec message type.
Zone.Types.DiscoverySpec.Types.CsvOptions
Describe CSV and similar semi-structured data formats.
Zone.Types.DiscoverySpec.Types.JsonOptions
Describe JSON data format.
Zone.Types.ResourceSpec
Settings for resources attached as assets within a zone.
Zone.Types.ResourceSpec.Types
Container for nested types declared in the ResourceSpec message type.
ZoneName
Resource name for the Zone
resource.
Enums
Action.DetailsOneofCase
Enum of possible cases for the "details" oneof.
Action.Types.Category
The category of issues.
Action.Types.IncompatibleDataSchema.Types.SchemaChange
Whether the action relates to a schema that is incompatible or modified.
Action.Types.InvalidDataPartition.Types.PartitionStructure
The expected partition structure.
ActionName.ResourceNameType
The possible contents of ActionName.
Asset.Types.DiscoverySpec.TriggerOneofCase
Enum of possible cases for the "trigger" oneof.
Asset.Types.DiscoveryStatus.Types.State
Current state of discovery.
Asset.Types.ResourceSpec.Types.Type
Type of resource.
Asset.Types.ResourceStatus.Types.State
The state of a resource.
Asset.Types.SecurityStatus.Types.State
The state of the security policy.
AssetName.ResourceNameType
The possible contents of AssetName.
Content.ContentOneofCase
Enum of possible cases for the "content" oneof.
Content.DataOneofCase
Enum of possible cases for the "data" oneof.
Content.Types.Notebook.Types.KernelType
Kernel Type of the Jupyter notebook.
Content.Types.SqlScript.Types.QueryEngine
Query Engine Type of the SQL Script.
ContentName.ResourceNameType
The possible contents of ContentName.
DiscoveryEvent.DetailsOneofCase
Enum of possible cases for the "details" oneof.
DiscoveryEvent.Types.EntityType
The type of the entity.
DiscoveryEvent.Types.EventType
The type of the event.
Entity.Types.Type
The type of entity.
EntityName.ResourceNameType
The possible contents of EntityName.
Environment.Types.InfrastructureSpec.ResourcesOneofCase
Enum of possible cases for the "resources" oneof.
Environment.Types.InfrastructureSpec.RuntimeOneofCase
Enum of possible cases for the "runtime" oneof.
EnvironmentName.ResourceNameType
The possible contents of EnvironmentName.
GetContentRequest.Types.ContentView
Specifies whether the request should return the full or the partial representation.
GetEntityRequest.Types.EntityView
Entity views for get entity partial result.
Job.Types.Service
Job.Types.State
JobEvent.Types.Service
The service used to execute the job.
JobEvent.Types.State
The completion status of the job.
JobEvent.Types.Type
The type of the job.
JobName.ResourceNameType
The possible contents of JobName.
Lake.Types.MetastoreStatus.Types.State
Current state of association.
LakeName.ResourceNameType
The possible contents of LakeName.
ListEntitiesRequest.Types.EntityView
Entity views.
PartitionName.ResourceNameType
The possible contents of PartitionName.
Schema.Types.Mode
Additional qualifiers to define field semantics.
Schema.Types.PartitionStyle
The structure of paths within the entity, which represent partitions.
Schema.Types.Type
Type information for fields in schemas and partition schemas.
SessionEvent.DetailOneofCase
Enum of possible cases for the "detail" oneof.
SessionEvent.Types.EventType
The type of the event.
SessionEvent.Types.QueryDetail.Types.Engine
Query Execution engine.
SessionName.ResourceNameType
The possible contents of SessionName.
State
State of a resource.
StorageFormat.OptionsOneofCase
Enum of possible cases for the "options" oneof.
StorageFormat.Types.CompressionFormat
The specific compressed file format of the data.
StorageFormat.Types.Format
The specific file format of the data.
StorageSystem
Identifies the cloud system that manages the data storage.
Task.ConfigOneofCase
Enum of possible cases for the "config" oneof.
Task.Types.InfrastructureSpec.NetworkOneofCase
Enum of possible cases for the "network" oneof.
Task.Types.InfrastructureSpec.ResourcesOneofCase
Enum of possible cases for the "resources" oneof.
Task.Types.InfrastructureSpec.RuntimeOneofCase
Enum of possible cases for the "runtime" oneof.
Task.Types.InfrastructureSpec.Types.VpcNetwork.NetworkNameOneofCase
Enum of possible cases for the "network_name" oneof.
Task.Types.SparkTaskConfig.DriverOneofCase
Enum of possible cases for the "driver" oneof.
Task.Types.TriggerSpec.TriggerOneofCase
Enum of possible cases for the "trigger" oneof.
Task.Types.TriggerSpec.Types.Type
Determines how often and when the job will run.
TaskName.ResourceNameType
The possible contents of TaskName.
Zone.Types.DiscoverySpec.TriggerOneofCase
Enum of possible cases for the "trigger" oneof.
Zone.Types.ResourceSpec.Types.LocationType
Location type of the resources attached to a zone.
Zone.Types.Type
Type of zone.
ZoneName.ResourceNameType
The possible contents of ZoneName.