DataCatalogClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.datacatalog.v1beta1.DataCatalogClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class DataCatalogClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: Data Catalog API service allows clients to discover, understand, and manage their data.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
```
 
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String entryGroupId = "";
   EntryGroup entryGroup = EntryGroup.newBuilder().build();
   EntryGroup response = dataCatalogClient.createEntryGroup(formattedParent, entryGroupId, entryGroup);
 }
 
 
```
Note: close() needs to be called on the dataCatalogClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DataCatalogSettings to create(). For example:
To customize credentials:
```
 
 DataCatalogSettings dataCatalogSettings =
     DataCatalogSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataCatalogClient dataCatalogClient =
     DataCatalogClient.create(dataCatalogSettings);
 
 
```
To customize the endpoint:
```
 
 DataCatalogSettings dataCatalogSettings =
     DataCatalogSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataCatalogClient dataCatalogClient =
     DataCatalogClient.create(dataCatalogSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataCatalogClient.ListTagsFixedSizeCollection`
`static class`	`DataCatalogClient.ListTagsPage`
`static class`	`DataCatalogClient.ListTagsPagedResponse`
`static class`	`DataCatalogClient.SearchCatalogFixedSizeCollection`
`static class`	`DataCatalogClient.SearchCatalogPage`
`static class`	`DataCatalogClient.SearchCatalogPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DataCatalogClient(DataCatalogSettings settings)` Constructs an instance of DataCatalogClient, using the given settings.
`protected`	`DataCatalogClient(DataCatalogStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static DataCatalogClient`	`create()` Constructs an instance of DataCatalogClient with default settings.
`static DataCatalogClient`	`create(DataCatalogSettings settings)` Constructs an instance of DataCatalogClient, using the given settings.
`static DataCatalogClient`	`create(DataCatalogStub stub)` Constructs an instance of DataCatalogClient, using the given stub for making calls.
`Entry`	`createEntry(CreateEntryRequest request)` Alpha feature.
`Entry`	`createEntry(String parent, String entryId, Entry entry)` Alpha feature.
`com.google.api.gax.rpc.UnaryCallable<CreateEntryRequest,Entry>`	`createEntryCallable()` Alpha feature.
`EntryGroup`	`createEntryGroup(CreateEntryGroupRequest request)` Alpha feature.
`EntryGroup`	`createEntryGroup(String parent, String entryGroupId, EntryGroup entryGroup)` Alpha feature.
`com.google.api.gax.rpc.UnaryCallable<CreateEntryGroupRequest,EntryGroup>`	`createEntryGroupCallable()` Alpha feature.
`Tag`	`createTag(CreateTagRequest request)` Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
`Tag`	`createTag(String parent, Tag tag)` Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
`com.google.api.gax.rpc.UnaryCallable<CreateTagRequest,Tag>`	`createTagCallable()` Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
`TagTemplate`	`createTagTemplate(CreateTagTemplateRequest request)` Creates a tag template.
`TagTemplate`	`createTagTemplate(String parent, String tagTemplateId, TagTemplate tagTemplate)` Creates a tag template.
`com.google.api.gax.rpc.UnaryCallable<CreateTagTemplateRequest,TagTemplate>`	`createTagTemplateCallable()` Creates a tag template.
`TagTemplateField`	`createTagTemplateField(CreateTagTemplateFieldRequest request)` Creates a field in a tag template.
`TagTemplateField`	`createTagTemplateField(String parent, String tagTemplateFieldId, TagTemplateField tagTemplateField)` Creates a field in a tag template.
`com.google.api.gax.rpc.UnaryCallable<CreateTagTemplateFieldRequest,TagTemplateField>`	`createTagTemplateFieldCallable()` Creates a field in a tag template.
`void`	`deleteEntry(DeleteEntryRequest request)` Alpha feature.
`void`	`deleteEntry(String name)` Alpha feature.
`com.google.api.gax.rpc.UnaryCallable<DeleteEntryRequest,Empty>`	`deleteEntryCallable()` Alpha feature.
`void`	`deleteEntryGroup(DeleteEntryGroupRequest request)` Alpha feature.
`void`	`deleteEntryGroup(String name)` Alpha feature.
`com.google.api.gax.rpc.UnaryCallable<DeleteEntryGroupRequest,Empty>`	`deleteEntryGroupCallable()` Alpha feature.
`void`	`deleteTag(DeleteTagRequest request)` Deletes a tag.
`void`	`deleteTag(String name)` Deletes a tag.
`com.google.api.gax.rpc.UnaryCallable<DeleteTagRequest,Empty>`	`deleteTagCallable()` Deletes a tag.
`void`	`deleteTagTemplate(DeleteTagTemplateRequest request)` Deletes a tag template and all tags using the template.
`void`	`deleteTagTemplate(String name, boolean force)` Deletes a tag template and all tags using the template.
`com.google.api.gax.rpc.UnaryCallable<DeleteTagTemplateRequest,Empty>`	`deleteTagTemplateCallable()` Deletes a tag template and all tags using the template.
`void`	`deleteTagTemplateField(DeleteTagTemplateFieldRequest request)` Deletes a field in a tag template and all uses of that field.
`void`	`deleteTagTemplateField(String name, boolean force)` Deletes a field in a tag template and all uses of that field.
`com.google.api.gax.rpc.UnaryCallable<DeleteTagTemplateFieldRequest,Empty>`	`deleteTagTemplateFieldCallable()` Deletes a field in a tag template and all uses of that field.
`static String`	`formatEntryGroupName(String project, String location, String entryGroup)` Deprecated. Use the `EntryGroupName` class instead.
`static String`	`formatEntryName(String project, String location, String entryGroup, String entry)` Deprecated. Use the `EntryName` class instead.
`static String`	`formatFieldName(String project, String location, String tagTemplate, String field)` Deprecated. Use the `FieldName` class instead.
`static String`	`formatLocationName(String project, String location)` Deprecated. Use the `LocationName` class instead.
`static String`	`formatTagName(String project, String location, String entryGroup, String entry, String tag)` Deprecated. Use the `TagName` class instead.
`static String`	`formatTagTemplateName(String project, String location, String tagTemplate)` Deprecated. Use the `TagTemplateName` class instead.
`Entry`	`getEntry(GetEntryRequest request)` Gets an entry.
`Entry`	`getEntry(String name)` Gets an entry.
`com.google.api.gax.rpc.UnaryCallable<GetEntryRequest,Entry>`	`getEntryCallable()` Gets an entry.
`EntryGroup`	`getEntryGroup(GetEntryGroupRequest request)` Alpha feature.
`EntryGroup`	`getEntryGroup(String name, FieldMask readMask)` Alpha feature.
`com.google.api.gax.rpc.UnaryCallable<GetEntryGroupRequest,EntryGroup>`	`getEntryGroupCallable()` Alpha feature.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`com.google.iam.v1.Policy`	`getIamPolicy(String resource)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`DataCatalogSettings`	`getSettings()`
`DataCatalogStub`	`getStub()`
`TagTemplate`	`getTagTemplate(GetTagTemplateRequest request)` Gets a tag template.
`TagTemplate`	`getTagTemplate(String name)` Gets a tag template.
`com.google.api.gax.rpc.UnaryCallable<GetTagTemplateRequest,TagTemplate>`	`getTagTemplateCallable()` Gets a tag template.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`DataCatalogClient.ListTagsPagedResponse`	`listTags(ListTagsRequest request)` Lists the tags on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
`DataCatalogClient.ListTagsPagedResponse`	`listTags(String parent)` Lists the tags on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
`com.google.api.gax.rpc.UnaryCallable<ListTagsRequest,ListTagsResponse>`	`listTagsCallable()` Lists the tags on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
`com.google.api.gax.rpc.UnaryCallable<ListTagsRequest,DataCatalogClient.ListTagsPagedResponse>`	`listTagsPagedCallable()` Lists the tags on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
`Entry`	`lookupEntry(LookupEntryRequest request)` Get an entry by target resource name.
`com.google.api.gax.rpc.UnaryCallable<LookupEntryRequest,Entry>`	`lookupEntryCallable()` Get an entry by target resource name.
`static String`	`parseEntryFromEntryName(String entryName)` Deprecated. Use the `EntryName` class instead.
`static String`	`parseEntryFromTagName(String tagName)` Deprecated. Use the `TagName` class instead.
`static String`	`parseEntryGroupFromEntryGroupName(String entryGroupName)` Deprecated. Use the `EntryGroupName` class instead.
`static String`	`parseEntryGroupFromEntryName(String entryName)` Deprecated. Use the `EntryName` class instead.
`static String`	`parseEntryGroupFromTagName(String tagName)` Deprecated. Use the `TagName` class instead.
`static String`	`parseFieldFromFieldName(String fieldName)` Deprecated. Use the `FieldName` class instead.
`static String`	`parseLocationFromEntryGroupName(String entryGroupName)` Deprecated. Use the `EntryGroupName` class instead.
`static String`	`parseLocationFromEntryName(String entryName)` Deprecated. Use the `EntryName` class instead.
`static String`	`parseLocationFromFieldName(String fieldName)` Deprecated. Use the `FieldName` class instead.
`static String`	`parseLocationFromLocationName(String locationName)` Deprecated. Use the `LocationName` class instead.
`static String`	`parseLocationFromTagName(String tagName)` Deprecated. Use the `TagName` class instead.
`static String`	`parseLocationFromTagTemplateName(String tagTemplateName)` Deprecated. Use the `TagTemplateName` class instead.
`static String`	`parseProjectFromEntryGroupName(String entryGroupName)` Deprecated. Use the `EntryGroupName` class instead.
`static String`	`parseProjectFromEntryName(String entryName)` Deprecated. Use the `EntryName` class instead.
`static String`	`parseProjectFromFieldName(String fieldName)` Deprecated. Use the `FieldName` class instead.
`static String`	`parseProjectFromLocationName(String locationName)` Deprecated. Use the `LocationName` class instead.
`static String`	`parseProjectFromTagName(String tagName)` Deprecated. Use the `TagName` class instead.
`static String`	`parseProjectFromTagTemplateName(String tagTemplateName)` Deprecated. Use the `TagTemplateName` class instead.
`static String`	`parseTagFromTagName(String tagName)` Deprecated. Use the `TagName` class instead.
`static String`	`parseTagTemplateFromFieldName(String fieldName)` Deprecated. Use the `FieldName` class instead.
`static String`	`parseTagTemplateFromTagTemplateName(String tagTemplateName)` Deprecated. Use the `TagTemplateName` class instead.
`TagTemplateField`	`renameTagTemplateField(RenameTagTemplateFieldRequest request)` Renames a field in a tag template.
`TagTemplateField`	`renameTagTemplateField(String name, String newTagTemplateFieldId)` Renames a field in a tag template.
`com.google.api.gax.rpc.UnaryCallable<RenameTagTemplateFieldRequest,TagTemplateField>`	`renameTagTemplateFieldCallable()` Renames a field in a tag template.
`DataCatalogClient.SearchCatalogPagedResponse`	`searchCatalog(SearchCatalogRequest.Scope scope, String query, String orderBy)` Searches Data Catalog for multiple resources like entries, tags that match a query.
`DataCatalogClient.SearchCatalogPagedResponse`	`searchCatalog(SearchCatalogRequest request)` Searches Data Catalog for multiple resources like entries, tags that match a query.
`com.google.api.gax.rpc.UnaryCallable<SearchCatalogRequest,SearchCatalogResponse>`	`searchCatalogCallable()` Searches Data Catalog for multiple resources like entries, tags that match a query.
`com.google.api.gax.rpc.UnaryCallable<SearchCatalogRequest,DataCatalogClient.SearchCatalogPagedResponse>`	`searchCatalogPagedCallable()` Searches Data Catalog for multiple resources like entries, tags that match a query.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy for a resource.
`com.google.iam.v1.Policy`	`setIamPolicy(String resource, com.google.iam.v1.Policy policy)` Sets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy for a resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(String resource, List<String> permissions)` Returns the caller's permissions on a resource.
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns the caller's permissions on a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns the caller's permissions on a resource.
`Entry`	`updateEntry(Entry entry, FieldMask updateMask)` Updates an existing entry.
`Entry`	`updateEntry(UpdateEntryRequest request)` Updates an existing entry.
`com.google.api.gax.rpc.UnaryCallable<UpdateEntryRequest,Entry>`	`updateEntryCallable()` Updates an existing entry.
`Tag`	`updateTag(Tag tag, FieldMask updateMask)` Updates an existing tag.
`Tag`	`updateTag(UpdateTagRequest request)` Updates an existing tag.
`com.google.api.gax.rpc.UnaryCallable<UpdateTagRequest,Tag>`	`updateTagCallable()` Updates an existing tag.
`TagTemplate`	`updateTagTemplate(TagTemplate tagTemplate, FieldMask updateMask)` Updates a tag template.
`TagTemplate`	`updateTagTemplate(UpdateTagTemplateRequest request)` Updates a tag template.
`com.google.api.gax.rpc.UnaryCallable<UpdateTagTemplateRequest,TagTemplate>`	`updateTagTemplateCallable()` Updates a tag template.
`TagTemplateField`	`updateTagTemplateField(String name, TagTemplateField tagTemplateField, FieldMask updateMask)` Updates a field in a tag template.
`TagTemplateField`	`updateTagTemplateField(UpdateTagTemplateFieldRequest request)` Updates a field in a tag template.
`com.google.api.gax.rpc.UnaryCallable<UpdateTagTemplateFieldRequest,TagTemplateField>`	`updateTagTemplateFieldCallable()` Updates a field in a tag template.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DataCatalogClient
```
protected DataCatalogClient(DataCatalogSettings settings)
                     throws IOException
```
  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.
  
  Throws:
  
  IOException
- DataCatalogClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected DataCatalogClient(DataCatalogStub stub)
```

Method Detail

formatEntryName

@Deprecated
public static final String formatEntryName(String project,
                                                       String location,
                                                       String entryGroup,
                                                       String entry)

Deprecated. Use the EntryName class instead.

Formats a string containing the fully-qualified path to represent a entry resource.

formatEntryGroupName

@Deprecated
public static final String formatEntryGroupName(String project,
                                                            String location,
                                                            String entryGroup)

Deprecated. Use the EntryGroupName class instead.

Formats a string containing the fully-qualified path to represent a entry_group resource.

formatFieldName

@Deprecated
public static final String formatFieldName(String project,
                                                       String location,
                                                       String tagTemplate,
                                                       String field)

Deprecated. Use the FieldName class instead.

Formats a string containing the fully-qualified path to represent a field resource.

formatLocationName

@Deprecated
public static final String formatLocationName(String project,
                                                          String location)

Deprecated. Use the LocationName class instead.

Formats a string containing the fully-qualified path to represent a location resource.

formatTagName

@Deprecated
public static final String formatTagName(String project,
                                                     String location,
                                                     String entryGroup,
                                                     String entry,
                                                     String tag)

Deprecated. Use the TagName class instead.

Formats a string containing the fully-qualified path to represent a tag resource.

formatTagTemplateName

@Deprecated
public static final String formatTagTemplateName(String project,
                                                             String location,
                                                             String tagTemplate)

Deprecated. Use the TagTemplateName class instead.

Formats a string containing the fully-qualified path to represent a tag_template resource.

parseProjectFromEntryName
```
@Deprecated
public static final String parseProjectFromEntryName(String entryName)
```
Deprecated. Use the EntryName class instead.

Parses the project from the given fully-qualified path which represents a entry resource.

parseLocationFromEntryName
```
@Deprecated
public static final String parseLocationFromEntryName(String entryName)
```
Deprecated. Use the EntryName class instead.

Parses the location from the given fully-qualified path which represents a entry resource.

parseEntryGroupFromEntryName
```
@Deprecated
public static final String parseEntryGroupFromEntryName(String entryName)
```
Deprecated. Use the EntryName class instead.

Parses the entry_group from the given fully-qualified path which represents a entry resource.

parseEntryFromEntryName
```
@Deprecated
public static final String parseEntryFromEntryName(String entryName)
```
Deprecated. Use the EntryName class instead.

Parses the entry from the given fully-qualified path which represents a entry resource.

parseProjectFromEntryGroupName
```
@Deprecated
public static final String parseProjectFromEntryGroupName(String entryGroupName)
```
Deprecated. Use the EntryGroupName class instead.

Parses the project from the given fully-qualified path which represents a entry_group resource.

parseLocationFromEntryGroupName
```
@Deprecated
public static final String parseLocationFromEntryGroupName(String entryGroupName)
```
Deprecated. Use the EntryGroupName class instead.

Parses the location from the given fully-qualified path which represents a entry_group resource.

parseEntryGroupFromEntryGroupName
```
@Deprecated
public static final String parseEntryGroupFromEntryGroupName(String entryGroupName)
```
Deprecated. Use the EntryGroupName class instead.

Parses the entry_group from the given fully-qualified path which represents a entry_group resource.

parseProjectFromFieldName
```
@Deprecated
public static final String parseProjectFromFieldName(String fieldName)
```
Deprecated. Use the FieldName class instead.

Parses the project from the given fully-qualified path which represents a field resource.

parseLocationFromFieldName
```
@Deprecated
public static final String parseLocationFromFieldName(String fieldName)
```
Deprecated. Use the FieldName class instead.

Parses the location from the given fully-qualified path which represents a field resource.

parseTagTemplateFromFieldName
```
@Deprecated
public static final String parseTagTemplateFromFieldName(String fieldName)
```
Deprecated. Use the FieldName class instead.

Parses the tag_template from the given fully-qualified path which represents a field resource.

parseFieldFromFieldName
```
@Deprecated
public static final String parseFieldFromFieldName(String fieldName)
```
Deprecated. Use the FieldName class instead.

Parses the field from the given fully-qualified path which represents a field resource.

parseProjectFromLocationName
```
@Deprecated
public static final String parseProjectFromLocationName(String locationName)
```
Deprecated. Use the LocationName class instead.

Parses the project from the given fully-qualified path which represents a location resource.

parseLocationFromLocationName
```
@Deprecated
public static final String parseLocationFromLocationName(String locationName)
```
Deprecated. Use the LocationName class instead.

Parses the location from the given fully-qualified path which represents a location resource.

parseProjectFromTagName
```
@Deprecated
public static final String parseProjectFromTagName(String tagName)
```
Deprecated. Use the TagName class instead.

Parses the project from the given fully-qualified path which represents a tag resource.

parseLocationFromTagName
```
@Deprecated
public static final String parseLocationFromTagName(String tagName)
```
Deprecated. Use the TagName class instead.

Parses the location from the given fully-qualified path which represents a tag resource.

parseEntryGroupFromTagName
```
@Deprecated
public static final String parseEntryGroupFromTagName(String tagName)
```
Deprecated. Use the TagName class instead.

Parses the entry_group from the given fully-qualified path which represents a tag resource.

parseEntryFromTagName
```
@Deprecated
public static final String parseEntryFromTagName(String tagName)
```
Deprecated. Use the TagName class instead.

Parses the entry from the given fully-qualified path which represents a tag resource.

parseTagFromTagName
```
@Deprecated
public static final String parseTagFromTagName(String tagName)
```
Deprecated. Use the TagName class instead.

Parses the tag from the given fully-qualified path which represents a tag resource.

parseProjectFromTagTemplateName
```
@Deprecated
public static final String parseProjectFromTagTemplateName(String tagTemplateName)
```
Deprecated. Use the TagTemplateName class instead.

Parses the project from the given fully-qualified path which represents a tag_template resource.

parseLocationFromTagTemplateName
```
@Deprecated
public static final String parseLocationFromTagTemplateName(String tagTemplateName)
```
Deprecated. Use the TagTemplateName class instead.

Parses the location from the given fully-qualified path which represents a tag_template resource.

parseTagTemplateFromTagTemplateName
```
@Deprecated
public static final String parseTagTemplateFromTagTemplateName(String tagTemplateName)
```
Deprecated. Use the TagTemplateName class instead.

Parses the tag_template from the given fully-qualified path which represents a tag_template resource.

create

public static final DataCatalogClient create()
                                      throws IOException

Constructs an instance of DataCatalogClient with default settings.

Throws:: IOException

create
```
public static final DataCatalogClient create(DataCatalogSettings settings)
                                      throws IOException
