Namespace com.google.cloud.datacatalog.v1

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

======================= DataCatalogClient =======================

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

Sample for DataCatalogClient:


 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: Policy Tag Manager API service allows you to manage your policy tags and taxonomies.

Policy tags are used to tag BigQuery columns and apply additional access control policies. A taxonomy is a hierarchical grouping of policy tags that classify data along a common axis.

Sample for PolicyTagManagerClient:


 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 you to manipulate your policy tags and taxonomies in a serialized format.

Taxonomy is a hierarchical group of policy tags.

Sample for PolicyTagManagerSerializationClient:


 try (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create()) {
   ReplaceTaxonomyRequest request =
       ReplaceTaxonomyRequest.newBuilder()
           .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
           .setSerializedTaxonomy(SerializedTaxonomy.newBuilder().build())
           .build();
   Taxonomy response = policyTagManagerSerializationClient.replaceTaxonomy(request);
 }

Classes

BigQueryConnectionSpec

Specification for the BigQuery connection.

Protobuf type google.cloud.datacatalog.v1.BigQueryConnectionSpec

BigQueryConnectionSpec.Builder

Specification for the BigQuery connection.

Protobuf type google.cloud.datacatalog.v1.BigQueryConnectionSpec

BigQueryDateShardedSpec

Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name
 pattern.
 For more information, see [Introduction to partitioned tables]
 (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).

Protobuf type google.cloud.datacatalog.v1.BigQueryDateShardedSpec

BigQueryDateShardedSpec.Builder

Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name
 pattern.
 For more information, see [Introduction to partitioned tables]
 (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).

Protobuf type google.cloud.datacatalog.v1.BigQueryDateShardedSpec

BigQueryProto

BigQueryRoutineSpec

Fields specific for BigQuery routines.

Protobuf type google.cloud.datacatalog.v1.BigQueryRoutineSpec

BigQueryRoutineSpec.Builder

Fields specific for BigQuery routines.

Protobuf type google.cloud.datacatalog.v1.BigQueryRoutineSpec

BigQueryTableSpec

Describes a BigQuery table.

Protobuf type google.cloud.datacatalog.v1.BigQueryTableSpec

BigQueryTableSpec.Builder

Describes a BigQuery table.

Protobuf type google.cloud.datacatalog.v1.BigQueryTableSpec

CloudSqlBigQueryConnectionSpec

Specification for the BigQuery connection to a Cloud SQL instance.

Protobuf type google.cloud.datacatalog.v1.CloudSqlBigQueryConnectionSpec

CloudSqlBigQueryConnectionSpec.Builder

Specification for the BigQuery connection to a Cloud SQL instance.

Protobuf type google.cloud.datacatalog.v1.CloudSqlBigQueryConnectionSpec

ColumnSchema

A column within a schema. Columns can be nested inside
 other columns.

Protobuf type google.cloud.datacatalog.v1.ColumnSchema

ColumnSchema.Builder

A column within a schema. Columns can be nested inside
 other columns.

Protobuf type google.cloud.datacatalog.v1.ColumnSchema

Common

CreateEntryGroupRequest

Request message for
 [CreateEntryGroup][google.cloud.datacatalog.v1.DataCatalog.CreateEntryGroup].

Protobuf type google.cloud.datacatalog.v1.CreateEntryGroupRequest

CreateEntryGroupRequest.Builder

Request message for
 [CreateEntryGroup][google.cloud.datacatalog.v1.DataCatalog.CreateEntryGroup].

Protobuf type google.cloud.datacatalog.v1.CreateEntryGroupRequest

CreateEntryRequest

Request message for
 [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry].

Protobuf type google.cloud.datacatalog.v1.CreateEntryRequest

CreateEntryRequest.Builder

Request message for
 [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry].

Protobuf type google.cloud.datacatalog.v1.CreateEntryRequest

CreatePolicyTagRequest

Request message for
 [CreatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.CreatePolicyTag].

Protobuf type google.cloud.datacatalog.v1.CreatePolicyTagRequest

CreatePolicyTagRequest.Builder

Request message for
 [CreatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.CreatePolicyTag].

Protobuf type google.cloud.datacatalog.v1.CreatePolicyTagRequest

CreateTagRequest

Request message for
 [CreateTag][google.cloud.datacatalog.v1.DataCatalog.CreateTag].

Protobuf type google.cloud.datacatalog.v1.CreateTagRequest

CreateTagRequest.Builder

Request message for
 [CreateTag][google.cloud.datacatalog.v1.DataCatalog.CreateTag].

Protobuf type google.cloud.datacatalog.v1.CreateTagRequest

CreateTagTemplateFieldRequest

Request message for
 [CreateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateField].

Protobuf type google.cloud.datacatalog.v1.CreateTagTemplateFieldRequest

CreateTagTemplateFieldRequest.Builder

Request message for
 [CreateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateField].

Protobuf type google.cloud.datacatalog.v1.CreateTagTemplateFieldRequest

CreateTagTemplateRequest

Request message for
 [CreateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplate].

Protobuf type google.cloud.datacatalog.v1.CreateTagTemplateRequest

CreateTagTemplateRequest.Builder

Request message for
 [CreateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplate].

Protobuf type google.cloud.datacatalog.v1.CreateTagTemplateRequest

CreateTaxonomyRequest

Request message for
 [CreateTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.CreateTaxonomy].

Protobuf type google.cloud.datacatalog.v1.CreateTaxonomyRequest

CreateTaxonomyRequest.Builder

Request message for
 [CreateTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.CreateTaxonomy].

Protobuf type google.cloud.datacatalog.v1.CreateTaxonomyRequest

CrossRegionalSource

Cross-regional source used to import an existing taxonomy into a different
 region.

Protobuf type google.cloud.datacatalog.v1.CrossRegionalSource

CrossRegionalSource.Builder

Cross-regional source used to import an existing taxonomy into a different
 region.

Protobuf type google.cloud.datacatalog.v1.CrossRegionalSource

DataCatalogClient

Service Description: Data Catalog API service allows you to discover, understand, and manage your 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:

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:

  1. 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.
  2. 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.
  3. 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:

