com.google.cloud.datacatalog.v1beta1.DataCatalogClient Maven / Gradle / Ivy
Show all versions of google-cloud-datacatalog Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.datacatalog.v1beta1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.api.resourcenames.ResourceName;
import com.google.cloud.datacatalog.v1beta1.stub.DataCatalogStub;
import com.google.cloud.datacatalog.v1beta1.stub.DataCatalogStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Data Catalog API service allows clients to discover, understand, and manage
* their data.
*
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
*
{@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);
* }
* }
*
* 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().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* SearchCatalog
Searches Data Catalog for multiple resources like entries, tags that match a query.
*
This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequently call `Get` methods.
*
Note that Data Catalog search queries do not guarantee full recall. Query results that match your query may not be returned, even in subsequent result pages. Also note that results returned (and not returned) can vary across repeated search queries.
*
See [Data Catalog Search Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more information.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* searchCatalog(SearchCatalogRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* searchCatalog(SearchCatalogRequest.Scope scope, String query)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* searchCatalogPagedCallable()
*
searchCatalogCallable()
*
*
*
*
* CreateEntryGroup
A maximum of 10,000 entry groups may be created per organization across all locations.
*
Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createEntryGroup(CreateEntryGroupRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createEntryGroup(LocationName parent, String entryGroupId, EntryGroup entryGroup)
*
createEntryGroup(String parent, String entryGroupId, EntryGroup entryGroup)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createEntryGroupCallable()
*
*
*
*
* UpdateEntryGroup
Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by the `entry_group.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateEntryGroup(UpdateEntryGroupRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateEntryGroup(EntryGroup entryGroup)
*
updateEntryGroup(EntryGroup entryGroup, FieldMask updateMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateEntryGroupCallable()
*
*
*
*
* GetEntryGroup
Gets an EntryGroup.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getEntryGroup(GetEntryGroupRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getEntryGroup(EntryGroupName name)
*
getEntryGroup(String name)
*
getEntryGroup(EntryGroupName name, FieldMask readMask)
*
getEntryGroup(String name, FieldMask readMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getEntryGroupCallable()
*
*
*
*
* DeleteEntryGroup
Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteEntryGroup(DeleteEntryGroupRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteEntryGroup(EntryGroupName name)
*
deleteEntryGroup(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteEntryGroupCallable()
*
*
*
*
* ListEntryGroups
Lists entry groups.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listEntryGroups(ListEntryGroupsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listEntryGroups(LocationName parent)
*
listEntryGroups(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listEntryGroupsPagedCallable()
*
listEntryGroupsCallable()
*
*
*
*
* CreateEntry
Creates an entry. Only entries of 'FILESET' type or user-specified type can be created.
*
Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
A maximum of 100,000 entries may be created per entry group.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createEntry(CreateEntryRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createEntry(EntryGroupName parent, String entryId, Entry entry)
*
createEntry(String parent, String entryId, Entry entry)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createEntryCallable()
*
*
*
*
* UpdateEntry
Updates an existing entry. Users should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateEntry(UpdateEntryRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateEntry(Entry entry)
*
updateEntry(Entry entry, FieldMask updateMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateEntryCallable()
*
*
*
*
* DeleteEntry
Deletes an existing entry. Only entries created through [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry] method can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteEntry(DeleteEntryRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteEntry(EntryName name)
*
deleteEntry(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteEntryCallable()
*
*
*
*
* GetEntry
Gets an entry.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getEntry(GetEntryRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getEntry(EntryName name)
*
getEntry(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getEntryCallable()
*
*
*
*
* LookupEntry
Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* lookupEntry(LookupEntryRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* lookupEntryCallable()
*
*
*
*
* ListEntries
Lists entries.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listEntries(ListEntriesRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listEntries(EntryGroupName parent)
*
listEntries(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listEntriesPagedCallable()
*
listEntriesCallable()
*
*
*
*
* CreateTagTemplate
Creates a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createTagTemplate(CreateTagTemplateRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createTagTemplate(LocationName parent, String tagTemplateId, TagTemplate tagTemplate)
*
createTagTemplate(String parent, String tagTemplateId, TagTemplate tagTemplate)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createTagTemplateCallable()
*
*
*
*
* GetTagTemplate
Gets a tag template.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getTagTemplate(GetTagTemplateRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getTagTemplate(TagTemplateName name)
*
getTagTemplate(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getTagTemplateCallable()
*
*
*
*
* UpdateTagTemplate
Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateTagTemplate(UpdateTagTemplateRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateTagTemplate(TagTemplate tagTemplate)
*
updateTagTemplate(TagTemplate tagTemplate, FieldMask updateMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateTagTemplateCallable()
*
*
*
*
* DeleteTagTemplate
Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteTagTemplate(DeleteTagTemplateRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteTagTemplate(TagTemplateName name, boolean force)
*
deleteTagTemplate(String name, boolean force)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteTagTemplateCallable()
*
*
*
*
* CreateTagTemplateField
Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createTagTemplateField(CreateTagTemplateFieldRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createTagTemplateField(TagTemplateName parent, String tagTemplateFieldId, TagTemplateField tagTemplateField)
*
createTagTemplateField(String parent, String tagTemplateFieldId, TagTemplateField tagTemplateField)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createTagTemplateFieldCallable()
*
*
*
*
* UpdateTagTemplateField
Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateTagTemplateField(UpdateTagTemplateFieldRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateTagTemplateField(TagTemplateFieldName name, TagTemplateField tagTemplateField)
*
updateTagTemplateField(String name, TagTemplateField tagTemplateField)
*
updateTagTemplateField(TagTemplateFieldName name, TagTemplateField tagTemplateField, FieldMask updateMask)
*
updateTagTemplateField(String name, TagTemplateField tagTemplateField, FieldMask updateMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateTagTemplateFieldCallable()
*
*
*
*
* RenameTagTemplateField
Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* renameTagTemplateField(RenameTagTemplateFieldRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* renameTagTemplateField(TagTemplateFieldName name, String newTagTemplateFieldId)
*
renameTagTemplateField(String name, String newTagTemplateFieldId)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* renameTagTemplateFieldCallable()
*
*
*
*
* RenameTagTemplateFieldEnumValue
Renames an enum value in a tag template. The enum values have to be unique within one enum field. Thus, an enum value cannot be renamed with a name used in any other enum value within the same enum field.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* renameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* renameTagTemplateFieldEnumValue(TagTemplateFieldEnumValueName name, String newEnumValueDisplayName)
*
renameTagTemplateFieldEnumValue(String name, String newEnumValueDisplayName)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* renameTagTemplateFieldEnumValueCallable()
*
*
*
*
* DeleteTagTemplateField
Deletes a field in a tag template and all uses of that field. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteTagTemplateField(DeleteTagTemplateFieldRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteTagTemplateField(TagTemplateFieldName name, boolean force)
*
deleteTagTemplateField(String name, boolean force)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteTagTemplateFieldCallable()
*
*
*
*
* CreateTag
Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry]. Note: The project identified by the `parent` parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createTag(CreateTagRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createTag(EntryName parent, Tag tag)
*
createTag(String parent, Tag tag)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createTagCallable()
*
*
*
*
* UpdateTag
Updates an existing tag.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateTag(UpdateTagRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateTag(Tag tag)
*
updateTag(Tag tag, FieldMask updateMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateTagCallable()
*
*
*
*
* DeleteTag
Deletes a tag.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteTag(DeleteTagRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteTag(EntryName name)
*
deleteTag(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteTagCallable()
*
*
*
*
* ListTags
Lists tags assigned to an [Entry][google.cloud.datacatalog.v1beta1.Entry]. The [columns][google.cloud.datacatalog.v1beta1.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.
*
* listTags(ListTagsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listTags(EntryName parent)
*
listTags(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listTagsPagedCallable()
*
listTagsCallable()
*
*
*
*
* SetIamPolicy
Sets the access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.
*
Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on entries. - `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.
*
* setIamPolicy(SetIamPolicyRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* setIamPolicy(ResourceName resource, Policy policy)
*
setIamPolicy(String resource, Policy policy)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* setIamPolicyCallable()
*
*
*
*
* GetIamPolicy
Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
*
Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.
*
Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - `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.
*
* getIamPolicy(GetIamPolicyRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getIamPolicy(ResourceName resource)
*
getIamPolicy(String resource)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getIamPolicyCallable()
*
*
*
*
* TestIamPermissions
Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error).
*
Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.
*
A caller is not required to have Google IAM permission to make this request.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* testIamPermissions(TestIamPermissionsRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* testIamPermissionsCallable()
*
*
*
*
*
* 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:
*
*
{@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
* DataCatalogSettings dataCatalogSettings =
* DataCatalogSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* DataCatalogClient dataCatalogClient = DataCatalogClient.create(dataCatalogSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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:
*
*
{@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
* DataCatalogSettings dataCatalogSettings = DataCatalogSettings.newHttpJsonBuilder().build();
* DataCatalogClient dataCatalogClient = DataCatalogClient.create(dataCatalogSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class DataCatalogClient implements BackgroundResource {
private final DataCatalogSettings settings;
private final DataCatalogStub stub;
/** Constructs an instance of DataCatalogClient with default settings. */
public static final DataCatalogClient create() throws IOException {
return create(DataCatalogSettings.newBuilder().build());
}
/**
* Constructs an instance of DataCatalogClient, using the given settings. The channels are created
* based on the settings passed in, or defaults for any settings that are not set.
*/
public static final DataCatalogClient create(DataCatalogSettings settings) throws IOException {
return new DataCatalogClient(settings);
}
/**
* Constructs an instance of DataCatalogClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(DataCatalogSettings).
*/
public static final DataCatalogClient create(DataCatalogStub stub) {
return new DataCatalogClient(stub);
}
/**
* Constructs an instance of DataCatalogClient, using the given settings. This is protected so
* that it is easy to make a subclass, but otherwise, the static factory methods should be
* preferred.
*/
protected DataCatalogClient(DataCatalogSettings settings) throws IOException {
this.settings = settings;
this.stub = ((DataCatalogStubSettings) settings.getStubSettings()).createStub();
}
protected DataCatalogClient(DataCatalogStub stub) {
this.settings = null;
this.stub = stub;
}
public final DataCatalogSettings getSettings() {
return settings;
}
public DataCatalogStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Searches Data Catalog for multiple resources like entries, tags that match a query.
*
*
This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not
* return the complete resource, only the resource identifier and high level fields. Clients can
* subsequently call `Get` methods.
*
*
Note that Data Catalog search queries do not guarantee full recall. Query results that match
* your query may not be returned, even in subsequent result pages. Also note that results
* returned (and not returned) can vary across repeated search queries.
*
*
See [Data Catalog Search
* Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more
* information.
*
*
Sample code:
*
*
{@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);
* }
* }
* }
*
* @param scope Required. The scope of this search request. A `scope` that has empty
* `include_org_ids`, `include_project_ids` AND false `include_gcp_public_datasets` is
* considered invalid. Data Catalog will return an error in such a case.
* @param query Optional. The query string in search query syntax. An empty query string will
* result in all data assets (in the specified scope) that the user has access to. Query
* strings can be simple as "x" or more qualified as:
*
* - name:x
*
- column:x
*
- description:y
*
* Note: Query tokens need to have a minimum of 3 characters for substring matching to work
* correctly. See [Data Catalog Search
* Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more
* information.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchCatalogPagedResponse searchCatalog(
SearchCatalogRequest.Scope scope, String query) {
SearchCatalogRequest request =
SearchCatalogRequest.newBuilder().setScope(scope).setQuery(query).build();
return searchCatalog(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Searches Data Catalog for multiple resources like entries, tags that match a query.
*
*
This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not
* return the complete resource, only the resource identifier and high level fields. Clients can
* subsequently call `Get` methods.
*
*
Note that Data Catalog search queries do not guarantee full recall. Query results that match
* your query may not be returned, even in subsequent result pages. Also note that results
* returned (and not returned) can vary across repeated search queries.
*
*
See [Data Catalog Search
* Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more
* information.
*
*
Sample code:
*
*
{@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")
* .build();
* for (SearchCatalogResult element : dataCatalogClient.searchCatalog(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SearchCatalogPagedResponse searchCatalog(SearchCatalogRequest request) {
return searchCatalogPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Searches Data Catalog for multiple resources like entries, tags that match a query.
*
* This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not
* return the complete resource, only the resource identifier and high level fields. Clients can
* subsequently call `Get` methods.
*
*
Note that Data Catalog search queries do not guarantee full recall. Query results that match
* your query may not be returned, even in subsequent result pages. Also note that results
* returned (and not returned) can vary across repeated search queries.
*
*
See [Data Catalog Search
* Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more
* information.
*
*
Sample code:
*
*
{@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")
* .build();
* ApiFuture future =
* dataCatalogClient.searchCatalogPagedCallable().futureCall(request);
* // Do something.
* for (SearchCatalogResult element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
searchCatalogPagedCallable() {
return stub.searchCatalogPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Searches Data Catalog for multiple resources like entries, tags that match a query.
*
* This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not
* return the complete resource, only the resource identifier and high level fields. Clients can
* subsequently call `Get` methods.
*
*
Note that Data Catalog search queries do not guarantee full recall. Query results that match
* your query may not be returned, even in subsequent result pages. Also note that results
* returned (and not returned) can vary across repeated search queries.
*
*
See [Data Catalog Search
* Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more
* information.
*
*
Sample code:
*
*
{@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")
* .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 UnaryCallable searchCatalogCallable() {
return stub.searchCatalogCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* A maximum of 10,000 entry groups may be created per organization across all locations.
*
* Users should enable the Data Catalog API in the project identified by the `parent` parameter
* (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. The name of the project this entry group is in. Example:
*
* - projects/{project_id}/locations/{location}
*
* Note that this EntryGroup and its child resources may not actually be stored in the
* location in this name.
* @param entryGroupId Required. The id of the entry group to create. The id must begin with a
* letter or underscore, contain only English letters, numbers and underscores, and be at most
* 64 characters.
* @param entryGroup The entry group to create. Defaults to an empty entry group.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EntryGroup createEntryGroup(
LocationName parent, String entryGroupId, EntryGroup entryGroup) {
CreateEntryGroupRequest request =
CreateEntryGroupRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setEntryGroupId(entryGroupId)
.setEntryGroup(entryGroup)
.build();
return createEntryGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* A maximum of 10,000 entry groups may be created per organization across all locations.
*
*
Users should enable the Data Catalog API in the project identified by the `parent` parameter
* (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. The name of the project this entry group is in. Example:
*
* - projects/{project_id}/locations/{location}
*
* Note that this EntryGroup and its child resources may not actually be stored in the
* location in this name.
* @param entryGroupId Required. The id of the entry group to create. The id must begin with a
* letter or underscore, contain only English letters, numbers and underscores, and be at most
* 64 characters.
* @param entryGroup The entry group to create. Defaults to an empty entry group.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EntryGroup createEntryGroup(
String parent, String entryGroupId, EntryGroup entryGroup) {
CreateEntryGroupRequest request =
CreateEntryGroupRequest.newBuilder()
.setParent(parent)
.setEntryGroupId(entryGroupId)
.setEntryGroup(entryGroup)
.build();
return createEntryGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* A maximum of 10,000 entry groups may be created per organization across all locations.
*
*
Users should enable the Data Catalog API in the project identified by the `parent` parameter
* (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EntryGroup createEntryGroup(CreateEntryGroupRequest request) {
return createEntryGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* A maximum of 10,000 entry groups may be created per organization across all locations.
*
* Users should enable the Data Catalog API in the project identified by the `parent` parameter
* (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
*
Sample code:
*
*
{@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 future =
* dataCatalogClient.createEntryGroupCallable().futureCall(request);
* // Do something.
* EntryGroup response = future.get();
* }
* }
*/
public final UnaryCallable createEntryGroupCallable() {
return stub.createEntryGroupCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by
* the `entry_group.name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param entryGroup Required. The updated entry group. "name" field must be set.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EntryGroup updateEntryGroup(EntryGroup entryGroup) {
UpdateEntryGroupRequest request =
UpdateEntryGroupRequest.newBuilder().setEntryGroup(entryGroup).build();
return updateEntryGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by
* the `entry_group.name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param entryGroup Required. The updated entry group. "name" field must be set.
* @param 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.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EntryGroup updateEntryGroup(EntryGroup entryGroup, FieldMask updateMask) {
UpdateEntryGroupRequest request =
UpdateEntryGroupRequest.newBuilder()
.setEntryGroup(entryGroup)
.setUpdateMask(updateMask)
.build();
return updateEntryGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by
* the `entry_group.name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EntryGroup updateEntryGroup(UpdateEntryGroupRequest request) {
return updateEntryGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by
* the `entry_group.name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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 future =
* dataCatalogClient.updateEntryGroupCallable().futureCall(request);
* // Do something.
* EntryGroup response = future.get();
* }
* }
*/
public final UnaryCallable updateEntryGroupCallable() {
return stub.updateEntryGroupCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an EntryGroup.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the entry group. For example,
* `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EntryGroup getEntryGroup(EntryGroupName name) {
GetEntryGroupRequest request =
GetEntryGroupRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getEntryGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an EntryGroup.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the entry group. For example,
* `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EntryGroup getEntryGroup(String name) {
GetEntryGroupRequest request = GetEntryGroupRequest.newBuilder().setName(name).build();
return getEntryGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an EntryGroup.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the entry group. For example,
* `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
* @param readMask The fields to return. If not set or empty, all fields are returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EntryGroup getEntryGroup(EntryGroupName name, FieldMask readMask) {
GetEntryGroupRequest request =
GetEntryGroupRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setReadMask(readMask)
.build();
return getEntryGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an EntryGroup.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the entry group. For example,
* `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
* @param readMask The fields to return. If not set or empty, all fields are returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EntryGroup getEntryGroup(String name, FieldMask readMask) {
GetEntryGroupRequest request =
GetEntryGroupRequest.newBuilder().setName(name).setReadMask(readMask).build();
return getEntryGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an EntryGroup.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EntryGroup getEntryGroup(GetEntryGroupRequest request) {
return getEntryGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an EntryGroup.
*
* Sample code:
*
*
{@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 future = dataCatalogClient.getEntryGroupCallable().futureCall(request);
* // Do something.
* EntryGroup response = future.get();
* }
* }
*/
public final UnaryCallable getEntryGroupCallable() {
return stub.getEntryGroupCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users
* should enable the Data Catalog API in the project identified by the `name` parameter (see [Data
* Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the entry group. For example,
* `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteEntryGroup(EntryGroupName name) {
DeleteEntryGroupRequest request =
DeleteEntryGroupRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteEntryGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users
* should enable the Data Catalog API in the project identified by the `name` parameter (see [Data
* Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the entry group. For example,
* `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteEntryGroup(String name) {
DeleteEntryGroupRequest request = DeleteEntryGroupRequest.newBuilder().setName(name).build();
deleteEntryGroup(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users
* should enable the Data Catalog API in the project identified by the `name` parameter (see [Data
* Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteEntryGroup(DeleteEntryGroupRequest request) {
deleteEntryGroupCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users
* should enable the Data Catalog API in the project identified by the `name` parameter (see [Data
* Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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 future = dataCatalogClient.deleteEntryGroupCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteEntryGroupCallable() {
return stub.deleteEntryGroupCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists entry groups.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param parent Required. The name of the location that contains the entry groups, which can be
* provided in URL format. Example:
*
* - projects/{project_id}/locations/{location}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListEntryGroupsPagedResponse listEntryGroups(LocationName parent) {
ListEntryGroupsRequest request =
ListEntryGroupsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listEntryGroups(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists entry groups.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param parent Required. The name of the location that contains the entry groups, which can be
* provided in URL format. Example:
*
* - projects/{project_id}/locations/{location}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListEntryGroupsPagedResponse listEntryGroups(String parent) {
ListEntryGroupsRequest request = ListEntryGroupsRequest.newBuilder().setParent(parent).build();
return listEntryGroups(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists entry groups.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListEntryGroupsPagedResponse listEntryGroups(ListEntryGroupsRequest request) {
return listEntryGroupsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists entry groups.
*
* Sample code:
*
*
{@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 future =
* dataCatalogClient.listEntryGroupsPagedCallable().futureCall(request);
* // Do something.
* for (EntryGroup element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listEntryGroupsPagedCallable() {
return stub.listEntryGroupsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists entry groups.
*
* Sample code:
*
*
{@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 UnaryCallable
listEntryGroupsCallable() {
return stub.listEntryGroupsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an entry. Only entries of 'FILESET' type or user-specified type can be created.
*
* Users should enable the Data Catalog API in the project identified by the `parent` parameter
* (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
*
A maximum of 100,000 entries may be created per entry group.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. The name of the entry group this entry is in. Example:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
*
* Note that this Entry and its child resources may not actually be stored in the location
* in this name.
* @param entryId Required. The id of the entry to create.
* @param entry Required. The entry to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Entry createEntry(EntryGroupName parent, String entryId, Entry entry) {
CreateEntryRequest request =
CreateEntryRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setEntryId(entryId)
.setEntry(entry)
.build();
return createEntry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an entry. Only entries of 'FILESET' type or user-specified type can be created.
*
*
Users should enable the Data Catalog API in the project identified by the `parent` parameter
* (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
*
A maximum of 100,000 entries may be created per entry group.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. The name of the entry group this entry is in. Example:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
*
* Note that this Entry and its child resources may not actually be stored in the location
* in this name.
* @param entryId Required. The id of the entry to create.
* @param entry Required. The entry to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Entry createEntry(String parent, String entryId, Entry entry) {
CreateEntryRequest request =
CreateEntryRequest.newBuilder()
.setParent(parent)
.setEntryId(entryId)
.setEntry(entry)
.build();
return createEntry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an entry. Only entries of 'FILESET' type or user-specified type can be created.
*
*
Users should enable the Data Catalog API in the project identified by the `parent` parameter
* (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
*
A maximum of 100,000 entries may be created per entry group.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Entry createEntry(CreateEntryRequest request) {
return createEntryCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an entry. Only entries of 'FILESET' type or user-specified type can be created.
*
* Users should enable the Data Catalog API in the project identified by the `parent` parameter
* (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
*
A maximum of 100,000 entries may be created per entry group.
*
*
Sample code:
*
*
{@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 future = dataCatalogClient.createEntryCallable().futureCall(request);
* // Do something.
* Entry response = future.get();
* }
* }
*/
public final UnaryCallable createEntryCallable() {
return stub.createEntryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing entry. Users should enable the Data Catalog API in the project identified
* by the `entry.name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param entry Required. The updated entry. The "name" field must be set.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Entry updateEntry(Entry entry) {
UpdateEntryRequest request = UpdateEntryRequest.newBuilder().setEntry(entry).build();
return updateEntry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing entry. Users should enable the Data Catalog API in the project identified
* by the `entry.name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param entry Required. The updated entry. The "name" field must be set.
* @param 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.
*
The following fields are modifiable:
*
* - For entries with type `DATA_STREAM`: * `schema`
*
- For entries with type `FILESET`: * `schema` * `display_name` *
* `description` * `gcs_fileset_spec` * `gcs_fileset_spec.file_patterns`
*
- For entries with `user_specified_type`: * `schema` * `display_name` *
* `description` * `user_specified_type` * `user_specified_system` *
* `linked_resource` * `source_system_timestamps`
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Entry updateEntry(Entry entry, FieldMask updateMask) {
UpdateEntryRequest request =
UpdateEntryRequest.newBuilder().setEntry(entry).setUpdateMask(updateMask).build();
return updateEntry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing entry. Users should enable the Data Catalog API in the project identified
* by the `entry.name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Entry updateEntry(UpdateEntryRequest request) {
return updateEntryCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing entry. Users should enable the Data Catalog API in the project identified
* by the `entry.name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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 future = dataCatalogClient.updateEntryCallable().futureCall(request);
* // Do something.
* Entry response = future.get();
* }
* }
*/
public final UnaryCallable updateEntryCallable() {
return stub.updateEntryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an existing entry. Only entries created through
* [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry] method can be deleted.
* Users should enable the Data Catalog API in the project identified by the `name` parameter (see
* [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the entry. Example:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteEntry(EntryName name) {
DeleteEntryRequest request =
DeleteEntryRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteEntry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an existing entry. Only entries created through
* [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry] method can be deleted.
* Users should enable the Data Catalog API in the project identified by the `name` parameter (see
* [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the entry. Example:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteEntry(String name) {
DeleteEntryRequest request = DeleteEntryRequest.newBuilder().setName(name).build();
deleteEntry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an existing entry. Only entries created through
* [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry] method can be deleted.
* Users should enable the Data Catalog API in the project identified by the `name` parameter (see
* [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteEntry(DeleteEntryRequest request) {
deleteEntryCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes an existing entry. Only entries created through
* [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry] method can be deleted.
* Users should enable the Data Catalog API in the project identified by the `name` parameter (see
* [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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 future = dataCatalogClient.deleteEntryCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteEntryCallable() {
return stub.deleteEntryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an entry.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the entry. Example:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Entry getEntry(EntryName name) {
GetEntryRequest request =
GetEntryRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getEntry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an entry.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the entry. Example:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Entry getEntry(String name) {
GetEntryRequest request = GetEntryRequest.newBuilder().setName(name).build();
return getEntry(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an entry.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Entry getEntry(GetEntryRequest request) {
return getEntryCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an entry.
*
* Sample code:
*
*
{@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 future = dataCatalogClient.getEntryCallable().futureCall(request);
* // Do something.
* Entry response = future.get();
* }
* }
*/
public final UnaryCallable getEntryCallable() {
return stub.getEntryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get an entry by target resource name. This method allows clients to use the resource name from
* the source Google Cloud Platform service to get the Data Catalog Entry.
*
* Sample code:
*
*
{@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().build();
* Entry response = dataCatalogClient.lookupEntry(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Entry lookupEntry(LookupEntryRequest request) {
return lookupEntryCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get an entry by target resource name. This method allows clients to use the resource name from
* the source Google Cloud Platform service to get the Data Catalog Entry.
*
* Sample code:
*
*
{@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().build();
* ApiFuture future = dataCatalogClient.lookupEntryCallable().futureCall(request);
* // Do something.
* Entry response = future.get();
* }
* }
*/
public final UnaryCallable lookupEntryCallable() {
return stub.lookupEntryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists entries.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param parent Required. The name of the entry group that contains the entries, which can be
* provided in URL format. Example:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListEntriesPagedResponse listEntries(EntryGroupName parent) {
ListEntriesRequest request =
ListEntriesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listEntries(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists entries.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param parent Required. The name of the entry group that contains the entries, which can be
* provided in URL format. Example:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListEntriesPagedResponse listEntries(String parent) {
ListEntriesRequest request = ListEntriesRequest.newBuilder().setParent(parent).build();
return listEntries(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists entries.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListEntriesPagedResponse listEntries(ListEntriesRequest request) {
return listEntriesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists entries.
*
* Sample code:
*
*
{@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 future = dataCatalogClient.listEntriesPagedCallable().futureCall(request);
* // Do something.
* for (Entry element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listEntriesPagedCallable() {
return stub.listEntriesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists entries.
*
* Sample code:
*
*
{@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 UnaryCallable listEntriesCallable() {
return stub.listEntriesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a tag template. The user should enable the Data Catalog API in the project identified
* by the `parent` parameter (see [Data Catalog Resource
* Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. The name of the project and the template location
* [region](https://cloud.google.com/data-catalog/docs/concepts/regions.
* Example:
*
* - projects/{project_id}/locations/us-central1
*
*
* @param tagTemplateId Required. The id of the tag template to create.
* @param tagTemplate Required. The tag template to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplate createTagTemplate(
LocationName parent, String tagTemplateId, TagTemplate tagTemplate) {
CreateTagTemplateRequest request =
CreateTagTemplateRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setTagTemplateId(tagTemplateId)
.setTagTemplate(tagTemplate)
.build();
return createTagTemplate(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a tag template. The user should enable the Data Catalog API in the project identified
* by the `parent` parameter (see [Data Catalog Resource
* Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. The name of the project and the template location
* [region](https://cloud.google.com/data-catalog/docs/concepts/regions.
* Example:
*
* - projects/{project_id}/locations/us-central1
*
*
* @param tagTemplateId Required. The id of the tag template to create.
* @param tagTemplate Required. The tag template to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplate createTagTemplate(
String parent, String tagTemplateId, TagTemplate tagTemplate) {
CreateTagTemplateRequest request =
CreateTagTemplateRequest.newBuilder()
.setParent(parent)
.setTagTemplateId(tagTemplateId)
.setTagTemplate(tagTemplate)
.build();
return createTagTemplate(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a tag template. The user should enable the Data Catalog API in the project identified
* by the `parent` parameter (see [Data Catalog Resource
* Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplate createTagTemplate(CreateTagTemplateRequest request) {
return createTagTemplateCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a tag template. The user should enable the Data Catalog API in the project identified
* by the `parent` parameter (see [Data Catalog Resource
* Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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 future =
* dataCatalogClient.createTagTemplateCallable().futureCall(request);
* // Do something.
* TagTemplate response = future.get();
* }
* }
*/
public final UnaryCallable createTagTemplateCallable() {
return stub.createTagTemplateCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a tag template.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag template. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplate getTagTemplate(TagTemplateName name) {
GetTagTemplateRequest request =
GetTagTemplateRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getTagTemplate(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a tag template.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag template. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplate getTagTemplate(String name) {
GetTagTemplateRequest request = GetTagTemplateRequest.newBuilder().setName(name).build();
return getTagTemplate(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a tag template.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplate getTagTemplate(GetTagTemplateRequest request) {
return getTagTemplateCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a tag template.
*
* Sample code:
*
*
{@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 future =
* dataCatalogClient.getTagTemplateCallable().futureCall(request);
* // Do something.
* TagTemplate response = future.get();
* }
* }
*/
public final UnaryCallable getTagTemplateCallable() {
return stub.getTagTemplateCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a tag template. This method cannot be used to update the fields of a template. The tag
* template fields are represented as separate resources and should be updated using their own
* create/update/delete methods. Users should enable the Data Catalog API in the project
* identified by the `tag_template.name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param tagTemplate Required. The template to update. The "name" field must be set.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplate updateTagTemplate(TagTemplate tagTemplate) {
UpdateTagTemplateRequest request =
UpdateTagTemplateRequest.newBuilder().setTagTemplate(tagTemplate).build();
return updateTagTemplate(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a tag template. This method cannot be used to update the fields of a template. The tag
* template fields are represented as separate resources and should be updated using their own
* create/update/delete methods. Users should enable the Data Catalog API in the project
* identified by the `tag_template.name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param tagTemplate Required. The template to update. The "name" field must be set.
* @param updateMask Names of fields whose values to overwrite on a tag template. Currently, only
* `display_name` can be overwritten.
* 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.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplate updateTagTemplate(TagTemplate tagTemplate, FieldMask updateMask) {
UpdateTagTemplateRequest request =
UpdateTagTemplateRequest.newBuilder()
.setTagTemplate(tagTemplate)
.setUpdateMask(updateMask)
.build();
return updateTagTemplate(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a tag template. This method cannot be used to update the fields of a template. The tag
* template fields are represented as separate resources and should be updated using their own
* create/update/delete methods. Users should enable the Data Catalog API in the project
* identified by the `tag_template.name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplate updateTagTemplate(UpdateTagTemplateRequest request) {
return updateTagTemplateCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a tag template. This method cannot be used to update the fields of a template. The tag
* template fields are represented as separate resources and should be updated using their own
* create/update/delete methods. Users should enable the Data Catalog API in the project
* identified by the `tag_template.name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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 future =
* dataCatalogClient.updateTagTemplateCallable().futureCall(request);
* // Do something.
* TagTemplate response = future.get();
* }
* }
*/
public final UnaryCallable updateTagTemplateCallable() {
return stub.updateTagTemplateCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a tag template and all tags using the template. Users should enable the Data Catalog
* API in the project identified by the `name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag template to delete. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
*
*
* @param force Required. Currently, this field must always be set to `true`. This confirms the
* deletion of any possible tags using this template. `force = false` will be supported in the
* future.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTagTemplate(TagTemplateName name, boolean force) {
DeleteTagTemplateRequest request =
DeleteTagTemplateRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setForce(force)
.build();
deleteTagTemplate(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a tag template and all tags using the template. Users should enable the Data Catalog
* API in the project identified by the `name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag template to delete. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
*
*
* @param force Required. Currently, this field must always be set to `true`. This confirms the
* deletion of any possible tags using this template. `force = false` will be supported in the
* future.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTagTemplate(String name, boolean force) {
DeleteTagTemplateRequest request =
DeleteTagTemplateRequest.newBuilder().setName(name).setForce(force).build();
deleteTagTemplate(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a tag template and all tags using the template. Users should enable the Data Catalog
* API in the project identified by the `name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTagTemplate(DeleteTagTemplateRequest request) {
deleteTagTemplateCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a tag template and all tags using the template. Users should enable the Data Catalog
* API in the project identified by the `name` parameter (see [Data Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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 future = dataCatalogClient.deleteTagTemplateCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteTagTemplateCallable() {
return stub.deleteTagTemplateCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a field in a tag template. The user should enable the Data Catalog API in the project
* identified by the `parent` parameter (see [Data Catalog Resource
* Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. The name of the project and the template location
* [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
* Example:
*
* - projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id}
*
*
* @param tagTemplateFieldId Required. The ID of the tag template field to create. 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.
* @param tagTemplateField Required. The tag template field to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField createTagTemplateField(
TagTemplateName parent, String tagTemplateFieldId, TagTemplateField tagTemplateField) {
CreateTagTemplateFieldRequest request =
CreateTagTemplateFieldRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setTagTemplateFieldId(tagTemplateFieldId)
.setTagTemplateField(tagTemplateField)
.build();
return createTagTemplateField(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a field in a tag template. The user should enable the Data Catalog API in the project
* identified by the `parent` parameter (see [Data Catalog Resource
* Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. The name of the project and the template location
* [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
* Example:
*
* - projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id}
*
*
* @param tagTemplateFieldId Required. The ID of the tag template field to create. 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.
* @param tagTemplateField Required. The tag template field to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField createTagTemplateField(
String parent, String tagTemplateFieldId, TagTemplateField tagTemplateField) {
CreateTagTemplateFieldRequest request =
CreateTagTemplateFieldRequest.newBuilder()
.setParent(parent)
.setTagTemplateFieldId(tagTemplateFieldId)
.setTagTemplateField(tagTemplateField)
.build();
return createTagTemplateField(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a field in a tag template. The user should enable the Data Catalog API in the project
* identified by the `parent` parameter (see [Data Catalog Resource
* Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField createTagTemplateField(CreateTagTemplateFieldRequest request) {
return createTagTemplateFieldCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a field in a tag template. The user should enable the Data Catalog API in the project
* identified by the `parent` parameter (see [Data Catalog Resource
* Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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 future =
* dataCatalogClient.createTagTemplateFieldCallable().futureCall(request);
* // Do something.
* TagTemplateField response = future.get();
* }
* }
*/
public final UnaryCallable
createTagTemplateFieldCallable() {
return stub.createTagTemplateFieldCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a field in a tag template. This method cannot be used to update the field type. Users
* should enable the Data Catalog API in the project identified by the `name` parameter (see [Data
* Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag template field. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
*
*
* @param tagTemplateField Required. The template to update.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField updateTagTemplateField(
TagTemplateFieldName name, TagTemplateField tagTemplateField) {
UpdateTagTemplateFieldRequest request =
UpdateTagTemplateFieldRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setTagTemplateField(tagTemplateField)
.build();
return updateTagTemplateField(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a field in a tag template. This method cannot be used to update the field type. Users
* should enable the Data Catalog API in the project identified by the `name` parameter (see [Data
* Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag template field. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
*
*
* @param tagTemplateField Required. The template to update.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField updateTagTemplateField(
String name, TagTemplateField tagTemplateField) {
UpdateTagTemplateFieldRequest request =
UpdateTagTemplateFieldRequest.newBuilder()
.setName(name)
.setTagTemplateField(tagTemplateField)
.build();
return updateTagTemplateField(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a field in a tag template. This method cannot be used to update the field type. Users
* should enable the Data Catalog API in the project identified by the `name` parameter (see [Data
* Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag template field. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
*
*
* @param tagTemplateField Required. The template to update.
* @param updateMask Optional. Names of fields whose values to overwrite on an individual field of
* a tag template. The following fields are modifiable:
* * `display_name` * `type.enum_type` * `is_required`
*
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
*
* - not* allowed.
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField updateTagTemplateField(
TagTemplateFieldName name, TagTemplateField tagTemplateField, FieldMask updateMask) {
UpdateTagTemplateFieldRequest request =
UpdateTagTemplateFieldRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setTagTemplateField(tagTemplateField)
.setUpdateMask(updateMask)
.build();
return updateTagTemplateField(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a field in a tag template. This method cannot be used to update the field type. Users
* should enable the Data Catalog API in the project identified by the `name` parameter (see [Data
* Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag template field. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
*
*
* @param tagTemplateField Required. The template to update.
* @param updateMask Optional. Names of fields whose values to overwrite on an individual field of
* a tag template. The following fields are modifiable:
* * `display_name` * `type.enum_type` * `is_required`
*
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
*
* - not* allowed.
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField updateTagTemplateField(
String name, TagTemplateField tagTemplateField, FieldMask updateMask) {
UpdateTagTemplateFieldRequest request =
UpdateTagTemplateFieldRequest.newBuilder()
.setName(name)
.setTagTemplateField(tagTemplateField)
.setUpdateMask(updateMask)
.build();
return updateTagTemplateField(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a field in a tag template. This method cannot be used to update the field type. Users
* should enable the Data Catalog API in the project identified by the `name` parameter (see [Data
* Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField updateTagTemplateField(UpdateTagTemplateFieldRequest request) {
return updateTagTemplateFieldCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a field in a tag template. This method cannot be used to update the field type. Users
* should enable the Data Catalog API in the project identified by the `name` parameter (see [Data
* Catalog Resource Project]
* (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
*
* Sample code:
*
*
{@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 future =
* dataCatalogClient.updateTagTemplateFieldCallable().futureCall(request);
* // Do something.
* TagTemplateField response = future.get();
* }
* }
*/
public final UnaryCallable
updateTagTemplateFieldCallable() {
return stub.updateTagTemplateFieldCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Renames a field in a tag template. The user should enable the Data Catalog API in the project
* identified by the `name` parameter (see [Data Catalog Resource
* Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag template. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
*
*
* @param newTagTemplateFieldId Required. The new ID of this tag template field. For example,
* `my_new_field`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField renameTagTemplateField(
TagTemplateFieldName name, String newTagTemplateFieldId) {
RenameTagTemplateFieldRequest request =
RenameTagTemplateFieldRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setNewTagTemplateFieldId(newTagTemplateFieldId)
.build();
return renameTagTemplateField(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Renames a field in a tag template. The user should enable the Data Catalog API in the project
* identified by the `name` parameter (see [Data Catalog Resource
* Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag template. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
*
*
* @param newTagTemplateFieldId Required. The new ID of this tag template field. For example,
* `my_new_field`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField renameTagTemplateField(String name, String newTagTemplateFieldId) {
RenameTagTemplateFieldRequest request =
RenameTagTemplateFieldRequest.newBuilder()
.setName(name)
.setNewTagTemplateFieldId(newTagTemplateFieldId)
.build();
return renameTagTemplateField(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Renames a field in a tag template. The user should enable the Data Catalog API in the project
* identified by the `name` parameter (see [Data Catalog Resource
* Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField renameTagTemplateField(RenameTagTemplateFieldRequest request) {
return renameTagTemplateFieldCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Renames a field in a tag template. The user should enable the Data Catalog API in the project
* identified by the `name` parameter (see [Data Catalog Resource
* Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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 future =
* dataCatalogClient.renameTagTemplateFieldCallable().futureCall(request);
* // Do something.
* TagTemplateField response = future.get();
* }
* }
*/
public final UnaryCallable
renameTagTemplateFieldCallable() {
return stub.renameTagTemplateFieldCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Renames an enum value in a tag template. The enum values have to be unique within one enum
* field. Thus, an enum value cannot be renamed with a name used in any other enum value within
* the same enum field.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the enum field value. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name}
*
*
* @param newEnumValueDisplayName Required. The new display name of the enum value. For example,
* `my_new_enum_value`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField renameTagTemplateFieldEnumValue(
TagTemplateFieldEnumValueName name, String newEnumValueDisplayName) {
RenameTagTemplateFieldEnumValueRequest request =
RenameTagTemplateFieldEnumValueRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setNewEnumValueDisplayName(newEnumValueDisplayName)
.build();
return renameTagTemplateFieldEnumValue(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Renames an enum value in a tag template. The enum values have to be unique within one enum
* field. Thus, an enum value cannot be renamed with a name used in any other enum value within
* the same enum field.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the enum field value. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}/enumValues/{enum_value_display_name}
*
*
* @param newEnumValueDisplayName Required. The new display name of the enum value. For example,
* `my_new_enum_value`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField renameTagTemplateFieldEnumValue(
String name, String newEnumValueDisplayName) {
RenameTagTemplateFieldEnumValueRequest request =
RenameTagTemplateFieldEnumValueRequest.newBuilder()
.setName(name)
.setNewEnumValueDisplayName(newEnumValueDisplayName)
.build();
return renameTagTemplateFieldEnumValue(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Renames an enum value in a tag template. The enum values have to be unique within one enum
* field. Thus, an enum value cannot be renamed with a name used in any other enum value within
* the same enum field.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TagTemplateField renameTagTemplateFieldEnumValue(
RenameTagTemplateFieldEnumValueRequest request) {
return renameTagTemplateFieldEnumValueCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Renames an enum value in a tag template. The enum values have to be unique within one enum
* field. Thus, an enum value cannot be renamed with a name used in any other enum value within
* the same enum field.
*
* Sample code:
*
*
{@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 future =
* dataCatalogClient.renameTagTemplateFieldEnumValueCallable().futureCall(request);
* // Do something.
* TagTemplateField response = future.get();
* }
* }
*/
public final UnaryCallable
renameTagTemplateFieldEnumValueCallable() {
return stub.renameTagTemplateFieldEnumValueCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a field in a tag template and all uses of that field. Users should enable the Data
* Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource
* Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag template field to delete. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
*
*
* @param force Required. Currently, this field must always be set to `true`. This confirms the
* deletion of this field from any tags using this field. `force = false` will be supported in
* the future.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTagTemplateField(TagTemplateFieldName name, boolean force) {
DeleteTagTemplateFieldRequest request =
DeleteTagTemplateFieldRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setForce(force)
.build();
deleteTagTemplateField(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a field in a tag template and all uses of that field. Users should enable the Data
* Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource
* Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag template field to delete. Example:
*
* - projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}
*
*
* @param force Required. Currently, this field must always be set to `true`. This confirms the
* deletion of this field from any tags using this field. `force = false` will be supported in
* the future.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTagTemplateField(String name, boolean force) {
DeleteTagTemplateFieldRequest request =
DeleteTagTemplateFieldRequest.newBuilder().setName(name).setForce(force).build();
deleteTagTemplateField(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a field in a tag template and all uses of that field. Users should enable the Data
* Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource
* Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTagTemplateField(DeleteTagTemplateFieldRequest request) {
deleteTagTemplateFieldCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a field in a tag template and all uses of that field. Users should enable the Data
* Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource
* Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more
* information).
*
* Sample code:
*
*
{@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 future =
* dataCatalogClient.deleteTagTemplateFieldCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable
deleteTagTemplateFieldCallable() {
return stub.deleteTagTemplateFieldCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry]. Note: The project
* identified by the `parent` parameter for the
* [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters)
* and the [tag
* template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters)
* used to create the tag must be from the same organization.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. The name of the resource to attach this tag to. Tags can be attached to
* Entries. Example:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
*
* Note that this Tag and its child resources may not actually be stored in the location in
* this name.
* @param tag Required. The tag to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Tag createTag(EntryName parent, Tag tag) {
CreateTagRequest request =
CreateTagRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setTag(tag)
.build();
return createTag(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry]. Note: The project
* identified by the `parent` parameter for the
* [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters)
* and the [tag
* template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters)
* used to create the tag must be from the same organization.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param parent Required. The name of the resource to attach this tag to. Tags can be attached to
* Entries. Example:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
*
* Note that this Tag and its child resources may not actually be stored in the location in
* this name.
* @param tag Required. The tag to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Tag createTag(String parent, Tag tag) {
CreateTagRequest request = CreateTagRequest.newBuilder().setParent(parent).setTag(tag).build();
return createTag(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry]. Note: The project
* identified by the `parent` parameter for the
* [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters)
* and the [tag
* template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters)
* used to create the tag must be from the same organization.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Tag createTag(CreateTagRequest request) {
return createTagCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry]. Note: The project
* identified by the `parent` parameter for the
* [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters)
* and the [tag
* template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters)
* used to create the tag must be from the same organization.
*
* Sample code:
*
*
{@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 future = dataCatalogClient.createTagCallable().futureCall(request);
* // Do something.
* Tag response = future.get();
* }
* }
*/
public final UnaryCallable createTagCallable() {
return stub.createTagCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing tag.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param tag Required. The updated tag. The "name" field must be set.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Tag updateTag(Tag tag) {
UpdateTagRequest request = UpdateTagRequest.newBuilder().setTag(tag).build();
return updateTag(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing tag.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param tag Required. The updated tag. The "name" field must be set.
* @param updateMask Note: Currently, this parameter can only take `"fields"` as value.
* 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.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Tag updateTag(Tag tag, FieldMask updateMask) {
UpdateTagRequest request =
UpdateTagRequest.newBuilder().setTag(tag).setUpdateMask(updateMask).build();
return updateTag(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing tag.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Tag updateTag(UpdateTagRequest request) {
return updateTagCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an existing tag.
*
* Sample code:
*
*
{@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 future = dataCatalogClient.updateTagCallable().futureCall(request);
* // Do something.
* Tag response = future.get();
* }
* }
*/
public final UnaryCallable updateTagCallable() {
return stub.updateTagCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a tag.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag to delete. Example:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTag(EntryName name) {
DeleteTagRequest request =
DeleteTagRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteTag(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a tag.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param name Required. The name of the tag to delete. Example:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTag(String name) {
DeleteTagRequest request = DeleteTagRequest.newBuilder().setName(name).build();
deleteTag(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a tag.
*
* Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTag(DeleteTagRequest request) {
deleteTagCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a tag.
*
* Sample code:
*
*
{@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 future = dataCatalogClient.deleteTagCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteTagCallable() {
return stub.deleteTagCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists tags assigned to an [Entry][google.cloud.datacatalog.v1beta1.Entry]. The
* [columns][google.cloud.datacatalog.v1beta1.Tag.column] in the response are lowercased.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param parent Required. The name of the Data Catalog resource to list the tags of. The resource
* could be an [Entry][google.cloud.datacatalog.v1beta1.Entry] or an
* [EntryGroup][google.cloud.datacatalog.v1beta1.EntryGroup].
* Examples:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
*
- projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTagsPagedResponse listTags(EntryName parent) {
ListTagsRequest request =
ListTagsRequest.newBuilder().setParent(parent == null ? null : parent.toString()).build();
return listTags(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists tags assigned to an [Entry][google.cloud.datacatalog.v1beta1.Entry]. The
* [columns][google.cloud.datacatalog.v1beta1.Tag.column] in the response are lowercased.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param parent Required. The name of the Data Catalog resource to list the tags of. The resource
* could be an [Entry][google.cloud.datacatalog.v1beta1.Entry] or an
* [EntryGroup][google.cloud.datacatalog.v1beta1.EntryGroup].
* Examples:
*
* - projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}
*
- projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
*
*
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTagsPagedResponse listTags(String parent) {
ListTagsRequest request = ListTagsRequest.newBuilder().setParent(parent).build();
return listTags(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists tags assigned to an [Entry][google.cloud.datacatalog.v1beta1.Entry]. The
* [columns][google.cloud.datacatalog.v1beta1.Tag.column] in the response are lowercased.
*
* Sample code:
*
*
{@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);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTagsPagedResponse listTags(ListTagsRequest request) {
return listTagsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists tags assigned to an [Entry][google.cloud.datacatalog.v1beta1.Entry]. The
* [columns][google.cloud.datacatalog.v1beta1.Tag.column] in the response are lowercased.
*
* Sample code:
*
*
{@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 future = dataCatalogClient.listTagsPagedCallable().futureCall(request);
* // Do something.
* for (Tag element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable listTagsPagedCallable() {
return stub.listTagsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists tags assigned to an [Entry][google.cloud.datacatalog.v1beta1.Entry]. The
* [columns][google.cloud.datacatalog.v1beta1.Tag.column] in the response are lowercased.
*
* Sample code:
*
*
{@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 UnaryCallable listTagsCallable() {
return stub.listTagsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy for a resource. Replaces any existing policy. Supported
* resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to
* manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced
* to Data Catalog.
*
* Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy`
* to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on
* entries. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @param 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.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(ResourceName resource, Policy policy) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.setPolicy(policy)
.build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy for a resource. Replaces any existing policy. Supported
* resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to
* manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced
* to Data Catalog.
*
* Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy`
* to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on
* entries. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @param 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.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(String resource, Policy policy) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder().setResource(resource).setPolicy(policy).build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy for a resource. Replaces any existing policy. Supported
* resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to
* manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced
* to Data Catalog.
*
* Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy`
* to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on
* entries. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(SetIamPolicyRequest request) {
return setIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy for a resource. Replaces any existing policy. Supported
* resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to
* manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced
* to Data Catalog.
*
* Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy`
* to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on
* entries. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.
*
*
Sample code:
*
*
{@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 future = dataCatalogClient.setIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }
*/
public final UnaryCallable setIamPolicyCallable() {
return stub.setIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource
* does not exist. An empty policy is returned if the resource exists but does not have a policy
* set on it.
*
* Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method
* cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform
* resources synced to Data Catalog.
*
*
Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy`
* to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on
* entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(ResourceName resource) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource
* does not exist. An empty policy is returned if the resource exists but does not have a policy
* set on it.
*
* Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method
* cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform
* resources synced to Data Catalog.
*
*
Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy`
* to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on
* entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(String resource) {
GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder().setResource(resource).build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource
* does not exist. An empty policy is returned if the resource exists but does not have a policy
* set on it.
*
* Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method
* cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform
* resources synced to Data Catalog.
*
*
Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy`
* to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on
* entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
*
*
Sample code:
*
*
{@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);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(GetIamPolicyRequest request) {
return getIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource
* does not exist. An empty policy is returned if the resource exists but does not have a policy
* set on it.
*
* Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method
* cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform
* resources synced to Data Catalog.
*
*
Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy`
* to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on
* entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.
*
*
Sample code:
*
*
{@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 future = dataCatalogClient.getIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }
*/
public final UnaryCallable getIamPolicyCallable() {
return stub.getIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the caller's permissions on a resource. If the resource does not exist, an empty set of
* permissions is returned (We don't return a `NOT_FOUND` error).
*
* Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method
* cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform
* resources synced to Data Catalog.
*
*
A caller is not required to have Google IAM permission to make this request.
*
*
Sample code:
*
*
{@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())
* .build();
* TestIamPermissionsResponse response = dataCatalogClient.testIamPermissions(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
return testIamPermissionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the caller's permissions on a resource. If the resource does not exist, an empty set of
* permissions is returned (We don't return a `NOT_FOUND` error).
*
* Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method
* cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform
* resources synced to Data Catalog.
*
*
A caller is not required to have Google IAM permission to make this request.
*
*
Sample code:
*
*
{@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())
* .build();
* ApiFuture future =
* dataCatalogClient.testIamPermissionsCallable().futureCall(request);
* // Do something.
* TestIamPermissionsResponse response = future.get();
* }
* }
*/
public final UnaryCallable
testIamPermissionsCallable() {
return stub.testIamPermissionsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class SearchCatalogPagedResponse
extends AbstractPagedListResponse<
SearchCatalogRequest,
SearchCatalogResponse,
SearchCatalogResult,
SearchCatalogPage,
SearchCatalogFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
SearchCatalogPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new SearchCatalogPagedResponse(input),
MoreExecutors.directExecutor());
}
private SearchCatalogPagedResponse(SearchCatalogPage page) {
super(page, SearchCatalogFixedSizeCollection.createEmptyCollection());
}
}
public static class SearchCatalogPage
extends AbstractPage<
SearchCatalogRequest, SearchCatalogResponse, SearchCatalogResult, SearchCatalogPage> {
private SearchCatalogPage(
PageContext context,
SearchCatalogResponse response) {
super(context, response);
}
private static SearchCatalogPage createEmptyPage() {
return new SearchCatalogPage(null, null);
}
@Override
protected SearchCatalogPage createPage(
PageContext context,
SearchCatalogResponse response) {
return new SearchCatalogPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class SearchCatalogFixedSizeCollection
extends AbstractFixedSizeCollection<
SearchCatalogRequest,
SearchCatalogResponse,
SearchCatalogResult,
SearchCatalogPage,
SearchCatalogFixedSizeCollection> {
private SearchCatalogFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static SearchCatalogFixedSizeCollection createEmptyCollection() {
return new SearchCatalogFixedSizeCollection(null, 0);
}
@Override
protected SearchCatalogFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new SearchCatalogFixedSizeCollection(pages, collectionSize);
}
}
public static class ListEntryGroupsPagedResponse
extends AbstractPagedListResponse<
ListEntryGroupsRequest,
ListEntryGroupsResponse,
EntryGroup,
ListEntryGroupsPage,
ListEntryGroupsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListEntryGroupsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListEntryGroupsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListEntryGroupsPagedResponse(ListEntryGroupsPage page) {
super(page, ListEntryGroupsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListEntryGroupsPage
extends AbstractPage<
ListEntryGroupsRequest, ListEntryGroupsResponse, EntryGroup, ListEntryGroupsPage> {
private ListEntryGroupsPage(
PageContext context,
ListEntryGroupsResponse response) {
super(context, response);
}
private static ListEntryGroupsPage createEmptyPage() {
return new ListEntryGroupsPage(null, null);
}
@Override
protected ListEntryGroupsPage createPage(
PageContext context,
ListEntryGroupsResponse response) {
return new ListEntryGroupsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListEntryGroupsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListEntryGroupsRequest,
ListEntryGroupsResponse,
EntryGroup,
ListEntryGroupsPage,
ListEntryGroupsFixedSizeCollection> {
private ListEntryGroupsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListEntryGroupsFixedSizeCollection createEmptyCollection() {
return new ListEntryGroupsFixedSizeCollection(null, 0);
}
@Override
protected ListEntryGroupsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListEntryGroupsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListEntriesPagedResponse
extends AbstractPagedListResponse<
ListEntriesRequest,
ListEntriesResponse,
Entry,
ListEntriesPage,
ListEntriesFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListEntriesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage, input -> new ListEntriesPagedResponse(input), MoreExecutors.directExecutor());
}
private ListEntriesPagedResponse(ListEntriesPage page) {
super(page, ListEntriesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListEntriesPage
extends AbstractPage {
private ListEntriesPage(
PageContext context,
ListEntriesResponse response) {
super(context, response);
}
private static ListEntriesPage createEmptyPage() {
return new ListEntriesPage(null, null);
}
@Override
protected ListEntriesPage createPage(
PageContext context,
ListEntriesResponse response) {
return new ListEntriesPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListEntriesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListEntriesRequest,
ListEntriesResponse,
Entry,
ListEntriesPage,
ListEntriesFixedSizeCollection> {
private ListEntriesFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListEntriesFixedSizeCollection createEmptyCollection() {
return new ListEntriesFixedSizeCollection(null, 0);
}
@Override
protected ListEntriesFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListEntriesFixedSizeCollection(pages, collectionSize);
}
}
public static class ListTagsPagedResponse
extends AbstractPagedListResponse<
ListTagsRequest, ListTagsResponse, Tag, ListTagsPage, ListTagsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListTagsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage, input -> new ListTagsPagedResponse(input), MoreExecutors.directExecutor());
}
private ListTagsPagedResponse(ListTagsPage page) {
super(page, ListTagsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListTagsPage
extends AbstractPage {
private ListTagsPage(
PageContext context, ListTagsResponse response) {
super(context, response);
}
private static ListTagsPage createEmptyPage() {
return new ListTagsPage(null, null);
}
@Override
protected ListTagsPage createPage(
PageContext context, ListTagsResponse response) {
return new ListTagsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListTagsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListTagsRequest, ListTagsResponse, Tag, ListTagsPage, ListTagsFixedSizeCollection> {
private ListTagsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListTagsFixedSizeCollection createEmptyCollection() {
return new ListTagsFixedSizeCollection(null, 0);
}
@Override
protected ListTagsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListTagsFixedSizeCollection(pages, collectionSize);
}
}
}