```
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.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final DataCatalogClient create(DataCatalogStub stub)

Constructs an instance of DataCatalogClient, using the given stub for making calls. This is for advanced usage - prefer to use DataCatalogSettings}.

getSettings

public final DataCatalogSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public DataCatalogStub getStub()

searchCatalog
```
public final DataCatalogClient.SearchCatalogPagedResponse searchCatalog(SearchCatalogRequest.Scope scope,
                                                                        String query,
                                                                        String orderBy)
```
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 subsequentally call `Get` methods.
Note that searches do not have full recall. There may be results that match your query but are not returned, even in subsequent pages of results. These missing results may vary across repeated calls to search. Do not rely on this method if you need to guarantee full recall.
See [Data Catalog Search Syntax](/data-catalog/docs/how-to/search-reference) for more information.
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   SearchCatalogRequest.Scope scope = SearchCatalogRequest.Scope.newBuilder().build();
   String query = "";
   String orderBy = "";
   for (SearchCatalogResult element : dataCatalogClient.searchCatalog(scope, query, orderBy).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:

scope - Required. The scope of this search request.

query - Required. The query string in search query syntax. The query must be non-empty.
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](/data-catalog/docs/how-to/search-reference) for more information.

orderBy - Specifies the ordering of results, currently supported case-sensitive choices are:
* `relevance`, only supports desecending * `last_access_timestamp [asc|desc]`, defaults to descending if not specified * `last_modified_timestamp [asc|desc]`, defaults to descending if not specified
If not specified, defaults to `relevance` descending.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

searchCatalog
```
public final DataCatalogClient.SearchCatalogPagedResponse searchCatalog(SearchCatalogRequest request)
```
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 subsequentally call `Get` methods.
Note that searches do not have full recall. There may be results that match your query but are not returned, even in subsequent pages of results. These missing results may vary across repeated calls to search. Do not rely on this method if you need to guarantee full recall.
See [Data Catalog Search Syntax](/data-catalog/docs/how-to/search-reference) for more information.
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   SearchCatalogRequest.Scope scope = SearchCatalogRequest.Scope.newBuilder().build();
   String query = "";
   String orderBy = "";
   SearchCatalogRequest request = SearchCatalogRequest.newBuilder()
     .setScope(scope)
     .setQuery(query)
     .setOrderBy(orderBy)
     .build();
   for (SearchCatalogResult element : dataCatalogClient.searchCatalog(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:

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

searchCatalogPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<SearchCatalogRequest,DataCatalogClient.SearchCatalogPagedResponse> searchCatalogPagedCallable()

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 subsequentally call `Get` methods.

Note that searches do not have full recall. There may be results that match your query but are not returned, even in subsequent pages of results. These missing results may vary across repeated calls to search. Do not rely on this method if you need to guarantee full recall.

See [Data Catalog Search Syntax](/data-catalog/docs/how-to/search-reference) for more information.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   SearchCatalogRequest.Scope scope = SearchCatalogRequest.Scope.newBuilder().build();
   String query = "";
   String orderBy = "";
   SearchCatalogRequest request = SearchCatalogRequest.newBuilder()
     .setScope(scope)
     .setQuery(query)
     .setOrderBy(orderBy)
     .build();
   ApiFuture<SearchCatalogPagedResponse> future = dataCatalogClient.searchCatalogPagedCallable().futureCall(request);
   // Do something
   for (SearchCatalogResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

searchCatalogCallable

public final com.google.api.gax.rpc.UnaryCallable<SearchCatalogRequest,SearchCatalogResponse> searchCatalogCallable()

Searches Data Catalog for multiple resources like entries, tags that match a query.

See [Data Catalog Search Syntax](/data-catalog/docs/how-to/search-reference) for more information.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   SearchCatalogRequest.Scope scope = SearchCatalogRequest.Scope.newBuilder().build();
   String query = "";
   String orderBy = "";
   SearchCatalogRequest request = SearchCatalogRequest.newBuilder()
     .setScope(scope)
     .setQuery(query)
     .setOrderBy(orderBy)
     .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;
     }
   }
 }

createEntryGroup
```
public final EntryGroup createEntryGroup(String parent,
                                         String entryGroupId,
                                         EntryGroup entryGroup)
