Package com.google.cloud.dataplex.v1 (1.13.0)

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

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

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