Package com.google.cloud.datacatalog.v1beta1 (1.28.0)

A client to Google Cloud Data Catalog API

The interfaces provided are listed below, along with usage samples.

DataCatalogClient

Service Description: Data Catalog API service allows clients to discover, understand, and manage their data.

Sample for DataCatalogClient:


 // 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 (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   String entryGroupId = "entryGroupId1228924712";
   EntryGroup entryGroup = EntryGroup.newBuilder().build();
   EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
 }

PolicyTagManagerClient

Service Description: The policy tag manager API service allows clients to manage their taxonomies and policy tags.

Sample for PolicyTagManagerClient:


 // 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 (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Taxonomy taxonomy = Taxonomy.newBuilder().build();
   Taxonomy response = policyTagManagerClient.createTaxonomy(parent, taxonomy);
 }

PolicyTagManagerSerializationClient

Service Description: Policy tag manager serialization API service allows clients to manipulate their taxonomies and policy tags data with serialized format.

Sample for PolicyTagManagerSerializationClient:


 // 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 (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create()) {
   ImportTaxonomiesRequest request =
       ImportTaxonomiesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ImportTaxonomiesResponse response =
       policyTagManagerSerializationClient.importTaxonomies(request);
 }

Classes

BigQueryDateShardedSpec

Spec for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding

Protobuf type google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec

BigQueryDateShardedSpec.Builder

Spec for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding

Protobuf type google.cloud.datacatalog.v1beta1.BigQueryDateShardedSpec

BigQueryTableSpec

Describes a BigQuery table.

Protobuf type google.cloud.datacatalog.v1beta1.BigQueryTableSpec

BigQueryTableSpec.Builder

Describes a BigQuery table.

Protobuf type google.cloud.datacatalog.v1beta1.BigQueryTableSpec

ColumnSchema

Representation of a column within a schema. Columns could be nested inside other columns.

Protobuf type google.cloud.datacatalog.v1beta1.ColumnSchema

ColumnSchema.Builder

Representation of a column within a schema. Columns could be nested inside other columns.

Protobuf type google.cloud.datacatalog.v1beta1.ColumnSchema

CreateEntryGroupRequest

Request message for CreateEntryGroup.

Protobuf type google.cloud.datacatalog.v1beta1.CreateEntryGroupRequest

CreateEntryGroupRequest.Builder

Request message for CreateEntryGroup.

Protobuf type google.cloud.datacatalog.v1beta1.CreateEntryGroupRequest

CreateEntryRequest

Request message for CreateEntry.

Protobuf type google.cloud.datacatalog.v1beta1.CreateEntryRequest

CreateEntryRequest.Builder

Request message for CreateEntry.

Protobuf type google.cloud.datacatalog.v1beta1.CreateEntryRequest

CreatePolicyTagRequest

Request message for CreatePolicyTag.

Protobuf type google.cloud.datacatalog.v1beta1.CreatePolicyTagRequest

CreatePolicyTagRequest.Builder

Request message for CreatePolicyTag.

Protobuf type google.cloud.datacatalog.v1beta1.CreatePolicyTagRequest

CreateTagRequest

Request message for CreateTag.

Protobuf type google.cloud.datacatalog.v1beta1.CreateTagRequest

CreateTagRequest.Builder

Request message for CreateTag.

Protobuf type google.cloud.datacatalog.v1beta1.CreateTagRequest

CreateTagTemplateFieldRequest

Request message for CreateTagTemplateField.

Protobuf type google.cloud.datacatalog.v1beta1.CreateTagTemplateFieldRequest

CreateTagTemplateFieldRequest.Builder

Request message for CreateTagTemplateField.

Protobuf type google.cloud.datacatalog.v1beta1.CreateTagTemplateFieldRequest

CreateTagTemplateRequest

Request message for CreateTagTemplate.

Protobuf type google.cloud.datacatalog.v1beta1.CreateTagTemplateRequest

CreateTagTemplateRequest.Builder

Request message for CreateTagTemplate.

Protobuf type google.cloud.datacatalog.v1beta1.CreateTagTemplateRequest

CreateTaxonomyRequest

Request message for CreateTaxonomy.

Protobuf type google.cloud.datacatalog.v1beta1.CreateTaxonomyRequest

CreateTaxonomyRequest.Builder

Request message for CreateTaxonomy.

Protobuf type google.cloud.datacatalog.v1beta1.CreateTaxonomyRequest

DataCatalogClient

Service Description: Data Catalog API service allows clients to discover, understand, and manage their data.

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 (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   String entryGroupId = "entryGroupId1228924712";
   EntryGroup entryGroup = EntryGroup.newBuilder().build();
   EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
 }

Note: close() needs to be called on the DataCatalogClient 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 DataCatalogSettings 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
 DataCatalogSettings dataCatalogSettings =
     DataCatalogSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataCatalogClient dataCatalogClient = DataCatalogClient.create(dataCatalogSettings);

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
 DataCatalogSettings dataCatalogSettings =
     DataCatalogSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataCatalogClient dataCatalogClient = DataCatalogClient.create(dataCatalogSettings);

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
 DataCatalogSettings dataCatalogSettings = DataCatalogSettings.newHttpJsonBuilder().build();
 DataCatalogClient dataCatalogClient = DataCatalogClient.create(dataCatalogSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

DataCatalogClient.ListEntriesFixedSizeCollection

DataCatalogClient.ListEntriesPage

DataCatalogClient.ListEntriesPagedResponse

DataCatalogClient.ListEntryGroupsFixedSizeCollection

DataCatalogClient.ListEntryGroupsPage

DataCatalogClient.ListEntryGroupsPagedResponse

DataCatalogClient.ListTagsFixedSizeCollection

DataCatalogClient.ListTagsPage

DataCatalogClient.ListTagsPagedResponse