```
Alpha feature. Creates an EntryGroup. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String entryGroupId = "";
   EntryGroup entryGroup = EntryGroup.newBuilder().build();
   EntryGroup response = dataCatalogClient.createEntryGroup(formattedParent, entryGroupId, entryGroup);
 }
 
```
Parameters:

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.

entryGroupId - Required. The id of the entry group to create.

entryGroup - Optional. The entry group to create. Defaults to an empty entry group.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntryGroup

public final EntryGroup createEntryGroup(CreateEntryGroupRequest request)

Alpha feature. Creates an EntryGroup. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String entryGroupId = "";
   EntryGroup entryGroup = EntryGroup.newBuilder().build();
   CreateEntryGroupRequest request = CreateEntryGroupRequest.newBuilder()
     .setParent(formattedParent)
     .setEntryGroupId(entryGroupId)
     .setEntryGroup(entryGroup)
     .build();
   EntryGroup response = dataCatalogClient.createEntryGroup(request);
 }

Parameters:: 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

createEntryGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateEntryGroupRequest,EntryGroup> createEntryGroupCallable()

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String entryGroupId = "";
   EntryGroup entryGroup = EntryGroup.newBuilder().build();
   CreateEntryGroupRequest request = CreateEntryGroupRequest.newBuilder()
     .setParent(formattedParent)
     .setEntryGroupId(entryGroupId)
     .setEntryGroup(entryGroup)
     .build();
   ApiFuture<EntryGroup> future = dataCatalogClient.createEntryGroupCallable().futureCall(request);
   // Do something
   EntryGroup response = future.get();
 }

getEntryGroup

public final EntryGroup getEntryGroup(String name,
                                      FieldMask readMask)

Alpha feature. Gets an EntryGroup.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatEntryGroupName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   FieldMask readMask = FieldMask.newBuilder().build();
   EntryGroup response = dataCatalogClient.getEntryGroup(formattedName, readMask);
 }

Parameters:: name - Required. The name of the entry group. For example, `projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}`.; readMask - Optional. 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

getEntryGroup

public final EntryGroup getEntryGroup(GetEntryGroupRequest request)

Alpha feature. Gets an EntryGroup.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatEntryGroupName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   GetEntryGroupRequest request = GetEntryGroupRequest.newBuilder()
     .setName(formattedName)
     .build();
   EntryGroup response = dataCatalogClient.getEntryGroup(request);
 }

Parameters:: 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

getEntryGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<GetEntryGroupRequest,EntryGroup> getEntryGroupCallable()

Alpha feature. Gets an EntryGroup.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatEntryGroupName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   GetEntryGroupRequest request = GetEntryGroupRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<EntryGroup> future = dataCatalogClient.getEntryGroupCallable().futureCall(request);
   // Do something
   EntryGroup response = future.get();
 }

