A client to Cloud Dataplex API
The interfaces provided are listed below, along with usage samples.
ContentServiceClient
Service Description: ContentService manages Notebook and SQL Scripts for Dataplex.
Sample for ContentServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
Content content = Content.newBuilder().build();
Content response = contentServiceClient.createContent(parent, content);
}
DataScanServiceClient
Service Description: 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.
Sample for DataScanServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataScanServiceClient dataScanServiceClient = DataScanServiceClient.create()) {
DataScanName name = DataScanName.of("[PROJECT]", "[LOCATION]", "[DATASCAN]");
DataScan response = dataScanServiceClient.getDataScan(name);
}
MetadataServiceClient
Service Description: Metadata service manages metadata resources such as tables, filesets and partitions.
Sample for MetadataServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (MetadataServiceClient metadataServiceClient = MetadataServiceClient.create()) {
ZoneName parent = ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]");
Entity entity = Entity.newBuilder().build();
Entity response = metadataServiceClient.createEntity(parent, entity);
}
DataplexServiceClient
Service Description: 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.
Sample for DataplexServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
LakeName name = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
Lake response = dataplexServiceClient.getLake(name);
}
Classes
Action
Action represents an issue requiring administrator action for resolution.
Protobuf type google.cloud.dataplex.v1.Action
Action.Builder
Action represents an issue requiring administrator action for resolution.
Protobuf type google.cloud.dataplex.v1.Action
Action.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.
Protobuf type google.cloud.dataplex.v1.Action.FailedSecurityPolicyApply
Action.FailedSecurityPolicyApply.Builder
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.
Protobuf type google.cloud.dataplex.v1.Action.FailedSecurityPolicyApply
Action.IncompatibleDataSchema
Action details for incompatible schemas detected by discovery.
Protobuf type google.cloud.dataplex.v1.Action.IncompatibleDataSchema
Action.IncompatibleDataSchema.Builder
Action details for incompatible schemas detected by discovery.
Protobuf type google.cloud.dataplex.v1.Action.IncompatibleDataSchema
Action.InvalidDataFormat
Action details for invalid or unsupported data files detected by discovery.
Protobuf type google.cloud.dataplex.v1.Action.InvalidDataFormat
Action.InvalidDataFormat.Builder
Action details for invalid or unsupported data files detected by discovery.
Protobuf type google.cloud.dataplex.v1.Action.InvalidDataFormat
Action.InvalidDataOrganization
Action details for invalid data arrangement.
Protobuf type google.cloud.dataplex.v1.Action.InvalidDataOrganization
Action.InvalidDataOrganization.Builder
Action details for invalid data arrangement.
Protobuf type google.cloud.dataplex.v1.Action.InvalidDataOrganization
Action.InvalidDataPartition
Action details for invalid or unsupported partitions detected by discovery.
Protobuf type google.cloud.dataplex.v1.Action.InvalidDataPartition
Action.InvalidDataPartition.Builder
Action details for invalid or unsupported partitions detected by discovery.
Protobuf type google.cloud.dataplex.v1.Action.InvalidDataPartition
Action.MissingData
Action details for absence of data detected by discovery.
Protobuf type google.cloud.dataplex.v1.Action.MissingData
Action.MissingData.Builder
Action details for absence of data detected by discovery.
Protobuf type google.cloud.dataplex.v1.Action.MissingData
Action.MissingResource
Action details for resource references in assets that cannot be located.
Protobuf type google.cloud.dataplex.v1.Action.MissingResource
Action.MissingResource.Builder
Action details for resource references in assets that cannot be located.
Protobuf type google.cloud.dataplex.v1.Action.MissingResource
Action.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.
Protobuf type google.cloud.dataplex.v1.Action.UnauthorizedResource
Action.UnauthorizedResource.Builder
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.
Protobuf type google.cloud.dataplex.v1.Action.UnauthorizedResource
AnalyzeProto
Asset
An asset represents a cloud resource that is being managed within a lake as a member of a zone.
Protobuf type google.cloud.dataplex.v1.Asset
Asset.Builder
An asset represents a cloud resource that is being managed within a lake as a member of a zone.
Protobuf type google.cloud.dataplex.v1.Asset
Asset.DiscoverySpec
Settings to manage the metadata discovery and publishing for an asset.
Protobuf type google.cloud.dataplex.v1.Asset.DiscoverySpec
Asset.DiscoverySpec.Builder
Settings to manage the metadata discovery and publishing for an asset.
Protobuf type google.cloud.dataplex.v1.Asset.DiscoverySpec
Asset.DiscoverySpec.CsvOptions
Describe CSV and similar semi-structured data formats.
Protobuf type google.cloud.dataplex.v1.Asset.DiscoverySpec.CsvOptions
Asset.DiscoverySpec.CsvOptions.Builder
Describe CSV and similar semi-structured data formats.
Protobuf type google.cloud.dataplex.v1.Asset.DiscoverySpec.CsvOptions
Asset.DiscoverySpec.JsonOptions
Describe JSON data format.
Protobuf type google.cloud.dataplex.v1.Asset.DiscoverySpec.JsonOptions
Asset.DiscoverySpec.JsonOptions.Builder
Describe JSON data format.
Protobuf type google.cloud.dataplex.v1.Asset.DiscoverySpec.JsonOptions
Asset.DiscoveryStatus
Status of discovery for an asset.
Protobuf type google.cloud.dataplex.v1.Asset.DiscoveryStatus
Asset.DiscoveryStatus.Builder
Status of discovery for an asset.
Protobuf type google.cloud.dataplex.v1.Asset.DiscoveryStatus
Asset.DiscoveryStatus.Stats
The aggregated data statistics for the asset reported by discovery.
Protobuf type google.cloud.dataplex.v1.Asset.DiscoveryStatus.Stats
Asset.DiscoveryStatus.Stats.Builder
The aggregated data statistics for the asset reported by discovery.
Protobuf type google.cloud.dataplex.v1.Asset.DiscoveryStatus.Stats
Asset.ResourceSpec
Identifies the cloud resource that is referenced by this asset.
Protobuf type google.cloud.dataplex.v1.Asset.ResourceSpec
Asset.ResourceSpec.Builder
Identifies the cloud resource that is referenced by this asset.
Protobuf type google.cloud.dataplex.v1.Asset.ResourceSpec
Asset.ResourceStatus
Status of the resource referenced by an asset.
Protobuf type google.cloud.dataplex.v1.Asset.ResourceStatus
Asset.ResourceStatus.Builder
Status of the resource referenced by an asset.
Protobuf type google.cloud.dataplex.v1.Asset.ResourceStatus
Asset.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.
Protobuf type google.cloud.dataplex.v1.Asset.SecurityStatus
Asset.SecurityStatus.Builder
Security policy status of the asset. Data security policy, i.e., readers, writers & owners, should be specified in the lake/zone/asset IAM policy.
Protobuf type google.cloud.dataplex.v1.Asset.SecurityStatus
AssetName
AssetName.Builder
Builder for projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}.
AssetStatus
Aggregated status of the underlying assets of a lake or zone.
Protobuf type google.cloud.dataplex.v1.AssetStatus
AssetStatus.Builder
Aggregated status of the underlying assets of a lake or zone.
Protobuf type google.cloud.dataplex.v1.AssetStatus
CancelJobRequest
Cancel task jobs.
Protobuf type google.cloud.dataplex.v1.CancelJobRequest
CancelJobRequest.Builder
Cancel task jobs.
Protobuf type google.cloud.dataplex.v1.CancelJobRequest
Content
Content represents a user-visible notebook or a sql script
Protobuf type google.cloud.dataplex.v1.Content
Content.Builder
Content represents a user-visible notebook or a sql script
Protobuf type google.cloud.dataplex.v1.Content
Content.Notebook
Configuration for Notebook content.
Protobuf type google.cloud.dataplex.v1.Content.Notebook
Content.Notebook.Builder
Configuration for Notebook content.
Protobuf type google.cloud.dataplex.v1.Content.Notebook
Content.SqlScript
Configuration for the Sql Script content.
Protobuf type google.cloud.dataplex.v1.Content.SqlScript
Content.SqlScript.Builder
Configuration for the Sql Script content.
Protobuf type google.cloud.dataplex.v1.Content.SqlScript
ContentName
ContentName.Builder
Builder for projects/{project}/locations/{location}/lakes/{lake}/content/{content}.
ContentProto
ContentServiceClient
Service Description: ContentService manages Notebook and SQL Scripts for Dataplex.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ContentServiceClient contentServiceClient = ContentServiceClient.create()) {
LakeName parent = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
Content content = Content.newBuilder().build();
Content response = contentServiceClient.createContent(parent, content);
}
Note: close() needs to be called on the ContentServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ContentServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ContentServiceSettings contentServiceSettings =
ContentServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ContentServiceClient contentServiceClient = ContentServiceClient.create(contentServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ContentServiceSettings contentServiceSettings =
ContentServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
ContentServiceClient contentServiceClient = ContentServiceClient.create(contentServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ContentServiceSettings contentServiceSettings =
ContentServiceSettings.newHttpJsonBuilder().build();
ContentServiceClient contentServiceClient = ContentServiceClient.create(contentServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ContentServiceClient.ListContentFixedSizeCollection
ContentServiceClient.ListContentPage
ContentServiceClient.ListContentPagedResponse
ContentServiceClient.ListLocationsFixedSizeCollection
ContentServiceClient.ListLocationsPage
ContentServiceClient.ListLocationsPagedResponse
ContentServiceGrpc
ContentService manages Notebook and SQL Scripts for Dataplex.
ContentServiceGrpc.ContentServiceBlockingStub
ContentService manages Notebook and SQL Scripts for Dataplex.
ContentServiceGrpc.ContentServiceFutureStub
ContentService manages Notebook and SQL Scripts for Dataplex.
ContentServiceGrpc.ContentServiceImplBase
ContentService manages Notebook and SQL Scripts for Dataplex.
ContentServiceGrpc.ContentServiceStub
ContentService manages Notebook and SQL Scripts for Dataplex.
ContentServiceSettings
Settings class to configure an instance of ContentServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (dataplex.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of createContent to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ContentServiceSettings.Builder contentServiceSettingsBuilder =
ContentServiceSettings.newBuilder();
contentServiceSettingsBuilder
.createContentSettings()
.setRetrySettings(
contentServiceSettingsBuilder
.createContentSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ContentServiceSettings contentServiceSettings = contentServiceSettingsBuilder.build();
ContentServiceSettings.Builder
Builder for ContentServiceSettings.
CreateAssetRequest
Create asset request.
Protobuf type google.cloud.dataplex.v1.CreateAssetRequest
CreateAssetRequest.Builder
Create asset request.
Protobuf type google.cloud.dataplex.v1.CreateAssetRequest
CreateContentRequest
Create content request.
Protobuf type google.cloud.dataplex.v1.CreateContentRequest
CreateContentRequest.Builder
Create content request.
Protobuf type google.cloud.dataplex.v1.CreateContentRequest
CreateDataScanRequest
Create dataScan request.
Protobuf type google.cloud.dataplex.v1.CreateDataScanRequest
CreateDataScanRequest.Builder
Create dataScan request.
Protobuf type google.cloud.dataplex.v1.CreateDataScanRequest
CreateEntityRequest
Create a metadata entity request.
Protobuf type google.cloud.dataplex.v1.CreateEntityRequest
CreateEntityRequest.Builder
Create a metadata entity request.
Protobuf type google.cloud.dataplex.v1.CreateEntityRequest
CreateEnvironmentRequest
Create environment request.
Protobuf type google.cloud.dataplex.v1.CreateEnvironmentRequest
CreateEnvironmentRequest.Builder
Create environment request.
Protobuf type google.cloud.dataplex.v1.CreateEnvironmentRequest
CreateLakeRequest
Create lake request.
Protobuf type google.cloud.dataplex.v1.CreateLakeRequest
CreateLakeRequest.Builder
Create lake request.
Protobuf type google.cloud.dataplex.v1.CreateLakeRequest
CreatePartitionRequest
Create metadata partition request.
Protobuf type google.cloud.dataplex.v1.CreatePartitionRequest
CreatePartitionRequest.Builder
Create metadata partition request.
Protobuf type google.cloud.dataplex.v1.CreatePartitionRequest
CreateTaskRequest
Create task request.
Protobuf type google.cloud.dataplex.v1.CreateTaskRequest
CreateTaskRequest.Builder
Create task request.
Protobuf type google.cloud.dataplex.v1.CreateTaskRequest
CreateZoneRequest
Create zone request.
Protobuf type google.cloud.dataplex.v1.CreateZoneRequest
CreateZoneRequest.Builder
Create zone request.
Protobuf type google.cloud.dataplex.v1.CreateZoneRequest
DataProfileProto
DataProfileResult
DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result.
Protobuf type google.cloud.dataplex.v1.DataProfileResult
DataProfileResult.Builder
DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result.
Protobuf type google.cloud.dataplex.v1.DataProfileResult
DataProfileResult.Profile
Profile information describing the structure and layout of the data and contains the profile info.
Protobuf type google.cloud.dataplex.v1.DataProfileResult.Profile
DataProfileResult.Profile.Builder
Profile information describing the structure and layout of the data and contains the profile info.
Protobuf type google.cloud.dataplex.v1.DataProfileResult.Profile
DataProfileResult.Profile.Field
Represents a column field within a table schema.
Protobuf type google.cloud.dataplex.v1.DataProfileResult.Profile.Field
DataProfileResult.Profile.Field.Builder
Represents a column field within a table schema.
Protobuf type google.cloud.dataplex.v1.DataProfileResult.Profile.Field
DataProfileResult.Profile.Field.ProfileInfo
ProfileInfo defines the profile information for each schema field type.
Protobuf type google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo
DataProfileResult.Profile.Field.ProfileInfo.Builder
ProfileInfo defines the profile information for each schema field type.
Protobuf type
google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo
DataProfileResult.Profile.Field.ProfileInfo.DoubleFieldInfo
DoubleFieldInfo defines output for any double type field.
Protobuf type
google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.DoubleFieldInfo
DataProfileResult.Profile.Field.ProfileInfo.DoubleFieldInfo.Builder
DoubleFieldInfo defines output for any double type field.
Protobuf type
google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.DoubleFieldInfo
DataProfileResult.Profile.Field.ProfileInfo.IntegerFieldInfo
IntegerFieldInfo defines output for any integer type field.
Protobuf type
google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.IntegerFieldInfo
DataProfileResult.Profile.Field.ProfileInfo.IntegerFieldInfo.Builder
IntegerFieldInfo defines output for any integer type field.
Protobuf type
google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.IntegerFieldInfo
DataProfileResult.Profile.Field.ProfileInfo.StringFieldInfo
StringFieldInfo defines output info for any string type field.
Protobuf type
google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.StringFieldInfo
DataProfileResult.Profile.Field.ProfileInfo.StringFieldInfo.Builder
StringFieldInfo defines output info for any string type field.
Protobuf type
google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.StringFieldInfo
DataProfileResult.Profile.Field.ProfileInfo.TopNValue
The TopNValue defines the structure of output of top N values of a field.
Protobuf type
google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.TopNValue
DataProfileResult.Profile.Field.ProfileInfo.TopNValue.Builder
The TopNValue defines the structure of output of top N values of a field.
Protobuf type
google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo.TopNValue
DataProfileSpec
DataProfileScan related setting.
Protobuf type google.cloud.dataplex.v1.DataProfileSpec
DataProfileSpec.Builder
DataProfileScan related setting.
Protobuf type google.cloud.dataplex.v1.DataProfileSpec
DataQualityDimensionResult
DataQualityDimensionResult provides a more detailed, per-dimension level view of the results.
Protobuf type google.cloud.dataplex.v1.DataQualityDimensionResult
DataQualityDimensionResult.Builder
DataQualityDimensionResult provides a more detailed, per-dimension level view of the results.
Protobuf type google.cloud.dataplex.v1.DataQualityDimensionResult
DataQualityProto
DataQualityResult
The output of a DataQualityScan.
Protobuf type google.cloud.dataplex.v1.DataQualityResult
DataQualityResult.Builder
The output of a DataQualityScan.
Protobuf type google.cloud.dataplex.v1.DataQualityResult
DataQualityRule
A rule captures data quality intent about a data source.
Protobuf type google.cloud.dataplex.v1.DataQualityRule
DataQualityRule.Builder
A rule captures data quality intent about a data source.
Protobuf type google.cloud.dataplex.v1.DataQualityRule
DataQualityRule.NonNullExpectation
Evaluates whether each column value is null.
Protobuf type google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation
DataQualityRule.NonNullExpectation.Builder
Evaluates whether each column value is null.
Protobuf type google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation
DataQualityRule.RangeExpectation
Evaluates whether each column value lies between a specified range.
Protobuf type google.cloud.dataplex.v1.DataQualityRule.RangeExpectation
DataQualityRule.RangeExpectation.Builder
Evaluates whether each column value lies between a specified range.
Protobuf type google.cloud.dataplex.v1.DataQualityRule.RangeExpectation
DataQualityRule.RegexExpectation
Evaluates whether each column value matches a specified regex.
Protobuf type google.cloud.dataplex.v1.DataQualityRule.RegexExpectation
DataQualityRule.RegexExpectation.Builder
Evaluates whether each column value matches a specified regex.
Protobuf type google.cloud.dataplex.v1.DataQualityRule.RegexExpectation
DataQualityRule.RowConditionExpectation
Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10
Protobuf type google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation
DataQualityRule.RowConditionExpectation.Builder
Evaluates whether each row passes the specified condition. The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean per row as the result. Example: col1 >= 0 AND col2 < 10
Protobuf type google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation
DataQualityRule.SetExpectation
Evaluates whether each column value is contained by a specified set.
Protobuf type google.cloud.dataplex.v1.DataQualityRule.SetExpectation
DataQualityRule.SetExpectation.Builder
Evaluates whether each column value is contained by a specified set.
Protobuf type google.cloud.dataplex.v1.DataQualityRule.SetExpectation
DataQualityRule.StatisticRangeExpectation
Evaluates whether the column aggregate statistic lies between a specified range.
Protobuf type google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation
DataQualityRule.StatisticRangeExpectation.Builder
Evaluates whether the column aggregate statistic lies between a specified range.
Protobuf type google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation
DataQualityRule.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
Protobuf type google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation
DataQualityRule.TableConditionExpectation.Builder
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
Protobuf type google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation
DataQualityRule.UniquenessExpectation
Evaluates whether the column has duplicates.
Protobuf type google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation
DataQualityRule.UniquenessExpectation.Builder
Evaluates whether the column has duplicates.
Protobuf type google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation
DataQualityRuleResult
DataQualityRuleResult provides a more detailed, per-rule level view of the results.
Protobuf type google.cloud.dataplex.v1.DataQualityRuleResult
DataQualityRuleResult.Builder
DataQualityRuleResult provides a more detailed, per-rule level view of the results.
Protobuf type google.cloud.dataplex.v1.DataQualityRuleResult
DataQualitySpec
DataQualityScan related setting.
Protobuf type google.cloud.dataplex.v1.DataQualitySpec
DataQualitySpec.Builder
DataQualityScan related setting.
Protobuf type google.cloud.dataplex.v1.DataQualitySpec
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).
Protobuf type google.cloud.dataplex.v1.DataScan
DataScan.Builder
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).
Protobuf type google.cloud.dataplex.v1.DataScan
DataScan.ExecutionSpec
DataScan execution settings.
Protobuf type google.cloud.dataplex.v1.DataScan.ExecutionSpec
DataScan.ExecutionSpec.Builder
DataScan execution settings.
Protobuf type google.cloud.dataplex.v1.DataScan.ExecutionSpec
DataScan.ExecutionStatus
Status of the data scan execution.
Protobuf type google.cloud.dataplex.v1.DataScan.ExecutionStatus
DataScan.ExecutionStatus.Builder
Status of the data scan execution.
Protobuf type google.cloud.dataplex.v1.DataScan.ExecutionStatus
DataScanEvent
These messages contain information about the execution of a datascan. The monitored resource is 'DataScan'
Protobuf type google.cloud.dataplex.v1.DataScanEvent
DataScanEvent.Builder
These messages contain information about the execution of a datascan. The monitored resource is 'DataScan'
Protobuf type google.cloud.dataplex.v1.DataScanEvent
DataScanEvent.DataProfileResult
Data profile result for data scan job.
Protobuf type google.cloud.dataplex.v1.DataScanEvent.DataProfileResult
DataScanEvent.DataProfileResult.Builder
Data profile result for data scan job.
Protobuf type google.cloud.dataplex.v1.DataScanEvent.DataProfileResult
DataScanEvent.DataQualityResult
Data quality result for data scan job.
Protobuf type google.cloud.dataplex.v1.DataScanEvent.DataQualityResult
DataScanEvent.DataQualityResult.Builder
Data quality result for data scan job.
Protobuf type google.cloud.dataplex.v1.DataScanEvent.DataQualityResult
DataScanJob
A DataScanJob represents an instance of DataScan execution.
Protobuf type google.cloud.dataplex.v1.DataScanJob
DataScanJob.Builder
A DataScanJob represents an instance of DataScan execution.
Protobuf type google.cloud.dataplex.v1.DataScanJob
DataScanJobName
DataScanJobName.Builder
Builder for projects/{project}/locations/{location}/dataScans/{dataScan}/jobs/{job}.
DataScanName
DataScanName.Builder
Builder for projects/{project}/locations/{location}/dataScans/{dataScan}.
DataScanServiceClient
Service Description: 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.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataScanServiceClient dataScanServiceClient = DataScanServiceClient.create()) {
DataScanName name = DataScanName.of("[PROJECT]", "[LOCATION]", "[DATASCAN]");
DataScan response = dataScanServiceClient.getDataScan(name);
}
Note: close() needs to be called on the DataScanServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DataScanServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataScanServiceSettings dataScanServiceSettings =
DataScanServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DataScanServiceClient dataScanServiceClient =
DataScanServiceClient.create(dataScanServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataScanServiceSettings dataScanServiceSettings =
DataScanServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
DataScanServiceClient dataScanServiceClient =
DataScanServiceClient.create(dataScanServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataScanServiceSettings dataScanServiceSettings =
DataScanServiceSettings.newHttpJsonBuilder().build();
DataScanServiceClient dataScanServiceClient =
DataScanServiceClient.create(dataScanServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
DataScanServiceClient.ListDataScanJobsFixedSizeCollection
DataScanServiceClient.ListDataScanJobsPage
DataScanServiceClient.ListDataScanJobsPagedResponse
DataScanServiceClient.ListDataScansFixedSizeCollection
DataScanServiceClient.ListDataScansPage
DataScanServiceClient.ListDataScansPagedResponse
DataScanServiceClient.ListLocationsFixedSizeCollection
DataScanServiceClient.ListLocationsPage
DataScanServiceClient.ListLocationsPagedResponse
DataScanServiceGrpc
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.
DataScanServiceGrpc.DataScanServiceBlockingStub
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.
DataScanServiceGrpc.DataScanServiceFutureStub
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.
DataScanServiceGrpc.DataScanServiceImplBase
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.
DataScanServiceGrpc.DataScanServiceStub
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.
DataScanServiceSettings
Settings class to configure an instance of DataScanServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (dataplex.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getDataScan to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataScanServiceSettings.Builder dataScanServiceSettingsBuilder =
DataScanServiceSettings.newBuilder();
dataScanServiceSettingsBuilder
.getDataScanSettings()
.setRetrySettings(
dataScanServiceSettingsBuilder
.getDataScanSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
DataScanServiceSettings dataScanServiceSettings = dataScanServiceSettingsBuilder.build();
DataScanServiceSettings.Builder
Builder for DataScanServiceSettings.
DataScansProto
DataSource
The data source for DataScan.
Protobuf type google.cloud.dataplex.v1.DataSource
DataSource.Builder
The data source for DataScan.
Protobuf type google.cloud.dataplex.v1.DataSource
DataplexServiceClient
Service Description: 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.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataplexServiceClient dataplexServiceClient = DataplexServiceClient.create()) {
LakeName name = LakeName.of("[PROJECT]", "[LOCATION]", "[LAKE]");
Lake response = dataplexServiceClient.getLake(name);
}
Note: close() needs to be called on the DataplexServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DataplexServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataplexServiceSettings dataplexServiceSettings =
DataplexServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DataplexServiceClient dataplexServiceClient =
DataplexServiceClient.create(dataplexServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataplexServiceSettings dataplexServiceSettings =
DataplexServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
DataplexServiceClient dataplexServiceClient =
DataplexServiceClient.create(dataplexServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataplexServiceSettings dataplexServiceSettings =
DataplexServiceSettings.newHttpJsonBuilder().build();
DataplexServiceClient dataplexServiceClient =
DataplexServiceClient.create(dataplexServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
DataplexServiceClient.ListAssetActionsFixedSizeCollection
DataplexServiceClient.ListAssetActionsPage
DataplexServiceClient.ListAssetActionsPagedResponse
DataplexServiceClient.ListAssetsFixedSizeCollection
DataplexServiceClient.ListAssetsPage
DataplexServiceClient.ListAssetsPagedResponse
DataplexServiceClient.ListEnvironmentsFixedSizeCollection
DataplexServiceClient.ListEnvironmentsPage
DataplexServiceClient.ListEnvironmentsPagedResponse
DataplexServiceClient.ListJobsFixedSizeCollection
DataplexServiceClient.ListJobsPage
DataplexServiceClient.ListJobsPagedResponse
DataplexServiceClient.ListLakeActionsFixedSizeCollection
DataplexServiceClient.ListLakeActionsPage
DataplexServiceClient.ListLakeActionsPagedResponse
DataplexServiceClient.ListLakesFixedSizeCollection
DataplexServiceClient.ListLakesPage
DataplexServiceClient.ListLakesPagedResponse
DataplexServiceClient.ListLocationsFixedSizeCollection
DataplexServiceClient.ListLocationsPage
DataplexServiceClient.ListLocationsPagedResponse
DataplexServiceClient.ListSessionsFixedSizeCollection
DataplexServiceClient.ListSessionsPage
DataplexServiceClient.ListSessionsPagedResponse
DataplexServiceClient.ListTasksFixedSizeCollection
DataplexServiceClient.ListTasksPage
DataplexServiceClient.ListTasksPagedResponse
DataplexServiceClient.ListZoneActionsFixedSizeCollection
DataplexServiceClient.ListZoneActionsPage
DataplexServiceClient.ListZoneActionsPagedResponse
DataplexServiceClient.ListZonesFixedSizeCollection
DataplexServiceClient.ListZonesPage
DataplexServiceClient.ListZonesPagedResponse
DataplexServiceGrpc
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.
DataplexServiceGrpc.DataplexServiceBlockingStub
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.
DataplexServiceGrpc.DataplexServiceFutureStub
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.
DataplexServiceGrpc.DataplexServiceImplBase
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.
DataplexServiceGrpc.DataplexServiceStub
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.
DataplexServiceSettings
Settings class to configure an instance of DataplexServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (dataplex.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getLake to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataplexServiceSettings.Builder dataplexServiceSettingsBuilder =
DataplexServiceSettings.newBuilder();
dataplexServiceSettingsBuilder
.getLakeSettings()
.setRetrySettings(
dataplexServiceSettingsBuilder
.getLakeSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
DataplexServiceSettings dataplexServiceSettings = dataplexServiceSettingsBuilder.build();
DataplexServiceSettings.Builder
Builder for DataplexServiceSettings.
DeleteAssetRequest
Delete asset request.
Protobuf type google.cloud.dataplex.v1.DeleteAssetRequest
DeleteAssetRequest.Builder
Delete asset request.
Protobuf type google.cloud.dataplex.v1.DeleteAssetRequest
DeleteContentRequest
Delete content request.
Protobuf type google.cloud.dataplex.v1.DeleteContentRequest
DeleteContentRequest.Builder
Delete content request.
Protobuf type google.cloud.dataplex.v1.DeleteContentRequest
DeleteDataScanRequest
Delete dataScan request.
Protobuf type google.cloud.dataplex.v1.DeleteDataScanRequest
DeleteDataScanRequest.Builder
Delete dataScan request.
Protobuf type google.cloud.dataplex.v1.DeleteDataScanRequest
DeleteEntityRequest
Delete a metadata entity request.
Protobuf type google.cloud.dataplex.v1.DeleteEntityRequest
DeleteEntityRequest.Builder
Delete a metadata entity request.
Protobuf type google.cloud.dataplex.v1.DeleteEntityRequest
DeleteEnvironmentRequest
Delete environment request.
Protobuf type google.cloud.dataplex.v1.DeleteEnvironmentRequest
DeleteEnvironmentRequest.Builder
Delete environment request.
Protobuf type google.cloud.dataplex.v1.DeleteEnvironmentRequest
DeleteLakeRequest
Delete lake request.
Protobuf type google.cloud.dataplex.v1.DeleteLakeRequest
DeleteLakeRequest.Builder
Delete lake request.
Protobuf type google.cloud.dataplex.v1.DeleteLakeRequest
DeletePartitionRequest
Delete metadata partition request.
Protobuf type google.cloud.dataplex.v1.DeletePartitionRequest
DeletePartitionRequest.Builder
Delete metadata partition request.
Protobuf type google.cloud.dataplex.v1.DeletePartitionRequest
DeleteTaskRequest
Delete task request.
Protobuf type google.cloud.dataplex.v1.DeleteTaskRequest
DeleteTaskRequest.Builder
Delete task request.
Protobuf type google.cloud.dataplex.v1.DeleteTaskRequest
DeleteZoneRequest
Delete zone request.
Protobuf type google.cloud.dataplex.v1.DeleteZoneRequest
DeleteZoneRequest.Builder
Delete zone request.
Protobuf type google.cloud.dataplex.v1.DeleteZoneRequest
DiscoveryEvent
The payload associated with Discovery data processing.
Protobuf type google.cloud.dataplex.v1.DiscoveryEvent
DiscoveryEvent.ActionDetails
Details about the action.
Protobuf type google.cloud.dataplex.v1.DiscoveryEvent.ActionDetails
DiscoveryEvent.ActionDetails.Builder
Details about the action.
Protobuf type google.cloud.dataplex.v1.DiscoveryEvent.ActionDetails
DiscoveryEvent.Builder
The payload associated with Discovery data processing.
Protobuf type google.cloud.dataplex.v1.DiscoveryEvent
DiscoveryEvent.ConfigDetails
Details about configuration events.
Protobuf type google.cloud.dataplex.v1.DiscoveryEvent.ConfigDetails
DiscoveryEvent.ConfigDetails.Builder
Details about configuration events.
Protobuf type google.cloud.dataplex.v1.DiscoveryEvent.ConfigDetails
DiscoveryEvent.EntityDetails
Details about the entity.
Protobuf type google.cloud.dataplex.v1.DiscoveryEvent.EntityDetails
DiscoveryEvent.EntityDetails.Builder
Details about the entity.
Protobuf type google.cloud.dataplex.v1.DiscoveryEvent.EntityDetails
DiscoveryEvent.PartitionDetails
Details about the partition.
Protobuf type google.cloud.dataplex.v1.DiscoveryEvent.PartitionDetails
DiscoveryEvent.PartitionDetails.Builder
Details about the partition.
Protobuf type google.cloud.dataplex.v1.DiscoveryEvent.PartitionDetails
Entity
Represents tables and fileset metadata contained within a zone.
Protobuf type google.cloud.dataplex.v1.Entity
Entity.Builder
Represents tables and fileset metadata contained within a zone.
Protobuf type google.cloud.dataplex.v1.Entity
Entity.CompatibilityStatus
Provides compatibility information for various metadata stores.
Protobuf type google.cloud.dataplex.v1.Entity.CompatibilityStatus
Entity.CompatibilityStatus.Builder
Provides compatibility information for various metadata stores.
Protobuf type google.cloud.dataplex.v1.Entity.CompatibilityStatus
Entity.CompatibilityStatus.Compatibility
Provides compatibility information for a specific metadata store.
Protobuf type google.cloud.dataplex.v1.Entity.CompatibilityStatus.Compatibility
Entity.CompatibilityStatus.Compatibility.Builder
Provides compatibility information for a specific metadata store.
Protobuf type google.cloud.dataplex.v1.Entity.CompatibilityStatus.Compatibility
EntityName
EntityName.Builder
Builder for projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}.
Environment
Environment represents a user-visible compute infrastructure for analytics within a lake.
Protobuf type google.cloud.dataplex.v1.Environment
Environment.Builder
Environment represents a user-visible compute infrastructure for analytics within a lake.
Protobuf type google.cloud.dataplex.v1.Environment
Environment.Endpoints
Protobuf type google.cloud.dataplex.v1.Environment.Endpoints
Environment.Endpoints.Builder
Protobuf type google.cloud.dataplex.v1.Environment.Endpoints
Environment.InfrastructureSpec
Configuration for the underlying infrastructure used to run workloads.
Protobuf type google.cloud.dataplex.v1.Environment.InfrastructureSpec
Environment.InfrastructureSpec.Builder
Configuration for the underlying infrastructure used to run workloads.
Protobuf type google.cloud.dataplex.v1.Environment.InfrastructureSpec
Environment.InfrastructureSpec.ComputeResources
Compute resources associated with the analyze interactive workloads.
Protobuf type
google.cloud.dataplex.v1.Environment.InfrastructureSpec.ComputeResources
Environment.InfrastructureSpec.ComputeResources.Builder
Compute resources associated with the analyze interactive workloads.
Protobuf type
google.cloud.dataplex.v1.Environment.InfrastructureSpec.ComputeResources
Environment.InfrastructureSpec.OsImageRuntime
Software Runtime Configuration to run Analyze.
Protobuf type google.cloud.dataplex.v1.Environment.InfrastructureSpec.OsImageRuntime
Environment.InfrastructureSpec.OsImageRuntime.Builder
Software Runtime Configuration to run Analyze.
Protobuf type
google.cloud.dataplex.v1.Environment.InfrastructureSpec.OsImageRuntime
Environment.SessionSpec
Protobuf type google.cloud.dataplex.v1.Environment.SessionSpec
Environment.SessionSpec.Builder
Protobuf type google.cloud.dataplex.v1.Environment.SessionSpec
Environment.SessionStatus
Protobuf type google.cloud.dataplex.v1.Environment.SessionStatus
Environment.SessionStatus.Builder
Protobuf type google.cloud.dataplex.v1.Environment.SessionStatus
EnvironmentName
EnvironmentName.Builder
Builder for projects/{project}/locations/{location}/lakes/{lake}/environments/{environment}.
GetAssetRequest
Get asset request.
Protobuf type google.cloud.dataplex.v1.GetAssetRequest
GetAssetRequest.Builder
Get asset request.
Protobuf type google.cloud.dataplex.v1.GetAssetRequest
GetContentRequest
Get content request.
Protobuf type google.cloud.dataplex.v1.GetContentRequest
GetContentRequest.Builder
Get content request.
Protobuf type google.cloud.dataplex.v1.GetContentRequest
GetDataScanJobRequest
Get DataScanJob request.
Protobuf type google.cloud.dataplex.v1.GetDataScanJobRequest
GetDataScanJobRequest.Builder
Get DataScanJob request.
Protobuf type google.cloud.dataplex.v1.GetDataScanJobRequest
GetDataScanRequest
Get dataScan request.
Protobuf type google.cloud.dataplex.v1.GetDataScanRequest
GetDataScanRequest.Builder
Get dataScan request.
Protobuf type google.cloud.dataplex.v1.GetDataScanRequest
GetEntityRequest
Get metadata entity request.
Protobuf type google.cloud.dataplex.v1.GetEntityRequest
GetEntityRequest.Builder
Get metadata entity request.
Protobuf type google.cloud.dataplex.v1.GetEntityRequest
GetEnvironmentRequest
Get environment request.
Protobuf type google.cloud.dataplex.v1.GetEnvironmentRequest
GetEnvironmentRequest.Builder
Get environment request.
Protobuf type google.cloud.dataplex.v1.GetEnvironmentRequest
GetJobRequest
Get job request.
Protobuf type google.cloud.dataplex.v1.GetJobRequest
GetJobRequest.Builder
Get job request.
Protobuf type google.cloud.dataplex.v1.GetJobRequest
GetLakeRequest
Get lake request.
Protobuf type google.cloud.dataplex.v1.GetLakeRequest
GetLakeRequest.Builder
Get lake request.
Protobuf type google.cloud.dataplex.v1.GetLakeRequest
GetPartitionRequest
Get metadata partition request.
Protobuf type google.cloud.dataplex.v1.GetPartitionRequest
GetPartitionRequest.Builder
Get metadata partition request.
Protobuf type google.cloud.dataplex.v1.GetPartitionRequest
GetTaskRequest
Get task request.
Protobuf type google.cloud.dataplex.v1.GetTaskRequest
GetTaskRequest.Builder
Get task request.
Protobuf type google.cloud.dataplex.v1.GetTaskRequest
GetZoneRequest
Get zone request.
Protobuf type google.cloud.dataplex.v1.GetZoneRequest
GetZoneRequest.Builder
Get zone request.
Protobuf type google.cloud.dataplex.v1.GetZoneRequest
Job
A job represents an instance of a task.
Protobuf type google.cloud.dataplex.v1.Job
Job.Builder
A job represents an instance of a task.
Protobuf type google.cloud.dataplex.v1.Job
JobEvent
The payload associated with Job logs that contains events describing jobs that have run within a Lake.
Protobuf type google.cloud.dataplex.v1.JobEvent
JobEvent.Builder
The payload associated with Job logs that contains events describing jobs that have run within a Lake.
Protobuf type google.cloud.dataplex.v1.JobEvent
JobName
JobName.Builder
Builder for projects/{project}/locations/{location}/lakes/{lake}/tasks/{task}/jobs/{job}.
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.
Protobuf type google.cloud.dataplex.v1.Lake
Lake.Builder
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.
Protobuf type google.cloud.dataplex.v1.Lake
Lake.Metastore
Settings to manage association of Dataproc Metastore with a lake.
Protobuf type google.cloud.dataplex.v1.Lake.Metastore
Lake.Metastore.Builder
Settings to manage association of Dataproc Metastore with a lake.
Protobuf type google.cloud.dataplex.v1.Lake.Metastore
Lake.MetastoreStatus
Status of Lake and Dataproc Metastore service instance association.
Protobuf type google.cloud.dataplex.v1.Lake.MetastoreStatus
Lake.MetastoreStatus.Builder
Status of Lake and Dataproc Metastore service instance association.
Protobuf type google.cloud.dataplex.v1.Lake.MetastoreStatus
LakeName
LakeName.Builder
Builder for projects/{project}/locations/{location}/lakes/{lake}.
ListActionsResponse
List actions response.
Protobuf type google.cloud.dataplex.v1.ListActionsResponse
ListActionsResponse.Builder
List actions response.
Protobuf type google.cloud.dataplex.v1.ListActionsResponse
ListAssetActionsRequest
List asset actions request.
Protobuf type google.cloud.dataplex.v1.ListAssetActionsRequest
ListAssetActionsRequest.Builder
List asset actions request.
Protobuf type google.cloud.dataplex.v1.ListAssetActionsRequest
ListAssetsRequest
List assets request.
Protobuf type google.cloud.dataplex.v1.ListAssetsRequest
ListAssetsRequest.Builder
List assets request.
Protobuf type google.cloud.dataplex.v1.ListAssetsRequest
ListAssetsResponse
List assets response.
Protobuf type google.cloud.dataplex.v1.ListAssetsResponse
ListAssetsResponse.Builder
List assets response.
Protobuf type google.cloud.dataplex.v1.ListAssetsResponse
ListContentRequest
List content request. Returns the BASIC Content view.
Protobuf type google.cloud.dataplex.v1.ListContentRequest
ListContentRequest.Builder
List content request. Returns the BASIC Content view.
Protobuf type google.cloud.dataplex.v1.ListContentRequest
ListContentResponse
List content response.
Protobuf type google.cloud.dataplex.v1.ListContentResponse
ListContentResponse.Builder
List content response.
Protobuf type google.cloud.dataplex.v1.ListContentResponse
ListDataScanJobsRequest
List DataScanJobs request.
Protobuf type google.cloud.dataplex.v1.ListDataScanJobsRequest
ListDataScanJobsRequest.Builder
List DataScanJobs request.
Protobuf type google.cloud.dataplex.v1.ListDataScanJobsRequest
ListDataScanJobsResponse
List DataScanJobs response.
Protobuf type google.cloud.dataplex.v1.ListDataScanJobsResponse
ListDataScanJobsResponse.Builder
List DataScanJobs response.
Protobuf type google.cloud.dataplex.v1.ListDataScanJobsResponse
ListDataScansRequest
List dataScans request.
Protobuf type google.cloud.dataplex.v1.ListDataScansRequest
ListDataScansRequest.Builder
List dataScans request.
Protobuf type google.cloud.dataplex.v1.ListDataScansRequest
ListDataScansResponse
List dataScans response.
Protobuf type google.cloud.dataplex.v1.ListDataScansResponse
ListDataScansResponse.Builder
List dataScans response.
Protobuf type google.cloud.dataplex.v1.ListDataScansResponse
ListEntitiesRequest
List metadata entities request.
Protobuf type google.cloud.dataplex.v1.ListEntitiesRequest
ListEntitiesRequest.Builder
List metadata entities request.
Protobuf type google.cloud.dataplex.v1.ListEntitiesRequest
ListEntitiesResponse
List metadata entities response.
Protobuf type google.cloud.dataplex.v1.ListEntitiesResponse
ListEntitiesResponse.Builder
List metadata entities response.
Protobuf type google.cloud.dataplex.v1.ListEntitiesResponse
ListEnvironmentsRequest
List environments request.
Protobuf type google.cloud.dataplex.v1.ListEnvironmentsRequest
ListEnvironmentsRequest.Builder
List environments request.
Protobuf type google.cloud.dataplex.v1.ListEnvironmentsRequest
ListEnvironmentsResponse
List environments response.
Protobuf type google.cloud.dataplex.v1.ListEnvironmentsResponse
ListEnvironmentsResponse.Builder
List environments response.
Protobuf type google.cloud.dataplex.v1.ListEnvironmentsResponse
ListJobsRequest
List jobs request.
Protobuf type google.cloud.dataplex.v1.ListJobsRequest
ListJobsRequest.Builder
List jobs request.
Protobuf type google.cloud.dataplex.v1.ListJobsRequest
ListJobsResponse
List jobs response.
Protobuf type google.cloud.dataplex.v1.ListJobsResponse
ListJobsResponse.Builder
List jobs response.
Protobuf type google.cloud.dataplex.v1.ListJobsResponse
ListLakeActionsRequest
List lake actions request.
Protobuf type google.cloud.dataplex.v1.ListLakeActionsRequest
ListLakeActionsRequest.Builder
List lake actions request.
Protobuf type google.cloud.dataplex.v1.ListLakeActionsRequest
ListLakesRequest
List lakes request.
Protobuf type google.cloud.dataplex.v1.ListLakesRequest
ListLakesRequest.Builder
List lakes request.
Protobuf type google.cloud.dataplex.v1.ListLakesRequest
ListLakesResponse
List lakes response.
Protobuf type google.cloud.dataplex.v1.ListLakesResponse
ListLakesResponse.Builder
List lakes response.
Protobuf type google.cloud.dataplex.v1.ListLakesResponse
ListPartitionsRequest
List metadata partitions request.
Protobuf type google.cloud.dataplex.v1.ListPartitionsRequest
ListPartitionsRequest.Builder
List metadata partitions request.
Protobuf type google.cloud.dataplex.v1.ListPartitionsRequest
ListPartitionsResponse
List metadata partitions response.
Protobuf type google.cloud.dataplex.v1.ListPartitionsResponse
ListPartitionsResponse.Builder
List metadata partitions response.
Protobuf type google.cloud.dataplex.v1.ListPartitionsResponse
ListSessionsRequest
List sessions request.
Protobuf type google.cloud.dataplex.v1.ListSessionsRequest
ListSessionsRequest.Builder
List sessions request.
Protobuf type google.cloud.dataplex.v1.ListSessionsRequest
ListSessionsResponse
List sessions response.
Protobuf type google.cloud.dataplex.v1.ListSessionsResponse
ListSessionsResponse.Builder
List sessions response.
Protobuf type google.cloud.dataplex.v1.ListSessionsResponse
ListTasksRequest
List tasks request.
Protobuf type google.cloud.dataplex.v1.ListTasksRequest
ListTasksRequest.Builder
List tasks request.
Protobuf type google.cloud.dataplex.v1.ListTasksRequest
ListTasksResponse
List tasks response.
Protobuf type google.cloud.dataplex.v1.ListTasksResponse
ListTasksResponse.Builder
List tasks response.
Protobuf type google.cloud.dataplex.v1.ListTasksResponse
ListZoneActionsRequest
List zone actions request.
Protobuf type google.cloud.dataplex.v1.ListZoneActionsRequest
ListZoneActionsRequest.Builder
List zone actions request.
Protobuf type google.cloud.dataplex.v1.ListZoneActionsRequest
ListZonesRequest
List zones request.
Protobuf type google.cloud.dataplex.v1.ListZonesRequest
ListZonesRequest.Builder
List zones request.
Protobuf type google.cloud.dataplex.v1.ListZonesRequest
ListZonesResponse
List zones response.
Protobuf type google.cloud.dataplex.v1.ListZonesResponse
ListZonesResponse.Builder
List zones response.
Protobuf type google.cloud.dataplex.v1.ListZonesResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
LogsProto
MetadataProto
MetadataServiceClient
Service Description: Metadata service manages metadata resources such as tables, filesets and partitions.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (MetadataServiceClient metadataServiceClient = MetadataServiceClient.create()) {
ZoneName parent = ZoneName.of("[PROJECT]", "[LOCATION]", "[LAKE]", "[ZONE]");
Entity entity = Entity.newBuilder().build();
Entity response = metadataServiceClient.createEntity(parent, entity);
}
Note: close() needs to be called on the MetadataServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of MetadataServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
MetadataServiceSettings metadataServiceSettings =
MetadataServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
MetadataServiceClient metadataServiceClient =
MetadataServiceClient.create(metadataServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
MetadataServiceSettings metadataServiceSettings =
MetadataServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
MetadataServiceClient metadataServiceClient =
MetadataServiceClient.create(metadataServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
MetadataServiceSettings metadataServiceSettings =
MetadataServiceSettings.newHttpJsonBuilder().build();
MetadataServiceClient metadataServiceClient =
MetadataServiceClient.create(metadataServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
MetadataServiceClient.ListEntitiesFixedSizeCollection
MetadataServiceClient.ListEntitiesPage
MetadataServiceClient.ListEntitiesPagedResponse
MetadataServiceClient.ListLocationsFixedSizeCollection
MetadataServiceClient.ListLocationsPage
MetadataServiceClient.ListLocationsPagedResponse
MetadataServiceClient.ListPartitionsFixedSizeCollection
MetadataServiceClient.ListPartitionsPage
MetadataServiceClient.ListPartitionsPagedResponse
MetadataServiceGrpc
Metadata service manages metadata resources such as tables, filesets and partitions.
MetadataServiceGrpc.MetadataServiceBlockingStub
Metadata service manages metadata resources such as tables, filesets and partitions.
MetadataServiceGrpc.MetadataServiceFutureStub
Metadata service manages metadata resources such as tables, filesets and partitions.
MetadataServiceGrpc.MetadataServiceImplBase
Metadata service manages metadata resources such as tables, filesets and partitions.
MetadataServiceGrpc.MetadataServiceStub
Metadata service manages metadata resources such as tables, filesets and partitions.
MetadataServiceSettings
Settings class to configure an instance of MetadataServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (dataplex.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of createEntity to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
MetadataServiceSettings.Builder metadataServiceSettingsBuilder =
MetadataServiceSettings.newBuilder();
metadataServiceSettingsBuilder
.createEntitySettings()
.setRetrySettings(
metadataServiceSettingsBuilder
.createEntitySettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
MetadataServiceSettings metadataServiceSettings = metadataServiceSettingsBuilder.build();
MetadataServiceSettings.Builder
Builder for MetadataServiceSettings.
OperationMetadata
Represents the metadata of a long-running operation.
Protobuf type google.cloud.dataplex.v1.OperationMetadata
OperationMetadata.Builder
Represents the metadata of a long-running operation.
Protobuf type google.cloud.dataplex.v1.OperationMetadata
Partition
Represents partition metadata contained within entity instances.
Protobuf type google.cloud.dataplex.v1.Partition
Partition.Builder
Represents partition metadata contained within entity instances.
Protobuf type google.cloud.dataplex.v1.Partition
PartitionName
PartitionName.Builder
Builder for projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}/partitions/{partition}.
ProcessingProto
ResourcesProto
RunDataScanRequest
Run DataScan Request
Protobuf type google.cloud.dataplex.v1.RunDataScanRequest
RunDataScanRequest.Builder
Run DataScan Request
Protobuf type google.cloud.dataplex.v1.RunDataScanRequest
RunDataScanResponse
Run DataScan Response.
Protobuf type google.cloud.dataplex.v1.RunDataScanResponse
RunDataScanResponse.Builder
Run DataScan Response.
Protobuf type google.cloud.dataplex.v1.RunDataScanResponse
ScannedData
The data scanned during processing (e.g. in incremental DataScan)
Protobuf type google.cloud.dataplex.v1.ScannedData
ScannedData.Builder
The data scanned during processing (e.g. in incremental DataScan)
Protobuf type google.cloud.dataplex.v1.ScannedData
ScannedData.IncrementalField
A data range denoted by a pair of start/end values of a field.
Protobuf type google.cloud.dataplex.v1.ScannedData.IncrementalField
ScannedData.IncrementalField.Builder
A data range denoted by a pair of start/end values of a field.
Protobuf type google.cloud.dataplex.v1.ScannedData.IncrementalField
Schema
Schema information describing the structure and layout of the data.
Protobuf type google.cloud.dataplex.v1.Schema
Schema.Builder
Schema information describing the structure and layout of the data.
Protobuf type google.cloud.dataplex.v1.Schema
Schema.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.
Protobuf type google.cloud.dataplex.v1.Schema.PartitionField
Schema.PartitionField.Builder
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.
Protobuf type google.cloud.dataplex.v1.Schema.PartitionField
Schema.SchemaField
Represents a column field within a table schema.
Protobuf type google.cloud.dataplex.v1.Schema.SchemaField
Schema.SchemaField.Builder
Represents a column field within a table schema.
Protobuf type google.cloud.dataplex.v1.Schema.SchemaField
ServiceProto
Session
Represents an active analyze session running for a user.
Protobuf type google.cloud.dataplex.v1.Session
Session.Builder
Represents an active analyze session running for a user.
Protobuf type google.cloud.dataplex.v1.Session
SessionEvent
These messages contain information about sessions within an environment. The monitored resource is 'Environment'.
Protobuf type google.cloud.dataplex.v1.SessionEvent
SessionEvent.Builder
These messages contain information about sessions within an environment. The monitored resource is 'Environment'.
Protobuf type google.cloud.dataplex.v1.SessionEvent
SessionEvent.QueryDetail
Execution details of the query.
Protobuf type google.cloud.dataplex.v1.SessionEvent.QueryDetail
SessionEvent.QueryDetail.Builder
Execution details of the query.
Protobuf type google.cloud.dataplex.v1.SessionEvent.QueryDetail
StorageFormat
Describes the format of the data within its storage location.
Protobuf type google.cloud.dataplex.v1.StorageFormat
StorageFormat.Builder
Describes the format of the data within its storage location.
Protobuf type google.cloud.dataplex.v1.StorageFormat
StorageFormat.CsvOptions
Describes CSV and similar semi-structured data formats.
Protobuf type google.cloud.dataplex.v1.StorageFormat.CsvOptions
StorageFormat.CsvOptions.Builder
Describes CSV and similar semi-structured data formats.
Protobuf type google.cloud.dataplex.v1.StorageFormat.CsvOptions
StorageFormat.IcebergOptions
Describes Iceberg data format.
Protobuf type google.cloud.dataplex.v1.StorageFormat.IcebergOptions
StorageFormat.IcebergOptions.Builder
Describes Iceberg data format.
Protobuf type google.cloud.dataplex.v1.StorageFormat.IcebergOptions
StorageFormat.JsonOptions
Describes JSON data format.
Protobuf type google.cloud.dataplex.v1.StorageFormat.JsonOptions
StorageFormat.JsonOptions.Builder
Describes JSON data format.
Protobuf type google.cloud.dataplex.v1.StorageFormat.JsonOptions
Task
A task represents a user-visible job.
Protobuf type google.cloud.dataplex.v1.Task
Task.Builder
A task represents a user-visible job.
Protobuf type google.cloud.dataplex.v1.Task
Task.ExecutionSpec
Execution related settings, like retry and service_account.
Protobuf type google.cloud.dataplex.v1.Task.ExecutionSpec
Task.ExecutionSpec.Builder
Execution related settings, like retry and service_account.
Protobuf type google.cloud.dataplex.v1.Task.ExecutionSpec
Task.ExecutionStatus
Status of the task execution (e.g. Jobs).
Protobuf type google.cloud.dataplex.v1.Task.ExecutionStatus
Task.ExecutionStatus.Builder
Status of the task execution (e.g. Jobs).
Protobuf type google.cloud.dataplex.v1.Task.ExecutionStatus
Task.InfrastructureSpec
Configuration for the underlying infrastructure used to run workloads.
Protobuf type google.cloud.dataplex.v1.Task.InfrastructureSpec
Task.InfrastructureSpec.BatchComputeResources
Batch compute resources associated with the task.
Protobuf type google.cloud.dataplex.v1.Task.InfrastructureSpec.BatchComputeResources
Task.InfrastructureSpec.BatchComputeResources.Builder
Batch compute resources associated with the task.
Protobuf type
google.cloud.dataplex.v1.Task.InfrastructureSpec.BatchComputeResources
Task.InfrastructureSpec.Builder
Configuration for the underlying infrastructure used to run workloads.
Protobuf type google.cloud.dataplex.v1.Task.InfrastructureSpec
Task.InfrastructureSpec.ContainerImageRuntime
Container Image Runtime Configuration used with Batch execution.
Protobuf type google.cloud.dataplex.v1.Task.InfrastructureSpec.ContainerImageRuntime
Task.InfrastructureSpec.ContainerImageRuntime.Builder
Container Image Runtime Configuration used with Batch execution.
Protobuf type
google.cloud.dataplex.v1.Task.InfrastructureSpec.ContainerImageRuntime
Task.InfrastructureSpec.VpcNetwork
Cloud VPC Network used to run the infrastructure.
Protobuf type google.cloud.dataplex.v1.Task.InfrastructureSpec.VpcNetwork
Task.InfrastructureSpec.VpcNetwork.Builder
Cloud VPC Network used to run the infrastructure.
Protobuf type google.cloud.dataplex.v1.Task.InfrastructureSpec.VpcNetwork
Task.NotebookTaskConfig
Config for running scheduled notebooks.
Protobuf type google.cloud.dataplex.v1.Task.NotebookTaskConfig
Task.NotebookTaskConfig.Builder
Config for running scheduled notebooks.
Protobuf type google.cloud.dataplex.v1.Task.NotebookTaskConfig
Task.SparkTaskConfig
User-specified config for running a Spark task.
Protobuf type google.cloud.dataplex.v1.Task.SparkTaskConfig
Task.SparkTaskConfig.Builder
User-specified config for running a Spark task.
Protobuf type google.cloud.dataplex.v1.Task.SparkTaskConfig
Task.TriggerSpec
Task scheduling and trigger settings.
Protobuf type google.cloud.dataplex.v1.Task.TriggerSpec
Task.TriggerSpec.Builder
Task scheduling and trigger settings.
Protobuf type google.cloud.dataplex.v1.Task.TriggerSpec
TaskName
TaskName.Builder
Builder for projects/{project}/locations/{location}/lakes/{lake}/tasks/{task}.
TasksProto
Trigger
DataScan scheduling and trigger settings.
Protobuf type google.cloud.dataplex.v1.Trigger
Trigger.Builder
DataScan scheduling and trigger settings.
Protobuf type google.cloud.dataplex.v1.Trigger
Trigger.OnDemand
The scan runs one-time via RunDataScan API.
Protobuf type google.cloud.dataplex.v1.Trigger.OnDemand
Trigger.OnDemand.Builder
The scan runs one-time via RunDataScan API.
Protobuf type google.cloud.dataplex.v1.Trigger.OnDemand
Trigger.Schedule
The scan is scheduled to run periodically.
Protobuf type google.cloud.dataplex.v1.Trigger.Schedule
Trigger.Schedule.Builder
The scan is scheduled to run periodically.
Protobuf type google.cloud.dataplex.v1.Trigger.Schedule
UpdateAssetRequest
Update asset request.
Protobuf type google.cloud.dataplex.v1.UpdateAssetRequest
UpdateAssetRequest.Builder
Update asset request.
Protobuf type google.cloud.dataplex.v1.UpdateAssetRequest
UpdateContentRequest
Update content request.
Protobuf type google.cloud.dataplex.v1.UpdateContentRequest
UpdateContentRequest.Builder
Update content request.
Protobuf type google.cloud.dataplex.v1.UpdateContentRequest
UpdateDataScanRequest
Update dataScan request.
Protobuf type google.cloud.dataplex.v1.UpdateDataScanRequest
UpdateDataScanRequest.Builder
Update dataScan request.
Protobuf type google.cloud.dataplex.v1.UpdateDataScanRequest
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.
Protobuf type google.cloud.dataplex.v1.UpdateEntityRequest
UpdateEntityRequest.Builder
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.
Protobuf type google.cloud.dataplex.v1.UpdateEntityRequest
UpdateEnvironmentRequest
Update environment request.
Protobuf type google.cloud.dataplex.v1.UpdateEnvironmentRequest
UpdateEnvironmentRequest.Builder
Update environment request.
Protobuf type google.cloud.dataplex.v1.UpdateEnvironmentRequest
UpdateLakeRequest
Update lake request.
Protobuf type google.cloud.dataplex.v1.UpdateLakeRequest
UpdateLakeRequest.Builder
Update lake request.
Protobuf type google.cloud.dataplex.v1.UpdateLakeRequest
UpdateTaskRequest
Update task request.
Protobuf type google.cloud.dataplex.v1.UpdateTaskRequest
UpdateTaskRequest.Builder
Update task request.
Protobuf type google.cloud.dataplex.v1.UpdateTaskRequest
UpdateZoneRequest
Update zone request.
Protobuf type google.cloud.dataplex.v1.UpdateZoneRequest
UpdateZoneRequest.Builder
Update zone request.
Protobuf type google.cloud.dataplex.v1.UpdateZoneRequest
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.
Protobuf type google.cloud.dataplex.v1.Zone
Zone.Builder
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.
Protobuf type google.cloud.dataplex.v1.Zone
Zone.DiscoverySpec
Settings to manage the metadata discovery and publishing in a zone.
Protobuf type google.cloud.dataplex.v1.Zone.DiscoverySpec
Zone.DiscoverySpec.Builder
Settings to manage the metadata discovery and publishing in a zone.
Protobuf type google.cloud.dataplex.v1.Zone.DiscoverySpec
Zone.DiscoverySpec.CsvOptions
Describe CSV and similar semi-structured data formats.
Protobuf type google.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions
Zone.DiscoverySpec.CsvOptions.Builder
Describe CSV and similar semi-structured data formats.
Protobuf type google.cloud.dataplex.v1.Zone.DiscoverySpec.CsvOptions
Zone.DiscoverySpec.JsonOptions
Describe JSON data format.
Protobuf type google.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions
Zone.DiscoverySpec.JsonOptions.Builder
Describe JSON data format.
Protobuf type google.cloud.dataplex.v1.Zone.DiscoverySpec.JsonOptions
Zone.ResourceSpec
Settings for resources attached as assets within a zone.
Protobuf type google.cloud.dataplex.v1.Zone.ResourceSpec
Zone.ResourceSpec.Builder
Settings for resources attached as assets within a zone.
Protobuf type google.cloud.dataplex.v1.Zone.ResourceSpec
ZoneName
ZoneName.Builder
Builder for projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}.
Interfaces
Action.FailedSecurityPolicyApplyOrBuilder
Action.IncompatibleDataSchemaOrBuilder
Action.InvalidDataFormatOrBuilder
Action.InvalidDataOrganizationOrBuilder
Action.InvalidDataPartitionOrBuilder
Action.MissingDataOrBuilder
Action.MissingResourceOrBuilder
Action.UnauthorizedResourceOrBuilder
ActionOrBuilder
Asset.DiscoverySpec.CsvOptionsOrBuilder
Asset.DiscoverySpec.JsonOptionsOrBuilder
Asset.DiscoverySpecOrBuilder
Asset.DiscoveryStatus.StatsOrBuilder
Asset.DiscoveryStatusOrBuilder
Asset.ResourceSpecOrBuilder
Asset.ResourceStatusOrBuilder
Asset.SecurityStatusOrBuilder
AssetOrBuilder
AssetStatusOrBuilder
CancelJobRequestOrBuilder
Content.NotebookOrBuilder
Content.SqlScriptOrBuilder
ContentOrBuilder
CreateAssetRequestOrBuilder
CreateContentRequestOrBuilder
CreateDataScanRequestOrBuilder
CreateEntityRequestOrBuilder
CreateEnvironmentRequestOrBuilder
CreateLakeRequestOrBuilder
CreatePartitionRequestOrBuilder
CreateTaskRequestOrBuilder
CreateZoneRequestOrBuilder
DataProfileResult.Profile.Field.ProfileInfo.DoubleFieldInfoOrBuilder
DataProfileResult.Profile.Field.ProfileInfo.IntegerFieldInfoOrBuilder
DataProfileResult.Profile.Field.ProfileInfo.StringFieldInfoOrBuilder
DataProfileResult.Profile.Field.ProfileInfo.TopNValueOrBuilder
DataProfileResult.Profile.Field.ProfileInfoOrBuilder
DataProfileResult.Profile.FieldOrBuilder
DataProfileResult.ProfileOrBuilder
DataProfileResultOrBuilder
DataProfileSpecOrBuilder
DataQualityDimensionResultOrBuilder
DataQualityResultOrBuilder
DataQualityRule.NonNullExpectationOrBuilder
DataQualityRule.RangeExpectationOrBuilder
DataQualityRule.RegexExpectationOrBuilder
DataQualityRule.RowConditionExpectationOrBuilder
DataQualityRule.SetExpectationOrBuilder
DataQualityRule.StatisticRangeExpectationOrBuilder
DataQualityRule.TableConditionExpectationOrBuilder
DataQualityRule.UniquenessExpectationOrBuilder
DataQualityRuleOrBuilder
DataQualityRuleResultOrBuilder
DataQualitySpecOrBuilder
DataScan.ExecutionSpecOrBuilder
DataScan.ExecutionStatusOrBuilder
DataScanEvent.DataProfileResultOrBuilder
DataScanEvent.DataQualityResultOrBuilder
DataScanEventOrBuilder
DataScanJobOrBuilder
DataScanOrBuilder
DataSourceOrBuilder
DeleteAssetRequestOrBuilder
DeleteContentRequestOrBuilder
DeleteDataScanRequestOrBuilder
DeleteEntityRequestOrBuilder
DeleteEnvironmentRequestOrBuilder
DeleteLakeRequestOrBuilder
DeletePartitionRequestOrBuilder
DeleteTaskRequestOrBuilder
DeleteZoneRequestOrBuilder
DiscoveryEvent.ActionDetailsOrBuilder
DiscoveryEvent.ConfigDetailsOrBuilder
DiscoveryEvent.EntityDetailsOrBuilder
DiscoveryEvent.PartitionDetailsOrBuilder
DiscoveryEventOrBuilder
Entity.CompatibilityStatus.CompatibilityOrBuilder
Entity.CompatibilityStatusOrBuilder
EntityOrBuilder
Environment.EndpointsOrBuilder
Environment.InfrastructureSpec.ComputeResourcesOrBuilder
Environment.InfrastructureSpec.OsImageRuntimeOrBuilder
Environment.InfrastructureSpecOrBuilder
Environment.SessionSpecOrBuilder
Environment.SessionStatusOrBuilder
EnvironmentOrBuilder
GetAssetRequestOrBuilder
GetContentRequestOrBuilder
GetDataScanJobRequestOrBuilder
GetDataScanRequestOrBuilder
GetEntityRequestOrBuilder
GetEnvironmentRequestOrBuilder
GetJobRequestOrBuilder
GetLakeRequestOrBuilder
GetPartitionRequestOrBuilder
GetTaskRequestOrBuilder
GetZoneRequestOrBuilder
JobEventOrBuilder
JobOrBuilder
Lake.MetastoreOrBuilder
Lake.MetastoreStatusOrBuilder
LakeOrBuilder
ListActionsResponseOrBuilder
ListAssetActionsRequestOrBuilder
ListAssetsRequestOrBuilder
ListAssetsResponseOrBuilder
ListContentRequestOrBuilder
ListContentResponseOrBuilder
ListDataScanJobsRequestOrBuilder
ListDataScanJobsResponseOrBuilder
ListDataScansRequestOrBuilder
ListDataScansResponseOrBuilder
ListEntitiesRequestOrBuilder
ListEntitiesResponseOrBuilder
ListEnvironmentsRequestOrBuilder
ListEnvironmentsResponseOrBuilder
ListJobsRequestOrBuilder
ListJobsResponseOrBuilder
ListLakeActionsRequestOrBuilder
ListLakesRequestOrBuilder
ListLakesResponseOrBuilder
ListPartitionsRequestOrBuilder
ListPartitionsResponseOrBuilder
ListSessionsRequestOrBuilder
ListSessionsResponseOrBuilder
ListTasksRequestOrBuilder
ListTasksResponseOrBuilder
ListZoneActionsRequestOrBuilder
ListZonesRequestOrBuilder
ListZonesResponseOrBuilder
OperationMetadataOrBuilder
PartitionOrBuilder
RunDataScanRequestOrBuilder
RunDataScanResponseOrBuilder
ScannedData.IncrementalFieldOrBuilder
ScannedDataOrBuilder
Schema.PartitionFieldOrBuilder
Schema.SchemaFieldOrBuilder
SchemaOrBuilder
SessionEvent.QueryDetailOrBuilder
SessionEventOrBuilder
SessionOrBuilder
StorageFormat.CsvOptionsOrBuilder
StorageFormat.IcebergOptionsOrBuilder
StorageFormat.JsonOptionsOrBuilder
StorageFormatOrBuilder
Task.ExecutionSpecOrBuilder
Task.ExecutionStatusOrBuilder
Task.InfrastructureSpec.BatchComputeResourcesOrBuilder
Task.InfrastructureSpec.ContainerImageRuntimeOrBuilder
Task.InfrastructureSpec.VpcNetworkOrBuilder
Task.InfrastructureSpecOrBuilder
Task.NotebookTaskConfigOrBuilder
Task.SparkTaskConfigOrBuilder
Task.TriggerSpecOrBuilder
TaskOrBuilder
Trigger.OnDemandOrBuilder
Trigger.ScheduleOrBuilder
TriggerOrBuilder
UpdateAssetRequestOrBuilder
UpdateContentRequestOrBuilder
UpdateDataScanRequestOrBuilder
UpdateEntityRequestOrBuilder
UpdateEnvironmentRequestOrBuilder
UpdateLakeRequestOrBuilder
UpdateTaskRequestOrBuilder
UpdateZoneRequestOrBuilder
Zone.DiscoverySpec.CsvOptionsOrBuilder
Zone.DiscoverySpec.JsonOptionsOrBuilder
Zone.DiscoverySpecOrBuilder
Zone.ResourceSpecOrBuilder
ZoneOrBuilder
Enums
Action.Category
The category of issues.
Protobuf enum google.cloud.dataplex.v1.Action.Category
Action.DetailsCase
Action.IncompatibleDataSchema.SchemaChange
Whether the action relates to a schema that is incompatible or modified.
Protobuf enum google.cloud.dataplex.v1.Action.IncompatibleDataSchema.SchemaChange
Action.InvalidDataPartition.PartitionStructure
The expected partition structure.
Protobuf enum google.cloud.dataplex.v1.Action.InvalidDataPartition.PartitionStructure
Asset.DiscoverySpec.TriggerCase
Asset.DiscoveryStatus.State
Current state of discovery.
Protobuf enum google.cloud.dataplex.v1.Asset.DiscoveryStatus.State
Asset.ResourceSpec.Type
Type of resource.
Protobuf enum google.cloud.dataplex.v1.Asset.ResourceSpec.Type
Asset.ResourceStatus.State
The state of a resource.
Protobuf enum google.cloud.dataplex.v1.Asset.ResourceStatus.State
Asset.SecurityStatus.State
The state of the security policy.
Protobuf enum google.cloud.dataplex.v1.Asset.SecurityStatus.State
Content.ContentCase
Content.DataCase
Content.Notebook.KernelType
Kernel Type of the Jupyter notebook.
Protobuf enum google.cloud.dataplex.v1.Content.Notebook.KernelType
Content.SqlScript.QueryEngine
Query Engine Type of the SQL Script.
Protobuf enum google.cloud.dataplex.v1.Content.SqlScript.QueryEngine
DataProfileResult.Profile.Field.ProfileInfo.FieldInfoCase
DataQualityRule.RuleTypeCase
DataQualityRule.StatisticRangeExpectation.ColumnStatistic
Protobuf enum
google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation.ColumnStatistic
DataScan.ExecutionSpec.IncrementalCase
DataScan.ResultCase
DataScan.SpecCase
DataScanEvent.ResultCase
DataScanEvent.ScanType
The type of the data scan.
Protobuf enum google.cloud.dataplex.v1.DataScanEvent.ScanType
DataScanEvent.Scope
The scope of job for the data scan.
Protobuf enum google.cloud.dataplex.v1.DataScanEvent.Scope
DataScanEvent.State
The job state of the data scan.
Protobuf enum google.cloud.dataplex.v1.DataScanEvent.State
DataScanEvent.Trigger
The trigger type for the data scan.
Protobuf enum google.cloud.dataplex.v1.DataScanEvent.Trigger
DataScanJob.ResultCase
DataScanJob.SpecCase
DataScanJob.State
Execution state for the DataScanJob.
Protobuf enum google.cloud.dataplex.v1.DataScanJob.State
DataScanType
The type of DataScan.
Protobuf enum google.cloud.dataplex.v1.DataScanType
DataSource.SourceCase
DiscoveryEvent.DetailsCase
DiscoveryEvent.EntityType
The type of the entity.
Protobuf enum google.cloud.dataplex.v1.DiscoveryEvent.EntityType
DiscoveryEvent.EventType
The type of the event.
Protobuf enum google.cloud.dataplex.v1.DiscoveryEvent.EventType
Entity.Type
The type of entity.
Protobuf enum google.cloud.dataplex.v1.Entity.Type
Environment.InfrastructureSpec.ResourcesCase
Environment.InfrastructureSpec.RuntimeCase
GetContentRequest.ContentView
Specifies whether the request should return the full or the partial representation.
Protobuf enum google.cloud.dataplex.v1.GetContentRequest.ContentView
GetDataScanJobRequest.DataScanJobView
DataScanJob view options.
Protobuf enum google.cloud.dataplex.v1.GetDataScanJobRequest.DataScanJobView
GetDataScanRequest.DataScanView
DataScan view options.
Protobuf enum google.cloud.dataplex.v1.GetDataScanRequest.DataScanView
GetEntityRequest.EntityView
Entity views for get entity partial result.
Protobuf enum google.cloud.dataplex.v1.GetEntityRequest.EntityView
Job.Service
Protobuf enum google.cloud.dataplex.v1.Job.Service
Job.State
Protobuf enum google.cloud.dataplex.v1.Job.State
JobEvent.Service
The service used to execute the job.
Protobuf enum google.cloud.dataplex.v1.JobEvent.Service
JobEvent.State
The completion status of the job.
Protobuf enum google.cloud.dataplex.v1.JobEvent.State
JobEvent.Type
The type of the job.
Protobuf enum google.cloud.dataplex.v1.JobEvent.Type
Lake.MetastoreStatus.State
Current state of association.
Protobuf enum google.cloud.dataplex.v1.Lake.MetastoreStatus.State
ListEntitiesRequest.EntityView
Entity views.
Protobuf enum google.cloud.dataplex.v1.ListEntitiesRequest.EntityView
ScannedData.DataRangeCase
Schema.Mode
Additional qualifiers to define field semantics.
Protobuf enum google.cloud.dataplex.v1.Schema.Mode
Schema.PartitionStyle
The structure of paths within the entity, which represent partitions.
Protobuf enum google.cloud.dataplex.v1.Schema.PartitionStyle
Schema.Type
Type information for fields in schemas and partition schemas.
Protobuf enum google.cloud.dataplex.v1.Schema.Type
SessionEvent.DetailCase
SessionEvent.EventType
The type of the event.
Protobuf enum google.cloud.dataplex.v1.SessionEvent.EventType
SessionEvent.QueryDetail.Engine
Query Execution engine.
Protobuf enum google.cloud.dataplex.v1.SessionEvent.QueryDetail.Engine
State
State of a resource.
Protobuf enum google.cloud.dataplex.v1.State
StorageFormat.CompressionFormat
The specific compressed file format of the data.
Protobuf enum google.cloud.dataplex.v1.StorageFormat.CompressionFormat
StorageFormat.Format
The specific file format of the data.
Protobuf enum google.cloud.dataplex.v1.StorageFormat.Format
StorageFormat.OptionsCase
StorageSystem
Identifies the cloud system that manages the data storage.
Protobuf enum google.cloud.dataplex.v1.StorageSystem
Task.ConfigCase
Task.InfrastructureSpec.NetworkCase
Task.InfrastructureSpec.ResourcesCase
Task.InfrastructureSpec.RuntimeCase
Task.InfrastructureSpec.VpcNetwork.NetworkNameCase
Task.SparkTaskConfig.DriverCase
Task.TriggerSpec.TriggerCase
Task.TriggerSpec.Type
Determines how often and when the job will run.
Protobuf enum google.cloud.dataplex.v1.Task.TriggerSpec.Type
Trigger.ModeCase
Zone.DiscoverySpec.TriggerCase
Zone.ResourceSpec.LocationType
Location type of the resources attached to a zone.
Protobuf enum google.cloud.dataplex.v1.Zone.ResourceSpec.LocationType
Zone.Type
Type of zone.
Protobuf enum google.cloud.dataplex.v1.Zone.Type