DataCatalogSettings dataCatalogSettings =
     DataCatalogSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataCatalogClient dataCatalogClient = DataCatalogClient.create(dataCatalogSettings);

To customize the endpoint:

DataCatalogSettings dataCatalogSettings =
     DataCatalogSettings.newBuilder().setEndpoint(myEndpoint).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

DataCatalogClient.SearchCatalogFixedSizeCollection

DataCatalogClient.SearchCatalogPage

DataCatalogClient.SearchCatalogPagedResponse

DataCatalogGrpc

Data Catalog API service allows you to discover, understand, and manage
 your data.

DataCatalogGrpc.DataCatalogBlockingStub

Data Catalog API service allows you to discover, understand, and manage
 your data.

DataCatalogGrpc.DataCatalogFutureStub

Data Catalog API service allows you to discover, understand, and manage
 your data.

DataCatalogGrpc.DataCatalogImplBase

Data Catalog API service allows you to discover, understand, and manage
 your data.

DataCatalogGrpc.DataCatalogStub

Data Catalog API service allows you to discover, understand, and manage
 your data.

DataCatalogSettings

Settings class to configure an instance of DataCatalogClient.

The default instance has everything set to sensible defaults:

  • The default service address (datacatalog.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 createEntryGroup to 30 seconds:

DataCatalogSettings.Builder dataCatalogSettingsBuilder = DataCatalogSettings.newBuilder();
 dataCatalogSettingsBuilder
     .createEntryGroupSettings()
     .setRetrySettings(
         dataCatalogSettingsBuilder
             .createEntryGroupSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DataCatalogSettings dataCatalogSettings = dataCatalogSettingsBuilder.build();

DataCatalogSettings.Builder

Builder for DataCatalogSettings.

DataSource

Physical location of an entry.

Protobuf type google.cloud.datacatalog.v1.DataSource

DataSource.Builder

Physical location of an entry.

Protobuf type google.cloud.datacatalog.v1.DataSource

DataSourceConnectionSpec

Specification that applies to a data source connection. Valid only for
 entries with the `DATA_SOURCE_CONNECTION` type.

Protobuf type google.cloud.datacatalog.v1.DataSourceConnectionSpec

DataSourceConnectionSpec.Builder

Specification that applies to a data source connection. Valid only for
 entries with the `DATA_SOURCE_CONNECTION` type.

Protobuf type google.cloud.datacatalog.v1.DataSourceConnectionSpec

DataSourceProto

DatabaseTableSpec

Specification that applies to a table resource. Valid only
 for entries with the `TABLE` type.

Protobuf type google.cloud.datacatalog.v1.DatabaseTableSpec

DatabaseTableSpec.Builder

Specification that applies to a table resource. Valid only
 for entries with the `TABLE` type.

Protobuf type google.cloud.datacatalog.v1.DatabaseTableSpec

Datacatalog

DeleteEntryGroupRequest

Request message for
 [DeleteEntryGroup][google.cloud.datacatalog.v1.DataCatalog.DeleteEntryGroup].

Protobuf type google.cloud.datacatalog.v1.DeleteEntryGroupRequest

DeleteEntryGroupRequest.Builder

Request message for
 [DeleteEntryGroup][google.cloud.datacatalog.v1.DataCatalog.DeleteEntryGroup].

Protobuf type google.cloud.datacatalog.v1.DeleteEntryGroupRequest

DeleteEntryRequest

Request message for
 [DeleteEntry][google.cloud.datacatalog.v1.DataCatalog.DeleteEntry].

Protobuf type google.cloud.datacatalog.v1.DeleteEntryRequest

DeleteEntryRequest.Builder

Request message for
 [DeleteEntry][google.cloud.datacatalog.v1.DataCatalog.DeleteEntry].

Protobuf type google.cloud.datacatalog.v1.DeleteEntryRequest

DeletePolicyTagRequest

Request message for
 [DeletePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.DeletePolicyTag].

Protobuf type google.cloud.datacatalog.v1.DeletePolicyTagRequest

DeletePolicyTagRequest.Builder

Request message for
 [DeletePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.DeletePolicyTag].

Protobuf type google.cloud.datacatalog.v1.DeletePolicyTagRequest

DeleteTagRequest

Request message for
 [DeleteTag][google.cloud.datacatalog.v1.DataCatalog.DeleteTag].

Protobuf type google.cloud.datacatalog.v1.DeleteTagRequest

DeleteTagRequest.Builder

Request message for
 [DeleteTag][google.cloud.datacatalog.v1.DataCatalog.DeleteTag].

Protobuf type google.cloud.datacatalog.v1.DeleteTagRequest

DeleteTagTemplateFieldRequest

Request message for
 [DeleteTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateField].

Protobuf type google.cloud.datacatalog.v1.DeleteTagTemplateFieldRequest

DeleteTagTemplateFieldRequest.Builder

Request message for
 [DeleteTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateField].

Protobuf type google.cloud.datacatalog.v1.DeleteTagTemplateFieldRequest

DeleteTagTemplateRequest

Request message for
 [DeleteTagTemplate][google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplate].

Protobuf type google.cloud.datacatalog.v1.DeleteTagTemplateRequest

DeleteTagTemplateRequest.Builder

Request message for
 [DeleteTagTemplate][google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplate].

Protobuf type google.cloud.datacatalog.v1.DeleteTagTemplateRequest

DeleteTaxonomyRequest

Request message for
 [DeleteTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.DeleteTaxonomy].

Protobuf type google.cloud.datacatalog.v1.DeleteTaxonomyRequest

DeleteTaxonomyRequest.Builder

Request message for
 [DeleteTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.DeleteTaxonomy].

Protobuf type google.cloud.datacatalog.v1.DeleteTaxonomyRequest

Entry

Entry metadata.
 A Data Catalog entry represents another resource in Google
 Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or
 outside of it. You can use the `linked_resource` field
 in the entry resource to refer to the original resource ID of the source
 system.
 An entry resource contains resource details, for example, its schema.
 Additionally, you can attach flexible metadata to an entry in the form of a
 [Tag][google.cloud.datacatalog.v1.Tag].

Protobuf type google.cloud.datacatalog.v1.Entry

Entry.Builder

Entry metadata.
 A Data Catalog entry represents another resource in Google
 Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or
 outside of it. You can use the `linked_resource` field
 in the entry resource to refer to the original resource ID of the source
 system.
 An entry resource contains resource details, for example, its schema.
 Additionally, you can attach flexible metadata to an entry in the form of a
 [Tag][google.cloud.datacatalog.v1.Tag].

Protobuf type google.cloud.datacatalog.v1.Entry

EntryGroup

Entry group metadata.
 An `EntryGroup` resource represents a logical grouping of zero or more
 Data Catalog [Entry][google.cloud.datacatalog.v1.Entry] resources.

Protobuf type google.cloud.datacatalog.v1.EntryGroup

EntryGroup.Builder

Entry group metadata.
 An `EntryGroup` resource represents a logical grouping of zero or more
 Data Catalog [Entry][google.cloud.datacatalog.v1.Entry] resources.

Protobuf type google.cloud.datacatalog.v1.EntryGroup

EntryGroupName

EntryGroupName.Builder

Builder for projects/{project}/locations/{location}/entryGroups/{entry_group}.

EntryName

EntryName.Builder

Builder for projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.

ExportTaxonomiesRequest

Request message for
 [ExportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies].

Protobuf type google.cloud.datacatalog.v1.ExportTaxonomiesRequest

ExportTaxonomiesRequest.Builder

Request message for
 [ExportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies].

Protobuf type google.cloud.datacatalog.v1.ExportTaxonomiesRequest

ExportTaxonomiesResponse

Response message for
 [ExportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies].

Protobuf type google.cloud.datacatalog.v1.ExportTaxonomiesResponse

ExportTaxonomiesResponse.Builder

Response message for
 [ExportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies].

Protobuf type google.cloud.datacatalog.v1.ExportTaxonomiesResponse

FieldType

Protobuf type google.cloud.datacatalog.v1.FieldType

FieldType.Builder

Protobuf type google.cloud.datacatalog.v1.FieldType

FieldType.EnumType

Protobuf type google.cloud.datacatalog.v1.FieldType.EnumType

FieldType.EnumType.Builder

Protobuf type google.cloud.datacatalog.v1.FieldType.EnumType

FieldType.EnumType.EnumValue

Protobuf type google.cloud.datacatalog.v1.FieldType.EnumType.EnumValue

FieldType.EnumType.EnumValue.Builder

Protobuf type google.cloud.datacatalog.v1.FieldType.EnumType.EnumValue

GcsFileSpec

Specification of a single file in Cloud Storage.

Protobuf type google.cloud.datacatalog.v1.GcsFileSpec

GcsFileSpec.Builder

Specification of a single file in Cloud Storage.

Protobuf type google.cloud.datacatalog.v1.GcsFileSpec

GcsFilesetSpec

Describes a Cloud Storage fileset entry.

Protobuf type google.cloud.datacatalog.v1.GcsFilesetSpec

GcsFilesetSpec.Builder

Describes a Cloud Storage fileset entry.

Protobuf type google.cloud.datacatalog.v1.GcsFilesetSpec

GcsFilesetSpecOuterClass

GetEntryGroupRequest

Request message for
 [GetEntryGroup][google.cloud.datacatalog.v1.DataCatalog.GetEntryGroup].

Protobuf type google.cloud.datacatalog.v1.GetEntryGroupRequest

GetEntryGroupRequest.Builder

Request message for
 [GetEntryGroup][google.cloud.datacatalog.v1.DataCatalog.GetEntryGroup].

Protobuf type google.cloud.datacatalog.v1.GetEntryGroupRequest

GetEntryRequest

Request message for
 [GetEntry][google.cloud.datacatalog.v1.DataCatalog.GetEntry].

Protobuf type google.cloud.datacatalog.v1.GetEntryRequest

GetEntryRequest.Builder

Request message for
 [GetEntry][google.cloud.datacatalog.v1.DataCatalog.GetEntry].

Protobuf type google.cloud.datacatalog.v1.GetEntryRequest

GetPolicyTagRequest

Request message for
 [GetPolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.GetPolicyTag].

Protobuf type google.cloud.datacatalog.v1.GetPolicyTagRequest

GetPolicyTagRequest.Builder

Request message for
 [GetPolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.GetPolicyTag].

Protobuf type google.cloud.datacatalog.v1.GetPolicyTagRequest

GetTagTemplateRequest

Request message for
 [GetTagTemplate][google.cloud.datacatalog.v1.DataCatalog.GetTagTemplate].

Protobuf type google.cloud.datacatalog.v1.GetTagTemplateRequest

GetTagTemplateRequest.Builder

Request message for
 [GetTagTemplate][google.cloud.datacatalog.v1.DataCatalog.GetTagTemplate].

Protobuf type google.cloud.datacatalog.v1.GetTagTemplateRequest

GetTaxonomyRequest

Request message for
 [GetTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.GetTaxonomy].

Protobuf type google.cloud.datacatalog.v1.GetTaxonomyRequest

GetTaxonomyRequest.Builder

Request message for
 [GetTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.GetTaxonomy].

Protobuf type google.cloud.datacatalog.v1.GetTaxonomyRequest

ImportTaxonomiesRequest

Request message for
 [ImportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies].

Protobuf type google.cloud.datacatalog.v1.ImportTaxonomiesRequest

ImportTaxonomiesRequest.Builder

Request message for
 [ImportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies].

Protobuf type google.cloud.datacatalog.v1.ImportTaxonomiesRequest

ImportTaxonomiesResponse

Response message for
 [ImportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies].

Protobuf type google.cloud.datacatalog.v1.ImportTaxonomiesResponse

ImportTaxonomiesResponse.Builder

Response message for
 [ImportTaxonomies][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies].

Protobuf type google.cloud.datacatalog.v1.ImportTaxonomiesResponse

InlineSource

Inline source containing taxonomies to import.

Protobuf type google.cloud.datacatalog.v1.InlineSource

InlineSource.Builder

Inline source containing taxonomies to import.

Protobuf type google.cloud.datacatalog.v1.InlineSource

ListEntriesRequest

Request message for
 [ListEntries][google.cloud.datacatalog.v1.DataCatalog.ListEntries].

Protobuf type google.cloud.datacatalog.v1.ListEntriesRequest

ListEntriesRequest.Builder

Request message for
 [ListEntries][google.cloud.datacatalog.v1.DataCatalog.ListEntries].

Protobuf type google.cloud.datacatalog.v1.ListEntriesRequest

ListEntriesResponse

Response message for
 [ListEntries][google.cloud.datacatalog.v1.DataCatalog.ListEntries].

Protobuf type google.cloud.datacatalog.v1.ListEntriesResponse

ListEntriesResponse.Builder

Response message for
 [ListEntries][google.cloud.datacatalog.v1.DataCatalog.ListEntries].

Protobuf type google.cloud.datacatalog.v1.ListEntriesResponse

ListEntryGroupsRequest

Request message for
 [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].

Protobuf type google.cloud.datacatalog.v1.ListEntryGroupsRequest

ListEntryGroupsRequest.Builder

Request message for
 [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].

Protobuf type google.cloud.datacatalog.v1.ListEntryGroupsRequest

ListEntryGroupsResponse

Response message for
 [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].

Protobuf type google.cloud.datacatalog.v1.ListEntryGroupsResponse

ListEntryGroupsResponse.Builder

Response message for
 [ListEntryGroups][google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups].

Protobuf type google.cloud.datacatalog.v1.ListEntryGroupsResponse

ListPolicyTagsRequest

Request message for
 [ListPolicyTags][google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags].

Protobuf type google.cloud.datacatalog.v1.ListPolicyTagsRequest

ListPolicyTagsRequest.Builder

Request message for
 [ListPolicyTags][google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags].

Protobuf type google.cloud.datacatalog.v1.ListPolicyTagsRequest

ListPolicyTagsResponse

Response message for
 [ListPolicyTags][google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags].

Protobuf type google.cloud.datacatalog.v1.ListPolicyTagsResponse

ListPolicyTagsResponse.Builder

Response message for
 [ListPolicyTags][google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags].

Protobuf type google.cloud.datacatalog.v1.ListPolicyTagsResponse

ListTagsRequest

Request message for
 [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].

Protobuf type google.cloud.datacatalog.v1.ListTagsRequest

ListTagsRequest.Builder

Request message for
 [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].

Protobuf type google.cloud.datacatalog.v1.ListTagsRequest

ListTagsResponse

Response message for
 [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].

Protobuf type google.cloud.datacatalog.v1.ListTagsResponse

ListTagsResponse.Builder

Response message for
 [ListTags][google.cloud.datacatalog.v1.DataCatalog.ListTags].

Protobuf type google.cloud.datacatalog.v1.ListTagsResponse

ListTaxonomiesRequest

Request message for
 [ListTaxonomies][google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies].

Protobuf type google.cloud.datacatalog.v1.ListTaxonomiesRequest

ListTaxonomiesRequest.Builder

Request message for
 [ListTaxonomies][google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies].

Protobuf type google.cloud.datacatalog.v1.ListTaxonomiesRequest

ListTaxonomiesResponse

Response message for
 [ListTaxonomies][google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies].

Protobuf type google.cloud.datacatalog.v1.ListTaxonomiesResponse

ListTaxonomiesResponse.Builder

Response message for
 [ListTaxonomies][google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies].

Protobuf type google.cloud.datacatalog.v1.ListTaxonomiesResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

LookupEntryRequest

Request message for
 [LookupEntry][google.cloud.datacatalog.v1.DataCatalog.LookupEntry].

Protobuf type google.cloud.datacatalog.v1.LookupEntryRequest

LookupEntryRequest.Builder

Request message for
 [LookupEntry][google.cloud.datacatalog.v1.DataCatalog.LookupEntry].

Protobuf type google.cloud.datacatalog.v1.LookupEntryRequest

PolicyTag

Denotes one policy tag in a taxonomy, for example, SSN.
 Policy tags can be defined in a hierarchy. For example:
  • Geolocation
    • LatLong
    • City
    • ZipCode Where the "Geolocation" policy tag contains three children.

Protobuf type google.cloud.datacatalog.v1.PolicyTag

PolicyTag.Builder

Denotes one policy tag in a taxonomy, for example, SSN.
 Policy tags can be defined in a hierarchy. For example:
  • Geolocation
    • LatLong
    • City
    • ZipCode Where the "Geolocation" policy tag contains three children.

Protobuf type google.cloud.datacatalog.v1.PolicyTag

PolicyTagManagerClient

Service Description: Policy Tag Manager API service allows you to manage your policy tags and taxonomies.

Policy tags are used to tag BigQuery columns and apply additional access control policies. A taxonomy is a hierarchical grouping of policy tags that classify data along a common axis.

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:

try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Taxonomy taxonomy = Taxonomy.newBuilder().build();
   Taxonomy response = policyTagManagerClient.createTaxonomy(parent, taxonomy);
 }

Note: close() needs to be called on the PolicyTagManagerClient 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:

  1. 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.
  2. 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.
  3. 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 PolicyTagManagerSettings to create(). For example:

To customize credentials:

PolicyTagManagerSettings policyTagManagerSettings =
     PolicyTagManagerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PolicyTagManagerClient policyTagManagerClient =
     PolicyTagManagerClient.create(policyTagManagerSettings);

To customize the endpoint:

PolicyTagManagerSettings policyTagManagerSettings =
     PolicyTagManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
 PolicyTagManagerClient policyTagManagerClient =
     PolicyTagManagerClient.create(policyTagManagerSettings);

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

PolicyTagManagerClient.ListPolicyTagsFixedSizeCollection

PolicyTagManagerClient.ListPolicyTagsPage

PolicyTagManagerClient.ListPolicyTagsPagedResponse

PolicyTagManagerClient.ListTaxonomiesFixedSizeCollection

PolicyTagManagerClient.ListTaxonomiesPage

PolicyTagManagerClient.ListTaxonomiesPagedResponse

PolicyTagManagerGrpc

Policy Tag Manager API service allows you to manage your policy tags and
 taxonomies.
 Policy tags are used to tag BigQuery columns and apply additional access
 control policies. A taxonomy is a hierarchical grouping of policy tags that
 classify data along a common axis.

PolicyTagManagerGrpc.PolicyTagManagerBlockingStub

Policy Tag Manager API service allows you to manage your policy tags and
 taxonomies.
 Policy tags are used to tag BigQuery columns and apply additional access
 control policies. A taxonomy is a hierarchical grouping of policy tags that
 classify data along a common axis.

PolicyTagManagerGrpc.PolicyTagManagerFutureStub

Policy Tag Manager API service allows you to manage your policy tags and
 taxonomies.
 Policy tags are used to tag BigQuery columns and apply additional access
 control policies. A taxonomy is a hierarchical grouping of policy tags that
 classify data along a common axis.

PolicyTagManagerGrpc.PolicyTagManagerImplBase

Policy Tag Manager API service allows you to manage your policy tags and
 taxonomies.
 Policy tags are used to tag BigQuery columns and apply additional access
 control policies. A taxonomy is a hierarchical grouping of policy tags that
 classify data along a common axis.

PolicyTagManagerGrpc.PolicyTagManagerStub

Policy Tag Manager API service allows you to manage your policy tags and
 taxonomies.
 Policy tags are used to tag BigQuery columns and apply additional access
 control policies. A taxonomy is a hierarchical grouping of policy tags that
 classify data along a common axis.

PolicyTagManagerProto

PolicyTagManagerSerializationClient

Service Description: Policy Tag Manager Serialization API service allows you to manipulate your policy tags and taxonomies in a serialized format.

Taxonomy is a hierarchical group of policy tags.

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:

try (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create()) {
   ReplaceTaxonomyRequest request =
       ReplaceTaxonomyRequest.newBuilder()
           .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
           .setSerializedTaxonomy(SerializedTaxonomy.newBuilder().build())
           .build();
   Taxonomy response = policyTagManagerSerializationClient.replaceTaxonomy(request);
 }

Note: close() needs to be called on the PolicyTagManagerSerializationClient 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:

  1. 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.
  2. 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.
  3. 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 PolicyTagManagerSerializationSettings to create(). For example:

To customize credentials:

PolicyTagManagerSerializationSettings policyTagManagerSerializationSettings =
     PolicyTagManagerSerializationSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create(policyTagManagerSerializationSettings);

To customize the endpoint:

PolicyTagManagerSerializationSettings policyTagManagerSerializationSettings =
     PolicyTagManagerSerializationSettings.newBuilder().setEndpoint(myEndpoint).build();
 PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
     PolicyTagManagerSerializationClient.create(policyTagManagerSerializationSettings);

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

PolicyTagManagerSerializationGrpc

Policy Tag Manager Serialization API service allows you to manipulate
 your policy tags and taxonomies in a serialized format.
 Taxonomy is a hierarchical group of policy tags.

PolicyTagManagerSerializationGrpc.PolicyTagManagerSerializationBlockingStub

Policy Tag Manager Serialization API service allows you to manipulate
 your policy tags and taxonomies in a serialized format.
 Taxonomy is a hierarchical group of policy tags.

PolicyTagManagerSerializationGrpc.PolicyTagManagerSerializationFutureStub

Policy Tag Manager Serialization API service allows you to manipulate
 your policy tags and taxonomies in a serialized format.
 Taxonomy is a hierarchical group of policy tags.

PolicyTagManagerSerializationGrpc.PolicyTagManagerSerializationImplBase

Policy Tag Manager Serialization API service allows you to manipulate
 your policy tags and taxonomies in a serialized format.
 Taxonomy is a hierarchical group of policy tags.

PolicyTagManagerSerializationGrpc.PolicyTagManagerSerializationStub

Policy Tag Manager Serialization API service allows you to manipulate
 your policy tags and taxonomies in a serialized format.
 Taxonomy is a hierarchical group of policy tags.

PolicyTagManagerSerializationProto

PolicyTagManagerSerializationSettings

Settings class to configure an instance of PolicyTagManagerSerializationClient.

The default instance has everything set to sensible defaults:

  • The default service address (datacatalog.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 replaceTaxonomy to 30 seconds:

PolicyTagManagerSerializationSettings.Builder policyTagManagerSerializationSettingsBuilder =
     PolicyTagManagerSerializationSettings.newBuilder();
 policyTagManagerSerializationSettingsBuilder
     .replaceTaxonomySettings()
     .setRetrySettings(
         policyTagManagerSerializationSettingsBuilder
             .replaceTaxonomySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PolicyTagManagerSerializationSettings policyTagManagerSerializationSettings =
     policyTagManagerSerializationSettingsBuilder.build();

PolicyTagManagerSerializationSettings.Builder

Builder for PolicyTagManagerSerializationSettings.

PolicyTagManagerSettings

Settings class to configure an instance of PolicyTagManagerClient.

The default instance has everything set to sensible defaults:

  • The default service address (datacatalog.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 createTaxonomy to 30 seconds:

PolicyTagManagerSettings.Builder policyTagManagerSettingsBuilder =
     PolicyTagManagerSettings.newBuilder();
 policyTagManagerSettingsBuilder
     .createTaxonomySettings()
     .setRetrySettings(
         policyTagManagerSettingsBuilder
             .createTaxonomySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PolicyTagManagerSettings policyTagManagerSettings = policyTagManagerSettingsBuilder.build();

PolicyTagManagerSettings.Builder

Builder for PolicyTagManagerSettings.

PolicyTagName

PolicyTagName.Builder

Builder for projects/{project}/locations/{location}/taxonomies/{taxonomy}/policyTags/{policy_tag}.

RenameTagTemplateFieldEnumValueRequest

Request message for
 [RenameTagTemplateFieldEnumValue][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue].

Protobuf type google.cloud.datacatalog.v1.RenameTagTemplateFieldEnumValueRequest

RenameTagTemplateFieldEnumValueRequest.Builder

Request message for
 [RenameTagTemplateFieldEnumValue][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue].

Protobuf type google.cloud.datacatalog.v1.RenameTagTemplateFieldEnumValueRequest

RenameTagTemplateFieldRequest

Request message for
 [RenameTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateField].

Protobuf type google.cloud.datacatalog.v1.RenameTagTemplateFieldRequest

RenameTagTemplateFieldRequest.Builder

Request message for
 [RenameTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateField].

Protobuf type google.cloud.datacatalog.v1.RenameTagTemplateFieldRequest

ReplaceTaxonomyRequest

Request message for
 [ReplaceTaxonomy][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ReplaceTaxonomy].

Protobuf type google.cloud.datacatalog.v1.ReplaceTaxonomyRequest

ReplaceTaxonomyRequest.Builder

Request message for
 [ReplaceTaxonomy][google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ReplaceTaxonomy].

Protobuf type google.cloud.datacatalog.v1.ReplaceTaxonomyRequest

RoutineSpec

Specification that applies to a routine. Valid only for
 entries with the `ROUTINE` type.

Protobuf type google.cloud.datacatalog.v1.RoutineSpec

RoutineSpec.Argument

Input or output argument of a function or stored procedure.

Protobuf type google.cloud.datacatalog.v1.RoutineSpec.Argument

RoutineSpec.Argument.Builder

Input or output argument of a function or stored procedure.

Protobuf type google.cloud.datacatalog.v1.RoutineSpec.Argument

RoutineSpec.Builder

Specification that applies to a routine. Valid only for
 entries with the `ROUTINE` type.

Protobuf type google.cloud.datacatalog.v1.RoutineSpec

Schema

Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.

Protobuf type google.cloud.datacatalog.v1.Schema

Schema.Builder

Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema.

Protobuf type google.cloud.datacatalog.v1.Schema

SchemaOuterClass

SearchCatalogRequest

Request message for
 [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].

Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest

SearchCatalogRequest.Builder

Request message for
 [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].

Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest

SearchCatalogRequest.Scope

The criteria that select the subspace used for query matching.

Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest.Scope

SearchCatalogRequest.Scope.Builder

The criteria that select the subspace used for query matching.

Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest.Scope

SearchCatalogResponse

Response message for
 [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].

Protobuf type google.cloud.datacatalog.v1.SearchCatalogResponse

SearchCatalogResponse.Builder

Response message for
 [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].

Protobuf type google.cloud.datacatalog.v1.SearchCatalogResponse

SearchCatalogResult

Result in the response to a search request.
 Each result captures details of one entry that matches the search.

Protobuf type google.cloud.datacatalog.v1.SearchCatalogResult

SearchCatalogResult.Builder

Result in the response to a search request.
 Each result captures details of one entry that matches the search.

Protobuf type google.cloud.datacatalog.v1.SearchCatalogResult

SerializedPolicyTag

A nested protocol buffer that represents a policy tag and all its
 descendants.

Protobuf type google.cloud.datacatalog.v1.SerializedPolicyTag

SerializedPolicyTag.Builder

A nested protocol buffer that represents a policy tag and all its
 descendants.

Protobuf type google.cloud.datacatalog.v1.SerializedPolicyTag

SerializedTaxonomy

A nested protocol buffer that represents a taxonomy and the hierarchy of its
 policy tags. Used for taxonomy replacement, import, and
 export.

Protobuf type google.cloud.datacatalog.v1.SerializedTaxonomy

SerializedTaxonomy.Builder

A nested protocol buffer that represents a taxonomy and the hierarchy of its
 policy tags. Used for taxonomy replacement, import, and
 export.

Protobuf type google.cloud.datacatalog.v1.SerializedTaxonomy

SystemTimestamps

Timestamps associated with this resource in a particular system.

Protobuf type google.cloud.datacatalog.v1.SystemTimestamps

SystemTimestamps.Builder

Timestamps associated with this resource in a particular system.

Protobuf type google.cloud.datacatalog.v1.SystemTimestamps

TableSpec

Normal BigQuery table specification.

Protobuf type google.cloud.datacatalog.v1.TableSpec

TableSpec.Builder

Normal BigQuery table specification.

Protobuf type google.cloud.datacatalog.v1.TableSpec

TableSpecOuterClass

Tag

Tags contain custom metadata and are attached to Data Catalog resources. Tags
 conform with the specification of their tag template.
 See [Data Catalog
 IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information
 on the permissions needed to create or view tags.

Protobuf type google.cloud.datacatalog.v1.Tag

Tag.Builder

Tags contain custom metadata and are attached to Data Catalog resources. Tags
 conform with the specification of their tag template.
 See [Data Catalog
 IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information
 on the permissions needed to create or view tags.

Protobuf type google.cloud.datacatalog.v1.Tag

TagField

Contains the value and additional information on a field within
 a [Tag][google.cloud.datacatalog.v1.Tag].

Protobuf type google.cloud.datacatalog.v1.TagField

TagField.Builder

Contains the value and additional information on a field within
 a [Tag][google.cloud.datacatalog.v1.Tag].

Protobuf type google.cloud.datacatalog.v1.TagField

TagField.EnumValue

An enum value.

Protobuf type google.cloud.datacatalog.v1.TagField.EnumValue

TagField.EnumValue.Builder

An enum value.

Protobuf type google.cloud.datacatalog.v1.TagField.EnumValue

TagName

TagName.Builder

Builder for projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}/tags/{tag}.

TagTemplate

A tag template defines a tag that can have one or more typed fields.
 The template is used to create tags that are attached to GCP resources.
 [Tag template roles]
 (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
 provide permissions to create, edit, and use the template. For example,
 see the [TagTemplate User]
 (https://cloud.google.com/data-catalog/docs/how-to/template-user) role
 that includes a permission to use the tag template to tag resources.

Protobuf type google.cloud.datacatalog.v1.TagTemplate

TagTemplate.Builder

A tag template defines a tag that can have one or more typed fields.
 The template is used to create tags that are attached to GCP resources.
 [Tag template roles]
 (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
 provide permissions to create, edit, and use the template. For example,
 see the [TagTemplate User]
 (https://cloud.google.com/data-catalog/docs/how-to/template-user) role
 that includes a permission to use the tag template to tag resources.

Protobuf type google.cloud.datacatalog.v1.TagTemplate

TagTemplateField

The template for an individual field within a tag template.

Protobuf type google.cloud.datacatalog.v1.TagTemplateField

TagTemplateField.Builder

The template for an individual field within a tag template.

Protobuf type google.cloud.datacatalog.v1.TagTemplateField

TagTemplateFieldEnumValueName

TagTemplateFieldEnumValueName.Builder

Builder for projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name}.

TagTemplateFieldName

TagTemplateFieldName.Builder

Builder for projects/{project}/locations/{location}/tagTemplates/{tag_template}/fields/{field}.

TagTemplateName

TagTemplateName.Builder

Builder for projects/{project}/locations/{location}/tagTemplates/{tag_template}.

Tags

Taxonomy

A taxonomy is a collection of hierarchical policy tags that classify data
 along a common axis.
 For example, a "data sensitivity" taxonomy might contain the following policy
 tags:
  • PII
    • Account number
    • Age
    • SSN
    • Zipcode
  • Financials
    • Revenue A "data origin" taxonomy might contain the following policy tags:
  • User data
  • Employee data
  • Partner data
  • Public data

Protobuf type google.cloud.datacatalog.v1.Taxonomy

Taxonomy.Builder

A taxonomy is a collection of hierarchical policy tags that classify data
 along a common axis.
 For example, a "data sensitivity" taxonomy might contain the following policy
 tags:
  • PII
    • Account number
    • Age
    • SSN
    • Zipcode
  • Financials
    • Revenue A "data origin" taxonomy might contain the following policy tags:
  • User data
  • Employee data
  • Partner data
  • Public data

Protobuf type google.cloud.datacatalog.v1.Taxonomy

TaxonomyName

TaxonomyName.Builder

Builder for projects/{project}/locations/{location}/taxonomies/{taxonomy}.

Timestamps

UpdateEntryGroupRequest

Request message for
 [UpdateEntryGroup][google.cloud.datacatalog.v1.DataCatalog.UpdateEntryGroup].

Protobuf type google.cloud.datacatalog.v1.UpdateEntryGroupRequest

UpdateEntryGroupRequest.Builder

Request message for
 [UpdateEntryGroup][google.cloud.datacatalog.v1.DataCatalog.UpdateEntryGroup].

Protobuf type google.cloud.datacatalog.v1.UpdateEntryGroupRequest

UpdateEntryRequest

Request message for
 [UpdateEntry][google.cloud.datacatalog.v1.DataCatalog.UpdateEntry].

Protobuf type google.cloud.datacatalog.v1.UpdateEntryRequest

UpdateEntryRequest.Builder

Request message for
 [UpdateEntry][google.cloud.datacatalog.v1.DataCatalog.UpdateEntry].

Protobuf type google.cloud.datacatalog.v1.UpdateEntryRequest

UpdatePolicyTagRequest

Request message for
 [UpdatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.UpdatePolicyTag].

Protobuf type google.cloud.datacatalog.v1.UpdatePolicyTagRequest

UpdatePolicyTagRequest.Builder

Request message for
 [UpdatePolicyTag][google.cloud.datacatalog.v1.PolicyTagManager.UpdatePolicyTag].

Protobuf type google.cloud.datacatalog.v1.UpdatePolicyTagRequest

UpdateTagRequest

Request message for
 [UpdateTag][google.cloud.datacatalog.v1.DataCatalog.UpdateTag].

Protobuf type google.cloud.datacatalog.v1.UpdateTagRequest

UpdateTagRequest.Builder

Request message for
 [UpdateTag][google.cloud.datacatalog.v1.DataCatalog.UpdateTag].

Protobuf type google.cloud.datacatalog.v1.UpdateTagRequest

UpdateTagTemplateFieldRequest

Request message for
 [UpdateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateField].

Protobuf type google.cloud.datacatalog.v1.UpdateTagTemplateFieldRequest

UpdateTagTemplateFieldRequest.Builder

Request message for
 [UpdateTagTemplateField][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateField].

Protobuf type google.cloud.datacatalog.v1.UpdateTagTemplateFieldRequest

UpdateTagTemplateRequest

Request message for
 [UpdateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplate].

Protobuf type google.cloud.datacatalog.v1.UpdateTagTemplateRequest

UpdateTagTemplateRequest.Builder

Request message for
 [UpdateTagTemplate][google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplate].

Protobuf type google.cloud.datacatalog.v1.UpdateTagTemplateRequest

UpdateTaxonomyRequest

Request message for
 [UpdateTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.UpdateTaxonomy].

Protobuf type google.cloud.datacatalog.v1.UpdateTaxonomyRequest

UpdateTaxonomyRequest.Builder

Request message for
 [UpdateTaxonomy][google.cloud.datacatalog.v1.PolicyTagManager.UpdateTaxonomy].

Protobuf type google.cloud.datacatalog.v1.UpdateTaxonomyRequest

Usage

UsageSignal

The set of all usage signals that Data Catalog stores.
 Note: Usually, these signals are updated daily. In rare cases, an update may
 fail but will be performed again on the next day.

Protobuf type google.cloud.datacatalog.v1.UsageSignal

UsageSignal.Builder

The set of all usage signals that Data Catalog stores.
 Note: Usually, these signals are updated daily. In rare cases, an update may
 fail but will be performed again on the next day.

Protobuf type google.cloud.datacatalog.v1.UsageSignal

UsageStats

Detailed statistics on the entry's usage.
 Usage statistics have the following limitations:
 - Only BigQuery tables have them.
 - They only include BigQuery query jobs.
 - They might be underestimated because wildcard table references
   are not yet counted. For more information, see
   [Querying multiple tables using a wildcard table]
   (https://cloud.google.com/bigquery/docs/querying-wildcard-tables)

Protobuf type google.cloud.datacatalog.v1.UsageStats

UsageStats.Builder

Detailed statistics on the entry's usage.
 Usage statistics have the following limitations:
 - Only BigQuery tables have them.
 - They only include BigQuery query jobs.
 - They might be underestimated because wildcard table references
   are not yet counted. For more information, see
   [Querying multiple tables using a wildcard table]
   (https://cloud.google.com/bigquery/docs/querying-wildcard-tables)

Protobuf type google.cloud.datacatalog.v1.UsageStats

ViewSpec

Table view specification.

Protobuf type google.cloud.datacatalog.v1.ViewSpec

ViewSpec.Builder

Table view specification.

Protobuf type google.cloud.datacatalog.v1.ViewSpec

Interfaces

BigQueryConnectionSpecOrBuilder

BigQueryDateShardedSpecOrBuilder

BigQueryRoutineSpecOrBuilder

BigQueryTableSpecOrBuilder

CloudSqlBigQueryConnectionSpecOrBuilder

ColumnSchemaOrBuilder

CreateEntryGroupRequestOrBuilder

CreateEntryRequestOrBuilder

CreatePolicyTagRequestOrBuilder

CreateTagRequestOrBuilder

CreateTagTemplateFieldRequestOrBuilder

CreateTagTemplateRequestOrBuilder

CreateTaxonomyRequestOrBuilder

CrossRegionalSourceOrBuilder

DataSourceConnectionSpecOrBuilder

DataSourceOrBuilder

DatabaseTableSpecOrBuilder

DeleteEntryGroupRequestOrBuilder

DeleteEntryRequestOrBuilder

DeletePolicyTagRequestOrBuilder

DeleteTagRequestOrBuilder

DeleteTagTemplateFieldRequestOrBuilder

DeleteTagTemplateRequestOrBuilder

DeleteTaxonomyRequestOrBuilder

EntryGroupOrBuilder

EntryOrBuilder

ExportTaxonomiesRequestOrBuilder

ExportTaxonomiesResponseOrBuilder

FieldType.EnumType.EnumValueOrBuilder

FieldType.EnumTypeOrBuilder

FieldTypeOrBuilder

GcsFileSpecOrBuilder

GcsFilesetSpecOrBuilder

GetEntryGroupRequestOrBuilder

GetEntryRequestOrBuilder

GetPolicyTagRequestOrBuilder

GetTagTemplateRequestOrBuilder

GetTaxonomyRequestOrBuilder

ImportTaxonomiesRequestOrBuilder

ImportTaxonomiesResponseOrBuilder

InlineSourceOrBuilder

ListEntriesRequestOrBuilder

ListEntriesResponseOrBuilder

ListEntryGroupsRequestOrBuilder

ListEntryGroupsResponseOrBuilder

ListPolicyTagsRequestOrBuilder

ListPolicyTagsResponseOrBuilder

ListTagsRequestOrBuilder

ListTagsResponseOrBuilder

ListTaxonomiesRequestOrBuilder

ListTaxonomiesResponseOrBuilder

LookupEntryRequestOrBuilder

PolicyTagOrBuilder

RenameTagTemplateFieldEnumValueRequestOrBuilder

RenameTagTemplateFieldRequestOrBuilder

ReplaceTaxonomyRequestOrBuilder

RoutineSpec.ArgumentOrBuilder

RoutineSpecOrBuilder

SchemaOrBuilder

SearchCatalogRequest.ScopeOrBuilder

SearchCatalogRequestOrBuilder

SearchCatalogResponseOrBuilder

SearchCatalogResultOrBuilder

SerializedPolicyTagOrBuilder

SerializedTaxonomyOrBuilder

SystemTimestampsOrBuilder

TableSpecOrBuilder

TagField.EnumValueOrBuilder

TagFieldOrBuilder

TagOrBuilder

TagTemplateFieldOrBuilder

TagTemplateOrBuilder

TaxonomyOrBuilder

UpdateEntryGroupRequestOrBuilder

UpdateEntryRequestOrBuilder

UpdatePolicyTagRequestOrBuilder

UpdateTagRequestOrBuilder

UpdateTagTemplateFieldRequestOrBuilder

UpdateTagTemplateRequestOrBuilder

UpdateTaxonomyRequestOrBuilder

UsageSignalOrBuilder

UsageStatsOrBuilder

ViewSpecOrBuilder

Enums

BigQueryConnectionSpec.ConnectionSpecCase

BigQueryConnectionSpec.ConnectionType

The type of the BigQuery connection.

Protobuf enum google.cloud.datacatalog.v1.BigQueryConnectionSpec.ConnectionType

BigQueryTableSpec.TypeSpecCase

CloudSqlBigQueryConnectionSpec.DatabaseType

Supported Cloud SQL database types.

Protobuf enum google.cloud.datacatalog.v1.CloudSqlBigQueryConnectionSpec.DatabaseType

DataSource.Service

Name of a service that stores the data.

Protobuf enum google.cloud.datacatalog.v1.DataSource.Service

DatabaseTableSpec.TableType

Type of the table.

Protobuf enum google.cloud.datacatalog.v1.DatabaseTableSpec.TableType

Entry.EntryTypeCase

Entry.SpecCase

Entry.SystemCase

Entry.TypeSpecCase

EntryType

The enum field that lists all the types of entry resources in Data
 Catalog. For example, a BigQuery table entry has the `TABLE` type.

Protobuf enum google.cloud.datacatalog.v1.EntryType

ExportTaxonomiesRequest.DestinationCase

FieldType.PrimitiveType

Protobuf enum google.cloud.datacatalog.v1.FieldType.PrimitiveType

FieldType.TypeDeclCase

ImportTaxonomiesRequest.SourceCase

IntegratedSystem

This enum lists all the systems that Data Catalog integrates with.

Protobuf enum google.cloud.datacatalog.v1.IntegratedSystem

LookupEntryRequest.TargetNameCase

RoutineSpec.Argument.Mode

The input or output mode of the argument.

Protobuf enum google.cloud.datacatalog.v1.RoutineSpec.Argument.Mode

RoutineSpec.RoutineType

The fine-grained type of the routine.

Protobuf enum google.cloud.datacatalog.v1.RoutineSpec.RoutineType

RoutineSpec.SystemSpecCase

SearchCatalogResult.SystemCase

SearchResultType

The resource types that can be returned in search results.

Protobuf enum google.cloud.datacatalog.v1.SearchResultType

TableSourceType

Table source type.

Protobuf enum google.cloud.datacatalog.v1.TableSourceType

Tag.ScopeCase

TagField.KindCase

Taxonomy.PolicyType

Defines policy types where the policy tags can be used for.

Protobuf enum google.cloud.datacatalog.v1.Taxonomy.PolicyType