deleteEntryGroup
```
public final void deleteEntryGroup(String name)
```
Alpha feature. Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatEntryGroupName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   dataCatalogClient.deleteEntryGroup(formattedName);
 }
 
```
Parameters:

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

deleteEntryGroup
```
public final void deleteEntryGroup(DeleteEntryGroupRequest request)
```
Alpha feature. Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatEntryGroupName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   DeleteEntryGroupRequest request = DeleteEntryGroupRequest.newBuilder()
     .setName(formattedName)
     .build();
   dataCatalogClient.deleteEntryGroup(request);
 }
 
```
Parameters:

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

deleteEntryGroupCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteEntryGroupRequest,Empty> deleteEntryGroupCallable()

Alpha feature. Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatEntryGroupName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   DeleteEntryGroupRequest request = DeleteEntryGroupRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Void> future = dataCatalogClient.deleteEntryGroupCallable().futureCall(request);
   // Do something
   future.get();
 }

createEntry
```
public final Entry createEntry(String parent,
                               String entryId,
                               Entry entry)
```
Alpha feature. Creates an entry. Currently only entries of 'FILESET' type can be created. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatEntryGroupName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   String entryId = "";
   Entry entry = Entry.newBuilder().build();
   Entry response = dataCatalogClient.createEntry(formattedParent, entryId, entry);
 }
 
```
Parameters:

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.

entryId - Required. The id of the entry to create.

entry - Required. The entry to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntry

public final Entry createEntry(CreateEntryRequest request)

Alpha feature. Creates an entry. Currently only entries of 'FILESET' type can be created. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatEntryGroupName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   String entryId = "";
   Entry entry = Entry.newBuilder().build();
   CreateEntryRequest request = CreateEntryRequest.newBuilder()
     .setParent(formattedParent)
     .setEntryId(entryId)
     .setEntry(entry)
     .build();
   Entry response = dataCatalogClient.createEntry(request);
 }

Parameters:: 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

createEntryCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateEntryRequest,Entry> createEntryCallable()

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatEntryGroupName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
   String entryId = "";
   Entry entry = Entry.newBuilder().build();
   CreateEntryRequest request = CreateEntryRequest.newBuilder()
     .setParent(formattedParent)
     .setEntryId(entryId)
     .setEntry(entry)
     .build();
   ApiFuture<Entry> future = dataCatalogClient.createEntryCallable().futureCall(request);
   // Do something
   Entry response = future.get();
 }

updateEntry
```
public final Entry updateEntry(Entry entry,
                               FieldMask updateMask)
```
Updates an existing entry. The user should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   Entry entry = Entry.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Entry response = dataCatalogClient.updateEntry(entry, updateMask);
 }
 
```
Parameters:

entry - Required. The updated entry.

updateMask - Optional. The fields to update on the entry. If absent or empty, all modifiable fields are updated.
Currently only `schema` field in Cloud Pub/Sub topic entries is modifiable.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateEntry
```
public final Entry updateEntry(UpdateEntryRequest request)
```
Updates an existing entry. The user should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   Entry entry = Entry.newBuilder().build();
   UpdateEntryRequest request = UpdateEntryRequest.newBuilder()
     .setEntry(entry)
     .build();
   Entry response = dataCatalogClient.updateEntry(request);
 }
 
```
Parameters:

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

updateEntryCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateEntryRequest,Entry> updateEntryCallable()

Updates an existing entry. The user should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   Entry entry = Entry.newBuilder().build();
   UpdateEntryRequest request = UpdateEntryRequest.newBuilder()
     .setEntry(entry)
     .build();
   ApiFuture<Entry> future = dataCatalogClient.updateEntryCallable().futureCall(request);
   // Do something
   Entry response = future.get();
 }

deleteEntry
```
public final void deleteEntry(String name)
```
Alpha feature. Deletes an existing entry. Only entries created through [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry] method can be deleted. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   dataCatalogClient.deleteEntry(formattedName);
 }
 
```
Parameters:

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

deleteEntry
```
public final void deleteEntry(DeleteEntryRequest request)
```
Alpha feature. Deletes an existing entry. Only entries created through [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry] method can be deleted. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   DeleteEntryRequest request = DeleteEntryRequest.newBuilder()
     .setName(formattedName)
     .build();
   dataCatalogClient.deleteEntry(request);
 }
 
```
Parameters:

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

deleteEntryCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteEntryRequest,Empty> deleteEntryCallable()

Alpha feature. Deletes an existing entry. Only entries created through [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry] method can be deleted. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   DeleteEntryRequest request = DeleteEntryRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Void> future = dataCatalogClient.deleteEntryCallable().futureCall(request);
   // Do something
   future.get();
 }

getEntry
```
public final Entry getEntry(String name)
```
Gets an entry.
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   Entry response = dataCatalogClient.getEntry(formattedName);
 }
 
```
Parameters:

name - Required. The name of the entry. Example:
* projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}
Entry groups are logical groupings of entries. Currently, users cannot create/modify entry groups. They are created by Data Catalog; they include `@bigquery` for all BigQuery entries, and `@pubsub` for all Cloud Pub/Sub entries.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntry

public final Entry getEntry(GetEntryRequest request)

Gets an entry.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   GetEntryRequest request = GetEntryRequest.newBuilder()
     .setName(formattedName)
     .build();
   Entry response = dataCatalogClient.getEntry(request);
 }

Parameters:: 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

getEntryCallable

public final com.google.api.gax.rpc.UnaryCallable<GetEntryRequest,Entry> getEntryCallable()

Gets an entry.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   GetEntryRequest request = GetEntryRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Entry> future = dataCatalogClient.getEntryCallable().futureCall(request);
   // Do something
   Entry response = future.get();
 }

lookupEntry
```
public final Entry lookupEntry(LookupEntryRequest request)
```
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:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   LookupEntryRequest request = LookupEntryRequest.newBuilder().build();
   Entry response = dataCatalogClient.lookupEntry(request);
 }
 
```
Parameters:

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

lookupEntryCallable

public final com.google.api.gax.rpc.UnaryCallable<LookupEntryRequest,Entry> lookupEntryCallable()

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:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   LookupEntryRequest request = LookupEntryRequest.newBuilder().build();
   ApiFuture<Entry> future = dataCatalogClient.lookupEntryCallable().futureCall(request);
   // Do something
   Entry response = future.get();
 }

createTagTemplate
```
public final TagTemplate createTagTemplate(String parent,
                                           String tagTemplateId,
                                           TagTemplate tagTemplate)
```
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](/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String tagTemplateId = "";
   TagTemplate tagTemplate = TagTemplate.newBuilder().build();
   TagTemplate response = dataCatalogClient.createTagTemplate(formattedParent, tagTemplateId, tagTemplate);
 }
 
```
Parameters:

parent - Required. The name of the project and the location this template is in. Example:
* projects/{project_id}/locations/{location}
TagTemplate and its child resources may not actually be stored in the location in this name.

tagTemplateId - Required. The id of the tag template to create.

tagTemplate - Required. The tag template to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTagTemplate

public final TagTemplate createTagTemplate(CreateTagTemplateRequest request)

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](/data-catalog/docs/concepts/resource-project) for more information).

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String tagTemplateId = "";
   TagTemplate tagTemplate = TagTemplate.newBuilder().build();
   CreateTagTemplateRequest request = CreateTagTemplateRequest.newBuilder()
     .setParent(formattedParent)
     .setTagTemplateId(tagTemplateId)
     .setTagTemplate(tagTemplate)
     .build();
   TagTemplate response = dataCatalogClient.createTagTemplate(request);
 }

Parameters:: 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

createTagTemplateCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateTagTemplateRequest,TagTemplate> createTagTemplateCallable()

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatLocationName("[PROJECT]", "[LOCATION]");
   String tagTemplateId = "";
   TagTemplate tagTemplate = TagTemplate.newBuilder().build();
   CreateTagTemplateRequest request = CreateTagTemplateRequest.newBuilder()
     .setParent(formattedParent)
     .setTagTemplateId(tagTemplateId)
     .setTagTemplate(tagTemplate)
     .build();
   ApiFuture<TagTemplate> future = dataCatalogClient.createTagTemplateCallable().futureCall(request);
   // Do something
   TagTemplate response = future.get();
 }

getTagTemplate

public final TagTemplate getTagTemplate(String name)

Gets a tag template.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   TagTemplate response = dataCatalogClient.getTagTemplate(formattedName);
 }

Parameters:: 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

getTagTemplate

public final TagTemplate getTagTemplate(GetTagTemplateRequest request)

Gets a tag template.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   GetTagTemplateRequest request = GetTagTemplateRequest.newBuilder()
     .setName(formattedName)
     .build();
   TagTemplate response = dataCatalogClient.getTagTemplate(request);
 }

Parameters:: 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

getTagTemplateCallable

public final com.google.api.gax.rpc.UnaryCallable<GetTagTemplateRequest,TagTemplate> getTagTemplateCallable()

Gets a tag template.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   GetTagTemplateRequest request = GetTagTemplateRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<TagTemplate> future = dataCatalogClient.getTagTemplateCallable().futureCall(request);
   // Do something
   TagTemplate response = future.get();
 }

updateTagTemplate
```
public final TagTemplate updateTagTemplate(TagTemplate tagTemplate,
                                           FieldMask updateMask)
```
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. The user should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   TagTemplate tagTemplate = TagTemplate.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   TagTemplate response = dataCatalogClient.updateTagTemplate(tagTemplate, updateMask);
 }
 
```
Parameters:

tagTemplate - Required. The template to update.

updateMask - Optional. The field mask specifies the parts of the template to overwrite.
Allowed fields:
* `display_name`
If absent or empty, all of the allowed fields above will be updated.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateTagTemplate
```
public final TagTemplate updateTagTemplate(UpdateTagTemplateRequest request)
```
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. The user should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   TagTemplate tagTemplate = TagTemplate.newBuilder().build();
   UpdateTagTemplateRequest request = UpdateTagTemplateRequest.newBuilder()
     .setTagTemplate(tagTemplate)
     .build();
   TagTemplate response = dataCatalogClient.updateTagTemplate(request);
 }
 
```
Parameters:

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

updateTagTemplateCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateTagTemplateRequest,TagTemplate> updateTagTemplateCallable()

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. The user should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   TagTemplate tagTemplate = TagTemplate.newBuilder().build();
   UpdateTagTemplateRequest request = UpdateTagTemplateRequest.newBuilder()
     .setTagTemplate(tagTemplate)
     .build();
   ApiFuture<TagTemplate> future = dataCatalogClient.updateTagTemplateCallable().futureCall(request);
   // Do something
   TagTemplate response = future.get();
 }

deleteTagTemplate
```
public final void deleteTagTemplate(String name,
                                    boolean force)
```
Deletes a tag template and all tags using the template. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   boolean force = false;
   dataCatalogClient.deleteTagTemplate(formattedName, force);
 }
 
```
Parameters:

name - Required. The name of the tag template to delete. Example:
* projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

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

deleteTagTemplate

public final void deleteTagTemplate(DeleteTagTemplateRequest request)

Deletes a tag template and all tags using the template. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   boolean force = false;
   DeleteTagTemplateRequest request = DeleteTagTemplateRequest.newBuilder()
     .setName(formattedName)
     .setForce(force)
     .build();
   dataCatalogClient.deleteTagTemplate(request);
 }

Parameters:: 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

deleteTagTemplateCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteTagTemplateRequest,Empty> deleteTagTemplateCallable()

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   boolean force = false;
   DeleteTagTemplateRequest request = DeleteTagTemplateRequest.newBuilder()
     .setName(formattedName)
     .setForce(force)
     .build();
   ApiFuture<Void> future = dataCatalogClient.deleteTagTemplateCallable().futureCall(request);
   // Do something
   future.get();
 }

createTagTemplateField
```
public final TagTemplateField createTagTemplateField(String parent,
                                                     String tagTemplateFieldId,
                                                     TagTemplateField tagTemplateField)
```
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](/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   String tagTemplateFieldId = "";
   TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
   TagTemplateField response = dataCatalogClient.createTagTemplateField(formattedParent, tagTemplateFieldId, tagTemplateField);
 }
 
```
Parameters:

parent - Required. The name of the project this template is in. Example:
* projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
Note that this TagTemplateField may not actually be stored in the location in this name.

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.

tagTemplateField - Required. The tag template field to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTagTemplateField

public final TagTemplateField createTagTemplateField(CreateTagTemplateFieldRequest request)

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](/data-catalog/docs/concepts/resource-project) for more information).

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   String tagTemplateFieldId = "";
   TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
   CreateTagTemplateFieldRequest request = CreateTagTemplateFieldRequest.newBuilder()
     .setParent(formattedParent)
     .setTagTemplateFieldId(tagTemplateFieldId)
     .setTagTemplateField(tagTemplateField)
     .build();
   TagTemplateField response = dataCatalogClient.createTagTemplateField(request);
 }

Parameters:: 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

createTagTemplateFieldCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateTagTemplateFieldRequest,TagTemplateField> createTagTemplateFieldCallable()

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   String tagTemplateFieldId = "";
   TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
   CreateTagTemplateFieldRequest request = CreateTagTemplateFieldRequest.newBuilder()
     .setParent(formattedParent)
     .setTagTemplateFieldId(tagTemplateFieldId)
     .setTagTemplateField(tagTemplateField)
     .build();
   ApiFuture<TagTemplateField> future = dataCatalogClient.createTagTemplateFieldCallable().futureCall(request);
   // Do something
   TagTemplateField response = future.get();
 }

