This class provides the ability to make remote calls to the backing service through method + * calls that map to API methods. Sample code to get started: + * + *
+ *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ * String entryGroupId = "";
+ * EntryGroup entryGroup = EntryGroup.newBuilder().build();
+ * EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
+ * }
+ *
+ *
+ *
+ * Note: close() needs to be called on the dataCatalogClient object to clean up resources such as + * threads. In the example above, try-with-resources is used, which automatically calls close(). + * + *
The surface of this class includes several types of Java methods for each of the API's + * methods: + * + *
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);
+ *
+ *
+ */
+@Generated("by gapic-generator")
+@BetaApi
+public class DataCatalogClient implements BackgroundResource {
+ private final DataCatalogSettings settings;
+ private final DataCatalogStub stub;
+
+ /** Constructs an instance of DataCatalogClient with default settings. */
+ public static final DataCatalogClient create() throws IOException {
+ return create(DataCatalogSettings.newBuilder().build());
+ }
+
+ /**
+ * Constructs an instance of DataCatalogClient, using the given settings. The channels are created
+ * based on the settings passed in, or defaults for any settings that are not set.
+ */
+ public static final DataCatalogClient create(DataCatalogSettings settings) throws IOException {
+ return new DataCatalogClient(settings);
+ }
+
+ /**
+ * Constructs an instance of DataCatalogClient, using the given stub for making calls. This is for
+ * advanced usage - prefer to use DataCatalogSettings}.
+ */
+ @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
+ public static final DataCatalogClient create(DataCatalogStub stub) {
+ return new DataCatalogClient(stub);
+ }
+
+ /**
+ * Constructs an instance of DataCatalogClient, using the given settings. This is protected so
+ * that it is easy to make a subclass, but otherwise, the static factory methods should be
+ * preferred.
+ */
+ protected DataCatalogClient(DataCatalogSettings settings) throws IOException {
+ this.settings = settings;
+ this.stub = ((DataCatalogStubSettings) settings.getStubSettings()).createStub();
+ }
+
+ @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
+ protected DataCatalogClient(DataCatalogStub stub) {
+ this.settings = null;
+ this.stub = stub;
+ }
+
+ public final DataCatalogSettings getSettings() {
+ return settings;
+ }
+
+ @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
+ public DataCatalogStub getStub() {
+ return stub;
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD
+ /**
+ * Searches Data Catalog for multiple resources like entries, tags that match a query.
+ *
+ * This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not + * return the complete resource, only the resource identifier and high level fields. Clients can + * subsequentally call `Get` methods. + * + *
Note that Data Catalog search queries do not guarantee full recall. Query results that match + * your query may not be returned, even in subsequent result pages. Also note that results + * returned (and not returned) can vary across repeated search queries. + * + *
See [Data Catalog Search Syntax](/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 = "";
+ * for (SearchCatalogResult element : dataCatalogClient.searchCatalog(scope, query).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * 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. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final SearchCatalogPagedResponse searchCatalog( + SearchCatalogRequest.Scope scope, String query) { + SearchCatalogRequest request = + SearchCatalogRequest.newBuilder().setScope(scope).setQuery(query).build(); + return searchCatalog(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Searches Data Catalog for multiple resources like entries, tags that match a query. + * + *
This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not + * return the complete resource, only the resource identifier and high level fields. Clients can + * subsequentally call `Get` methods. + * + *
Note that Data Catalog search queries do not guarantee full recall. Query results that match + * your query may not be returned, even in subsequent result pages. Also note that results + * returned (and not returned) can vary across repeated search queries. + * + *
See [Data Catalog Search Syntax](/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 = "";
+ * SearchCatalogRequest request = SearchCatalogRequest.newBuilder()
+ * .setScope(scope)
+ * .setQuery(query)
+ * .build();
+ * for (SearchCatalogResult element : dataCatalogClient.searchCatalog(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * 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 Data Catalog search queries do not guarantee full recall. Query results that match + * your query may not be returned, even in subsequent result pages. Also note that results + * returned (and not returned) can vary across repeated search queries. + * + *
See [Data Catalog Search Syntax](/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 = "";
+ * SearchCatalogRequest request = SearchCatalogRequest.newBuilder()
+ * .setScope(scope)
+ * .setQuery(query)
+ * .build();
+ * ApiFuture<SearchCatalogPagedResponse> future = dataCatalogClient.searchCatalogPagedCallable().futureCall(request);
+ * // Do something
+ * for (SearchCatalogResult element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * 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 Data Catalog search queries do not guarantee full recall. Query results that match + * your query may not be returned, even in subsequent result pages. Also note that results + * returned (and not returned) can vary across repeated search queries. + * + *
See [Data Catalog Search Syntax](/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 = "";
+ * SearchCatalogRequest request = SearchCatalogRequest.newBuilder()
+ * .setScope(scope)
+ * .setQuery(query)
+ * .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;
+ * }
+ * }
+ * }
+ * An entry group contains logically related entries together with Cloud Identity and Access + * Management policies that specify the users who can create, edit, and view entries within the + * entry group. + * + *
Data Catalog automatically creates an entry group for BigQuery entries + * ("{@literal @}bigquery") and Pub/Sub topics ("{@literal @}pubsub"). Users create their own + * entry group to contain Cloud Storage fileset entries or custom type entries, and the IAM + * policies associated with those entries. Entry groups, like entries, can be searched. + * + *
A maximum of 10,000 entry groups may be created per organization across all locations. + * + *
Users should enable the Data Catalog API in the project identified by the `parent` parameter + * (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more + * information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ * String entryGroupId = "";
+ * EntryGroup entryGroup = EntryGroup.newBuilder().build();
+ * EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
+ * }
+ * * projects/{project_id}/locations/{location} + *
Note that this EntryGroup and its child resources may not actually be stored in the + * location in this name. + * @param entryGroupId Required. The id of the entry group to create. The id must begin with a + * letter or underscore, contain only English letters, numbers and underscores, and be at most + * 64 characters. + * @param entryGroup The entry group to create. Defaults to an empty entry group. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final EntryGroup createEntryGroup( + LocationName parent, String entryGroupId, EntryGroup entryGroup) { + CreateEntryGroupRequest request = + CreateEntryGroupRequest.newBuilder() + .setParent(parent == null ? null : parent.toString()) + .setEntryGroupId(entryGroupId) + .setEntryGroup(entryGroup) + .build(); + return createEntryGroup(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Creates an EntryGroup. + * + *
An entry group contains logically related entries together with Cloud Identity and Access + * Management policies that specify the users who can create, edit, and view entries within the + * entry group. + * + *
Data Catalog automatically creates an entry group for BigQuery entries + * ("{@literal @}bigquery") and Pub/Sub topics ("{@literal @}pubsub"). Users create their own + * entry group to contain Cloud Storage fileset entries or custom type entries, and the IAM + * policies associated with those entries. Entry groups, like entries, can be searched. + * + *
A maximum of 10,000 entry groups may be created per organization across all locations. + * + *
Users should enable the Data Catalog API in the project identified by the `parent` parameter + * (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more + * information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ * String entryGroupId = "";
+ * EntryGroup entryGroup = EntryGroup.newBuilder().build();
+ * EntryGroup response = dataCatalogClient.createEntryGroup(parent.toString(), entryGroupId, entryGroup);
+ * }
+ * * projects/{project_id}/locations/{location} + *
Note that this EntryGroup and its child resources may not actually be stored in the + * location in this name. + * @param entryGroupId Required. The id of the entry group to create. The id must begin with a + * letter or underscore, contain only English letters, numbers and underscores, and be at most + * 64 characters. + * @param entryGroup The entry group to create. Defaults to an empty entry group. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final EntryGroup createEntryGroup( + String parent, String entryGroupId, EntryGroup entryGroup) { + CreateEntryGroupRequest request = + CreateEntryGroupRequest.newBuilder() + .setParent(parent) + .setEntryGroupId(entryGroupId) + .setEntryGroup(entryGroup) + .build(); + return createEntryGroup(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Creates an EntryGroup. + * + *
An entry group contains logically related entries together with Cloud Identity and Access + * Management policies that specify the users who can create, edit, and view entries within the + * entry group. + * + *
Data Catalog automatically creates an entry group for BigQuery entries + * ("{@literal @}bigquery") and Pub/Sub topics ("{@literal @}pubsub"). Users create their own + * entry group to contain Cloud Storage fileset entries or custom type entries, and the IAM + * policies associated with those entries. Entry groups, like entries, can be searched. + * + *
A maximum of 10,000 entry groups may be created per organization across all locations. + * + *
Users should enable the Data Catalog API in the project identified by the `parent` parameter + * (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more + * information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ * String entryGroupId = "";
+ * CreateEntryGroupRequest request = CreateEntryGroupRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .setEntryGroupId(entryGroupId)
+ * .build();
+ * EntryGroup response = dataCatalogClient.createEntryGroup(request);
+ * }
+ * An entry group contains logically related entries together with Cloud Identity and Access + * Management policies that specify the users who can create, edit, and view entries within the + * entry group. + * + *
Data Catalog automatically creates an entry group for BigQuery entries + * ("{@literal @}bigquery") and Pub/Sub topics ("{@literal @}pubsub"). Users create their own + * entry group to contain Cloud Storage fileset entries or custom type entries, and the IAM + * policies associated with those entries. Entry groups, like entries, can be searched. + * + *
A maximum of 10,000 entry groups may be created per organization across all locations. + * + *
Users should enable the Data Catalog API in the project identified by the `parent` parameter + * (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more + * information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ * String entryGroupId = "";
+ * CreateEntryGroupRequest request = CreateEntryGroupRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .setEntryGroupId(entryGroupId)
+ * .build();
+ * ApiFuture<EntryGroup> future = dataCatalogClient.createEntryGroupCallable().futureCall(request);
+ * // Do something
+ * EntryGroup response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * EntryGroup response = dataCatalogClient.getEntryGroup(name);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * EntryGroup response = dataCatalogClient.getEntryGroup(name.toString());
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * FieldMask readMask = FieldMask.newBuilder().build();
+ * EntryGroup response = dataCatalogClient.getEntryGroup(name, readMask);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * FieldMask readMask = FieldMask.newBuilder().build();
+ * EntryGroup response = dataCatalogClient.getEntryGroup(name.toString(), readMask);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * GetEntryGroupRequest request = GetEntryGroupRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * EntryGroup response = dataCatalogClient.getEntryGroup(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * GetEntryGroupRequest request = GetEntryGroupRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * ApiFuture<EntryGroup> future = dataCatalogClient.getEntryGroupCallable().futureCall(request);
+ * // Do something
+ * EntryGroup response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroup entryGroup = EntryGroup.newBuilder().build();
+ * EntryGroup response = dataCatalogClient.updateEntryGroup(entryGroup);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroup entryGroup = EntryGroup.newBuilder().build();
+ * FieldMask updateMask = FieldMask.newBuilder().build();
+ * EntryGroup response = dataCatalogClient.updateEntryGroup(entryGroup, updateMask);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroup entryGroup = EntryGroup.newBuilder().build();
+ * UpdateEntryGroupRequest request = UpdateEntryGroupRequest.newBuilder()
+ * .setEntryGroup(entryGroup)
+ * .build();
+ * EntryGroup response = dataCatalogClient.updateEntryGroup(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroup entryGroup = EntryGroup.newBuilder().build();
+ * UpdateEntryGroupRequest request = UpdateEntryGroupRequest.newBuilder()
+ * .setEntryGroup(entryGroup)
+ * .build();
+ * ApiFuture<EntryGroup> future = dataCatalogClient.updateEntryGroupCallable().futureCall(request);
+ * // Do something
+ * EntryGroup response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * dataCatalogClient.deleteEntryGroup(name);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * dataCatalogClient.deleteEntryGroup(name.toString());
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * DeleteEntryGroupRequest request = DeleteEntryGroupRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * dataCatalogClient.deleteEntryGroup(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * DeleteEntryGroupRequest request = DeleteEntryGroupRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * ApiFuture<Void> future = dataCatalogClient.deleteEntryGroupCallable().futureCall(request);
+ * // Do something
+ * future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * for (EntryGroup element : dataCatalogClient.listEntryGroups(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * * projects/{project_id}/locations/{location} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final ListEntryGroupsPagedResponse listEntryGroups(EntryGroupName parent) { + ListEntryGroupsRequest request = + ListEntryGroupsRequest.newBuilder() + .setParent(parent == null ? null : parent.toString()) + .build(); + return listEntryGroups(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Lists entry groups. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * for (EntryGroup element : dataCatalogClient.listEntryGroups(parent.toString()).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * * projects/{project_id}/locations/{location} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final ListEntryGroupsPagedResponse listEntryGroups(String parent) { + ListEntryGroupsRequest request = ListEntryGroupsRequest.newBuilder().setParent(parent).build(); + return listEntryGroups(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Lists entry groups. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * ListEntryGroupsRequest request = ListEntryGroupsRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .build();
+ * for (EntryGroup element : dataCatalogClient.listEntryGroups(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * ListEntryGroupsRequest request = ListEntryGroupsRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .build();
+ * ApiFuture<ListEntryGroupsPagedResponse> future = dataCatalogClient.listEntryGroupsPagedCallable().futureCall(request);
+ * // Do something
+ * for (EntryGroup element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * ListEntryGroupsRequest request = ListEntryGroupsRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .build();
+ * while (true) {
+ * ListEntryGroupsResponse response = dataCatalogClient.listEntryGroupsCallable().call(request);
+ * for (EntryGroup element : response.getEntryGroupsList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * Users 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). + * + *
A maximum of 100,000 entries may be created per entry group. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * String entryId = "";
+ * Entry entry = Entry.newBuilder().build();
+ * Entry response = dataCatalogClient.createEntry(parent, entryId, entry);
+ * }
+ * * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} + *
Note that this Entry and its child resources may not actually be stored in the location + * in this name. + * @param entryId Required. The id of the entry to create. + * @param entry Required. The entry to create. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final Entry createEntry(EntryGroupName parent, String entryId, Entry entry) { + CreateEntryRequest request = + CreateEntryRequest.newBuilder() + .setParent(parent == null ? null : parent.toString()) + .setEntryId(entryId) + .setEntry(entry) + .build(); + return createEntry(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Creates an entry. Only entries of 'FILESET' type or user-specified type can be created. + * + *
Users should enable the Data Catalog API in the project identified by the `parent` parameter + * (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more + * information). + * + *
A maximum of 100,000 entries may be created per entry group. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * String entryId = "";
+ * Entry entry = Entry.newBuilder().build();
+ * Entry response = dataCatalogClient.createEntry(parent.toString(), entryId, entry);
+ * }
+ * * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} + *
Note that this Entry and its child resources may not actually be stored in the location + * in this name. + * @param entryId Required. The id of the entry to create. + * @param entry Required. The entry to create. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final Entry createEntry(String parent, String entryId, Entry entry) { + CreateEntryRequest request = + CreateEntryRequest.newBuilder() + .setParent(parent) + .setEntryId(entryId) + .setEntry(entry) + .build(); + return createEntry(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Creates an entry. Only entries of 'FILESET' type or user-specified type can be created. + * + *
Users should enable the Data Catalog API in the project identified by the `parent` parameter + * (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more + * information). + * + *
A maximum of 100,000 entries may be created per entry group. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * String entryId = "";
+ * Entry entry = Entry.newBuilder().build();
+ * CreateEntryRequest request = CreateEntryRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .setEntryId(entryId)
+ * .setEntry(entry)
+ * .build();
+ * Entry response = dataCatalogClient.createEntry(request);
+ * }
+ * Users 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). + * + *
A maximum of 100,000 entries may be created per entry group. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * String entryId = "";
+ * Entry entry = Entry.newBuilder().build();
+ * CreateEntryRequest request = CreateEntryRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .setEntryId(entryId)
+ * .setEntry(entry)
+ * .build();
+ * ApiFuture<Entry> future = dataCatalogClient.createEntryCallable().futureCall(request);
+ * // Do something
+ * Entry response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * Entry entry = Entry.newBuilder().build();
+ * Entry response = dataCatalogClient.updateEntry(entry);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * Entry entry = Entry.newBuilder().build();
+ * FieldMask updateMask = FieldMask.newBuilder().build();
+ * Entry response = dataCatalogClient.updateEntry(entry, updateMask);
+ * }
+ * The following fields are modifiable: * For entries with type `DATA_STREAM`: * + * `schema` * For entries with type `FILESET` * `schema` * `display_name` * + * `description` * `gcs_fileset_spec` * `gcs_fileset_spec.file_patterns` * For + * entries with `user_specified_type` * `schema` * `display_name` * `description` + * * user_specified_type * user_specified_system * linked_resource * + * source_system_timestamps + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final Entry updateEntry(Entry entry, FieldMask updateMask) { + UpdateEntryRequest request = + UpdateEntryRequest.newBuilder().setEntry(entry).setUpdateMask(updateMask).build(); + return updateEntry(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Updates an existing entry. Users should enable the Data Catalog API in the project identified + * by the `entry.name` parameter (see [Data Catalog Resource Project] + * (/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);
+ * }
+ * 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();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * dataCatalogClient.deleteEntry(name);
+ * }
+ * * + * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final void deleteEntry(EntryName name) { + DeleteEntryRequest request = + DeleteEntryRequest.newBuilder().setName(name == null ? null : name.toString()).build(); + deleteEntry(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Deletes an existing entry. Only entries created through + * [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method can be deleted. Users + * should enable the Data Catalog API in the project identified by the `name` parameter (see [Data + * Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * dataCatalogClient.deleteEntry(name.toString());
+ * }
+ * * + * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final void deleteEntry(String name) { + DeleteEntryRequest request = DeleteEntryRequest.newBuilder().setName(name).build(); + deleteEntry(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Deletes an existing entry. Only entries created through + * [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method can be deleted. Users + * should enable the Data Catalog API in the project identified by the `name` parameter (see [Data + * Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * DeleteEntryRequest request = DeleteEntryRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * dataCatalogClient.deleteEntry(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * DeleteEntryRequest request = DeleteEntryRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * ApiFuture<Void> future = dataCatalogClient.deleteEntryCallable().futureCall(request);
+ * // Do something
+ * future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * Entry response = dataCatalogClient.getEntry(name);
+ * }
+ * * + * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final Entry getEntry(EntryName name) { + GetEntryRequest request = + GetEntryRequest.newBuilder().setName(name == null ? null : name.toString()).build(); + return getEntry(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Gets an entry. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * Entry response = dataCatalogClient.getEntry(name.toString());
+ * }
+ * * + * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final Entry getEntry(String name) { + GetEntryRequest request = GetEntryRequest.newBuilder().setName(name).build(); + return getEntry(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Gets an entry. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * GetEntryRequest request = GetEntryRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * Entry response = dataCatalogClient.getEntry(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * GetEntryRequest request = GetEntryRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * ApiFuture<Entry> future = dataCatalogClient.getEntryCallable().futureCall(request);
+ * // Do something
+ * Entry response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * LookupEntryRequest request = LookupEntryRequest.newBuilder().build();
+ * Entry response = dataCatalogClient.lookupEntry(request);
+ * }
+ * 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();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * for (Entry element : dataCatalogClient.listEntries(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final ListEntriesPagedResponse listEntries(EntryGroupName parent) { + ListEntriesRequest request = + ListEntriesRequest.newBuilder() + .setParent(parent == null ? null : parent.toString()) + .build(); + return listEntries(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Lists entries. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * for (Entry element : dataCatalogClient.listEntries(parent.toString()).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final ListEntriesPagedResponse listEntries(String parent) { + ListEntriesRequest request = ListEntriesRequest.newBuilder().setParent(parent).build(); + return listEntries(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Lists entries. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * ListEntriesRequest request = ListEntriesRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .build();
+ * for (Entry element : dataCatalogClient.listEntries(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * ListEntriesRequest request = ListEntriesRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .build();
+ * ApiFuture<ListEntriesPagedResponse> future = dataCatalogClient.listEntriesPagedCallable().futureCall(request);
+ * // Do something
+ * for (Entry element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
+ * ListEntriesRequest request = ListEntriesRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .build();
+ * while (true) {
+ * ListEntriesResponse response = dataCatalogClient.listEntriesCallable().call(request);
+ * for (Entry element : response.getEntriesList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ * String tagTemplateId = "";
+ * TagTemplate tagTemplate = TagTemplate.newBuilder().build();
+ * TagTemplate response = dataCatalogClient.createTagTemplate(parent, tagTemplateId, tagTemplate);
+ * }
+ * Example: + *
* projects/{project_id}/locations/us-central1 + * @param tagTemplateId Required. The id of the tag template to create. + * @param tagTemplate Required. The tag template to create. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final TagTemplate createTagTemplate( + LocationName parent, String tagTemplateId, TagTemplate tagTemplate) { + CreateTagTemplateRequest request = + CreateTagTemplateRequest.newBuilder() + .setParent(parent == null ? null : parent.toString()) + .setTagTemplateId(tagTemplateId) + .setTagTemplate(tagTemplate) + .build(); + return createTagTemplate(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Creates a tag template. The user should enable the Data Catalog API in the project identified + * by the `parent` parameter (see [Data Catalog Resource + * Project](/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ * String tagTemplateId = "";
+ * TagTemplate tagTemplate = TagTemplate.newBuilder().build();
+ * TagTemplate response = dataCatalogClient.createTagTemplate(parent.toString(), tagTemplateId, tagTemplate);
+ * }
+ * Example: + *
* projects/{project_id}/locations/us-central1 + * @param tagTemplateId Required. The id of the tag template to create. + * @param tagTemplate Required. The tag template to create. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final TagTemplate createTagTemplate( + String parent, String tagTemplateId, TagTemplate tagTemplate) { + CreateTagTemplateRequest request = + CreateTagTemplateRequest.newBuilder() + .setParent(parent) + .setTagTemplateId(tagTemplateId) + .setTagTemplate(tagTemplate) + .build(); + return createTagTemplate(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Creates a tag template. The user should enable the Data Catalog API in the project identified + * by the `parent` parameter (see [Data Catalog Resource + * Project](/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ * String tagTemplateId = "";
+ * TagTemplate tagTemplate = TagTemplate.newBuilder().build();
+ * CreateTagTemplateRequest request = CreateTagTemplateRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .setTagTemplateId(tagTemplateId)
+ * .setTagTemplate(tagTemplate)
+ * .build();
+ * TagTemplate response = dataCatalogClient.createTagTemplate(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ * String tagTemplateId = "";
+ * TagTemplate tagTemplate = TagTemplate.newBuilder().build();
+ * CreateTagTemplateRequest request = CreateTagTemplateRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .setTagTemplateId(tagTemplateId)
+ * .setTagTemplate(tagTemplate)
+ * .build();
+ * ApiFuture<TagTemplate> future = dataCatalogClient.createTagTemplateCallable().futureCall(request);
+ * // Do something
+ * TagTemplate response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateName name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
+ * TagTemplate response = dataCatalogClient.getTagTemplate(name);
+ * }
+ * * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final TagTemplate getTagTemplate(TagTemplateName name) { + GetTagTemplateRequest request = + GetTagTemplateRequest.newBuilder().setName(name == null ? null : name.toString()).build(); + return getTagTemplate(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Gets a tag template. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateName name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
+ * TagTemplate response = dataCatalogClient.getTagTemplate(name.toString());
+ * }
+ * * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final TagTemplate getTagTemplate(String name) { + GetTagTemplateRequest request = GetTagTemplateRequest.newBuilder().setName(name).build(); + return getTagTemplate(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Gets a tag template. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateName name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
+ * GetTagTemplateRequest request = GetTagTemplateRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * TagTemplate response = dataCatalogClient.getTagTemplate(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateName name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
+ * GetTagTemplateRequest request = GetTagTemplateRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * ApiFuture<TagTemplate> future = dataCatalogClient.getTagTemplateCallable().futureCall(request);
+ * // Do something
+ * TagTemplate response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplate tagTemplate = TagTemplate.newBuilder().build();
+ * TagTemplate response = dataCatalogClient.updateTagTemplate(tagTemplate);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplate tagTemplate = TagTemplate.newBuilder().build();
+ * FieldMask updateMask = FieldMask.newBuilder().build();
+ * TagTemplate response = dataCatalogClient.updateTagTemplate(tagTemplate, updateMask);
+ * }
+ * 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 + */ + public final TagTemplate updateTagTemplate(TagTemplate tagTemplate, FieldMask updateMask) { + UpdateTagTemplateRequest request = + UpdateTagTemplateRequest.newBuilder() + .setTagTemplate(tagTemplate) + .setUpdateMask(updateMask) + .build(); + return updateTagTemplate(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Updates a tag template. This method cannot be used to update the fields of a template. The tag + * template fields are represented as separate resources and should be updated using their own + * create/update/delete methods. Users should enable the Data Catalog API in the project + * identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] + * (/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);
+ * }
+ * 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();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateName name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
+ * boolean force = false;
+ * dataCatalogClient.deleteTagTemplate(name, force);
+ * }
+ * * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} + * @param force Required. Currently, this field must always be set to `true`. This confirms the + * deletion of any possible tags using this template. `force = false` will be supported in the + * future. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final void deleteTagTemplate(TagTemplateName name, boolean force) { + DeleteTagTemplateRequest request = + DeleteTagTemplateRequest.newBuilder() + .setName(name == null ? null : name.toString()) + .setForce(force) + .build(); + deleteTagTemplate(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Deletes a tag template and all tags using the template. Users should enable the Data Catalog + * API in the project identified by the `name` parameter (see [Data Catalog Resource Project] + * (/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateName name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
+ * boolean force = false;
+ * dataCatalogClient.deleteTagTemplate(name.toString(), force);
+ * }
+ * * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} + * @param force Required. Currently, this field must always be set to `true`. This confirms the + * deletion of any possible tags using this template. `force = false` will be supported in the + * future. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final void deleteTagTemplate(String name, boolean force) { + DeleteTagTemplateRequest request = + DeleteTagTemplateRequest.newBuilder().setName(name).setForce(force).build(); + deleteTagTemplate(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Deletes a tag template and all tags using the template. Users should enable the Data Catalog + * API in the project identified by the `name` parameter (see [Data Catalog Resource Project] + * (/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateName name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
+ * boolean force = false;
+ * DeleteTagTemplateRequest request = DeleteTagTemplateRequest.newBuilder()
+ * .setName(name.toString())
+ * .setForce(force)
+ * .build();
+ * dataCatalogClient.deleteTagTemplate(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateName name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
+ * boolean force = false;
+ * DeleteTagTemplateRequest request = DeleteTagTemplateRequest.newBuilder()
+ * .setName(name.toString())
+ * .setForce(force)
+ * .build();
+ * ApiFuture<Void> future = dataCatalogClient.deleteTagTemplateCallable().futureCall(request);
+ * // Do something
+ * future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateName parent = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
+ * String tagTemplateFieldId = "";
+ * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
+ * TagTemplateField response = dataCatalogClient.createTagTemplateField(parent, tagTemplateFieldId, tagTemplateField);
+ * }
+ * Example: + *
* projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id} + * @param tagTemplateFieldId Required. The ID of the tag template field to create. Field ids can + * contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes + * (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs + * must also be unique within their template. + * @param tagTemplateField Required. The tag template field to create. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final TagTemplateField createTagTemplateField( + TagTemplateName parent, String tagTemplateFieldId, TagTemplateField tagTemplateField) { + CreateTagTemplateFieldRequest request = + CreateTagTemplateFieldRequest.newBuilder() + .setParent(parent == null ? null : parent.toString()) + .setTagTemplateFieldId(tagTemplateFieldId) + .setTagTemplateField(tagTemplateField) + .build(); + return createTagTemplateField(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Creates a field in a tag template. The user should enable the Data Catalog API in the project + * identified by the `parent` parameter (see [Data Catalog Resource + * Project](/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateName parent = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
+ * String tagTemplateFieldId = "";
+ * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
+ * TagTemplateField response = dataCatalogClient.createTagTemplateField(parent.toString(), tagTemplateFieldId, tagTemplateField);
+ * }
+ * Example: + *
* projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id} + * @param tagTemplateFieldId Required. The ID of the tag template field to create. Field ids can + * contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes + * (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs + * must also be unique within their template. + * @param tagTemplateField Required. The tag template field to create. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final TagTemplateField createTagTemplateField( + String parent, String tagTemplateFieldId, TagTemplateField tagTemplateField) { + CreateTagTemplateFieldRequest request = + CreateTagTemplateFieldRequest.newBuilder() + .setParent(parent) + .setTagTemplateFieldId(tagTemplateFieldId) + .setTagTemplateField(tagTemplateField) + .build(); + return createTagTemplateField(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Creates a field in a tag template. The user should enable the Data Catalog API in the project + * identified by the `parent` parameter (see [Data Catalog Resource + * Project](/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateName parent = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
+ * String tagTemplateFieldId = "";
+ * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
+ * CreateTagTemplateFieldRequest request = CreateTagTemplateFieldRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .setTagTemplateFieldId(tagTemplateFieldId)
+ * .setTagTemplateField(tagTemplateField)
+ * .build();
+ * TagTemplateField response = dataCatalogClient.createTagTemplateField(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateName parent = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
+ * String tagTemplateFieldId = "";
+ * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
+ * CreateTagTemplateFieldRequest request = CreateTagTemplateFieldRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .setTagTemplateFieldId(tagTemplateFieldId)
+ * .setTagTemplateField(tagTemplateField)
+ * .build();
+ * ApiFuture<TagTemplateField> future = dataCatalogClient.createTagTemplateFieldCallable().futureCall(request);
+ * // Do something
+ * TagTemplateField response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
+ * TagTemplateField response = dataCatalogClient.updateTagTemplateField(name, tagTemplateField);
+ * }
+ * * + * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} + * @param tagTemplateField Required. The template to update. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final TagTemplateField updateTagTemplateField( + TagTemplateFieldName name, TagTemplateField tagTemplateField) { + UpdateTagTemplateFieldRequest request = + UpdateTagTemplateFieldRequest.newBuilder() + .setName(name == null ? null : name.toString()) + .setTagTemplateField(tagTemplateField) + .build(); + return updateTagTemplateField(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Updates a field in a tag template. This method cannot be used to update the field type. Users + * should enable the Data Catalog API in the project identified by the `name` parameter (see [Data + * Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
+ * TagTemplateField response = dataCatalogClient.updateTagTemplateField(name.toString(), tagTemplateField);
+ * }
+ * * + * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} + * @param tagTemplateField Required. The template to update. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final TagTemplateField updateTagTemplateField( + String name, TagTemplateField tagTemplateField) { + UpdateTagTemplateFieldRequest request = + UpdateTagTemplateFieldRequest.newBuilder() + .setName(name) + .setTagTemplateField(tagTemplateField) + .build(); + return updateTagTemplateField(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Updates a field in a tag template. This method cannot be used to update the field type. Users + * should enable the Data Catalog API in the project identified by the `name` parameter (see [Data + * Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
+ * FieldMask updateMask = FieldMask.newBuilder().build();
+ * TagTemplateField response = dataCatalogClient.updateTagTemplateField(name, tagTemplateField, updateMask);
+ * }
+ * * + * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} + * @param tagTemplateField Required. The template to update. + * @param updateMask Optional. The field mask specifies the parts of the template to be updated. + * Allowed fields: + *
* `display_name` * `type.enum_type` * `is_required` + *
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. Updating a template field from optional to required is NOT allowed. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final TagTemplateField updateTagTemplateField( + TagTemplateFieldName name, TagTemplateField tagTemplateField, FieldMask updateMask) { + UpdateTagTemplateFieldRequest request = + UpdateTagTemplateFieldRequest.newBuilder() + .setName(name == null ? null : name.toString()) + .setTagTemplateField(tagTemplateField) + .setUpdateMask(updateMask) + .build(); + return updateTagTemplateField(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Updates a field in a tag template. This method cannot be used to update the field type. Users + * should enable the Data Catalog API in the project identified by the `name` parameter (see [Data + * Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
+ * FieldMask updateMask = FieldMask.newBuilder().build();
+ * TagTemplateField response = dataCatalogClient.updateTagTemplateField(name.toString(), tagTemplateField, updateMask);
+ * }
+ * * + * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} + * @param tagTemplateField Required. The template to update. + * @param updateMask Optional. The field mask specifies the parts of the template to be updated. + * Allowed fields: + *
* `display_name` * `type.enum_type` * `is_required` + *
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. Updating a template field from optional to required is NOT allowed. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final TagTemplateField updateTagTemplateField( + String name, TagTemplateField tagTemplateField, FieldMask updateMask) { + UpdateTagTemplateFieldRequest request = + UpdateTagTemplateFieldRequest.newBuilder() + .setName(name) + .setTagTemplateField(tagTemplateField) + .setUpdateMask(updateMask) + .build(); + return updateTagTemplateField(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Updates a field in a tag template. This method cannot be used to update the field type. Users + * should enable the Data Catalog API in the project identified by the `name` parameter (see [Data + * Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
+ * UpdateTagTemplateFieldRequest request = UpdateTagTemplateFieldRequest.newBuilder()
+ * .setName(name.toString())
+ * .setTagTemplateField(tagTemplateField)
+ * .build();
+ * TagTemplateField response = dataCatalogClient.updateTagTemplateField(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
+ * UpdateTagTemplateFieldRequest request = UpdateTagTemplateFieldRequest.newBuilder()
+ * .setName(name.toString())
+ * .setTagTemplateField(tagTemplateField)
+ * .build();
+ * ApiFuture<TagTemplateField> future = dataCatalogClient.updateTagTemplateFieldCallable().futureCall(request);
+ * // Do something
+ * TagTemplateField response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * String newTagTemplateFieldId = "";
+ * TagTemplateField response = dataCatalogClient.renameTagTemplateField(name, newTagTemplateFieldId);
+ * }
+ * * + * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} + * @param newTagTemplateFieldId Required. The new ID of this tag template field. For example, + * `my_new_field`. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final TagTemplateField renameTagTemplateField( + TagTemplateFieldName name, String newTagTemplateFieldId) { + RenameTagTemplateFieldRequest request = + RenameTagTemplateFieldRequest.newBuilder() + .setName(name == null ? null : name.toString()) + .setNewTagTemplateFieldId(newTagTemplateFieldId) + .build(); + return renameTagTemplateField(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Renames a field in a tag template. The user should enable the Data Catalog API in the project + * identified by the `name` parameter (see [Data Catalog Resource + * Project](/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * String newTagTemplateFieldId = "";
+ * TagTemplateField response = dataCatalogClient.renameTagTemplateField(name.toString(), newTagTemplateFieldId);
+ * }
+ * * + * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} + * @param newTagTemplateFieldId Required. The new ID of this tag template field. For example, + * `my_new_field`. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final TagTemplateField renameTagTemplateField(String name, String newTagTemplateFieldId) { + RenameTagTemplateFieldRequest request = + RenameTagTemplateFieldRequest.newBuilder() + .setName(name) + .setNewTagTemplateFieldId(newTagTemplateFieldId) + .build(); + return renameTagTemplateField(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Renames a field in a tag template. The user should enable the Data Catalog API in the project + * identified by the `name` parameter (see [Data Catalog Resource + * Project](/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * String newTagTemplateFieldId = "";
+ * RenameTagTemplateFieldRequest request = RenameTagTemplateFieldRequest.newBuilder()
+ * .setName(name.toString())
+ * .setNewTagTemplateFieldId(newTagTemplateFieldId)
+ * .build();
+ * TagTemplateField response = dataCatalogClient.renameTagTemplateField(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * String newTagTemplateFieldId = "";
+ * RenameTagTemplateFieldRequest request = RenameTagTemplateFieldRequest.newBuilder()
+ * .setName(name.toString())
+ * .setNewTagTemplateFieldId(newTagTemplateFieldId)
+ * .build();
+ * ApiFuture<TagTemplateField> future = dataCatalogClient.renameTagTemplateFieldCallable().futureCall(request);
+ * // Do something
+ * TagTemplateField response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * boolean force = false;
+ * dataCatalogClient.deleteTagTemplateField(name, force);
+ * }
+ * * + * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} + * @param force Required. Currently, this field must always be set to `true`. This confirms the + * deletion of this field from any tags using this field. `force = false` will be supported in + * the future. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final void deleteTagTemplateField(TagTemplateFieldName name, boolean force) { + DeleteTagTemplateFieldRequest request = + DeleteTagTemplateFieldRequest.newBuilder() + .setName(name == null ? null : name.toString()) + .setForce(force) + .build(); + deleteTagTemplateField(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Deletes a field in a tag template and all uses of that field. Users should enable the Data + * Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource + * Project] (/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * boolean force = false;
+ * dataCatalogClient.deleteTagTemplateField(name.toString(), force);
+ * }
+ * * + * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id} + * @param force Required. Currently, this field must always be set to `true`. This confirms the + * deletion of this field from any tags using this field. `force = false` will be supported in + * the future. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final void deleteTagTemplateField(String name, boolean force) { + DeleteTagTemplateFieldRequest request = + DeleteTagTemplateFieldRequest.newBuilder().setName(name).setForce(force).build(); + deleteTagTemplateField(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Deletes a field in a tag template and all uses of that field. Users should enable the Data + * Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource + * Project] (/data-catalog/docs/concepts/resource-project) for more information). + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * boolean force = false;
+ * DeleteTagTemplateFieldRequest request = DeleteTagTemplateFieldRequest.newBuilder()
+ * .setName(name.toString())
+ * .setForce(force)
+ * .build();
+ * dataCatalogClient.deleteTagTemplateField(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagTemplateFieldName name = TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
+ * boolean force = false;
+ * DeleteTagTemplateFieldRequest request = DeleteTagTemplateFieldRequest.newBuilder()
+ * .setName(name.toString())
+ * .setForce(force)
+ * .build();
+ * ApiFuture<Void> future = dataCatalogClient.deleteTagTemplateFieldCallable().futureCall(request);
+ * // Do something
+ * future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagName parent = TagName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]");
+ * Tag tag = Tag.newBuilder().build();
+ * Tag response = dataCatalogClient.createTag(parent, tag);
+ * }
+ * * + * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} + *
Note that this Tag and its child resources may not actually be stored in the location in + * this name. + * @param tag Required. The tag to create. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final Tag createTag(TagName parent, Tag tag) { + CreateTagRequest request = + CreateTagRequest.newBuilder() + .setParent(parent == null ? null : parent.toString()) + .setTag(tag) + .build(); + return createTag(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Creates a tag on an [Entry][google.cloud.datacatalog.v1.Entry]. Note: The project identified by + * the `parent` parameter for the + * [tag](/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) + * and the [tag + * template](/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) + * used to create the tag must be from the same organization. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagName parent = TagName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]");
+ * Tag tag = Tag.newBuilder().build();
+ * Tag response = dataCatalogClient.createTag(parent.toString(), tag);
+ * }
+ * * + * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} + *
Note that this Tag and its child resources may not actually be stored in the location in + * this name. + * @param tag Required. The tag to create. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final Tag createTag(String parent, Tag tag) { + CreateTagRequest request = CreateTagRequest.newBuilder().setParent(parent).setTag(tag).build(); + return createTag(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Creates a tag on an [Entry][google.cloud.datacatalog.v1.Entry]. Note: The project identified by + * the `parent` parameter for the + * [tag](/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) + * and the [tag + * template](/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) + * used to create the tag must be from the same organization. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagName parent = TagName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]");
+ * Tag tag = Tag.newBuilder().build();
+ * CreateTagRequest request = CreateTagRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .setTag(tag)
+ * .build();
+ * Tag response = dataCatalogClient.createTag(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * TagName parent = TagName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]", "[TAG]");
+ * Tag tag = Tag.newBuilder().build();
+ * CreateTagRequest request = CreateTagRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .setTag(tag)
+ * .build();
+ * ApiFuture<Tag> future = dataCatalogClient.createTagCallable().futureCall(request);
+ * // Do something
+ * Tag response = future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * Tag tag = Tag.newBuilder().build();
+ * Tag response = dataCatalogClient.updateTag(tag);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * Tag tag = Tag.newBuilder().build();
+ * FieldMask updateMask = FieldMask.newBuilder().build();
+ * Tag response = dataCatalogClient.updateTag(tag, updateMask);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * Tag tag = Tag.newBuilder().build();
+ * UpdateTagRequest request = UpdateTagRequest.newBuilder()
+ * .setTag(tag)
+ * .build();
+ * Tag response = dataCatalogClient.updateTag(request);
+ * }
+ * 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();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * dataCatalogClient.deleteTag(name);
+ * }
+ * * + * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final void deleteTag(EntryName name) { + DeleteTagRequest request = + DeleteTagRequest.newBuilder().setName(name == null ? null : name.toString()).build(); + deleteTag(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Deletes a tag. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * dataCatalogClient.deleteTag(name.toString());
+ * }
+ * * + * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final void deleteTag(String name) { + DeleteTagRequest request = DeleteTagRequest.newBuilder().setName(name).build(); + deleteTag(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Deletes a tag. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * DeleteTagRequest request = DeleteTagRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * dataCatalogClient.deleteTag(request);
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * DeleteTagRequest request = DeleteTagRequest.newBuilder()
+ * .setName(name.toString())
+ * .build();
+ * ApiFuture<Void> future = dataCatalogClient.deleteTagCallable().futureCall(request);
+ * // Do something
+ * future.get();
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName parent = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * for (Tag element : dataCatalogClient.listTags(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * Examples: + *
* projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} * + * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final ListTagsPagedResponse listTags(EntryName parent) { + ListTagsRequest request = + ListTagsRequest.newBuilder().setParent(parent == null ? null : parent.toString()).build(); + return listTags(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Lists the tags on an [Entry][google.cloud.datacatalog.v1.Entry]. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName parent = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * for (Tag element : dataCatalogClient.listTags(parent.toString()).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * Examples: + *
* projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} * + * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final ListTagsPagedResponse listTags(String parent) { + ListTagsRequest request = ListTagsRequest.newBuilder().setParent(parent).build(); + return listTags(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD + /** + * Lists the tags on an [Entry][google.cloud.datacatalog.v1.Entry]. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName parent = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * ListTagsRequest request = ListTagsRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .build();
+ * for (Tag element : dataCatalogClient.listTags(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName parent = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * ListTagsRequest request = ListTagsRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .build();
+ * ApiFuture<ListTagsPagedResponse> future = dataCatalogClient.listTagsPagedCallable().futureCall(request);
+ * // Do something
+ * for (Tag element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * EntryName parent = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * ListTagsRequest request = ListTagsRequest.newBuilder()
+ * .setParent(parent.toString())
+ * .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;
+ * }
+ * }
+ * }
+ * 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()) {
+ * ResourceName resource = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * Policy policy = Policy.newBuilder().build();
+ * SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder()
+ * .setResource(resource.toString())
+ * .setPolicy(policy)
+ * .build();
+ * Policy response = dataCatalogClient.setIamPolicy(request);
+ * }
+ * 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()) {
+ * ResourceName resource = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * Policy policy = Policy.newBuilder().build();
+ * SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder()
+ * .setResource(resource.toString())
+ * .setPolicy(policy)
+ * .build();
+ * ApiFuture<Policy> future = dataCatalogClient.setIamPolicyCallable().futureCall(request);
+ * // Do something
+ * Policy response = future.get();
+ * }
+ * Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method + * cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform + * resources synced to Data Catalog. + * + *
Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` + * to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on + * entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * ResourceName resource = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder()
+ * .setResource(resource.toString())
+ * .build();
+ * Policy response = dataCatalogClient.getIamPolicy(request);
+ * }
+ * Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method + * cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform + * resources synced to Data Catalog. + * + *
Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` + * to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on + * entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * ResourceName resource = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder()
+ * .setResource(resource.toString())
+ * .build();
+ * ApiFuture<Policy> future = dataCatalogClient.getIamPolicyCallable().futureCall(request);
+ * // Do something
+ * Policy response = future.get();
+ * }
+ * Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method + * cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform + * resources synced to Data Catalog. + * + *
A caller is not required to have Google IAM permission to make this request. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * ResourceName resource = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * List<String> permissions = new ArrayList<>();
+ * TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder()
+ * .setResource(resource.toString())
+ * .addAllPermissions(permissions)
+ * .build();
+ * TestIamPermissionsResponse response = dataCatalogClient.testIamPermissions(request);
+ * }
+ * Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method + * cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform + * resources synced to Data Catalog. + * + *
A caller is not required to have Google IAM permission to make this request. + * + *
Sample code: + * + *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * ResourceName resource = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
+ * List<String> permissions = new ArrayList<>();
+ * TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder()
+ * .setResource(resource.toString())
+ * .addAllPermissions(permissions)
+ * .build();
+ * ApiFuture<TestIamPermissionsResponse> future = dataCatalogClient.testIamPermissionsCallable().futureCall(request);
+ * // Do something
+ * TestIamPermissionsResponse response = future.get();
+ * }
+ * The default instance has everything set to sensible defaults: + * + *
The builder of this class is recursive, so contained classes are themselves builders. When + * build() is called, the tree of builders is called to create the complete settings object. + * + *
For example, to set the total timeout of createEntryGroup to 30 seconds: + * + *
+ *
+ * DataCatalogSettings.Builder dataCatalogSettingsBuilder =
+ * DataCatalogSettings.newBuilder();
+ * dataCatalogSettingsBuilder
+ * .createEntryGroupSettings()
+ * .setRetrySettings(
+ * dataCatalogSettingsBuilder.createEntryGroupSettings().getRetrySettings().toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * DataCatalogSettings dataCatalogSettings = dataCatalogSettingsBuilder.build();
+ *
+ *
+ */
+@Generated("by gapic-generator")
+@BetaApi
+public class DataCatalogSettings extends ClientSettingsNote: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction The interfaces provided are listed below, along with usage samples.
+ *
+ * ================= DataCatalogClient =================
+ *
+ * Service Description: Data Catalog API service allows clients to discover, understand, and
+ * manage their data.
+ *
+ * Sample for DataCatalogClient:
+ *
+ * This class is for advanced usage and reflects the underlying API directly.
+ */
+@Generated("by gapic-generator")
+@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
+public abstract class DataCatalogStub implements BackgroundResource {
+
+ public UnaryCallable The default instance has everything set to sensible defaults:
+ *
+ * The builder of this class is recursive, so contained classes are themselves builders. When
+ * build() is called, the tree of builders is called to create the complete settings object.
+ *
+ * For example, to set the total timeout of createEntryGroup to 30 seconds:
+ *
+ *
+ *
+ */
+@Generated("by gapic-generator")
+package com.google.cloud.datacatalog.v1;
+
+import javax.annotation.Generated;
diff --git a/google-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1/stub/DataCatalogStub.java b/google-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1/stub/DataCatalogStub.java
new file mode 100644
index 00000000..7064d108
--- /dev/null
+++ b/google-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1/stub/DataCatalogStub.java
@@ -0,0 +1,209 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.google.cloud.datacatalog.v1.stub;
+
+import static com.google.cloud.datacatalog.v1.DataCatalogClient.ListEntriesPagedResponse;
+import static com.google.cloud.datacatalog.v1.DataCatalogClient.ListEntryGroupsPagedResponse;
+import static com.google.cloud.datacatalog.v1.DataCatalogClient.ListTagsPagedResponse;
+import static com.google.cloud.datacatalog.v1.DataCatalogClient.SearchCatalogPagedResponse;
+
+import com.google.api.core.BetaApi;
+import com.google.api.gax.core.BackgroundResource;
+import com.google.api.gax.rpc.UnaryCallable;
+import com.google.cloud.datacatalog.v1.CreateEntryGroupRequest;
+import com.google.cloud.datacatalog.v1.CreateEntryRequest;
+import com.google.cloud.datacatalog.v1.CreateTagRequest;
+import com.google.cloud.datacatalog.v1.CreateTagTemplateFieldRequest;
+import com.google.cloud.datacatalog.v1.CreateTagTemplateRequest;
+import com.google.cloud.datacatalog.v1.DeleteEntryGroupRequest;
+import com.google.cloud.datacatalog.v1.DeleteEntryRequest;
+import com.google.cloud.datacatalog.v1.DeleteTagRequest;
+import com.google.cloud.datacatalog.v1.DeleteTagTemplateFieldRequest;
+import com.google.cloud.datacatalog.v1.DeleteTagTemplateRequest;
+import com.google.cloud.datacatalog.v1.Entry;
+import com.google.cloud.datacatalog.v1.EntryGroup;
+import com.google.cloud.datacatalog.v1.GetEntryGroupRequest;
+import com.google.cloud.datacatalog.v1.GetEntryRequest;
+import com.google.cloud.datacatalog.v1.GetTagTemplateRequest;
+import com.google.cloud.datacatalog.v1.ListEntriesRequest;
+import com.google.cloud.datacatalog.v1.ListEntriesResponse;
+import com.google.cloud.datacatalog.v1.ListEntryGroupsRequest;
+import com.google.cloud.datacatalog.v1.ListEntryGroupsResponse;
+import com.google.cloud.datacatalog.v1.ListTagsRequest;
+import com.google.cloud.datacatalog.v1.ListTagsResponse;
+import com.google.cloud.datacatalog.v1.LookupEntryRequest;
+import com.google.cloud.datacatalog.v1.RenameTagTemplateFieldRequest;
+import com.google.cloud.datacatalog.v1.SearchCatalogRequest;
+import com.google.cloud.datacatalog.v1.SearchCatalogResponse;
+import com.google.cloud.datacatalog.v1.Tag;
+import com.google.cloud.datacatalog.v1.TagTemplate;
+import com.google.cloud.datacatalog.v1.TagTemplateField;
+import com.google.cloud.datacatalog.v1.UpdateEntryGroupRequest;
+import com.google.cloud.datacatalog.v1.UpdateEntryRequest;
+import com.google.cloud.datacatalog.v1.UpdateTagRequest;
+import com.google.cloud.datacatalog.v1.UpdateTagTemplateFieldRequest;
+import com.google.cloud.datacatalog.v1.UpdateTagTemplateRequest;
+import com.google.iam.v1.GetIamPolicyRequest;
+import com.google.iam.v1.Policy;
+import com.google.iam.v1.SetIamPolicyRequest;
+import com.google.iam.v1.TestIamPermissionsRequest;
+import com.google.iam.v1.TestIamPermissionsResponse;
+import com.google.protobuf.Empty;
+import javax.annotation.Generated;
+
+// AUTO-GENERATED DOCUMENTATION AND CLASS
+/**
+ * Base stub class for Google Cloud Data Catalog API.
+ *
+ *
+ * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+ * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+ * String entryGroupId = "";
+ * EntryGroup entryGroup = EntryGroup.newBuilder().build();
+ * EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
+ * }
+ *
+ *
+ *
+ *
+ *
+ *
+ */
+@Generated("by gapic-generator")
+@BetaApi
+public class DataCatalogStubSettings extends StubSettings
+ * DataCatalogStubSettings.Builder dataCatalogSettingsBuilder =
+ * DataCatalogStubSettings.newBuilder();
+ * dataCatalogSettingsBuilder
+ * .createEntryGroupSettings()
+ * .setRetrySettings(
+ * dataCatalogSettingsBuilder.createEntryGroupSettings().getRetrySettings().toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * DataCatalogStubSettings dataCatalogSettings = dataCatalogSettingsBuilder.build();
+ *
+ *