- 1.59.0 (latest)
- 1.58.0
- 1.57.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.5
- 1.8.4
- 1.7.2
- 1.6.2
- 1.5.4
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:
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:
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:
try (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
PolicyTagManagerSerializationClient.create()) {
ImportTaxonomiesRequest request =
ImportTaxonomiesRequest.newBuilder()
.setParent(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").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
Common
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:
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:
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 clients to discover, understand, and manage their data.
DataCatalogGrpc.DataCatalogBlockingStub
Data Catalog API service allows clients to discover, understand, and manage their data.
DataCatalogGrpc.DataCatalogFutureStub
Data Catalog API service allows clients to discover, understand, and manage their data.
DataCatalogGrpc.DataCatalogImplBase
Data Catalog API service allows clients to discover, understand, and manage their data.
DataCatalogGrpc.DataCatalogStub
Data Catalog API service allows clients to discover, understand, and manage their 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.
Datacatalog
DeleteEntryGroupRequest
Request message for DeleteEntryGroup.
Protobuf type google.cloud.datacatalog.v1beta1.DeleteEntryGroupRequest
DeleteEntryGroupRequest.Builder
Request message for DeleteEntryGroup.
Protobuf type google.cloud.datacatalog.v1beta1.DeleteEntryGroupRequest
DeleteEntryRequest
Request message for DeleteEntry.
Protobuf type google.cloud.datacatalog.v1beta1.DeleteEntryRequest
DeleteEntryRequest.Builder
Request message for DeleteEntry.
Protobuf type google.cloud.datacatalog.v1beta1.DeleteEntryRequest
DeletePolicyTagRequest
Request message for DeletePolicyTag.
Protobuf type google.cloud.datacatalog.v1beta1.DeletePolicyTagRequest
DeletePolicyTagRequest.Builder
Request message for DeletePolicyTag.
Protobuf type google.cloud.datacatalog.v1beta1.DeletePolicyTagRequest
DeleteTagRequest
Request message for DeleteTag.
Protobuf type google.cloud.datacatalog.v1beta1.DeleteTagRequest
DeleteTagRequest.Builder
Request message for DeleteTag.
Protobuf type google.cloud.datacatalog.v1beta1.DeleteTagRequest
DeleteTagTemplateFieldRequest
Request message for DeleteTagTemplateField.
Protobuf type google.cloud.datacatalog.v1beta1.DeleteTagTemplateFieldRequest
DeleteTagTemplateFieldRequest.Builder
Request message for DeleteTagTemplateField.
Protobuf type google.cloud.datacatalog.v1beta1.DeleteTagTemplateFieldRequest
DeleteTagTemplateRequest
Request message for DeleteTagTemplate.
Protobuf type google.cloud.datacatalog.v1beta1.DeleteTagTemplateRequest
DeleteTagTemplateRequest.Builder
Request message for DeleteTagTemplate.
Protobuf type google.cloud.datacatalog.v1beta1.DeleteTagTemplateRequest
DeleteTaxonomyRequest
Request message for DeleteTaxonomy.
Protobuf type google.cloud.datacatalog.v1beta1.DeleteTaxonomyRequest
DeleteTaxonomyRequest.Builder
Request message for DeleteTaxonomy.
Protobuf type google.cloud.datacatalog.v1beta1.DeleteTaxonomyRequest
Entry
Entry Metadata.
A Data Catalog Entry resource represents another resource in Google
Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or
outside of Google Cloud Platform. Clients 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, such as its schema. An Entry can
also be used to attach flexible metadata, such as a
Tag.
Protobuf type google.cloud.datacatalog.v1beta1.Entry
Entry.Builder
Entry Metadata.
A Data Catalog Entry resource represents another resource in Google
Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or
outside of Google Cloud Platform. Clients 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, such as its schema. An Entry can
also be used to attach flexible metadata, such as a
Tag.
Protobuf type google.cloud.datacatalog.v1beta1.Entry
EntryGroup
EntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.
Protobuf type google.cloud.datacatalog.v1beta1.EntryGroup
EntryGroup.Builder
EntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.
Protobuf type google.cloud.datacatalog.v1beta1.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.
Protobuf type google.cloud.datacatalog.v1beta1.ExportTaxonomiesRequest
ExportTaxonomiesRequest.Builder
Request message for ExportTaxonomies.
Protobuf type google.cloud.datacatalog.v1beta1.ExportTaxonomiesRequest
ExportTaxonomiesResponse
Response message for ExportTaxonomies.
Protobuf type google.cloud.datacatalog.v1beta1.ExportTaxonomiesResponse
ExportTaxonomiesResponse.Builder
Response message for ExportTaxonomies.
Protobuf type google.cloud.datacatalog.v1beta1.ExportTaxonomiesResponse
FieldName
AUTO-GENERATED DOCUMENTATION AND CLASS
FieldName.Builder
Builder for FieldName.
FieldType
Protobuf type google.cloud.datacatalog.v1beta1.FieldType
FieldType.Builder
Protobuf type google.cloud.datacatalog.v1beta1.FieldType
FieldType.EnumType
Protobuf type google.cloud.datacatalog.v1beta1.FieldType.EnumType
FieldType.EnumType.Builder
Protobuf type google.cloud.datacatalog.v1beta1.FieldType.EnumType
FieldType.EnumType.EnumValue
Protobuf type google.cloud.datacatalog.v1beta1.FieldType.EnumType.EnumValue
FieldType.EnumType.EnumValue.Builder
Protobuf type google.cloud.datacatalog.v1beta1.FieldType.EnumType.EnumValue
GcsFileSpec
Specifications of a single file in Cloud Storage.
Protobuf type google.cloud.datacatalog.v1beta1.GcsFileSpec
GcsFileSpec.Builder
Specifications of a single file in Cloud Storage.
Protobuf type google.cloud.datacatalog.v1beta1.GcsFileSpec
GcsFilesetSpec
Describes a Cloud Storage fileset entry.
Protobuf type google.cloud.datacatalog.v1beta1.GcsFilesetSpec
GcsFilesetSpec.Builder
Describes a Cloud Storage fileset entry.
Protobuf type google.cloud.datacatalog.v1beta1.GcsFilesetSpec
GcsFilesetSpecOuterClass
GetEntryGroupRequest
Request message for GetEntryGroup.
Protobuf type google.cloud.datacatalog.v1beta1.GetEntryGroupRequest
GetEntryGroupRequest.Builder
Request message for GetEntryGroup.
Protobuf type google.cloud.datacatalog.v1beta1.GetEntryGroupRequest
GetEntryRequest
Request message for GetEntry.
Protobuf type google.cloud.datacatalog.v1beta1.GetEntryRequest
GetEntryRequest.Builder
Request message for GetEntry.
Protobuf type google.cloud.datacatalog.v1beta1.GetEntryRequest
GetPolicyTagRequest
Request message for GetPolicyTag.
Protobuf type google.cloud.datacatalog.v1beta1.GetPolicyTagRequest
GetPolicyTagRequest.Builder
Request message for GetPolicyTag.
Protobuf type google.cloud.datacatalog.v1beta1.GetPolicyTagRequest
GetTagTemplateRequest
Request message for GetTagTemplate.
Protobuf type google.cloud.datacatalog.v1beta1.GetTagTemplateRequest
GetTagTemplateRequest.Builder
Request message for GetTagTemplate.
Protobuf type google.cloud.datacatalog.v1beta1.GetTagTemplateRequest
GetTaxonomyRequest
Request message for GetTaxonomy.
Protobuf type google.cloud.datacatalog.v1beta1.GetTaxonomyRequest
GetTaxonomyRequest.Builder
Request message for GetTaxonomy.
Protobuf type google.cloud.datacatalog.v1beta1.GetTaxonomyRequest
ImportTaxonomiesRequest
Request message for ImportTaxonomies.
Protobuf type google.cloud.datacatalog.v1beta1.ImportTaxonomiesRequest
ImportTaxonomiesRequest.Builder
Request message for ImportTaxonomies.
Protobuf type google.cloud.datacatalog.v1beta1.ImportTaxonomiesRequest
ImportTaxonomiesResponse
Response message for ImportTaxonomies.
Protobuf type google.cloud.datacatalog.v1beta1.ImportTaxonomiesResponse
ImportTaxonomiesResponse.Builder
Response message for ImportTaxonomies.
Protobuf type google.cloud.datacatalog.v1beta1.ImportTaxonomiesResponse
InlineSource
Inline source used for taxonomies import.
Protobuf type google.cloud.datacatalog.v1beta1.InlineSource
InlineSource.Builder
Inline source used for taxonomies import.
Protobuf type google.cloud.datacatalog.v1beta1.InlineSource
ListEntriesRequest
Request message for ListEntries.
Protobuf type google.cloud.datacatalog.v1beta1.ListEntriesRequest
ListEntriesRequest.Builder
Request message for ListEntries.
Protobuf type google.cloud.datacatalog.v1beta1.ListEntriesRequest
ListEntriesResponse
Response message for ListEntries.
Protobuf type google.cloud.datacatalog.v1beta1.ListEntriesResponse
ListEntriesResponse.Builder
Response message for ListEntries.
Protobuf type google.cloud.datacatalog.v1beta1.ListEntriesResponse
ListEntryGroupsRequest
Request message for ListEntryGroups.
Protobuf type google.cloud.datacatalog.v1beta1.ListEntryGroupsRequest
ListEntryGroupsRequest.Builder
Request message for ListEntryGroups.
Protobuf type google.cloud.datacatalog.v1beta1.ListEntryGroupsRequest
ListEntryGroupsResponse
Response message for ListEntryGroups.
Protobuf type google.cloud.datacatalog.v1beta1.ListEntryGroupsResponse
ListEntryGroupsResponse.Builder
Response message for ListEntryGroups.
Protobuf type google.cloud.datacatalog.v1beta1.ListEntryGroupsResponse
ListPolicyTagsRequest
Request message for ListPolicyTags.
Protobuf type google.cloud.datacatalog.v1beta1.ListPolicyTagsRequest
ListPolicyTagsRequest.Builder
Request message for ListPolicyTags.
Protobuf type google.cloud.datacatalog.v1beta1.ListPolicyTagsRequest
ListPolicyTagsResponse
Response message for ListPolicyTags.
Protobuf type google.cloud.datacatalog.v1beta1.ListPolicyTagsResponse
ListPolicyTagsResponse.Builder
Response message for ListPolicyTags.
Protobuf type google.cloud.datacatalog.v1beta1.ListPolicyTagsResponse
ListTagsRequest
Request message for ListTags.
Protobuf type google.cloud.datacatalog.v1beta1.ListTagsRequest
ListTagsRequest.Builder
Request message for ListTags.
Protobuf type google.cloud.datacatalog.v1beta1.ListTagsRequest
ListTagsResponse
Response message for ListTags.
Protobuf type google.cloud.datacatalog.v1beta1.ListTagsResponse
ListTagsResponse.Builder
Response message for ListTags.
Protobuf type google.cloud.datacatalog.v1beta1.ListTagsResponse
ListTaxonomiesRequest
Request message for ListTaxonomies.
Protobuf type google.cloud.datacatalog.v1beta1.ListTaxonomiesRequest
ListTaxonomiesRequest.Builder
Request message for ListTaxonomies.
Protobuf type google.cloud.datacatalog.v1beta1.ListTaxonomiesRequest
ListTaxonomiesResponse
Response message for ListTaxonomies.
Protobuf type google.cloud.datacatalog.v1beta1.ListTaxonomiesResponse
ListTaxonomiesResponse.Builder
Response message for ListTaxonomies.
Protobuf type google.cloud.datacatalog.v1beta1.ListTaxonomiesResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
LookupEntryRequest
Request message for LookupEntry.
Protobuf type google.cloud.datacatalog.v1beta1.LookupEntryRequest
LookupEntryRequest.Builder
Request message for LookupEntry.
Protobuf type google.cloud.datacatalog.v1beta1.LookupEntryRequest
PolicyTag
Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierarchy: Geolocation -> (LatLong, City, ZipCode). PolicyTag "Geolocation" contains three child policy tags: "LatLong", "City", and "ZipCode".
Protobuf type google.cloud.datacatalog.v1beta1.PolicyTag
PolicyTag.Builder
Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierarchy: Geolocation -> (LatLong, City, ZipCode). PolicyTag "Geolocation" contains three child policy tags: "LatLong", "City", and "ZipCode".
Protobuf type google.cloud.datacatalog.v1beta1.PolicyTag
PolicyTagManagerClient
Service Description: The policy tag manager API service allows clients to manage their taxonomies and 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 (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:
- 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 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
The policy tag manager API service allows clients to manage their taxonomies and policy tags.
PolicyTagManagerGrpc.PolicyTagManagerBlockingStub
The policy tag manager API service allows clients to manage their taxonomies and policy tags.
PolicyTagManagerGrpc.PolicyTagManagerFutureStub
The policy tag manager API service allows clients to manage their taxonomies and policy tags.
PolicyTagManagerGrpc.PolicyTagManagerImplBase
The policy tag manager API service allows clients to manage their taxonomies and policy tags.
PolicyTagManagerGrpc.PolicyTagManagerStub
The policy tag manager API service allows clients to manage their taxonomies and policy tags.
PolicyTagManagerProto
PolicyTagManagerSerializationClient
Service Description: Policy tag manager serialization API service allows clients to manipulate their taxonomies and policy tags data with serialized format.
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()) {
ImportTaxonomiesRequest request =
ImportTaxonomiesRequest.newBuilder()
.setParent(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
.build();
ImportTaxonomiesResponse response =
policyTagManagerSerializationClient.importTaxonomies(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:
- 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 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 clients to manipulate their taxonomies and policy tags data with serialized format.
PolicyTagManagerSerializationGrpc.PolicyTagManagerSerializationBlockingStub
Policy tag manager serialization API service allows clients to manipulate their taxonomies and policy tags data with serialized format.
PolicyTagManagerSerializationGrpc.PolicyTagManagerSerializationFutureStub
Policy tag manager serialization API service allows clients to manipulate their taxonomies and policy tags data with serialized format.
PolicyTagManagerSerializationGrpc.PolicyTagManagerSerializationImplBase
Policy tag manager serialization API service allows clients to manipulate their taxonomies and policy tags data with serialized format.
PolicyTagManagerSerializationGrpc.PolicyTagManagerSerializationStub
Policy tag manager serialization API service allows clients to manipulate their taxonomies and policy tags data with serialized format.
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 importTaxonomies to 30 seconds:
PolicyTagManagerSerializationSettings.Builder policyTagManagerSerializationSettingsBuilder =
PolicyTagManagerSerializationSettings.newBuilder();
policyTagManagerSerializationSettingsBuilder
.importTaxonomiesSettings()
.setRetrySettings(
policyTagManagerSerializationSettingsBuilder
.importTaxonomiesSettings()
.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}.
RenameTagTemplateFieldRequest
Request message for RenameTagTemplateField.
Protobuf type google.cloud.datacatalog.v1beta1.RenameTagTemplateFieldRequest
RenameTagTemplateFieldRequest.Builder
Request message for RenameTagTemplateField.
Protobuf type google.cloud.datacatalog.v1beta1.RenameTagTemplateFieldRequest
Schema
Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
Protobuf type google.cloud.datacatalog.v1beta1.Schema
Schema.Builder
Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
Protobuf type google.cloud.datacatalog.v1beta1.Schema
SchemaOuterClass
Search
SearchCatalogRequest
Request message for SearchCatalog.
Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogRequest
SearchCatalogRequest.Builder
Request message for SearchCatalog.
Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogRequest
SearchCatalogRequest.Scope
The criteria that select the subspace used for query matching.
Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope
SearchCatalogRequest.Scope.Builder
The criteria that select the subspace used for query matching.
Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope
SearchCatalogResponse
Response message for SearchCatalog.
Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogResponse
SearchCatalogResponse.Builder
Response message for SearchCatalog.
Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogResponse
SearchCatalogResult
A result that appears in the response of a search request. Each result captures details of one entry that matches the search.
Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogResult
SearchCatalogResult.Builder
A result that appears in the response of a search request. Each result captures details of one entry that matches the search.
Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogResult
SerializedPolicyTag
Message representing one policy tag when exported as a nested proto.
Protobuf type google.cloud.datacatalog.v1beta1.SerializedPolicyTag
SerializedPolicyTag.Builder
Message representing one policy tag when exported as a nested proto.
Protobuf type google.cloud.datacatalog.v1beta1.SerializedPolicyTag
SerializedTaxonomy
Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation.
Protobuf type google.cloud.datacatalog.v1beta1.SerializedTaxonomy
SerializedTaxonomy.Builder
Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation.
Protobuf type google.cloud.datacatalog.v1beta1.SerializedTaxonomy
SystemTimestamps
Timestamps about this resource according to a particular system.
Protobuf type google.cloud.datacatalog.v1beta1.SystemTimestamps
SystemTimestamps.Builder
Timestamps about this resource according to a particular system.
Protobuf type google.cloud.datacatalog.v1beta1.SystemTimestamps
TableSpec
Normal BigQuery table spec.
Protobuf type google.cloud.datacatalog.v1beta1.TableSpec
TableSpec.Builder
Normal BigQuery table spec.
Protobuf type google.cloud.datacatalog.v1beta1.TableSpec
TableSpecOuterClass
Tag
Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template. See Data Catalog IAM for information on the permissions needed to create or view tags.
Protobuf type google.cloud.datacatalog.v1beta1.Tag
Tag.Builder
Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template. See Data Catalog IAM for information on the permissions needed to create or view tags.
Protobuf type google.cloud.datacatalog.v1beta1.Tag
TagField
Contains the value and supporting information for a field within a Tag.
Protobuf type google.cloud.datacatalog.v1beta1.TagField
TagField.Builder
Contains the value and supporting information for a field within a Tag.
Protobuf type google.cloud.datacatalog.v1beta1.TagField
TagField.EnumValue
Holds an enum value.
Protobuf type google.cloud.datacatalog.v1beta1.TagField.EnumValue
TagField.EnumValue.Builder
Holds an enum value.
Protobuf type google.cloud.datacatalog.v1beta1.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, which can have one or more typed fields. The template is used to create and attach the tag to GCP resources. Tag template roles provide permissions to create, edit, and use the template. See, for example, the TagTemplate User role, which includes permission to use the tag template to tag resources.
Protobuf type google.cloud.datacatalog.v1beta1.TagTemplate
TagTemplate.Builder
A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to GCP resources. Tag template roles provide permissions to create, edit, and use the template. See, for example, the TagTemplate User role, which includes permission to use the tag template to tag resources.
Protobuf type google.cloud.datacatalog.v1beta1.TagTemplate
TagTemplateField
The template for an individual field within a tag template.
Protobuf type google.cloud.datacatalog.v1beta1.TagTemplateField
TagTemplateField.Builder
The template for an individual field within a tag template.
Protobuf type google.cloud.datacatalog.v1beta1.TagTemplateField
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 policy tags that classify data along a common axis. For instance a data sensitivity taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data origin taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data.
Protobuf type google.cloud.datacatalog.v1beta1.Taxonomy
Taxonomy.Builder
A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data sensitivity taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data origin taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data.
Protobuf type google.cloud.datacatalog.v1beta1.Taxonomy
TaxonomyName
TaxonomyName.Builder
Builder for projects/{project}/locations/{location}/taxonomies/{taxonomy}.
Timestamps
UpdateEntryGroupRequest
Request message for UpdateEntryGroup.
Protobuf type google.cloud.datacatalog.v1beta1.UpdateEntryGroupRequest
UpdateEntryGroupRequest.Builder
Request message for UpdateEntryGroup.
Protobuf type google.cloud.datacatalog.v1beta1.UpdateEntryGroupRequest
UpdateEntryRequest
Request message for UpdateEntry.
Protobuf type google.cloud.datacatalog.v1beta1.UpdateEntryRequest
UpdateEntryRequest.Builder
Request message for UpdateEntry.
Protobuf type google.cloud.datacatalog.v1beta1.UpdateEntryRequest
UpdatePolicyTagRequest
Request message for UpdatePolicyTag.
Protobuf type google.cloud.datacatalog.v1beta1.UpdatePolicyTagRequest
UpdatePolicyTagRequest.Builder
Request message for UpdatePolicyTag.
Protobuf type google.cloud.datacatalog.v1beta1.UpdatePolicyTagRequest
UpdateTagRequest
Request message for UpdateTag.
Protobuf type google.cloud.datacatalog.v1beta1.UpdateTagRequest
UpdateTagRequest.Builder
Request message for UpdateTag.
Protobuf type google.cloud.datacatalog.v1beta1.UpdateTagRequest
UpdateTagTemplateFieldRequest
Request message for UpdateTagTemplateField.
Protobuf type google.cloud.datacatalog.v1beta1.UpdateTagTemplateFieldRequest
UpdateTagTemplateFieldRequest.Builder
Request message for UpdateTagTemplateField.
Protobuf type google.cloud.datacatalog.v1beta1.UpdateTagTemplateFieldRequest
UpdateTagTemplateRequest
Request message for UpdateTagTemplate.
Protobuf type google.cloud.datacatalog.v1beta1.UpdateTagTemplateRequest
UpdateTagTemplateRequest.Builder
Request message for UpdateTagTemplate.
Protobuf type google.cloud.datacatalog.v1beta1.UpdateTagTemplateRequest
UpdateTaxonomyRequest
Request message for UpdateTaxonomy.
Protobuf type google.cloud.datacatalog.v1beta1.UpdateTaxonomyRequest
UpdateTaxonomyRequest.Builder
Request message for UpdateTaxonomy.
Protobuf type google.cloud.datacatalog.v1beta1.UpdateTaxonomyRequest
ViewSpec
Table view specification.
Protobuf type google.cloud.datacatalog.v1beta1.ViewSpec
ViewSpec.Builder
Table view specification.
Protobuf type google.cloud.datacatalog.v1beta1.ViewSpec
Interfaces
BigQueryDateShardedSpecOrBuilder
BigQueryTableSpecOrBuilder
ColumnSchemaOrBuilder
CreateEntryGroupRequestOrBuilder
CreateEntryRequestOrBuilder
CreatePolicyTagRequestOrBuilder
CreateTagRequestOrBuilder
CreateTagTemplateFieldRequestOrBuilder
CreateTagTemplateRequestOrBuilder
CreateTaxonomyRequestOrBuilder
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
RenameTagTemplateFieldRequestOrBuilder
SchemaOrBuilder
SearchCatalogRequest.ScopeOrBuilder
SearchCatalogRequestOrBuilder
SearchCatalogResponseOrBuilder
SearchCatalogResultOrBuilder
SerializedPolicyTagOrBuilder
SerializedTaxonomyOrBuilder
SystemTimestampsOrBuilder
TableSpecOrBuilder
TagField.EnumValueOrBuilder
TagFieldOrBuilder
TagOrBuilder
TagTemplateFieldOrBuilder
TagTemplateOrBuilder
TaxonomyOrBuilder
UpdateEntryGroupRequestOrBuilder
UpdateEntryRequestOrBuilder
UpdatePolicyTagRequestOrBuilder
UpdateTagRequestOrBuilder
UpdateTagTemplateFieldRequestOrBuilder
UpdateTagTemplateRequestOrBuilder
UpdateTaxonomyRequestOrBuilder
ViewSpecOrBuilder
Enums
BigQueryTableSpec.TypeSpecCase
Entry.EntryTypeCase
Entry.SystemCase
Entry.TypeSpecCase
EntryType
Entry resources in Data Catalog can be of different types e.g. a BigQuery
Table entry is of type TABLE
. This enum describes all the possible types
Data Catalog contains.
Protobuf enum google.cloud.datacatalog.v1beta1.EntryType
ExportTaxonomiesRequest.DestinationCase
FieldType.PrimitiveType
Protobuf enum google.cloud.datacatalog.v1beta1.FieldType.PrimitiveType
FieldType.TypeDeclCase
ImportTaxonomiesRequest.SourceCase
IntegratedSystem
This enum describes all the possible systems that Data Catalog integrates with.
Protobuf enum google.cloud.datacatalog.v1beta1.IntegratedSystem
LookupEntryRequest.TargetNameCase
SearchResultType
The different types of resources that can be returned in search.
Protobuf enum google.cloud.datacatalog.v1beta1.SearchResultType
TableSourceType
Table source type.
Protobuf enum google.cloud.datacatalog.v1beta1.TableSourceType
Tag.ScopeCase
TagField.KindCase
Taxonomy.PolicyType
Defines policy types where policy tag can be used for.
Protobuf enum google.cloud.datacatalog.v1beta1.Taxonomy.PolicyType