updateTagTemplateField
```
public final TagTemplateField updateTagTemplateField(String name,
                                                     TagTemplateField tagTemplateField,
                                                     FieldMask updateMask)
```
Updates a field in a tag template. This method cannot be used to update the field type. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatFieldName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
   TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   TagTemplateField response = dataCatalogClient.updateTagTemplateField(formattedName, tagTemplateField, updateMask);
 }
 
```
Parameters:

name - Required. The name of the tag template field. Example:
* projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}

tagTemplateField - Required. The template to update.

updateMask - Optional. The field mask specifies the parts of the template to be updated. Allowed fields:
* `display_name` * `type.enum_type`
If `update_mask` is not set or empty, all of the allowed fields above will be updated.
When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateTagTemplateField

public final TagTemplateField updateTagTemplateField(UpdateTagTemplateFieldRequest request)

Updates a field in a tag template. This method cannot be used to update the field type. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatFieldName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
   TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
   UpdateTagTemplateFieldRequest request = UpdateTagTemplateFieldRequest.newBuilder()
     .setName(formattedName)
     .setTagTemplateField(tagTemplateField)
     .build();
   TagTemplateField response = dataCatalogClient.updateTagTemplateField(request);
 }

Parameters:: 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

updateTagTemplateFieldCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateTagTemplateFieldRequest,TagTemplateField> updateTagTemplateFieldCallable()

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatFieldName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
   TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
   UpdateTagTemplateFieldRequest request = UpdateTagTemplateFieldRequest.newBuilder()
     .setName(formattedName)
     .setTagTemplateField(tagTemplateField)
     .build();
   ApiFuture<TagTemplateField> future = dataCatalogClient.updateTagTemplateFieldCallable().futureCall(request);
   // Do something
   TagTemplateField response = future.get();
 }

renameTagTemplateField
```
public final TagTemplateField renameTagTemplateField(String name,
                                                     String newTagTemplateFieldId)
```
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](/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatFieldName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
   String newTagTemplateFieldId = "";
   TagTemplateField response = dataCatalogClient.renameTagTemplateField(formattedName, newTagTemplateFieldId);
 }
 
```
Parameters:

name - Required. The name of the tag template. Example:
* projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}

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

renameTagTemplateField

public final TagTemplateField renameTagTemplateField(RenameTagTemplateFieldRequest request)

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](/data-catalog/docs/concepts/resource-project) for more information).

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatFieldName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
   String newTagTemplateFieldId = "";
   RenameTagTemplateFieldRequest request = RenameTagTemplateFieldRequest.newBuilder()
     .setName(formattedName)
     .setNewTagTemplateFieldId(newTagTemplateFieldId)
     .build();
   TagTemplateField response = dataCatalogClient.renameTagTemplateField(request);
 }

Parameters:: 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

renameTagTemplateFieldCallable

public final com.google.api.gax.rpc.UnaryCallable<RenameTagTemplateFieldRequest,TagTemplateField> renameTagTemplateFieldCallable()

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatFieldName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
   String newTagTemplateFieldId = "";
   RenameTagTemplateFieldRequest request = RenameTagTemplateFieldRequest.newBuilder()
     .setName(formattedName)
     .setNewTagTemplateFieldId(newTagTemplateFieldId)
     .build();
   ApiFuture<TagTemplateField> future = dataCatalogClient.renameTagTemplateFieldCallable().futureCall(request);
   // Do something
   TagTemplateField response = future.get();
 }

deleteTagTemplateField
```
public final void deleteTagTemplateField(String name,
                                         boolean force)
```
Deletes a field in a tag template and all uses of that field. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatFieldName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
   boolean force = false;
   dataCatalogClient.deleteTagTemplateField(formattedName, force);
 }
 
```
Parameters:

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}

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

deleteTagTemplateField

public final void deleteTagTemplateField(DeleteTagTemplateFieldRequest request)

Deletes a field in a tag template and all uses of that field. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information).

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatFieldName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
   boolean force = false;
   DeleteTagTemplateFieldRequest request = DeleteTagTemplateFieldRequest.newBuilder()
     .setName(formattedName)
     .setForce(force)
     .build();
   dataCatalogClient.deleteTagTemplateField(request);
 }

Parameters:: 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

deleteTagTemplateFieldCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteTagTemplateFieldRequest,Empty> deleteTagTemplateFieldCallable()

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatFieldName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
   boolean force = false;
   DeleteTagTemplateFieldRequest request = DeleteTagTemplateFieldRequest.newBuilder()
     .setName(formattedName)
     .setForce(force)
     .build();
   ApiFuture<Void> future = dataCatalogClient.deleteTagTemplateFieldCallable().futureCall(request);
   // Do something
   future.get();
 }

createTag
```
public final Tag createTag(String parent,
                           Tag tag)
```
Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry]. Note: The project identified by the `parent` parameter for the [tag](/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](/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:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   Tag tag = Tag.newBuilder().build();
   Tag response = dataCatalogClient.createTag(formattedParent, tag);
 }
 
```
Parameters:

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.

tag - Required. The tag to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTag
```
public final Tag createTag(CreateTagRequest request)
```
Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry]. Note: The project identified by the `parent` parameter for the [tag](/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](/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:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   Tag tag = Tag.newBuilder().build();
   CreateTagRequest request = CreateTagRequest.newBuilder()
     .setParent(formattedParent)
     .setTag(tag)
     .build();
   Tag response = dataCatalogClient.createTag(request);
 }
 
