@Generated(value="by gapic-generator-java") public class DataCatalogClient extends Object implements com.google.api.gax.core.BackgroundResource
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
String entryGroupId = "entryGroupId1228924712";
EntryGroup entryGroup = EntryGroup.newBuilder().build();
EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
}
Note: close() needs to be called on the DataCatalogClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
SearchCatalog |
Searches Data Catalog for multiple resources like entries and tags that match a query. This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods. Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. For more information, see [Data Catalog search syntax] (https://cloud.google.com/data-catalog/docs/how-to/search-reference). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateEntryGroup |
Creates an entry group. An entry group contains logically related entries together with [Cloud Identity and Access Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the `@` symbol for the following resources:
You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the `@` symbol, it is reserved for automatically created groups. Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetEntryGroup |
Gets an entry group. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateEntryGroup |
Updates an entry group. You must enable the Data Catalog API in the project identified by the `entry_group.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteEntryGroup |
Deletes an entry group. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListEntryGroups |
Lists entry groups. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateEntry |
Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). An entry group can have a maximum of 100,000 entries. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateEntry |
Updates an existing entry. You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteEntry |
Deletes an existing entry. You can delete only the entries created by the [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetEntry |
Gets an entry. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
LookupEntry |
Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListEntries |
Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ModifyEntryOverview |
Modifies entry overview, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry]. To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission on the corresponding project. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ModifyEntryContacts |
Modifies contacts, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry]. To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission on the corresponding project. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateTagTemplate |
Creates a tag template. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetTagTemplate |
Gets a tag template. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateTagTemplate |
Updates a tag template. You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods. You must enable the Data Catalog API in the project identified by the `tag_template.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteTagTemplate |
Deletes a tag template and all tags that use it. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateTagTemplateField |
Creates a field in a tag template. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateTagTemplateField |
Updates a field in a tag template. You can't update the field type with this method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RenameTagTemplateField |
Renames a field in a tag template. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RenameTagTemplateFieldEnumValue |
Renames an enum value in a tag template. Within a single enum field, enum values must be unique. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteTagTemplateField |
Deletes a field in a tag template and all uses of this field from the tags based on this template. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateTag |
Creates a tag and assigns it to:
Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateTag |
Updates an existing tag. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteTag |
Deletes a tag. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListTags |
Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ReconcileTags |
`ReconcileTags` creates or updates a list of tags on the entry. If the [ReconcileTagsRequest.force_delete_missing][google.cloud.datacatalog.v1.ReconcileTagsRequest.force_delete_missing] parameter is set, the operation deletes tags not included in the input tag list. `ReconcileTags` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
StarEntry |
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring information is private to each user. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UnstarEntry |
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user. Starring information is private to each user. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy |
Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates - Entry groups Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetIamPolicy |
Gets the access control policy for a resource. May return:
Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
TestIamPermissions |
Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ImportEntries |
Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog. `ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of [DumpItem][google.cloud.datacatalog.v1.DumpItem] type. `ImportEntries` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata] and an [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse] message. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DataCatalogSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataCatalogSettings dataCatalogSettings =
DataCatalogSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DataCatalogClient dataCatalogClient = DataCatalogClient.create(dataCatalogSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataCatalogSettings dataCatalogSettings =
DataCatalogSettings.newBuilder().setEndpoint(myEndpoint).build();
DataCatalogClient dataCatalogClient = DataCatalogClient.create(dataCatalogSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DataCatalogSettings dataCatalogSettings = DataCatalogSettings.newHttpJsonBuilder().build();
DataCatalogClient dataCatalogClient = DataCatalogClient.create(dataCatalogSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
| Modifier and Type | Class and Description |
|---|---|
static class |
DataCatalogClient.ListEntriesFixedSizeCollection |
static class |
DataCatalogClient.ListEntriesPage |
static class |
DataCatalogClient.ListEntriesPagedResponse |
static class |
DataCatalogClient.ListEntryGroupsFixedSizeCollection |
static class |
DataCatalogClient.ListEntryGroupsPage |
static class |
DataCatalogClient.ListEntryGroupsPagedResponse |
static class |
DataCatalogClient.ListTagsFixedSizeCollection |
static class |
DataCatalogClient.ListTagsPage |
static class |
DataCatalogClient.ListTagsPagedResponse |
static class |
DataCatalogClient.SearchCatalogFixedSizeCollection |
static class |
DataCatalogClient.SearchCatalogPage |
static class |
DataCatalogClient.SearchCatalogPagedResponse |
| Modifier | Constructor and Description |
|---|---|
protected |
DataCatalogClient(DataCatalogSettings settings)
Constructs an instance of DataCatalogClient, using the given settings.
|
protected |
DataCatalogClient(DataCatalogStub stub) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
void |
close() |
static DataCatalogClient |
create()
Constructs an instance of DataCatalogClient with default settings.
|
static DataCatalogClient |
create(DataCatalogSettings settings)
Constructs an instance of DataCatalogClient, using the given settings.
|
static DataCatalogClient |
create(DataCatalogStub stub)
Constructs an instance of DataCatalogClient, using the given stub for making calls.
|
Entry |
createEntry(CreateEntryRequest request)
Creates an entry.
|
Entry |
createEntry(EntryGroupName parent,
String entryId,
Entry entry)
Creates an entry.
|
Entry |
createEntry(String parent,
String entryId,
Entry entry)
Creates an entry.
|
com.google.api.gax.rpc.UnaryCallable<CreateEntryRequest,Entry> |
createEntryCallable()
Creates an entry.
|
EntryGroup |
createEntryGroup(CreateEntryGroupRequest request)
Creates an entry group.
|
EntryGroup |
createEntryGroup(LocationName parent,
String entryGroupId,
EntryGroup entryGroup)
Creates an entry group.
|
EntryGroup |
createEntryGroup(String parent,
String entryGroupId,
EntryGroup entryGroup)
Creates an entry group.
|
com.google.api.gax.rpc.UnaryCallable<CreateEntryGroupRequest,EntryGroup> |
createEntryGroupCallable()
Creates an entry group.
|
Tag |
createTag(CreateTagRequest request)
Creates a tag and assigns it to:
An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
`projects.locations.entryGroups.entries.tags.create`.
|
Tag |
createTag(EntryName parent,
Tag tag)
Creates a tag and assigns it to:
An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
`projects.locations.entryGroups.entries.tags.create`.
|
Tag |
createTag(String parent,
Tag tag)
Creates a tag and assigns it to:
An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
`projects.locations.entryGroups.entries.tags.create`.
|
com.google.api.gax.rpc.UnaryCallable<CreateTagRequest,Tag> |
createTagCallable()
Creates a tag and assigns it to:
An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
`projects.locations.entryGroups.entries.tags.create`.
|
TagTemplate |
createTagTemplate(CreateTagTemplateRequest request)
Creates a tag template.
|
TagTemplate |
createTagTemplate(LocationName parent,
String tagTemplateId,
TagTemplate tagTemplate)
Creates a tag template.
|
TagTemplate |
createTagTemplate(String parent,
String tagTemplateId,
TagTemplate tagTemplate)
Creates a tag template.
|
com.google.api.gax.rpc.UnaryCallable<CreateTagTemplateRequest,TagTemplate> |
createTagTemplateCallable()
Creates a tag template.
|
TagTemplateField |
createTagTemplateField(CreateTagTemplateFieldRequest request)
Creates a field in a tag template.
|
TagTemplateField |
createTagTemplateField(String parent,
String tagTemplateFieldId,
TagTemplateField tagTemplateField)
Creates a field in a tag template.
|
TagTemplateField |
createTagTemplateField(TagTemplateName parent,
String tagTemplateFieldId,
TagTemplateField tagTemplateField)
Creates a field in a tag template.
|
com.google.api.gax.rpc.UnaryCallable<CreateTagTemplateFieldRequest,TagTemplateField> |
createTagTemplateFieldCallable()
Creates a field in a tag template.
|
void |
deleteEntry(DeleteEntryRequest request)
Deletes an existing entry.
|
void |
deleteEntry(EntryName name)
Deletes an existing entry.
|
void |
deleteEntry(String name)
Deletes an existing entry.
|
com.google.api.gax.rpc.UnaryCallable<DeleteEntryRequest,com.google.protobuf.Empty> |
deleteEntryCallable()
Deletes an existing entry.
|
void |
deleteEntryGroup(DeleteEntryGroupRequest request)
Deletes an entry group.
|
void |
deleteEntryGroup(EntryGroupName name)
Deletes an entry group.
|
void |
deleteEntryGroup(String name)
Deletes an entry group.
|
com.google.api.gax.rpc.UnaryCallable<DeleteEntryGroupRequest,com.google.protobuf.Empty> |
deleteEntryGroupCallable()
Deletes an entry group.
|
void |
deleteTag(DeleteTagRequest request)
Deletes a tag.
|
void |
deleteTag(EntryName name)
Deletes a tag.
|
void |
deleteTag(String name)
Deletes a tag.
|
com.google.api.gax.rpc.UnaryCallable<DeleteTagRequest,com.google.protobuf.Empty> |
deleteTagCallable()
Deletes a tag.
|
void |
deleteTagTemplate(DeleteTagTemplateRequest request)
Deletes a tag template and all tags that use it.
|
void |
deleteTagTemplate(String name,
boolean force)
Deletes a tag template and all tags that use it.
|
void |
deleteTagTemplate(TagTemplateName name,
boolean force)
Deletes a tag template and all tags that use it.
|
com.google.api.gax.rpc.UnaryCallable<DeleteTagTemplateRequest,com.google.protobuf.Empty> |
deleteTagTemplateCallable()
Deletes a tag template and all tags that use it.
|
void |
deleteTagTemplateField(DeleteTagTemplateFieldRequest request)
Deletes a field in a tag template and all uses of this field from the tags based on this
template.
|
void |
deleteTagTemplateField(String name,
boolean force)
Deletes a field in a tag template and all uses of this field from the tags based on this
template.
|
void |
deleteTagTemplateField(TagTemplateFieldName name,
boolean force)
Deletes a field in a tag template and all uses of this field from the tags based on this
template.
|
com.google.api.gax.rpc.UnaryCallable<DeleteTagTemplateFieldRequest,com.google.protobuf.Empty> |
deleteTagTemplateFieldCallable()
Deletes a field in a tag template and all uses of this field from the tags based on this
template.
|
Entry |
getEntry(EntryName name)
Gets an entry.
|
Entry |
getEntry(GetEntryRequest request)
Gets an entry.
|
Entry |
getEntry(String name)
Gets an entry.
|
com.google.api.gax.rpc.UnaryCallable<GetEntryRequest,Entry> |
getEntryCallable()
Gets an entry.
|
EntryGroup |
getEntryGroup(EntryGroupName name)
Gets an entry group.
|
EntryGroup |
getEntryGroup(EntryGroupName name,
com.google.protobuf.FieldMask readMask)
Gets an entry group.
|
EntryGroup |
getEntryGroup(GetEntryGroupRequest request)
Gets an entry group.
|
EntryGroup |
getEntryGroup(String name)
Gets an entry group.
|
EntryGroup |
getEntryGroup(String name,
com.google.protobuf.FieldMask readMask)
Gets an entry group.
|
com.google.api.gax.rpc.UnaryCallable<GetEntryGroupRequest,EntryGroup> |
getEntryGroupCallable()
Gets an entry group.
|
com.google.api.gax.httpjson.longrunning.OperationsClient |
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation
returned by another API method call.
|
com.google.iam.v1.Policy |
getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Gets the access control policy for a resource.
|
com.google.iam.v1.Policy |
getIamPolicy(com.google.api.resourcenames.ResourceName resource)
Gets the access control policy for a resource.
|
com.google.iam.v1.Policy |
getIamPolicy(String resource)
Gets the access control policy for a resource.
|
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getIamPolicyCallable()
Gets the access control policy for a resource.
|
com.google.longrunning.OperationsClient |
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation
returned by another API method call.
|
DataCatalogSettings |
getSettings() |
DataCatalogStub |
getStub() |
TagTemplate |
getTagTemplate(GetTagTemplateRequest request)
Gets a tag template.
|
TagTemplate |
getTagTemplate(String name)
Gets a tag template.
|
TagTemplate |
getTagTemplate(TagTemplateName name)
Gets a tag template.
|
com.google.api.gax.rpc.UnaryCallable<GetTagTemplateRequest,TagTemplate> |
getTagTemplateCallable()
Gets a tag template.
|
com.google.api.gax.longrunning.OperationFuture<ImportEntriesResponse,ImportEntriesMetadata> |
importEntriesAsync(ImportEntriesRequest request)
Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into
Data Catalog.
|
com.google.api.gax.rpc.UnaryCallable<ImportEntriesRequest,com.google.longrunning.Operation> |
importEntriesCallable()
Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into
Data Catalog.
|
com.google.api.gax.rpc.OperationCallable<ImportEntriesRequest,ImportEntriesResponse,ImportEntriesMetadata> |
importEntriesOperationCallable()
Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into
Data Catalog.
|
boolean |
isShutdown() |
boolean |
isTerminated() |
DataCatalogClient.ListEntriesPagedResponse |
listEntries(EntryGroupName parent)
Lists entries.
|
DataCatalogClient.ListEntriesPagedResponse |
listEntries(ListEntriesRequest request)
Lists entries.
|
DataCatalogClient.ListEntriesPagedResponse |
listEntries(String parent)
Lists entries.
|
com.google.api.gax.rpc.UnaryCallable<ListEntriesRequest,ListEntriesResponse> |
listEntriesCallable()
Lists entries.
|
com.google.api.gax.rpc.UnaryCallable<ListEntriesRequest,DataCatalogClient.ListEntriesPagedResponse> |
listEntriesPagedCallable()
Lists entries.
|
DataCatalogClient.ListEntryGroupsPagedResponse |
listEntryGroups(ListEntryGroupsRequest request)
Lists entry groups.
|
DataCatalogClient.ListEntryGroupsPagedResponse |
listEntryGroups(LocationName parent)
Lists entry groups.
|
DataCatalogClient.ListEntryGroupsPagedResponse |
listEntryGroups(String parent)
Lists entry groups.
|
com.google.api.gax.rpc.UnaryCallable<ListEntryGroupsRequest,ListEntryGroupsResponse> |
listEntryGroupsCallable()
Lists entry groups.
|
com.google.api.gax.rpc.UnaryCallable<ListEntryGroupsRequest,DataCatalogClient.ListEntryGroupsPagedResponse> |
listEntryGroupsPagedCallable()
Lists entry groups.
|
DataCatalogClient.ListTagsPagedResponse |
listTags(EntryName parent)
Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
|
DataCatalogClient.ListTagsPagedResponse |
listTags(ListTagsRequest request)
Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
|
DataCatalogClient.ListTagsPagedResponse |
listTags(String parent)
Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
|
com.google.api.gax.rpc.UnaryCallable<ListTagsRequest,ListTagsResponse> |
listTagsCallable()
Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
|
com.google.api.gax.rpc.UnaryCallable<ListTagsRequest,DataCatalogClient.ListTagsPagedResponse> |
listTagsPagedCallable()
Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
|
Entry |
lookupEntry(LookupEntryRequest request)
Gets an entry by its target resource name.
|
com.google.api.gax.rpc.UnaryCallable<LookupEntryRequest,Entry> |
lookupEntryCallable()
Gets an entry by its target resource name.
|
Contacts |
modifyEntryContacts(ModifyEntryContactsRequest request)
Modifies contacts, part of the business context of an
[Entry][google.cloud.datacatalog.v1.Entry].
|
com.google.api.gax.rpc.UnaryCallable<ModifyEntryContactsRequest,Contacts> |
modifyEntryContactsCallable()
Modifies contacts, part of the business context of an
[Entry][google.cloud.datacatalog.v1.Entry].
|
EntryOverview |
modifyEntryOverview(ModifyEntryOverviewRequest request)
Modifies entry overview, part of the business context of an
[Entry][google.cloud.datacatalog.v1.Entry].
|
com.google.api.gax.rpc.UnaryCallable<ModifyEntryOverviewRequest,EntryOverview> |
modifyEntryOverviewCallable()
Modifies entry overview, part of the business context of an
[Entry][google.cloud.datacatalog.v1.Entry].
|
com.google.api.gax.longrunning.OperationFuture<ReconcileTagsResponse,ReconcileTagsMetadata> |
reconcileTagsAsync(ReconcileTagsRequest request)
`ReconcileTags` creates or updates a list of tags on the entry.
|
com.google.api.gax.rpc.UnaryCallable<ReconcileTagsRequest,com.google.longrunning.Operation> |
reconcileTagsCallable()
`ReconcileTags` creates or updates a list of tags on the entry.
|
com.google.api.gax.rpc.OperationCallable<ReconcileTagsRequest,ReconcileTagsResponse,ReconcileTagsMetadata> |
reconcileTagsOperationCallable()
`ReconcileTags` creates or updates a list of tags on the entry.
|
TagTemplateField |
renameTagTemplateField(RenameTagTemplateFieldRequest request)
Renames a field in a tag template.
|
TagTemplateField |
renameTagTemplateField(String name,
String newTagTemplateFieldId)
Renames a field in a tag template.
|
TagTemplateField |
renameTagTemplateField(TagTemplateFieldName name,
String newTagTemplateFieldId)
Renames a field in a tag template.
|
com.google.api.gax.rpc.UnaryCallable<RenameTagTemplateFieldRequest,TagTemplateField> |
renameTagTemplateFieldCallable()
Renames a field in a tag template.
|
TagTemplateField |
renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request)
Renames an enum value in a tag template.
|
TagTemplateField |
renameTagTemplateFieldEnumValue(String name,
String newEnumValueDisplayName)
Renames an enum value in a tag template.
|
TagTemplateField |
renameTagTemplateFieldEnumValue(TagTemplateFieldEnumValueName name,
String newEnumValueDisplayName)
Renames an enum value in a tag template.
|
com.google.api.gax.rpc.UnaryCallable<RenameTagTemplateFieldEnumValueRequest,TagTemplateField> |
renameTagTemplateFieldEnumValueCallable()
Renames an enum value in a tag template.
|
DataCatalogClient.SearchCatalogPagedResponse |
searchCatalog(SearchCatalogRequest.Scope scope,
String query)
Searches Data Catalog for multiple resources like entries and tags that match a query.
|
DataCatalogClient.SearchCatalogPagedResponse |
searchCatalog(SearchCatalogRequest request)
Searches Data Catalog for multiple resources like entries and tags that match a query.
|
com.google.api.gax.rpc.UnaryCallable<SearchCatalogRequest,SearchCatalogResponse> |
searchCatalogCallable()
Searches Data Catalog for multiple resources like entries and tags that match a query.
|
com.google.api.gax.rpc.UnaryCallable<SearchCatalogRequest,DataCatalogClient.SearchCatalogPagedResponse> |
searchCatalogPagedCallable()
Searches Data Catalog for multiple resources like entries and tags that match a query.
|
com.google.iam.v1.Policy |
setIamPolicy(com.google.api.resourcenames.ResourceName resource,
com.google.iam.v1.Policy policy)
Sets an access control policy for a resource.
|
com.google.iam.v1.Policy |
setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets an access control policy for a resource.
|
com.google.iam.v1.Policy |
setIamPolicy(String resource,
com.google.iam.v1.Policy policy)
Sets an access control policy for a resource.
|
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
setIamPolicyCallable()
Sets an access control policy for a resource.
|
void |
shutdown() |
void |
shutdownNow() |
StarEntryResponse |
starEntry(EntryName name)
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user.
|
StarEntryResponse |
starEntry(StarEntryRequest request)
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user.
|
StarEntryResponse |
starEntry(String name)
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user.
|
com.google.api.gax.rpc.UnaryCallable<StarEntryRequest,StarEntryResponse> |
starEntryCallable()
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user.
|
com.google.iam.v1.TestIamPermissionsResponse |
testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Gets your permissions on a resource.
|
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
testIamPermissionsCallable()
Gets your permissions on a resource.
|
UnstarEntryResponse |
unstarEntry(EntryName name)
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user.
|
UnstarEntryResponse |
unstarEntry(String name)
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user.
|
UnstarEntryResponse |
unstarEntry(UnstarEntryRequest request)
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user.
|
com.google.api.gax.rpc.UnaryCallable<UnstarEntryRequest,UnstarEntryResponse> |
unstarEntryCallable()
Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user.
|
Entry |
updateEntry(Entry entry)
Updates an existing entry.
|
Entry |
updateEntry(Entry entry,
com.google.protobuf.FieldMask updateMask)
Updates an existing entry.
|
Entry |
updateEntry(UpdateEntryRequest request)
Updates an existing entry.
|
com.google.api.gax.rpc.UnaryCallable<UpdateEntryRequest,Entry> |
updateEntryCallable()
Updates an existing entry.
|
EntryGroup |
updateEntryGroup(EntryGroup entryGroup)
Updates an entry group.
|
EntryGroup |
updateEntryGroup(EntryGroup entryGroup,
com.google.protobuf.FieldMask updateMask)
Updates an entry group.
|
EntryGroup |
updateEntryGroup(UpdateEntryGroupRequest request)
Updates an entry group.
|
com.google.api.gax.rpc.UnaryCallable<UpdateEntryGroupRequest,EntryGroup> |
updateEntryGroupCallable()
Updates an entry group.
|
Tag |
updateTag(Tag tag)
Updates an existing tag.
|
Tag |
updateTag(Tag tag,
com.google.protobuf.FieldMask updateMask)
Updates an existing tag.
|
Tag |
updateTag(UpdateTagRequest request)
Updates an existing tag.
|
com.google.api.gax.rpc.UnaryCallable<UpdateTagRequest,Tag> |
updateTagCallable()
Updates an existing tag.
|
TagTemplate |
updateTagTemplate(TagTemplate tagTemplate)
Updates a tag template.
|
TagTemplate |
updateTagTemplate(TagTemplate tagTemplate,
com.google.protobuf.FieldMask updateMask)
Updates a tag template.
|
TagTemplate |
updateTagTemplate(UpdateTagTemplateRequest request)
Updates a tag template.
|
com.google.api.gax.rpc.UnaryCallable<UpdateTagTemplateRequest,TagTemplate> |
updateTagTemplateCallable()
Updates a tag template.
|
TagTemplateField |
updateTagTemplateField(String name,
TagTemplateField tagTemplateField)
Updates a field in a tag template.
|
TagTemplateField |
updateTagTemplateField(String name,
TagTemplateField tagTemplateField,
com.google.protobuf.FieldMask updateMask)
Updates a field in a tag template.
|
TagTemplateField |
updateTagTemplateField(TagTemplateFieldName name,
TagTemplateField tagTemplateField)
Updates a field in a tag template.
|
TagTemplateField |
updateTagTemplateField(TagTemplateFieldName name,
TagTemplateField tagTemplateField,
com.google.protobuf.FieldMask updateMask)
Updates a field in a tag template.
|
TagTemplateField |
updateTagTemplateField(UpdateTagTemplateFieldRequest request)
Updates a field in a tag template.
|
com.google.api.gax.rpc.UnaryCallable<UpdateTagTemplateFieldRequest,TagTemplateField> |
updateTagTemplateFieldCallable()
Updates a field in a tag template.
|
protected DataCatalogClient(DataCatalogSettings settings) throws IOException
IOExceptionprotected DataCatalogClient(DataCatalogStub stub)
public static final DataCatalogClient create() throws IOException
IOExceptionpublic static final DataCatalogClient create(DataCatalogSettings settings) throws IOException
IOExceptionpublic static final DataCatalogClient create(DataCatalogStub stub)
public final DataCatalogSettings getSettings()
public DataCatalogStub getStub()
public final com.google.longrunning.OperationsClient getOperationsClient()
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
public final DataCatalogClient.SearchCatalogPagedResponse searchCatalog(SearchCatalogRequest.Scope scope, String query)
This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.
Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries.
For more information, see [Data Catalog search syntax] (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
SearchCatalogRequest.Scope scope = SearchCatalogRequest.Scope.newBuilder().build();
String query = "query107944136";
for (SearchCatalogResult element :
dataCatalogClient.searchCatalog(scope, query).iterateAll()) {
// doThingsWith(element);
}
}
scope - Required. The scope of this search request.
The `scope` is invalid if `include_org_ids`, `include_project_ids` are empty AND `include_gcp_public_datasets` is set to `false`. In this case, the request returns an error.
query - Optional. The query string with a minimum of 3 characters and specific syntax. For
more information, see [Data Catalog search
syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).
An empty query string returns all data assets (in the specified scope) that you have access to.
A query string can be a simple `xyz` or qualified by predicates:
com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataCatalogClient.SearchCatalogPagedResponse searchCatalog(SearchCatalogRequest request)
This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.
Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries.
For more information, see [Data Catalog search syntax] (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
SearchCatalogRequest request =
SearchCatalogRequest.newBuilder()
.setScope(SearchCatalogRequest.Scope.newBuilder().build())
.setQuery("query107944136")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setAdminSearch(true)
.build();
for (SearchCatalogResult element : dataCatalogClient.searchCatalog(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<SearchCatalogRequest,DataCatalogClient.SearchCatalogPagedResponse> searchCatalogPagedCallable()
This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.
Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries.
For more information, see [Data Catalog search syntax] (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
SearchCatalogRequest request =
SearchCatalogRequest.newBuilder()
.setScope(SearchCatalogRequest.Scope.newBuilder().build())
.setQuery("query107944136")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setAdminSearch(true)
.build();
ApiFuture<SearchCatalogResult> future =
dataCatalogClient.searchCatalogPagedCallable().futureCall(request);
// Do something.
for (SearchCatalogResult element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<SearchCatalogRequest,SearchCatalogResponse> searchCatalogCallable()
This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.
Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries.
For more information, see [Data Catalog search syntax] (https://cloud.google.com/data-catalog/docs/how-to/search-reference).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
SearchCatalogRequest request =
SearchCatalogRequest.newBuilder()
.setScope(SearchCatalogRequest.Scope.newBuilder().build())
.setQuery("query107944136")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOrderBy("orderBy-1207110587")
.setAdminSearch(true)
.build();
while (true) {
SearchCatalogResponse response = dataCatalogClient.searchCatalogCallable().call(request);
for (SearchCatalogResult element : response.getResultsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final EntryGroup createEntryGroup(LocationName parent, String entryGroupId, EntryGroup entryGroup)
An entry group contains logically related entries together with [Cloud Identity and Access Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can create, edit, and view entries within entry groups.
Data Catalog automatically creates entry groups with names that start with the `@` symbol for the following resources:
You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the `@` symbol, it is reserved for automatically created groups.
Entry groups, like entries, can be searched.
A maximum of 10,000 entry groups may be created per organization across all locations.
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
String entryGroupId = "entryGroupId1228924712";
EntryGroup entryGroup = EntryGroup.newBuilder().build();
EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
}
parent - Required. The names of the project and location that the new entry group belongs
to.
Note: The entry group itself and its child resources might not be stored in the location specified in its name.
entryGroupId - Required. The ID of the entry group to create.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
entryGroup - The entry group to create. Defaults to empty.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EntryGroup createEntryGroup(String parent, String entryGroupId, EntryGroup entryGroup)
An entry group contains logically related entries together with [Cloud Identity and Access Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can create, edit, and view entries within entry groups.
Data Catalog automatically creates entry groups with names that start with the `@` symbol for the following resources:
You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the `@` symbol, it is reserved for automatically created groups.
Entry groups, like entries, can be searched.
A maximum of 10,000 entry groups may be created per organization across all locations.
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
String entryGroupId = "entryGroupId1228924712";
EntryGroup entryGroup = EntryGroup.newBuilder().build();
EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
}
parent - Required. The names of the project and location that the new entry group belongs
to.
Note: The entry group itself and its child resources might not be stored in the location specified in its name.
entryGroupId - Required. The ID of the entry group to create.
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
entryGroup - The entry group to create. Defaults to empty.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EntryGroup createEntryGroup(CreateEntryGroupRequest request)
An entry group contains logically related entries together with [Cloud Identity and Access Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can create, edit, and view entries within entry groups.
Data Catalog automatically creates entry groups with names that start with the `@` symbol for the following resources:
You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the `@` symbol, it is reserved for automatically created groups.
Entry groups, like entries, can be searched.
A maximum of 10,000 entry groups may be created per organization across all locations.
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
CreateEntryGroupRequest request =
CreateEntryGroupRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setEntryGroupId("entryGroupId1228924712")
.setEntryGroup(EntryGroup.newBuilder().build())
.build();
EntryGroup response = dataCatalogClient.createEntryGroup(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateEntryGroupRequest,EntryGroup> createEntryGroupCallable()
An entry group contains logically related entries together with [Cloud Identity and Access Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can create, edit, and view entries within entry groups.
Data Catalog automatically creates entry groups with names that start with the `@` symbol for the following resources:
You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the `@` symbol, it is reserved for automatically created groups.
Entry groups, like entries, can be searched.
A maximum of 10,000 entry groups may be created per organization across all locations.
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
CreateEntryGroupRequest request =
CreateEntryGroupRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setEntryGroupId("entryGroupId1228924712")
.setEntryGroup(EntryGroup.newBuilder().build())
.build();
ApiFuture<EntryGroup> future =
dataCatalogClient.createEntryGroupCallable().futureCall(request);
// Do something.
EntryGroup response = future.get();
}
public final EntryGroup getEntryGroup(EntryGroupName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
EntryGroup response = dataCatalogClient.getEntryGroup(name);
}
name - Required. The name of the entry group to get.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EntryGroup getEntryGroup(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
EntryGroup response = dataCatalogClient.getEntryGroup(name);
}
name - Required. The name of the entry group to get.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EntryGroup getEntryGroup(EntryGroupName name, com.google.protobuf.FieldMask readMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
FieldMask readMask = FieldMask.newBuilder().build();
EntryGroup response = dataCatalogClient.getEntryGroup(name, readMask);
}
name - Required. The name of the entry group to get.readMask - The fields to return. If empty or omitted, all fields are returned.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EntryGroup getEntryGroup(String name, com.google.protobuf.FieldMask readMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
FieldMask readMask = FieldMask.newBuilder().build();
EntryGroup response = dataCatalogClient.getEntryGroup(name, readMask);
}
name - Required. The name of the entry group to get.readMask - The fields to return. If empty or omitted, all fields are returned.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EntryGroup getEntryGroup(GetEntryGroupRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
GetEntryGroupRequest request =
GetEntryGroupRequest.newBuilder()
.setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setReadMask(FieldMask.newBuilder().build())
.build();
EntryGroup response = dataCatalogClient.getEntryGroup(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetEntryGroupRequest,EntryGroup> getEntryGroupCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
GetEntryGroupRequest request =
GetEntryGroupRequest.newBuilder()
.setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setReadMask(FieldMask.newBuilder().build())
.build();
ApiFuture<EntryGroup> future = dataCatalogClient.getEntryGroupCallable().futureCall(request);
// Do something.
EntryGroup response = future.get();
}
public final EntryGroup updateEntryGroup(EntryGroup entryGroup)
You must enable the Data Catalog API in the project identified by the `entry_group.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryGroup entryGroup = EntryGroup.newBuilder().build();
EntryGroup response = dataCatalogClient.updateEntryGroup(entryGroup);
}
entryGroup - Required. Updates for the entry group. The `name` field must be set.com.google.api.gax.rpc.ApiException - if the remote call failspublic final EntryGroup updateEntryGroup(EntryGroup entryGroup, com.google.protobuf.FieldMask updateMask)
You must enable the Data Catalog API in the project identified by the `entry_group.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryGroup entryGroup = EntryGroup.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
EntryGroup response = dataCatalogClient.updateEntryGroup(entryGroup, updateMask);
}
entryGroup - Required. Updates for the entry group. The `name` field must be set.updateMask - Names of fields whose values to overwrite on an entry group.
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final EntryGroup updateEntryGroup(UpdateEntryGroupRequest request)
You must enable the Data Catalog API in the project identified by the `entry_group.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
UpdateEntryGroupRequest request =
UpdateEntryGroupRequest.newBuilder()
.setEntryGroup(EntryGroup.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
EntryGroup response = dataCatalogClient.updateEntryGroup(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateEntryGroupRequest,EntryGroup> updateEntryGroupCallable()
You must enable the Data Catalog API in the project identified by the `entry_group.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
UpdateEntryGroupRequest request =
UpdateEntryGroupRequest.newBuilder()
.setEntryGroup(EntryGroup.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<EntryGroup> future =
dataCatalogClient.updateEntryGroupCallable().futureCall(request);
// Do something.
EntryGroup response = future.get();
}
public final void deleteEntryGroup(EntryGroupName name)
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
dataCatalogClient.deleteEntryGroup(name);
}
name - Required. The name of the entry group to delete.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteEntryGroup(String name)
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
dataCatalogClient.deleteEntryGroup(name);
}
name - Required. The name of the entry group to delete.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteEntryGroup(DeleteEntryGroupRequest request)
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
DeleteEntryGroupRequest request =
DeleteEntryGroupRequest.newBuilder()
.setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setForce(true)
.build();
dataCatalogClient.deleteEntryGroup(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteEntryGroupRequest,com.google.protobuf.Empty> deleteEntryGroupCallable()
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
DeleteEntryGroupRequest request =
DeleteEntryGroupRequest.newBuilder()
.setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setForce(true)
.build();
ApiFuture<Empty> future = dataCatalogClient.deleteEntryGroupCallable().futureCall(request);
// Do something.
future.get();
}
public final DataCatalogClient.ListEntryGroupsPagedResponse listEntryGroups(LocationName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (EntryGroup element : dataCatalogClient.listEntryGroups(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The name of the location that contains the entry groups to list.
Can be provided as a URL.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataCatalogClient.ListEntryGroupsPagedResponse listEntryGroups(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (EntryGroup element : dataCatalogClient.listEntryGroups(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The name of the location that contains the entry groups to list.
Can be provided as a URL.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataCatalogClient.ListEntryGroupsPagedResponse listEntryGroups(ListEntryGroupsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ListEntryGroupsRequest request =
ListEntryGroupsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (EntryGroup element : dataCatalogClient.listEntryGroups(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListEntryGroupsRequest,DataCatalogClient.ListEntryGroupsPagedResponse> listEntryGroupsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ListEntryGroupsRequest request =
ListEntryGroupsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<EntryGroup> future =
dataCatalogClient.listEntryGroupsPagedCallable().futureCall(request);
// Do something.
for (EntryGroup element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListEntryGroupsRequest,ListEntryGroupsResponse> listEntryGroupsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ListEntryGroupsRequest request =
ListEntryGroupsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListEntryGroupsResponse response =
dataCatalogClient.listEntryGroupsCallable().call(request);
for (EntryGroup element : response.getEntryGroupsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final Entry createEntry(EntryGroupName parent, String entryId, Entry entry)
You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
An entry group can have a maximum of 100,000 entries.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
String entryId = "entryId-1591558867";
Entry entry = Entry.newBuilder().build();
Entry response = dataCatalogClient.createEntry(parent, entryId, entry);
}
parent - Required. The name of the entry group this entry belongs to.
Note: The entry itself and its child resources might not be stored in the location specified in its name.
entryId - Required. The ID of the entry to create.
The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8.
entry - Required. The entry to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Entry createEntry(String parent, String entryId, Entry entry)
You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
An entry group can have a maximum of 100,000 entries.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
String entryId = "entryId-1591558867";
Entry entry = Entry.newBuilder().build();
Entry response = dataCatalogClient.createEntry(parent, entryId, entry);
}
parent - Required. The name of the entry group this entry belongs to.
Note: The entry itself and its child resources might not be stored in the location specified in its name.
entryId - Required. The ID of the entry to create.
The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8.
entry - Required. The entry to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Entry createEntry(CreateEntryRequest request)
You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
An entry group can have a maximum of 100,000 entries.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
CreateEntryRequest request =
CreateEntryRequest.newBuilder()
.setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setEntryId("entryId-1591558867")
.setEntry(Entry.newBuilder().build())
.build();
Entry response = dataCatalogClient.createEntry(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateEntryRequest,Entry> createEntryCallable()
You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
An entry group can have a maximum of 100,000 entries.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
CreateEntryRequest request =
CreateEntryRequest.newBuilder()
.setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setEntryId("entryId-1591558867")
.setEntry(Entry.newBuilder().build())
.build();
ApiFuture<Entry> future = dataCatalogClient.createEntryCallable().futureCall(request);
// Do something.
Entry response = future.get();
}
public final Entry updateEntry(Entry entry)
You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
Entry entry = Entry.newBuilder().build();
Entry response = dataCatalogClient.updateEntry(entry);
}
entry - Required. Updates for the entry. The `name` field must be set.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Entry updateEntry(Entry entry, com.google.protobuf.FieldMask updateMask)
You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
Entry entry = Entry.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Entry response = dataCatalogClient.updateEntry(entry, updateMask);
}
entry - Required. Updates for the entry. The `name` field must be set.updateMask - Names of fields whose values to overwrite on an entry.
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
You can modify only the fields listed below.
For entries with type `DATA_STREAM`:
For entries with type `FILESET`:
For entries with `user_specified_type`:
com.google.api.gax.rpc.ApiException - if the remote call failspublic final Entry updateEntry(UpdateEntryRequest request)
You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
UpdateEntryRequest request =
UpdateEntryRequest.newBuilder()
.setEntry(Entry.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Entry response = dataCatalogClient.updateEntry(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateEntryRequest,Entry> updateEntryCallable()
You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
UpdateEntryRequest request =
UpdateEntryRequest.newBuilder()
.setEntry(Entry.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Entry> future = dataCatalogClient.updateEntryCallable().futureCall(request);
// Do something.
Entry response = future.get();
}
public final void deleteEntry(EntryName name)
You can delete only the entries created by the [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method.
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
dataCatalogClient.deleteEntry(name);
}
name - Required. The name of the entry to delete.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteEntry(String name)
You can delete only the entries created by the [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method.
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
dataCatalogClient.deleteEntry(name);
}
name - Required. The name of the entry to delete.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteEntry(DeleteEntryRequest request)
You can delete only the entries created by the [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method.
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
DeleteEntryRequest request =
DeleteEntryRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.build();
dataCatalogClient.deleteEntry(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteEntryRequest,com.google.protobuf.Empty> deleteEntryCallable()
You can delete only the entries created by the [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method.
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
DeleteEntryRequest request =
DeleteEntryRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.build();
ApiFuture<Empty> future = dataCatalogClient.deleteEntryCallable().futureCall(request);
// Do something.
future.get();
}
public final Entry getEntry(EntryName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
Entry response = dataCatalogClient.getEntry(name);
}
name - Required. The name of the entry to get.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Entry getEntry(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
Entry response = dataCatalogClient.getEntry(name);
}
name - Required. The name of the entry to get.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Entry getEntry(GetEntryRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
GetEntryRequest request =
GetEntryRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.build();
Entry response = dataCatalogClient.getEntry(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetEntryRequest,Entry> getEntryCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
GetEntryRequest request =
GetEntryRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.build();
ApiFuture<Entry> future = dataCatalogClient.getEntryCallable().futureCall(request);
// Do something.
Entry response = future.get();
}
public final Entry lookupEntry(LookupEntryRequest request)
The resource name comes from the source Google Cloud Platform service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
LookupEntryRequest request =
LookupEntryRequest.newBuilder()
.setProject("project-309310695")
.setLocation("location1901043637")
.build();
Entry response = dataCatalogClient.lookupEntry(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<LookupEntryRequest,Entry> lookupEntryCallable()
The resource name comes from the source Google Cloud Platform service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
LookupEntryRequest request =
LookupEntryRequest.newBuilder()
.setProject("project-309310695")
.setLocation("location1901043637")
.build();
ApiFuture<Entry> future = dataCatalogClient.lookupEntryCallable().futureCall(request);
// Do something.
Entry response = future.get();
}
public final DataCatalogClient.ListEntriesPagedResponse listEntries(EntryGroupName parent)
Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
for (Entry element : dataCatalogClient.listEntries(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The name of the entry group that contains the entries to list.
Can be provided in URL format.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataCatalogClient.ListEntriesPagedResponse listEntries(String parent)
Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
for (Entry element : dataCatalogClient.listEntries(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The name of the entry group that contains the entries to list.
Can be provided in URL format.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataCatalogClient.ListEntriesPagedResponse listEntries(ListEntriesRequest request)
Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ListEntriesRequest request =
ListEntriesRequest.newBuilder()
.setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.build();
for (Entry element : dataCatalogClient.listEntries(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListEntriesRequest,DataCatalogClient.ListEntriesPagedResponse> listEntriesPagedCallable()
Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ListEntriesRequest request =
ListEntriesRequest.newBuilder()
.setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Entry> future = dataCatalogClient.listEntriesPagedCallable().futureCall(request);
// Do something.
for (Entry element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListEntriesRequest,ListEntriesResponse> listEntriesCallable()
Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ListEntriesRequest request =
ListEntriesRequest.newBuilder()
.setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.build();
while (true) {
ListEntriesResponse response = dataCatalogClient.listEntriesCallable().call(request);
for (Entry element : response.getEntriesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final EntryOverview modifyEntryOverview(ModifyEntryOverviewRequest request)
To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission on the corresponding project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ModifyEntryOverviewRequest request =
ModifyEntryOverviewRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setEntryOverview(EntryOverview.newBuilder().build())
.build();
EntryOverview response = dataCatalogClient.modifyEntryOverview(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ModifyEntryOverviewRequest,EntryOverview> modifyEntryOverviewCallable()
To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission on the corresponding project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ModifyEntryOverviewRequest request =
ModifyEntryOverviewRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setEntryOverview(EntryOverview.newBuilder().build())
.build();
ApiFuture<EntryOverview> future =
dataCatalogClient.modifyEntryOverviewCallable().futureCall(request);
// Do something.
EntryOverview response = future.get();
}
public final Contacts modifyEntryContacts(ModifyEntryContactsRequest request)
To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission on the corresponding project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ModifyEntryContactsRequest request =
ModifyEntryContactsRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setContacts(Contacts.newBuilder().build())
.build();
Contacts response = dataCatalogClient.modifyEntryContacts(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ModifyEntryContactsRequest,Contacts> modifyEntryContactsCallable()
To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission on the corresponding project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ModifyEntryContactsRequest request =
ModifyEntryContactsRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setContacts(Contacts.newBuilder().build())
.build();
ApiFuture<Contacts> future =
dataCatalogClient.modifyEntryContactsCallable().futureCall(request);
// Do something.
Contacts response = future.get();
}
public final TagTemplate createTagTemplate(LocationName parent, String tagTemplateId, TagTemplate tagTemplate)
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
String tagTemplateId = "tagTemplateId-1438776721";
TagTemplate tagTemplate = TagTemplate.newBuilder().build();
TagTemplate response =
dataCatalogClient.createTagTemplate(parent, tagTemplateId, tagTemplate);
}
parent - Required. The name of the project and the template location
[region](https://cloud.google.com/data-catalog/docs/concepts/regions).tagTemplateId - Required. The ID of the tag template to create.
The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
tagTemplate - Required. The tag template to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplate createTagTemplate(String parent, String tagTemplateId, TagTemplate tagTemplate)
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
String tagTemplateId = "tagTemplateId-1438776721";
TagTemplate tagTemplate = TagTemplate.newBuilder().build();
TagTemplate response =
dataCatalogClient.createTagTemplate(parent, tagTemplateId, tagTemplate);
}
parent - Required. The name of the project and the template location
[region](https://cloud.google.com/data-catalog/docs/concepts/regions).tagTemplateId - Required. The ID of the tag template to create.
The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
tagTemplate - Required. The tag template to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplate createTagTemplate(CreateTagTemplateRequest request)
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
CreateTagTemplateRequest request =
CreateTagTemplateRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setTagTemplateId("tagTemplateId-1438776721")
.setTagTemplate(TagTemplate.newBuilder().build())
.build();
TagTemplate response = dataCatalogClient.createTagTemplate(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateTagTemplateRequest,TagTemplate> createTagTemplateCallable()
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
CreateTagTemplateRequest request =
CreateTagTemplateRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setTagTemplateId("tagTemplateId-1438776721")
.setTagTemplate(TagTemplate.newBuilder().build())
.build();
ApiFuture<TagTemplate> future =
dataCatalogClient.createTagTemplateCallable().futureCall(request);
// Do something.
TagTemplate response = future.get();
}
public final TagTemplate getTagTemplate(TagTemplateName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
TagTemplateName name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
TagTemplate response = dataCatalogClient.getTagTemplate(name);
}
name - Required. The name of the tag template to get.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplate getTagTemplate(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString();
TagTemplate response = dataCatalogClient.getTagTemplate(name);
}
name - Required. The name of the tag template to get.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplate getTagTemplate(GetTagTemplateRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
GetTagTemplateRequest request =
GetTagTemplateRequest.newBuilder()
.setName(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
.build();
TagTemplate response = dataCatalogClient.getTagTemplate(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetTagTemplateRequest,TagTemplate> getTagTemplateCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
GetTagTemplateRequest request =
GetTagTemplateRequest.newBuilder()
.setName(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
.build();
ApiFuture<TagTemplate> future =
dataCatalogClient.getTagTemplateCallable().futureCall(request);
// Do something.
TagTemplate response = future.get();
}
public final TagTemplate updateTagTemplate(TagTemplate tagTemplate)
You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.
You must enable the Data Catalog API in the project identified by the `tag_template.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
TagTemplate tagTemplate = TagTemplate.newBuilder().build();
TagTemplate response = dataCatalogClient.updateTagTemplate(tagTemplate);
}
tagTemplate - Required. The template to update. The `name` field must be set.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplate updateTagTemplate(TagTemplate tagTemplate, com.google.protobuf.FieldMask updateMask)
You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.
You must enable the Data Catalog API in the project identified by the `tag_template.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
TagTemplate tagTemplate = TagTemplate.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
TagTemplate response = dataCatalogClient.updateTagTemplate(tagTemplate, updateMask);
}
tagTemplate - Required. The template to update. The `name` field must be set.updateMask - Names of fields whose values to overwrite on a tag template. Currently, only
`display_name` and `is_publicly_readable` can be overwritten.
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
Note: Updating the `is_publicly_readable` field may require up to 12 hours to take effect in search results.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplate updateTagTemplate(UpdateTagTemplateRequest request)
You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.
You must enable the Data Catalog API in the project identified by the `tag_template.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
UpdateTagTemplateRequest request =
UpdateTagTemplateRequest.newBuilder()
.setTagTemplate(TagTemplate.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
TagTemplate response = dataCatalogClient.updateTagTemplate(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateTagTemplateRequest,TagTemplate> updateTagTemplateCallable()
You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.
You must enable the Data Catalog API in the project identified by the `tag_template.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
UpdateTagTemplateRequest request =
UpdateTagTemplateRequest.newBuilder()
.setTagTemplate(TagTemplate.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<TagTemplate> future =
dataCatalogClient.updateTagTemplateCallable().futureCall(request);
// Do something.
TagTemplate response = future.get();
}
public final void deleteTagTemplate(TagTemplateName name, boolean force)
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
TagTemplateName name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
boolean force = true;
dataCatalogClient.deleteTagTemplate(name, force);
}
name - Required. The name of the tag template to delete.force - Required. If true, deletes all tags that use this template.
Currently, `true` is the only supported value.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteTagTemplate(String name, boolean force)
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString();
boolean force = true;
dataCatalogClient.deleteTagTemplate(name, force);
}
name - Required. The name of the tag template to delete.force - Required. If true, deletes all tags that use this template.
Currently, `true` is the only supported value.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteTagTemplate(DeleteTagTemplateRequest request)
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
DeleteTagTemplateRequest request =
DeleteTagTemplateRequest.newBuilder()
.setName(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
.setForce(true)
.build();
dataCatalogClient.deleteTagTemplate(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteTagTemplateRequest,com.google.protobuf.Empty> deleteTagTemplateCallable()
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
DeleteTagTemplateRequest request =
DeleteTagTemplateRequest.newBuilder()
.setName(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
.setForce(true)
.build();
ApiFuture<Empty> future = dataCatalogClient.deleteTagTemplateCallable().futureCall(request);
// Do something.
future.get();
}
public final TagTemplateField createTagTemplateField(TagTemplateName parent, String tagTemplateFieldId, TagTemplateField tagTemplateField)
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
TagTemplateName parent = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
String tagTemplateFieldId = "tagTemplateFieldId-1556835615";
TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
TagTemplateField response =
dataCatalogClient.createTagTemplateField(parent, tagTemplateFieldId, tagTemplateField);
}
parent - Required. The name of the project and the template location
[region](https://cloud.google.com/data-catalog/docs/concepts/regions).tagTemplateFieldId - Required. The ID of the tag template field to create.
Note: Adding a required field to an existing template is *not* allowed.
Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template.
tagTemplateField - Required. The tag template field to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplateField createTagTemplateField(String parent, String tagTemplateFieldId, TagTemplateField tagTemplateField)
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String parent = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString();
String tagTemplateFieldId = "tagTemplateFieldId-1556835615";
TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
TagTemplateField response =
dataCatalogClient.createTagTemplateField(parent, tagTemplateFieldId, tagTemplateField);
}
parent - Required. The name of the project and the template location
[region](https://cloud.google.com/data-catalog/docs/concepts/regions).tagTemplateFieldId - Required. The ID of the tag template field to create.
Note: Adding a required field to an existing template is *not* allowed.
Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template.
tagTemplateField - Required. The tag template field to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplateField createTagTemplateField(CreateTagTemplateFieldRequest request)
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
CreateTagTemplateFieldRequest request =
CreateTagTemplateFieldRequest.newBuilder()
.setParent(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
.setTagTemplateFieldId("tagTemplateFieldId-1556835615")
.setTagTemplateField(TagTemplateField.newBuilder().build())
.build();
TagTemplateField response = dataCatalogClient.createTagTemplateField(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateTagTemplateFieldRequest,TagTemplateField> createTagTemplateFieldCallable()
You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
CreateTagTemplateFieldRequest request =
CreateTagTemplateFieldRequest.newBuilder()
.setParent(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
.setTagTemplateFieldId("tagTemplateFieldId-1556835615")
.setTagTemplateField(TagTemplateField.newBuilder().build())
.build();
ApiFuture<TagTemplateField> future =
dataCatalogClient.createTagTemplateFieldCallable().futureCall(request);
// Do something.
TagTemplateField response = future.get();
}
public final TagTemplateField updateTagTemplateField(TagTemplateFieldName name, TagTemplateField tagTemplateField)
You can't update the field type with this method.
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
TagTemplateFieldName name =
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
TagTemplateField response = dataCatalogClient.updateTagTemplateField(name, tagTemplateField);
}
name - Required. The name of the tag template field.tagTemplateField - Required. The template to update.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplateField updateTagTemplateField(String name, TagTemplateField tagTemplateField)
You can't update the field type with this method.
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name =
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
.toString();
TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
TagTemplateField response = dataCatalogClient.updateTagTemplateField(name, tagTemplateField);
}
name - Required. The name of the tag template field.tagTemplateField - Required. The template to update.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplateField updateTagTemplateField(TagTemplateFieldName name, TagTemplateField tagTemplateField, com.google.protobuf.FieldMask updateMask)
You can't update the field type with this method.
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
TagTemplateFieldName name =
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
TagTemplateField response =
dataCatalogClient.updateTagTemplateField(name, tagTemplateField, updateMask);
}
name - Required. The name of the tag template field.tagTemplateField - Required. The template to update.updateMask - Optional. Names of fields whose values to overwrite on an individual field of
a tag template. The following fields are modifiable:
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.
Additionally, updating a template field from optional to required is
com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplateField updateTagTemplateField(String name, TagTemplateField tagTemplateField, com.google.protobuf.FieldMask updateMask)
You can't update the field type with this method.
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name =
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
.toString();
TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
TagTemplateField response =
dataCatalogClient.updateTagTemplateField(name, tagTemplateField, updateMask);
}
name - Required. The name of the tag template field.tagTemplateField - Required. The template to update.updateMask - Optional. Names of fields whose values to overwrite on an individual field of
a tag template. The following fields are modifiable:
If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.
Additionally, updating a template field from optional to required is
com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplateField updateTagTemplateField(UpdateTagTemplateFieldRequest request)
You can't update the field type with this method.
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
UpdateTagTemplateFieldRequest request =
UpdateTagTemplateFieldRequest.newBuilder()
.setName(
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
.toString())
.setTagTemplateField(TagTemplateField.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
TagTemplateField response = dataCatalogClient.updateTagTemplateField(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateTagTemplateFieldRequest,TagTemplateField> updateTagTemplateFieldCallable()
You can't update the field type with this method.
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
UpdateTagTemplateFieldRequest request =
UpdateTagTemplateFieldRequest.newBuilder()
.setName(
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
.toString())
.setTagTemplateField(TagTemplateField.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<TagTemplateField> future =
dataCatalogClient.updateTagTemplateFieldCallable().futureCall(request);
// Do something.
TagTemplateField response = future.get();
}
public final TagTemplateField renameTagTemplateField(TagTemplateFieldName name, String newTagTemplateFieldId)
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
TagTemplateFieldName name =
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
String newTagTemplateFieldId = "newTagTemplateFieldId2008993953";
TagTemplateField response =
dataCatalogClient.renameTagTemplateField(name, newTagTemplateFieldId);
}
name - Required. The name of the tag template field.newTagTemplateFieldId - Required. The new ID of this tag template field. For example,
`my_new_field`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplateField renameTagTemplateField(String name, String newTagTemplateFieldId)
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name =
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
.toString();
String newTagTemplateFieldId = "newTagTemplateFieldId2008993953";
TagTemplateField response =
dataCatalogClient.renameTagTemplateField(name, newTagTemplateFieldId);
}
name - Required. The name of the tag template field.newTagTemplateFieldId - Required. The new ID of this tag template field. For example,
`my_new_field`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplateField renameTagTemplateField(RenameTagTemplateFieldRequest request)
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
RenameTagTemplateFieldRequest request =
RenameTagTemplateFieldRequest.newBuilder()
.setName(
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
.toString())
.setNewTagTemplateFieldId("newTagTemplateFieldId2008993953")
.build();
TagTemplateField response = dataCatalogClient.renameTagTemplateField(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<RenameTagTemplateFieldRequest,TagTemplateField> renameTagTemplateFieldCallable()
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
RenameTagTemplateFieldRequest request =
RenameTagTemplateFieldRequest.newBuilder()
.setName(
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
.toString())
.setNewTagTemplateFieldId("newTagTemplateFieldId2008993953")
.build();
ApiFuture<TagTemplateField> future =
dataCatalogClient.renameTagTemplateFieldCallable().futureCall(request);
// Do something.
TagTemplateField response = future.get();
}
public final TagTemplateField renameTagTemplateFieldEnumValue(TagTemplateFieldEnumValueName name, String newEnumValueDisplayName)
Within a single enum field, enum values must be unique.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
TagTemplateFieldEnumValueName name =
TagTemplateFieldEnumValueName.of(
"[PROJECT]",
"[LOCATION]",
"[TAG_TEMPLATE]",
"[TAG_TEMPLATE_FIELD_ID]",
"[ENUM_VALUE_DISPLAY_NAME]");
String newEnumValueDisplayName = "newEnumValueDisplayName-1119629027";
TagTemplateField response =
dataCatalogClient.renameTagTemplateFieldEnumValue(name, newEnumValueDisplayName);
}
name - Required. The name of the enum field value.newEnumValueDisplayName - Required. The new display name of the enum value. For example,
`my_new_enum_value`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplateField renameTagTemplateFieldEnumValue(String name, String newEnumValueDisplayName)
Within a single enum field, enum values must be unique.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name =
TagTemplateFieldEnumValueName.of(
"[PROJECT]",
"[LOCATION]",
"[TAG_TEMPLATE]",
"[TAG_TEMPLATE_FIELD_ID]",
"[ENUM_VALUE_DISPLAY_NAME]")
.toString();
String newEnumValueDisplayName = "newEnumValueDisplayName-1119629027";
TagTemplateField response =
dataCatalogClient.renameTagTemplateFieldEnumValue(name, newEnumValueDisplayName);
}
name - Required. The name of the enum field value.newEnumValueDisplayName - Required. The new display name of the enum value. For example,
`my_new_enum_value`.com.google.api.gax.rpc.ApiException - if the remote call failspublic final TagTemplateField renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request)
Within a single enum field, enum values must be unique.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
RenameTagTemplateFieldEnumValueRequest request =
RenameTagTemplateFieldEnumValueRequest.newBuilder()
.setName(
TagTemplateFieldEnumValueName.of(
"[PROJECT]",
"[LOCATION]",
"[TAG_TEMPLATE]",
"[TAG_TEMPLATE_FIELD_ID]",
"[ENUM_VALUE_DISPLAY_NAME]")
.toString())
.setNewEnumValueDisplayName("newEnumValueDisplayName-1119629027")
.build();
TagTemplateField response = dataCatalogClient.renameTagTemplateFieldEnumValue(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<RenameTagTemplateFieldEnumValueRequest,TagTemplateField> renameTagTemplateFieldEnumValueCallable()
Within a single enum field, enum values must be unique.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
RenameTagTemplateFieldEnumValueRequest request =
RenameTagTemplateFieldEnumValueRequest.newBuilder()
.setName(
TagTemplateFieldEnumValueName.of(
"[PROJECT]",
"[LOCATION]",
"[TAG_TEMPLATE]",
"[TAG_TEMPLATE_FIELD_ID]",
"[ENUM_VALUE_DISPLAY_NAME]")
.toString())
.setNewEnumValueDisplayName("newEnumValueDisplayName-1119629027")
.build();
ApiFuture<TagTemplateField> future =
dataCatalogClient.renameTagTemplateFieldEnumValueCallable().futureCall(request);
// Do something.
TagTemplateField response = future.get();
}
public final void deleteTagTemplateField(TagTemplateFieldName name, boolean force)
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
TagTemplateFieldName name =
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
boolean force = true;
dataCatalogClient.deleteTagTemplateField(name, force);
}
name - Required. The name of the tag template field to delete.force - Required. If true, deletes this field from any tags that use it.
Currently, `true` is the only supported value.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteTagTemplateField(String name, boolean force)
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name =
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
.toString();
boolean force = true;
dataCatalogClient.deleteTagTemplateField(name, force);
}
name - Required. The name of the tag template field to delete.force - Required. If true, deletes this field from any tags that use it.
Currently, `true` is the only supported value.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteTagTemplateField(DeleteTagTemplateFieldRequest request)
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
DeleteTagTemplateFieldRequest request =
DeleteTagTemplateFieldRequest.newBuilder()
.setName(
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
.toString())
.setForce(true)
.build();
dataCatalogClient.deleteTagTemplateField(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteTagTemplateFieldRequest,com.google.protobuf.Empty> deleteTagTemplateFieldCallable()
You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
DeleteTagTemplateFieldRequest request =
DeleteTagTemplateFieldRequest.newBuilder()
.setName(
TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
.toString())
.setForce(true)
.build();
ApiFuture<Empty> future =
dataCatalogClient.deleteTagTemplateFieldCallable().futureCall(request);
// Do something.
future.get();
}
public final Tag createTag(EntryName parent, Tag tag)
Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryName parent = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
Tag tag = Tag.newBuilder().build();
Tag response = dataCatalogClient.createTag(parent, tag);
}
parent - Required. The name of the resource to attach this tag to.
Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags.
Note: The tag and its child resources might not be stored in the location specified in its name.
tag - Required. The tag to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Tag createTag(String parent, Tag tag)
Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String parent =
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
Tag tag = Tag.newBuilder().build();
Tag response = dataCatalogClient.createTag(parent, tag);
}
parent - Required. The name of the resource to attach this tag to.
Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags.
Note: The tag and its child resources might not be stored in the location specified in its name.
tag - Required. The tag to create.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Tag createTag(CreateTagRequest request)
Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
CreateTagRequest request =
CreateTagRequest.newBuilder()
.setParent(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setTag(Tag.newBuilder().build())
.build();
Tag response = dataCatalogClient.createTag(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<CreateTagRequest,Tag> createTagCallable()
Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
CreateTagRequest request =
CreateTagRequest.newBuilder()
.setParent(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setTag(Tag.newBuilder().build())
.build();
ApiFuture<Tag> future = dataCatalogClient.createTagCallable().futureCall(request);
// Do something.
Tag response = future.get();
}
public final Tag updateTag(Tag tag)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
Tag tag = Tag.newBuilder().build();
Tag response = dataCatalogClient.updateTag(tag);
}
tag - Required. The updated tag. The "name" field must be set.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Tag updateTag(Tag tag, com.google.protobuf.FieldMask updateMask)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
Tag tag = Tag.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Tag response = dataCatalogClient.updateTag(tag, updateMask);
}
tag - Required. The updated tag. The "name" field must be set.updateMask - Names of fields whose values to overwrite on a tag. Currently, a tag has the
only modifiable field with the name `fields`.
In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final Tag updateTag(UpdateTagRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
UpdateTagRequest request =
UpdateTagRequest.newBuilder()
.setTag(Tag.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Tag response = dataCatalogClient.updateTag(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateTagRequest,Tag> updateTagCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
UpdateTagRequest request =
UpdateTagRequest.newBuilder()
.setTag(Tag.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Tag> future = dataCatalogClient.updateTagCallable().futureCall(request);
// Do something.
Tag response = future.get();
}
public final void deleteTag(EntryName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
dataCatalogClient.deleteTag(name);
}
name - Required. The name of the tag to delete.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteTag(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
dataCatalogClient.deleteTag(name);
}
name - Required. The name of the tag to delete.com.google.api.gax.rpc.ApiException - if the remote call failspublic final void deleteTag(DeleteTagRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
DeleteTagRequest request =
DeleteTagRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.build();
dataCatalogClient.deleteTag(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteTagRequest,com.google.protobuf.Empty> deleteTagCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
DeleteTagRequest request =
DeleteTagRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.build();
ApiFuture<Empty> future = dataCatalogClient.deleteTagCallable().futureCall(request);
// Do something.
future.get();
}
public final DataCatalogClient.ListTagsPagedResponse listTags(EntryName parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryName parent = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
for (Tag element : dataCatalogClient.listTags(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The name of the Data Catalog resource to list the tags of.
The resource can be an [Entry][google.cloud.datacatalog.v1.Entry] or an [EntryGroup][google.cloud.datacatalog.v1.EntryGroup] (without `/entries/{entries}` at the end).
com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataCatalogClient.ListTagsPagedResponse listTags(String parent)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String parent =
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
for (Tag element : dataCatalogClient.listTags(parent).iterateAll()) {
// doThingsWith(element);
}
}
parent - Required. The name of the Data Catalog resource to list the tags of.
The resource can be an [Entry][google.cloud.datacatalog.v1.Entry] or an [EntryGroup][google.cloud.datacatalog.v1.EntryGroup] (without `/entries/{entries}` at the end).
com.google.api.gax.rpc.ApiException - if the remote call failspublic final DataCatalogClient.ListTagsPagedResponse listTags(ListTagsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ListTagsRequest request =
ListTagsRequest.newBuilder()
.setParent(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Tag element : dataCatalogClient.listTags(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListTagsRequest,DataCatalogClient.ListTagsPagedResponse> listTagsPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ListTagsRequest request =
ListTagsRequest.newBuilder()
.setParent(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Tag> future = dataCatalogClient.listTagsPagedCallable().futureCall(request);
// Do something.
for (Tag element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListTagsRequest,ListTagsResponse> listTagsCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ListTagsRequest request =
ListTagsRequest.newBuilder()
.setParent(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListTagsResponse response = dataCatalogClient.listTagsCallable().call(request);
for (Tag element : response.getTagsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<ReconcileTagsResponse,ReconcileTagsMetadata> reconcileTagsAsync(ReconcileTagsRequest request)
`ReconcileTags` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ReconcileTagsRequest request =
ReconcileTagsRequest.newBuilder()
.setParent(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setTagTemplate(
TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
.setForceDeleteMissing(true)
.addAllTags(new ArrayList<Tag>())
.build();
ReconcileTagsResponse response = dataCatalogClient.reconcileTagsAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<ReconcileTagsRequest,ReconcileTagsResponse,ReconcileTagsMetadata> reconcileTagsOperationCallable()
`ReconcileTags` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ReconcileTagsRequest request =
ReconcileTagsRequest.newBuilder()
.setParent(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setTagTemplate(
TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
.setForceDeleteMissing(true)
.addAllTags(new ArrayList<Tag>())
.build();
OperationFuture<ReconcileTagsResponse, ReconcileTagsMetadata> future =
dataCatalogClient.reconcileTagsOperationCallable().futureCall(request);
// Do something.
ReconcileTagsResponse response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<ReconcileTagsRequest,com.google.longrunning.Operation> reconcileTagsCallable()
`ReconcileTags` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ReconcileTagsRequest request =
ReconcileTagsRequest.newBuilder()
.setParent(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setTagTemplate(
TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
.setForceDeleteMissing(true)
.addAllTags(new ArrayList<Tag>())
.build();
ApiFuture<Operation> future = dataCatalogClient.reconcileTagsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final StarEntryResponse starEntry(EntryName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
StarEntryResponse response = dataCatalogClient.starEntry(name);
}
name - Required. The name of the entry to mark as starred.com.google.api.gax.rpc.ApiException - if the remote call failspublic final StarEntryResponse starEntry(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
StarEntryResponse response = dataCatalogClient.starEntry(name);
}
name - Required. The name of the entry to mark as starred.com.google.api.gax.rpc.ApiException - if the remote call failspublic final StarEntryResponse starEntry(StarEntryRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
StarEntryRequest request =
StarEntryRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.build();
StarEntryResponse response = dataCatalogClient.starEntry(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<StarEntryRequest,StarEntryResponse> starEntryCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
StarEntryRequest request =
StarEntryRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.build();
ApiFuture<StarEntryResponse> future =
dataCatalogClient.starEntryCallable().futureCall(request);
// Do something.
StarEntryResponse response = future.get();
}
public final UnstarEntryResponse unstarEntry(EntryName name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
UnstarEntryResponse response = dataCatalogClient.unstarEntry(name);
}
name - Required. The name of the entry to mark as **not** starred.com.google.api.gax.rpc.ApiException - if the remote call failspublic final UnstarEntryResponse unstarEntry(String name)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
UnstarEntryResponse response = dataCatalogClient.unstarEntry(name);
}
name - Required. The name of the entry to mark as **not** starred.com.google.api.gax.rpc.ApiException - if the remote call failspublic final UnstarEntryResponse unstarEntry(UnstarEntryRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
UnstarEntryRequest request =
UnstarEntryRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.build();
UnstarEntryResponse response = dataCatalogClient.unstarEntry(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UnstarEntryRequest,UnstarEntryResponse> unstarEntryCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
UnstarEntryRequest request =
UnstarEntryRequest.newBuilder()
.setName(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.build();
ApiFuture<UnstarEntryResponse> future =
dataCatalogClient.unstarEntryCallable().futureCall(request);
// Do something.
UnstarEntryResponse response = future.get();
}
public final com.google.iam.v1.Policy setIamPolicy(com.google.api.resourcenames.ResourceName resource,
com.google.iam.v1.Policy policy)
Supported resources are:
- Tag templates - Entry groups
Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog.
To call this method, you must have the following Google IAM permissions:
- `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ResourceName resource = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
Policy policy = Policy.newBuilder().build();
Policy response = dataCatalogClient.setIamPolicy(resource, policy);
}
resource - REQUIRED: The resource for which the policy is being specified. See the
operation documentation for the appropriate value for this field.policy - REQUIRED: The complete policy to be applied to the `resource`. The size of the
policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud
Platform services (such as Projects) might reject them.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.Policy setIamPolicy(String resource, com.google.iam.v1.Policy policy)
Supported resources are:
- Tag templates - Entry groups
Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog.
To call this method, you must have the following Google IAM permissions:
- `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String resource =
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
Policy policy = Policy.newBuilder().build();
Policy response = dataCatalogClient.setIamPolicy(resource, policy);
}
resource - REQUIRED: The resource for which the policy is being specified. See the
operation documentation for the appropriate value for this field.policy - REQUIRED: The complete policy to be applied to the `resource`. The size of the
policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud
Platform services (such as Projects) might reject them.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Supported resources are:
- Tag templates - Entry groups
Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog.
To call this method, you must have the following Google IAM permissions:
- `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = dataCatalogClient.setIamPolicy(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()
Supported resources are:
- Tag templates - Entry groups
Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog.
To call this method, you must have the following Google IAM permissions:
- `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future = dataCatalogClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
public final com.google.iam.v1.Policy getIamPolicy(com.google.api.resourcenames.ResourceName resource)
May return:
Supported resources are:
- Tag templates - Entry groups
Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.
To call this method, you must have the following Google IAM permissions:
- `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ResourceName resource = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
Policy response = dataCatalogClient.getIamPolicy(resource);
}
resource - REQUIRED: The resource for which the policy is being requested. See the
operation documentation for the appropriate value for this field.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.Policy getIamPolicy(String resource)
May return:
Supported resources are:
- Tag templates - Entry groups
Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.
To call this method, you must have the following Google IAM permissions:
- `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
String resource =
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
Policy response = dataCatalogClient.getIamPolicy(resource);
}
resource - REQUIRED: The resource for which the policy is being requested. See the
operation documentation for the appropriate value for this field.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
May return:
Supported resources are:
- Tag templates - Entry groups
Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.
To call this method, you must have the following Google IAM permissions:
- `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = dataCatalogClient.getIamPolicy(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()
May return:
Supported resources are:
- Tag templates - Entry groups
Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.
To call this method, you must have the following Google IAM permissions:
- `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future = dataCatalogClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Returns an empty set of permissions if the resource doesn't exist.
Supported resources are:
- Tag templates - Entry groups
Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog.
No Google IAM permissions are required to call this method.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response = dataCatalogClient.testIamPermissions(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()
Returns an empty set of permissions if the resource doesn't exist.
Supported resources are:
- Tag templates - Entry groups
Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog.
No Google IAM permissions are required to call this method.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
dataCatalogClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
public final com.google.api.gax.longrunning.OperationFuture<ImportEntriesResponse,ImportEntriesMetadata> importEntriesAsync(ImportEntriesRequest request)
`ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of [DumpItem][google.cloud.datacatalog.v1.DumpItem] type.
`ImportEntries` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata] and an [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse] message.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ImportEntriesRequest request =
ImportEntriesRequest.newBuilder()
.setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setJobId("jobId101296568")
.build();
ImportEntriesResponse response = dataCatalogClient.importEntriesAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<ImportEntriesRequest,ImportEntriesResponse,ImportEntriesMetadata> importEntriesOperationCallable()
`ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of [DumpItem][google.cloud.datacatalog.v1.DumpItem] type.
`ImportEntries` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata] and an [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse] message.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ImportEntriesRequest request =
ImportEntriesRequest.newBuilder()
.setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setJobId("jobId101296568")
.build();
OperationFuture<ImportEntriesResponse, ImportEntriesMetadata> future =
dataCatalogClient.importEntriesOperationCallable().futureCall(request);
// Do something.
ImportEntriesResponse response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<ImportEntriesRequest,com.google.longrunning.Operation> importEntriesCallable()
`ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of [DumpItem][google.cloud.datacatalog.v1.DumpItem] type.
`ImportEntries` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata] and an [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse] message.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
ImportEntriesRequest request =
ImportEntriesRequest.newBuilder()
.setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
.setJobId("jobId101296568")
.build();
ApiFuture<Operation> future = dataCatalogClient.importEntriesCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2024 Google LLC. All rights reserved.