```
Parameters:

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

createTagCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateTagRequest,Tag> createTagCallable()

Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry]. Note: The project identified by the `parent` parameter for the [tag](/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](/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:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   Tag tag = Tag.newBuilder().build();
   CreateTagRequest request = CreateTagRequest.newBuilder()
     .setParent(formattedParent)
     .setTag(tag)
     .build();
   ApiFuture<Tag> future = dataCatalogClient.createTagCallable().futureCall(request);
   // Do something
   Tag response = future.get();
 }

updateTag

public final Tag updateTag(Tag tag,
                           FieldMask updateMask)

Updates an existing tag.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   Tag tag = Tag.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Tag response = dataCatalogClient.updateTag(tag, updateMask);
 }

Parameters:: tag - Required. The updated tag.; updateMask - Optional. The fields to update on the Tag. If absent or empty, all modifiable fields are updated. Currently the only modifiable field is the field `fields`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateTag

public final Tag updateTag(UpdateTagRequest request)

Updates an existing tag.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   Tag tag = Tag.newBuilder().build();
   UpdateTagRequest request = UpdateTagRequest.newBuilder()
     .setTag(tag)
     .build();
   Tag response = dataCatalogClient.updateTag(request);
 }

Parameters:: 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

updateTagCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateTagRequest,Tag> updateTagCallable()

Updates an existing tag.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   Tag tag = Tag.newBuilder().build();
   UpdateTagRequest request = UpdateTagRequest.newBuilder()
     .setTag(tag)
     .build();
   ApiFuture<Tag> future = dataCatalogClient.updateTagCallable().futureCall(request);
   // Do something
   Tag response = future.get();
 }

deleteTag

public final void deleteTag(String name)

Deletes a tag.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatTagName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]");
   dataCatalogClient.deleteTag(formattedName);
 }

Parameters:: 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

deleteTag

public final void deleteTag(DeleteTagRequest request)

Deletes a tag.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatTagName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]");
   DeleteTagRequest request = DeleteTagRequest.newBuilder()
     .setName(formattedName)
     .build();
   dataCatalogClient.deleteTag(request);
 }

Parameters:: 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

deleteTagCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteTagRequest,Empty> deleteTagCallable()

Deletes a tag.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedName = DataCatalogClient.formatTagName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]");
   DeleteTagRequest request = DeleteTagRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Void> future = dataCatalogClient.deleteTagCallable().futureCall(request);
   // Do something
   future.get();
 }

listTags

public final DataCatalogClient.ListTagsPagedResponse listTags(String parent)

Lists the tags on an [Entry][google.cloud.datacatalog.v1beta1.Entry].

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   for (Tag element : dataCatalogClient.listTags(formattedParent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: 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].
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listTags

public final DataCatalogClient.ListTagsPagedResponse listTags(ListTagsRequest request)

Lists the tags on an [Entry][google.cloud.datacatalog.v1beta1.Entry].

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   ListTagsRequest request = ListTagsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   for (Tag element : dataCatalogClient.listTags(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: 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

listTagsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTagsRequest,DataCatalogClient.ListTagsPagedResponse> listTagsPagedCallable()

Lists the tags on an [Entry][google.cloud.datacatalog.v1beta1.Entry].

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   ListTagsRequest request = ListTagsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ApiFuture<ListTagsPagedResponse> future = dataCatalogClient.listTagsPagedCallable().futureCall(request);
   // Do something
   for (Tag element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listTagsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTagsRequest,ListTagsResponse> listTagsCallable()

Lists the tags on an [Entry][google.cloud.datacatalog.v1beta1.Entry].

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedParent = DataCatalogClient.formatEntryName("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
   ListTagsRequest request = ListTagsRequest.newBuilder()
     .setParent(formattedParent)
     .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;
     }
   }
 }

setIamPolicy
```
public final com.google.iam.v1.Policy setIamPolicy(String resource,
                                                   com.google.iam.v1.Policy policy)
```
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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud 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:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedResource = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   Policy policy = Policy.newBuilder().build();
   Policy response = dataCatalogClient.setIamPolicy(formattedResource, policy);
 }
 
```
Parameters:

resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy - REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

setIamPolicy
```
public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
```
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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud 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:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedResource = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   Policy policy = Policy.newBuilder().build();
   SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder()
     .setResource(formattedResource)
     .setPolicy(policy)
     .build();
   Policy response = dataCatalogClient.setIamPolicy(request);
 }
 
```
Parameters:

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

setIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()

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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud 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:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedResource = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   Policy policy = Policy.newBuilder().build();
   SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder()
     .setResource(formattedResource)
     .setPolicy(policy)
     .build();
   ApiFuture<Policy> future = dataCatalogClient.setIamPolicyCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }

getIamPolicy
```
public final com.google.iam.v1.Policy getIamPolicy(String resource)
```
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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud 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:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedResource = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   Policy response = dataCatalogClient.getIamPolicy(formattedResource);
 }
 
```
Parameters:

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

getIamPolicy
```
public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
```
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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud 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:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedResource = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder()
     .setResource(formattedResource)
     .build();
   Policy response = dataCatalogClient.getIamPolicy(request);
 }
 
```
Parameters:

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

getIamPolicyCallable
```
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()
```
Gets the access control policy for a resource. 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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud 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:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedResource = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder()
     .setResource(formattedResource)
     .build();
   ApiFuture<Policy> future = dataCatalogClient.getIamPolicyCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 
```

testIamPermissions
```
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(String resource,
                                                                             List<String> permissions)
```
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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.
A caller is not required to have Google IAM permission to make this request.
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedResource = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsResponse response = dataCatalogClient.testIamPermissions(formattedResource, permissions);
 }
 
```
Parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissions - The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

testIamPermissions
```
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
```
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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.
A caller is not required to have Google IAM permission to make this request.
Sample code:
```
 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedResource = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder()
     .setResource(formattedResource)
     .addAllPermissions(permissions)
     .build();
   TestIamPermissionsResponse response = dataCatalogClient.testIamPermissions(request);
 }
 
```
Parameters:

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

testIamPermissionsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()

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, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog.

A caller is not required to have Google IAM permission to make this request.

Sample code:


 try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
   String formattedResource = DataCatalogClient.formatTagTemplateName("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
   List<String> permissions = new ArrayList<>();
   TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder()
     .setResource(formattedResource)
     .addAllPermissions(permissions)
     .build();
   ApiFuture<TestIamPermissionsResponse> future = dataCatalogClient.testIamPermissionsCallable().futureCall(request);
   // Do something
   TestIamPermissionsResponse response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class DataCatalogClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataCatalogClient

DataCatalogClient

Method Detail

formatEntryName

formatEntryGroupName

formatFieldName

formatLocationName

formatTagName

formatTagTemplateName

parseProjectFromEntryName

parseLocationFromEntryName

parseEntryGroupFromEntryName

parseEntryFromEntryName

parseProjectFromEntryGroupName

parseLocationFromEntryGroupName

parseEntryGroupFromEntryGroupName

parseProjectFromFieldName

parseLocationFromFieldName

parseTagTemplateFromFieldName

parseFieldFromFieldName

parseProjectFromLocationName

parseLocationFromLocationName

parseProjectFromTagName

parseLocationFromTagName

parseEntryGroupFromTagName

parseEntryFromTagName

parseTagFromTagName

parseProjectFromTagTemplateName

parseLocationFromTagTemplateName

parseTagTemplateFromTagTemplateName

create

create

create

getSettings

getStub

searchCatalog

searchCatalog

searchCatalogPagedCallable

searchCatalogCallable

createEntryGroup

createEntryGroup

createEntryGroupCallable

getEntryGroup

getEntryGroup

getEntryGroupCallable

deleteEntryGroup

deleteEntryGroup

deleteEntryGroupCallable

createEntry

createEntry

createEntryCallable

updateEntry

updateEntry

updateEntryCallable

deleteEntry

deleteEntry

deleteEntryCallable

getEntry

getEntry

getEntryCallable

lookupEntry

lookupEntryCallable

createTagTemplate

createTagTemplate

createTagTemplateCallable

getTagTemplate

getTagTemplate

getTagTemplateCallable

updateTagTemplate

updateTagTemplate

updateTagTemplateCallable

deleteTagTemplate

deleteTagTemplate

deleteTagTemplateCallable