Data Catalog API service allows you to discover, understand, and manage your data. - * - *
This class provides the ability to make remote calls to the backing service through method - * calls that map to API methods. Sample code to get started: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
- * String entryGroupId = "entryGroupId1228924712";
- * EntryGroup entryGroup = EntryGroup.newBuilder().build();
- * EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
- * }
- * }
- *
- * Note: close() needs to be called on the DataCatalogClient object to clean up resources such as - * threads. In the example above, try-with-resources is used, which automatically calls close(). - * - *
| Method | - *Description | - *Method Variants | - *
|---|---|---|
SearchCatalog |
- * Searches Data Catalog for multiple resources like entries and tags that match a query. - * This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods. - * Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. - * For more information, see [Data Catalog search syntax] (https://cloud.google.com/data-catalog/docs/how-to/search-reference). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
CreateEntryGroup |
- * Creates an entry group. - * An entry group contains logically related entries together with [Cloud Identity and Access Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can create, edit, and view entries within entry groups. - * Data Catalog automatically creates entry groups with names that start with the `{@literal @}` symbol for the following resources: - *
You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the `{@literal @}` symbol, it is reserved for automatically created groups. - * Entry groups, like entries, can be searched. - * A maximum of 10,000 entry groups may be created per organization across all locations. - * You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
GetEntryGroup |
- * Gets an entry group. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
UpdateEntryGroup |
- * Updates an entry group. - * You must enable the Data Catalog API in the project identified by the `entry_group.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
DeleteEntryGroup |
- * Deletes an entry group. - * You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
ListEntryGroups |
- * Lists entry groups. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
CreateEntry |
- * Creates an entry. - * You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. - * You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * An entry group can have a maximum of 100,000 entries. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
UpdateEntry |
- * Updates an existing entry. - * You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
DeleteEntry |
- * Deletes an existing entry. - * You can delete only the entries created by the [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method. - * You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
GetEntry |
- * Gets an entry. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
LookupEntry |
- * Gets an entry by its target resource name. - * The resource name comes from the source Google Cloud Platform service. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
ListEntries |
- * Lists entries. - * Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
ModifyEntryOverview |
- * Modifies entry overview, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry]. - * To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission on the corresponding project. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
ModifyEntryContacts |
- * Modifies contacts, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry]. - * To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission on the corresponding project. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
CreateTagTemplate |
- * Creates a tag template. - * You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
GetTagTemplate |
- * Gets a tag template. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
UpdateTagTemplate |
- * Updates a tag template. - * You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods. - * You must enable the Data Catalog API in the project identified by the `tag_template.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
DeleteTagTemplate |
- * Deletes a tag template and all tags that use it. - * You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
CreateTagTemplateField |
- * Creates a field in a tag template. - * You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
UpdateTagTemplateField |
- * Updates a field in a tag template. - * You can't update the field type with this method. - * You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
RenameTagTemplateField |
- * Renames a field in a tag template. - * You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
RenameTagTemplateFieldEnumValue |
- * Renames an enum value in a tag template. - * Within a single enum field, enum values must be unique. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
DeleteTagTemplateField |
- * Deletes a field in a tag template and all uses of this field from the tags based on this template. - * You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
CreateTag |
- * Creates a tag and assigns it to: - *
Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
UpdateTag |
- * Updates an existing tag. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
DeleteTag |
- * Deletes a tag. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
ListTags |
- * Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
ReconcileTags |
- * `ReconcileTags` creates or updates a list of tags on the entry. If the [ReconcileTagsRequest.force_delete_missing][google.cloud.datacatalog.v1.ReconcileTagsRequest.force_delete_missing] parameter is set, the operation deletes tags not included in the input tag list. - * `ReconcileTags` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
StarEntry |
- * Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring information is private to each user. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
UnstarEntry |
- * Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user. Starring information is private to each user. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
SetIamPolicy |
- * Sets an access control policy for a resource. Replaces any existing policy. - * Supported resources are: - * - Tag templates - Entry groups - * Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. - * To call this method, you must have the following Google IAM permissions: - * - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
GetIamPolicy |
- * Gets the access control policy for a resource. - * May return: - *
Supported resources are: - * - Tag templates - Entry groups - * Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. - * To call this method, you must have the following Google IAM permissions: - * - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
TestIamPermissions |
- * Gets your permissions on a resource. - * Returns an empty set of permissions if the resource doesn't exist. - * Supported resources are: - * - Tag templates - Entry groups - * Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. - * No Google IAM permissions are required to call this method. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
ImportEntries |
- * Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog. - * `ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of [DumpItem][google.cloud.datacatalog.v1.DumpItem] type. - * `ImportEntries` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata] and an [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse] message. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
SetConfig |
- * Sets the configuration related to the migration to Dataplex for an organization or project. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
RetrieveConfig |
- * Retrieves the configuration related to the migration from Data Catalog to Dataplex for a specific organization, including all the projects under it which have a separate configuration set. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
RetrieveEffectiveConfig |
- * Retrieves the effective configuration related to the migration from Data Catalog to Dataplex for a specific organization or project. If there is no specific configuration set for the resource, the setting is checked hierarchicahlly through the ancestors of the resource, starting from the resource itself. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
See the individual methods for example code. - * - *
Many parameters require resource names to be formatted in a particular way. To assist with - * these names, this class includes a format method for each type of name, and additionally a parse - * method to extract the individual identifiers contained within names that are returned. - * - *
This class can be customized by passing in a custom instance of DataCatalogSettings to - * create(). For example: - * - *
To customize credentials: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * DataCatalogSettings dataCatalogSettings =
- * DataCatalogSettings.newBuilder()
- * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
- * .build();
- * DataCatalogClient dataCatalogClient = DataCatalogClient.create(dataCatalogSettings);
- * }
- *
- * To customize the endpoint: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * DataCatalogSettings dataCatalogSettings =
- * DataCatalogSettings.newBuilder().setEndpoint(myEndpoint).build();
- * DataCatalogClient dataCatalogClient = DataCatalogClient.create(dataCatalogSettings);
- * }
- *
- * To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over - * the wire: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * DataCatalogSettings dataCatalogSettings = DataCatalogSettings.newHttpJsonBuilder().build();
- * DataCatalogClient dataCatalogClient = DataCatalogClient.create(dataCatalogSettings);
- * }
- *
- * Please refer to the GitHub repository's samples for more quickstart code snippets. - * - * @deprecated This class is deprecated and will be removed in the next major version update. - */ -@NullMarked -@Deprecated -@Generated("by gapic-generator-java") -public class DataCatalogClient implements BackgroundResource { - private final @Nullable DataCatalogSettings settings; - private final DataCatalogStub stub; - private final OperationsClient httpJsonOperationsClient; - private final com.google.longrunning.OperationsClient operationsClient; - - /** Constructs an instance of DataCatalogClient with default settings. */ - public static final DataCatalogClient create() throws IOException { - return create(DataCatalogSettings.newBuilder().build()); - } - - /** - * Constructs an instance of DataCatalogClient, using the given settings. The channels are created - * based on the settings passed in, or defaults for any settings that are not set. - */ - public static final DataCatalogClient create(DataCatalogSettings settings) throws IOException { - return new DataCatalogClient(settings); - } - - /** - * Constructs an instance of DataCatalogClient, using the given stub for making calls. This is for - * advanced usage - prefer using create(DataCatalogSettings). - */ - public static final DataCatalogClient create(DataCatalogStub stub) { - return new DataCatalogClient(stub); - } - - /** - * Constructs an instance of DataCatalogClient, using the given settings. This is protected so - * that it is easy to make a subclass, but otherwise, the static factory methods should be - * preferred. - */ - protected DataCatalogClient(DataCatalogSettings settings) throws IOException { - this.settings = settings; - this.stub = ((DataCatalogStubSettings) settings.getStubSettings()).createStub(); - this.operationsClient = - com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub()); - this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub()); - } - - protected DataCatalogClient(DataCatalogStub stub) { - this.settings = null; - this.stub = stub; - this.operationsClient = - com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub()); - this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub()); - } - - public final @Nullable DataCatalogSettings getSettings() { - return settings; - } - - public DataCatalogStub getStub() { - return stub; - } - - /** - * Returns the OperationsClient that can be used to query the status of a long-running operation - * returned by another API method call. - */ - public final com.google.longrunning.OperationsClient getOperationsClient() { - return operationsClient; - } - - /** - * Returns the OperationsClient that can be used to query the status of a long-running operation - * returned by another API method call. - */ - @BetaApi - public final OperationsClient getHttpJsonOperationsClient() { - return httpJsonOperationsClient; - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Searches Data Catalog for multiple resources like entries and tags that match a query. - * - *
This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't - * return all information on a resource, only its ID and high level fields. To get more - * information, you can subsequently call specific get methods. - * - *
Note: Data Catalog search queries don't guarantee full recall. Results that match your query - * might not be returned, even in subsequent result pages. Additionally, returned (and not - * returned) results can vary if you repeat search queries. - * - *
For more information, see [Data Catalog search syntax] - * (https://cloud.google.com/data-catalog/docs/how-to/search-reference). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * SearchCatalogRequest.Scope scope = SearchCatalogRequest.Scope.newBuilder().build();
- * String query = "query107944136";
- * for (SearchCatalogResult element :
- * dataCatalogClient.searchCatalog(scope, query).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param scope Required. The scope of this search request.
- * The `scope` is invalid if `include_org_ids`, `include_project_ids` are empty AND - * `include_gcp_public_datasets` is set to `false`. In this case, the request returns an - * error. - * @param query Optional. The query string with a minimum of 3 characters and specific syntax. For - * more information, see [Data Catalog search - * syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference). - *
An empty query string returns all data assets (in the specified scope) that you have - * access to. - *
A query string can be a simple `xyz` or qualified by predicates: - *
This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't - * return all information on a resource, only its ID and high level fields. To get more - * information, you can subsequently call specific get methods. - * - *
Note: Data Catalog search queries don't guarantee full recall. Results that match your query - * might not be returned, even in subsequent result pages. Additionally, returned (and not - * returned) results can vary if you repeat search queries. - * - *
For more information, see [Data Catalog search syntax] - * (https://cloud.google.com/data-catalog/docs/how-to/search-reference). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * SearchCatalogRequest request =
- * SearchCatalogRequest.newBuilder()
- * .setScope(SearchCatalogRequest.Scope.newBuilder().build())
- * .setQuery("query107944136")
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .setOrderBy("orderBy-1207110587")
- * .setAdminSearch(true)
- * .build();
- * for (SearchCatalogResult element : dataCatalogClient.searchCatalog(request).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final SearchCatalogPagedResponse searchCatalog(SearchCatalogRequest request) {
- return searchCatalogPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Searches Data Catalog for multiple resources like entries and tags that match a query.
- *
- * This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't - * return all information on a resource, only its ID and high level fields. To get more - * information, you can subsequently call specific get methods. - * - *
Note: Data Catalog search queries don't guarantee full recall. Results that match your query - * might not be returned, even in subsequent result pages. Additionally, returned (and not - * returned) results can vary if you repeat search queries. - * - *
For more information, see [Data Catalog search syntax] - * (https://cloud.google.com/data-catalog/docs/how-to/search-reference). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * SearchCatalogRequest request =
- * SearchCatalogRequest.newBuilder()
- * .setScope(SearchCatalogRequest.Scope.newBuilder().build())
- * .setQuery("query107944136")
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .setOrderBy("orderBy-1207110587")
- * .setAdminSearch(true)
- * .build();
- * ApiFuture future =
- * dataCatalogClient.searchCatalogPagedCallable().futureCall(request);
- * // Do something.
- * for (SearchCatalogResult element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableThis is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't - * return all information on a resource, only its ID and high level fields. To get more - * information, you can subsequently call specific get methods. - * - *
Note: Data Catalog search queries don't guarantee full recall. Results that match your query - * might not be returned, even in subsequent result pages. Additionally, returned (and not - * returned) results can vary if you repeat search queries. - * - *
For more information, see [Data Catalog search syntax] - * (https://cloud.google.com/data-catalog/docs/how-to/search-reference). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * SearchCatalogRequest request =
- * SearchCatalogRequest.newBuilder()
- * .setScope(SearchCatalogRequest.Scope.newBuilder().build())
- * .setQuery("query107944136")
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .setOrderBy("orderBy-1207110587")
- * .setAdminSearch(true)
- * .build();
- * while (true) {
- * SearchCatalogResponse response = dataCatalogClient.searchCatalogCallable().call(request);
- * for (SearchCatalogResult element : response.getResultsList()) {
- * // doThingsWith(element);
- * }
- * String nextPageToken = response.getNextPageToken();
- * if (!Strings.isNullOrEmpty(nextPageToken)) {
- * request = request.toBuilder().setPageToken(nextPageToken).build();
- * } else {
- * break;
- * }
- * }
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableAn entry group contains logically related entries together with [Cloud Identity and Access - * Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can - * create, edit, and view entries within entry groups. - * - *
Data Catalog automatically creates entry groups with names that start with the - * `{@literal @}` symbol for the following resources: - * - *
You can create your own entry groups for Cloud Storage fileset entries and custom entries - * together with the corresponding IAM policies. User-created entry groups can't contain the - * `{@literal @}` symbol, it is reserved for automatically created groups. - * - *
Entry groups, like entries, can be searched. - * - *
A maximum of 10,000 entry groups may be created per organization across all locations. - * - *
You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
- * String entryGroupId = "entryGroupId1228924712";
- * EntryGroup entryGroup = EntryGroup.newBuilder().build();
- * EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
- * }
- * }
- *
- * @param parent Required. The names of the project and location that the new entry group belongs
- * to.
- * Note: The entry group itself and its child resources might not be stored in the location - * specified in its name. - * @param entryGroupId Required. The ID of the entry group to create. - *
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must - * start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. - * @param entryGroup The entry group to create. Defaults to empty. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final EntryGroup createEntryGroup( - @Nullable 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 entry group. - * - *
An entry group contains logically related entries together with [Cloud Identity and Access - * Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can - * create, edit, and view entries within entry groups. - * - *
Data Catalog automatically creates entry groups with names that start with the - * `{@literal @}` symbol for the following resources: - * - *
You can create your own entry groups for Cloud Storage fileset entries and custom entries - * together with the corresponding IAM policies. User-created entry groups can't contain the - * `{@literal @}` symbol, it is reserved for automatically created groups. - * - *
Entry groups, like entries, can be searched. - * - *
A maximum of 10,000 entry groups may be created per organization across all locations. - * - *
You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
- * String entryGroupId = "entryGroupId1228924712";
- * EntryGroup entryGroup = EntryGroup.newBuilder().build();
- * EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
- * }
- * }
- *
- * @param parent Required. The names of the project and location that the new entry group belongs
- * to.
- * Note: The entry group itself and its child resources might not be stored in the location - * specified in its name. - * @param entryGroupId Required. The ID of the entry group to create. - *
The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must - * start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. - * @param entryGroup The entry group to create. Defaults to empty. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - 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 entry group. - * - *
An entry group contains logically related entries together with [Cloud Identity and Access - * Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can - * create, edit, and view entries within entry groups. - * - *
Data Catalog automatically creates entry groups with names that start with the - * `{@literal @}` symbol for the following resources: - * - *
You can create your own entry groups for Cloud Storage fileset entries and custom entries - * together with the corresponding IAM policies. User-created entry groups can't contain the - * `{@literal @}` symbol, it is reserved for automatically created groups. - * - *
Entry groups, like entries, can be searched. - * - *
A maximum of 10,000 entry groups may be created per organization across all locations. - * - *
You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * CreateEntryGroupRequest request =
- * CreateEntryGroupRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .setEntryGroupId("entryGroupId1228924712")
- * .setEntryGroup(EntryGroup.newBuilder().build())
- * .build();
- * EntryGroup response = dataCatalogClient.createEntryGroup(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final EntryGroup createEntryGroup(CreateEntryGroupRequest request) {
- return createEntryGroupCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates an entry group.
- *
- * An entry group contains logically related entries together with [Cloud Identity and Access - * Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can - * create, edit, and view entries within entry groups. - * - *
Data Catalog automatically creates entry groups with names that start with the - * `{@literal @}` symbol for the following resources: - * - *
You can create your own entry groups for Cloud Storage fileset entries and custom entries - * together with the corresponding IAM policies. User-created entry groups can't contain the - * `{@literal @}` symbol, it is reserved for automatically created groups. - * - *
Entry groups, like entries, can be searched. - * - *
A maximum of 10,000 entry groups may be created per organization across all locations. - * - *
You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * CreateEntryGroupRequest request =
- * CreateEntryGroupRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .setEntryGroupId("entryGroupId1228924712")
- * .setEntryGroup(EntryGroup.newBuilder().build())
- * .build();
- * ApiFuture future =
- * dataCatalogClient.createEntryGroupCallable().futureCall(request);
- * // Do something.
- * EntryGroup response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
- * EntryGroup response = dataCatalogClient.getEntryGroup(name);
- * }
- * }
- *
- * @param name Required. The name of the entry group to get.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final EntryGroup getEntryGroup(@Nullable EntryGroupName name) {
- GetEntryGroupRequest request =
- GetEntryGroupRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- return getEntryGroup(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an entry group.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
- * EntryGroup response = dataCatalogClient.getEntryGroup(name);
- * }
- * }
- *
- * @param name Required. The name of the entry group to get.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final EntryGroup getEntryGroup(String name) {
- GetEntryGroupRequest request = GetEntryGroupRequest.newBuilder().setName(name).build();
- return getEntryGroup(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an entry group.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
- * FieldMask readMask = FieldMask.newBuilder().build();
- * EntryGroup response = dataCatalogClient.getEntryGroup(name, readMask);
- * }
- * }
- *
- * @param name Required. The name of the entry group to get.
- * @param readMask The fields to return. If empty or omitted, all fields are returned.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final EntryGroup getEntryGroup(@Nullable EntryGroupName name, FieldMask readMask) {
- GetEntryGroupRequest request =
- GetEntryGroupRequest.newBuilder()
- .setName(name == null ? null : name.toString())
- .setReadMask(readMask)
- .build();
- return getEntryGroup(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an entry group.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
- * FieldMask readMask = FieldMask.newBuilder().build();
- * EntryGroup response = dataCatalogClient.getEntryGroup(name, readMask);
- * }
- * }
- *
- * @param name Required. The name of the entry group to get.
- * @param readMask The fields to return. If empty or omitted, all fields are returned.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final EntryGroup getEntryGroup(String name, FieldMask readMask) {
- GetEntryGroupRequest request =
- GetEntryGroupRequest.newBuilder().setName(name).setReadMask(readMask).build();
- return getEntryGroup(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an entry group.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * GetEntryGroupRequest request =
- * GetEntryGroupRequest.newBuilder()
- * .setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setReadMask(FieldMask.newBuilder().build())
- * .build();
- * EntryGroup response = dataCatalogClient.getEntryGroup(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final EntryGroup getEntryGroup(GetEntryGroupRequest request) {
- return getEntryGroupCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an entry group.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * GetEntryGroupRequest request =
- * GetEntryGroupRequest.newBuilder()
- * .setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setReadMask(FieldMask.newBuilder().build())
- * .build();
- * ApiFuture future = dataCatalogClient.getEntryGroupCallable().futureCall(request);
- * // Do something.
- * EntryGroup response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableYou must enable the Data Catalog API in the project identified by the `entry_group.name` - * parameter. For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryGroup entryGroup = EntryGroup.newBuilder().build();
- * EntryGroup response = dataCatalogClient.updateEntryGroup(entryGroup);
- * }
- * }
- *
- * @param entryGroup Required. Updates for the entry group. The `name` field must be set.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final EntryGroup updateEntryGroup(EntryGroup entryGroup) {
- UpdateEntryGroupRequest request =
- UpdateEntryGroupRequest.newBuilder().setEntryGroup(entryGroup).build();
- return updateEntryGroup(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates an entry group.
- *
- * You must enable the Data Catalog API in the project identified by the `entry_group.name` - * parameter. For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryGroup entryGroup = EntryGroup.newBuilder().build();
- * FieldMask updateMask = FieldMask.newBuilder().build();
- * EntryGroup response = dataCatalogClient.updateEntryGroup(entryGroup, updateMask);
- * }
- * }
- *
- * @param entryGroup Required. Updates for the entry group. The `name` field must be set.
- * @param updateMask Names of fields whose values to overwrite on an entry group.
- * If this parameter is absent or empty, all modifiable fields are overwritten. If such - * fields are non-required and omitted in the request body, their values are emptied. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final EntryGroup updateEntryGroup(EntryGroup entryGroup, FieldMask updateMask) { - UpdateEntryGroupRequest request = - UpdateEntryGroupRequest.newBuilder() - .setEntryGroup(entryGroup) - .setUpdateMask(updateMask) - .build(); - return updateEntryGroup(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Updates an entry group. - * - *
You must enable the Data Catalog API in the project identified by the `entry_group.name` - * parameter. For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * UpdateEntryGroupRequest request =
- * UpdateEntryGroupRequest.newBuilder()
- * .setEntryGroup(EntryGroup.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * EntryGroup response = dataCatalogClient.updateEntryGroup(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final EntryGroup updateEntryGroup(UpdateEntryGroupRequest request) {
- return updateEntryGroupCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates an entry group.
- *
- * You must enable the Data Catalog API in the project identified by the `entry_group.name` - * parameter. For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * UpdateEntryGroupRequest request =
- * UpdateEntryGroupRequest.newBuilder()
- * .setEntryGroup(EntryGroup.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * ApiFuture future =
- * dataCatalogClient.updateEntryGroupCallable().futureCall(request);
- * // Do something.
- * EntryGroup response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableYou must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryGroupName name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
- * dataCatalogClient.deleteEntryGroup(name);
- * }
- * }
- *
- * @param name Required. The name of the entry group to delete.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final void deleteEntryGroup(@Nullable EntryGroupName name) {
- DeleteEntryGroupRequest request =
- DeleteEntryGroupRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- deleteEntryGroup(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an entry group.
- *
- * You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
- * dataCatalogClient.deleteEntryGroup(name);
- * }
- * }
- *
- * @param name Required. The name of the entry group to delete.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final void deleteEntryGroup(String name) {
- DeleteEntryGroupRequest request = DeleteEntryGroupRequest.newBuilder().setName(name).build();
- deleteEntryGroup(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an entry group.
- *
- * You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * DeleteEntryGroupRequest request =
- * DeleteEntryGroupRequest.newBuilder()
- * .setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setForce(true)
- * .build();
- * dataCatalogClient.deleteEntryGroup(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final void deleteEntryGroup(DeleteEntryGroupRequest request) {
- deleteEntryGroupCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an entry group.
- *
- * You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * DeleteEntryGroupRequest request =
- * DeleteEntryGroupRequest.newBuilder()
- * .setName(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setForce(true)
- * .build();
- * ApiFuture future = dataCatalogClient.deleteEntryGroupCallable().futureCall(request);
- * // Do something.
- * future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
- * for (EntryGroup element : dataCatalogClient.listEntryGroups(parent).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param parent Required. The name of the location that contains the entry groups to list.
- * Can be provided as a URL. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final ListEntryGroupsPagedResponse listEntryGroups(@Nullable LocationName parent) { - ListEntryGroupsRequest request = - ListEntryGroupsRequest.newBuilder() - .setParent(parent == null ? null : parent.toString()) - .build(); - return listEntryGroups(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Lists entry groups. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
- * for (EntryGroup element : dataCatalogClient.listEntryGroups(parent).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param parent Required. The name of the location that contains the entry groups to list.
- * Can be provided as a URL. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final ListEntryGroupsPagedResponse listEntryGroups(String parent) { - ListEntryGroupsRequest request = ListEntryGroupsRequest.newBuilder().setParent(parent).build(); - return listEntryGroups(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Lists entry groups. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ListEntryGroupsRequest request =
- * ListEntryGroupsRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .build();
- * for (EntryGroup element : dataCatalogClient.listEntryGroups(request).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final ListEntryGroupsPagedResponse listEntryGroups(ListEntryGroupsRequest request) {
- return listEntryGroupsPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists entry groups.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ListEntryGroupsRequest request =
- * ListEntryGroupsRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .build();
- * ApiFuture future =
- * dataCatalogClient.listEntryGroupsPagedCallable().futureCall(request);
- * // Do something.
- * for (EntryGroup element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ListEntryGroupsRequest request =
- * ListEntryGroupsRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .build();
- * while (true) {
- * ListEntryGroupsResponse response =
- * dataCatalogClient.listEntryGroupsCallable().call(request);
- * for (EntryGroup element : response.getEntryGroupsList()) {
- * // doThingsWith(element);
- * }
- * String nextPageToken = response.getNextPageToken();
- * if (!Strings.isNullOrEmpty(nextPageToken)) {
- * request = request.toBuilder().setPageToken(nextPageToken).build();
- * } else {
- * break;
- * }
- * }
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableYou can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data - * Catalog automatically creates entries with other types during metadata ingestion from - * integrated systems. - * - *
You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
An entry group can have a maximum of 100,000 entries. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
- * String entryId = "entryId-1591558867";
- * Entry entry = Entry.newBuilder().build();
- * Entry response = dataCatalogClient.createEntry(parent, entryId, entry);
- * }
- * }
- *
- * @param parent Required. The name of the entry group this entry belongs to.
- * Note: The entry itself and its child resources might not be stored in the location - * specified in its name. - * @param entryId Required. The ID of the entry to create. - *
The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The - * maximum size is 64 bytes when encoded in UTF-8. - * @param entry Required. The entry to create. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final Entry createEntry(@Nullable 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. - * - *
You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data - * Catalog automatically creates entries with other types during metadata ingestion from - * integrated systems. - * - *
You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
An entry group can have a maximum of 100,000 entries. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
- * String entryId = "entryId-1591558867";
- * Entry entry = Entry.newBuilder().build();
- * Entry response = dataCatalogClient.createEntry(parent, entryId, entry);
- * }
- * }
- *
- * @param parent Required. The name of the entry group this entry belongs to.
- * Note: The entry itself and its child resources might not be stored in the location - * specified in its name. - * @param entryId Required. The ID of the entry to create. - *
The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The - * maximum size is 64 bytes when encoded in UTF-8. - * @param entry Required. The entry to create. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - 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. - * - *
You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data - * Catalog automatically creates entries with other types during metadata ingestion from - * integrated systems. - * - *
You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
An entry group can have a maximum of 100,000 entries. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * CreateEntryRequest request =
- * CreateEntryRequest.newBuilder()
- * .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setEntryId("entryId-1591558867")
- * .setEntry(Entry.newBuilder().build())
- * .build();
- * Entry response = dataCatalogClient.createEntry(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Entry createEntry(CreateEntryRequest request) {
- return createEntryCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates an entry.
- *
- * You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data - * Catalog automatically creates entries with other types during metadata ingestion from - * integrated systems. - * - *
You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
An entry group can have a maximum of 100,000 entries. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * CreateEntryRequest request =
- * CreateEntryRequest.newBuilder()
- * .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setEntryId("entryId-1591558867")
- * .setEntry(Entry.newBuilder().build())
- * .build();
- * ApiFuture future = dataCatalogClient.createEntryCallable().futureCall(request);
- * // Do something.
- * Entry response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableYou must enable the Data Catalog API in the project identified by the `entry.name` - * parameter. For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * Entry entry = Entry.newBuilder().build();
- * Entry response = dataCatalogClient.updateEntry(entry);
- * }
- * }
- *
- * @param entry Required. Updates for the entry. The `name` field must be set.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Entry updateEntry(Entry entry) {
- UpdateEntryRequest request = UpdateEntryRequest.newBuilder().setEntry(entry).build();
- return updateEntry(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates an existing entry.
- *
- * You must enable the Data Catalog API in the project identified by the `entry.name` - * parameter. For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * Entry entry = Entry.newBuilder().build();
- * FieldMask updateMask = FieldMask.newBuilder().build();
- * Entry response = dataCatalogClient.updateEntry(entry, updateMask);
- * }
- * }
- *
- * @param entry Required. Updates for the entry. The `name` field must be set.
- * @param updateMask Names of fields whose values to overwrite on an entry.
- * If this parameter is absent or empty, all modifiable fields are overwritten. If such - * fields are non-required and omitted in the request body, their values are emptied. - *
You can modify only the fields listed below. - *
For entries with type `DATA_STREAM`: - *
For entries with type `FILESET`: - *
For entries with `user_specified_type`: - *
You must enable the Data Catalog API in the project identified by the `entry.name` - * parameter. For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * UpdateEntryRequest request =
- * UpdateEntryRequest.newBuilder()
- * .setEntry(Entry.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * Entry response = dataCatalogClient.updateEntry(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Entry updateEntry(UpdateEntryRequest request) {
- return updateEntryCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates an existing entry.
- *
- * You must enable the Data Catalog API in the project identified by the `entry.name` - * parameter. For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * UpdateEntryRequest request =
- * UpdateEntryRequest.newBuilder()
- * .setEntry(Entry.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * ApiFuture future = dataCatalogClient.updateEntryCallable().futureCall(request);
- * // Do something.
- * Entry response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableYou can delete only the entries created by the - * [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
- * dataCatalogClient.deleteEntry(name);
- * }
- * }
- *
- * @param name Required. The name of the entry to delete.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final void deleteEntry(@Nullable EntryName name) {
- DeleteEntryRequest request =
- DeleteEntryRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- deleteEntry(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an existing entry.
- *
- * You can delete only the entries created by the - * [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
- * dataCatalogClient.deleteEntry(name);
- * }
- * }
- *
- * @param name Required. The name of the entry to delete.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final void deleteEntry(String name) {
- DeleteEntryRequest request = DeleteEntryRequest.newBuilder().setName(name).build();
- deleteEntry(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an existing entry.
- *
- * You can delete only the entries created by the - * [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * DeleteEntryRequest request =
- * DeleteEntryRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .build();
- * dataCatalogClient.deleteEntry(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final void deleteEntry(DeleteEntryRequest request) {
- deleteEntryCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an existing entry.
- *
- * You can delete only the entries created by the - * [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * DeleteEntryRequest request =
- * DeleteEntryRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .build();
- * ApiFuture future = dataCatalogClient.deleteEntryCallable().futureCall(request);
- * // Do something.
- * future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
- * Entry response = dataCatalogClient.getEntry(name);
- * }
- * }
- *
- * @param name Required. The name of the entry to get.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Entry getEntry(@Nullable EntryName name) {
- GetEntryRequest request =
- GetEntryRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- return getEntry(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an entry.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
- * Entry response = dataCatalogClient.getEntry(name);
- * }
- * }
- *
- * @param name Required. The name of the entry to get.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Entry getEntry(String name) {
- GetEntryRequest request = GetEntryRequest.newBuilder().setName(name).build();
- return getEntry(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an entry.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * GetEntryRequest request =
- * GetEntryRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .build();
- * Entry response = dataCatalogClient.getEntry(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Entry getEntry(GetEntryRequest request) {
- return getEntryCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an entry.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * GetEntryRequest request =
- * GetEntryRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .build();
- * ApiFuture future = dataCatalogClient.getEntryCallable().futureCall(request);
- * // Do something.
- * Entry response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableThe resource name comes from the source Google Cloud Platform service. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * LookupEntryRequest request =
- * LookupEntryRequest.newBuilder()
- * .setProject("project-309310695")
- * .setLocation("location1901043637")
- * .build();
- * Entry response = dataCatalogClient.lookupEntry(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Entry lookupEntry(LookupEntryRequest request) {
- return lookupEntryCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an entry by its target resource name.
- *
- * The resource name comes from the source Google Cloud Platform service. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * LookupEntryRequest request =
- * LookupEntryRequest.newBuilder()
- * .setProject("project-309310695")
- * .setLocation("location1901043637")
- * .build();
- * ApiFuture future = dataCatalogClient.lookupEntryCallable().futureCall(request);
- * // Do something.
- * Entry response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableNote: Currently, this method can list only custom entries. To get a list of both custom and - * automatically created entries, use - * [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryGroupName parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
- * for (Entry element : dataCatalogClient.listEntries(parent).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param parent Required. The name of the entry group that contains the entries to list.
- * Can be provided in URL format. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final ListEntriesPagedResponse listEntries(@Nullable EntryGroupName parent) { - ListEntriesRequest request = - ListEntriesRequest.newBuilder() - .setParent(parent == null ? null : parent.toString()) - .build(); - return listEntries(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Lists entries. - * - *
Note: Currently, this method can list only custom entries. To get a list of both custom and - * automatically created entries, use - * [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String parent = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString();
- * for (Entry element : dataCatalogClient.listEntries(parent).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param parent Required. The name of the entry group that contains the entries to list.
- * Can be provided in URL format. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final ListEntriesPagedResponse listEntries(String parent) { - ListEntriesRequest request = ListEntriesRequest.newBuilder().setParent(parent).build(); - return listEntries(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Lists entries. - * - *
Note: Currently, this method can list only custom entries. To get a list of both custom and - * automatically created entries, use - * [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ListEntriesRequest request =
- * ListEntriesRequest.newBuilder()
- * .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .setReadMask(FieldMask.newBuilder().build())
- * .build();
- * for (Entry element : dataCatalogClient.listEntries(request).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final ListEntriesPagedResponse listEntries(ListEntriesRequest request) {
- return listEntriesPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists entries.
- *
- * Note: Currently, this method can list only custom entries. To get a list of both custom and - * automatically created entries, use - * [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ListEntriesRequest request =
- * ListEntriesRequest.newBuilder()
- * .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .setReadMask(FieldMask.newBuilder().build())
- * .build();
- * ApiFuture future = dataCatalogClient.listEntriesPagedCallable().futureCall(request);
- * // Do something.
- * for (Entry element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableNote: Currently, this method can list only custom entries. To get a list of both custom and - * automatically created entries, use - * [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ListEntriesRequest request =
- * ListEntriesRequest.newBuilder()
- * .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .setReadMask(FieldMask.newBuilder().build())
- * .build();
- * while (true) {
- * ListEntriesResponse response = dataCatalogClient.listEntriesCallable().call(request);
- * for (Entry element : response.getEntriesList()) {
- * // doThingsWith(element);
- * }
- * String nextPageToken = response.getNextPageToken();
- * if (!Strings.isNullOrEmpty(nextPageToken)) {
- * request = request.toBuilder().setPageToken(nextPageToken).build();
- * } else {
- * break;
- * }
- * }
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableTo call this method, you must have the `datacatalog.entries.updateOverview` IAM permission - * on the corresponding project. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ModifyEntryOverviewRequest request =
- * ModifyEntryOverviewRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setEntryOverview(EntryOverview.newBuilder().build())
- * .build();
- * EntryOverview response = dataCatalogClient.modifyEntryOverview(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final EntryOverview modifyEntryOverview(ModifyEntryOverviewRequest request) {
- return modifyEntryOverviewCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Modifies entry overview, part of the business context of an
- * [Entry][google.cloud.datacatalog.v1.Entry].
- *
- * To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission - * on the corresponding project. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ModifyEntryOverviewRequest request =
- * ModifyEntryOverviewRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setEntryOverview(EntryOverview.newBuilder().build())
- * .build();
- * ApiFuture future =
- * dataCatalogClient.modifyEntryOverviewCallable().futureCall(request);
- * // Do something.
- * EntryOverview response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableTo call this method, you must have the `datacatalog.entries.updateContacts` IAM permission - * on the corresponding project. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ModifyEntryContactsRequest request =
- * ModifyEntryContactsRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setContacts(Contacts.newBuilder().build())
- * .build();
- * Contacts response = dataCatalogClient.modifyEntryContacts(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Contacts modifyEntryContacts(ModifyEntryContactsRequest request) {
- return modifyEntryContactsCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Modifies contacts, part of the business context of an
- * [Entry][google.cloud.datacatalog.v1.Entry].
- *
- * To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission - * on the corresponding project. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ModifyEntryContactsRequest request =
- * ModifyEntryContactsRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setContacts(Contacts.newBuilder().build())
- * .build();
- * ApiFuture future =
- * dataCatalogClient.modifyEntryContactsCallable().futureCall(request);
- * // Do something.
- * Contacts response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableYou must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource project] - * (https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
- * String tagTemplateId = "tagTemplateId-1438776721";
- * TagTemplate tagTemplate = TagTemplate.newBuilder().build();
- * TagTemplate response =
- * dataCatalogClient.createTagTemplate(parent, tagTemplateId, tagTemplate);
- * }
- * }
- *
- * @param parent Required. The name of the project and the template location
- * [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
- * @param tagTemplateId Required. The ID of the tag template to create.
- * The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and - * must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. - * @param tagTemplate Required. The tag template to create. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final TagTemplate createTagTemplate( - @Nullable 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. - * - *
You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource project] - * (https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
- * String tagTemplateId = "tagTemplateId-1438776721";
- * TagTemplate tagTemplate = TagTemplate.newBuilder().build();
- * TagTemplate response =
- * dataCatalogClient.createTagTemplate(parent, tagTemplateId, tagTemplate);
- * }
- * }
- *
- * @param parent Required. The name of the project and the template location
- * [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
- * @param tagTemplateId Required. The ID of the tag template to create.
- * The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and - * must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8. - * @param tagTemplate Required. The tag template to create. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - 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. - * - *
You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource project] - * (https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * CreateTagTemplateRequest request =
- * CreateTagTemplateRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .setTagTemplateId("tagTemplateId-1438776721")
- * .setTagTemplate(TagTemplate.newBuilder().build())
- * .build();
- * TagTemplate response = dataCatalogClient.createTagTemplate(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplate createTagTemplate(CreateTagTemplateRequest request) {
- return createTagTemplateCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates a tag template.
- *
- * You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource project] - * (https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * CreateTagTemplateRequest request =
- * CreateTagTemplateRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .setTagTemplateId("tagTemplateId-1438776721")
- * .setTagTemplate(TagTemplate.newBuilder().build())
- * .build();
- * ApiFuture future =
- * dataCatalogClient.createTagTemplateCallable().futureCall(request);
- * // Do something.
- * TagTemplate response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * TagTemplateName name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
- * TagTemplate response = dataCatalogClient.getTagTemplate(name);
- * }
- * }
- *
- * @param name Required. The name of the tag template to get.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplate getTagTemplate(@Nullable TagTemplateName name) {
- GetTagTemplateRequest request =
- GetTagTemplateRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- return getTagTemplate(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets a tag template.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString();
- * TagTemplate response = dataCatalogClient.getTagTemplate(name);
- * }
- * }
- *
- * @param name Required. The name of the tag template to get.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplate getTagTemplate(String name) {
- GetTagTemplateRequest request = GetTagTemplateRequest.newBuilder().setName(name).build();
- return getTagTemplate(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets a tag template.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * GetTagTemplateRequest request =
- * GetTagTemplateRequest.newBuilder()
- * .setName(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
- * .build();
- * TagTemplate response = dataCatalogClient.getTagTemplate(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplate getTagTemplate(GetTagTemplateRequest request) {
- return getTagTemplateCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets a tag template.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * GetTagTemplateRequest request =
- * GetTagTemplateRequest.newBuilder()
- * .setName(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
- * .build();
- * ApiFuture future =
- * dataCatalogClient.getTagTemplateCallable().futureCall(request);
- * // Do something.
- * TagTemplate response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableYou can't update template fields with this method. These fields are separate resources with - * their own create, update, and delete methods. - * - *
You must enable the Data Catalog API in the project identified by the `tag_template.name` - * parameter. For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * TagTemplate tagTemplate = TagTemplate.newBuilder().build();
- * TagTemplate response = dataCatalogClient.updateTagTemplate(tagTemplate);
- * }
- * }
- *
- * @param tagTemplate Required. The template to update. The `name` field must be set.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplate updateTagTemplate(TagTemplate tagTemplate) {
- UpdateTagTemplateRequest request =
- UpdateTagTemplateRequest.newBuilder().setTagTemplate(tagTemplate).build();
- return updateTagTemplate(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates a tag template.
- *
- * You can't update template fields with this method. These fields are separate resources with - * their own create, update, and delete methods. - * - *
You must enable the Data Catalog API in the project identified by the `tag_template.name` - * parameter. For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * TagTemplate tagTemplate = TagTemplate.newBuilder().build();
- * FieldMask updateMask = FieldMask.newBuilder().build();
- * TagTemplate response = dataCatalogClient.updateTagTemplate(tagTemplate, updateMask);
- * }
- * }
- *
- * @param tagTemplate Required. The template to update. The `name` field must be set.
- * @param updateMask Names of fields whose values to overwrite on a tag template. Currently, only
- * `display_name` and `is_publicly_readable` can be overwritten.
- * If this parameter is absent or empty, all modifiable fields are overwritten. If such - * fields are non-required and omitted in the request body, their values are emptied. - *
Note: Updating the `is_publicly_readable` field may require up to 12 hours to take - * effect in search results. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - 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. - * - *
You can't update template fields with this method. These fields are separate resources with - * their own create, update, and delete methods. - * - *
You must enable the Data Catalog API in the project identified by the `tag_template.name` - * parameter. For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * UpdateTagTemplateRequest request =
- * UpdateTagTemplateRequest.newBuilder()
- * .setTagTemplate(TagTemplate.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * TagTemplate response = dataCatalogClient.updateTagTemplate(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplate updateTagTemplate(UpdateTagTemplateRequest request) {
- return updateTagTemplateCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates a tag template.
- *
- * You can't update template fields with this method. These fields are separate resources with - * their own create, update, and delete methods. - * - *
You must enable the Data Catalog API in the project identified by the `tag_template.name` - * parameter. For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * UpdateTagTemplateRequest request =
- * UpdateTagTemplateRequest.newBuilder()
- * .setTagTemplate(TagTemplate.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * ApiFuture future =
- * dataCatalogClient.updateTagTemplateCallable().futureCall(request);
- * // Do something.
- * TagTemplate response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableYou must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * TagTemplateName name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
- * boolean force = true;
- * dataCatalogClient.deleteTagTemplate(name, force);
- * }
- * }
- *
- * @param name Required. The name of the tag template to delete.
- * @param force Required. If true, deletes all tags that use this template.
- * Currently, `true` is the only supported value. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final void deleteTagTemplate(@Nullable 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 that use it. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString();
- * boolean force = true;
- * dataCatalogClient.deleteTagTemplate(name, force);
- * }
- * }
- *
- * @param name Required. The name of the tag template to delete.
- * @param force Required. If true, deletes all tags that use this template.
- * Currently, `true` is the only supported value. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - 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 that use it. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * DeleteTagTemplateRequest request =
- * DeleteTagTemplateRequest.newBuilder()
- * .setName(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
- * .setForce(true)
- * .build();
- * dataCatalogClient.deleteTagTemplate(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final void deleteTagTemplate(DeleteTagTemplateRequest request) {
- deleteTagTemplateCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a tag template and all tags that use it.
- *
- * You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * DeleteTagTemplateRequest request =
- * DeleteTagTemplateRequest.newBuilder()
- * .setName(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
- * .setForce(true)
- * .build();
- * ApiFuture future = dataCatalogClient.deleteTagTemplateCallable().futureCall(request);
- * // Do something.
- * future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableYou must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * TagTemplateName parent = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]");
- * String tagTemplateFieldId = "tagTemplateFieldId-1556835615";
- * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
- * TagTemplateField response =
- * dataCatalogClient.createTagTemplateField(parent, tagTemplateFieldId, tagTemplateField);
- * }
- * }
- *
- * @param parent Required. The name of the project and the template location
- * [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
- * @param tagTemplateFieldId Required. The ID of the tag template field to create.
- * Note: Adding a required field to an existing template is *not* allowed. - *
Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores - * (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters - * long. Field IDs must also be unique within their template. - * @param tagTemplateField Required. The tag template field to create. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final TagTemplateField createTagTemplateField( - @Nullable 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. - * - *
You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String parent = TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString();
- * String tagTemplateFieldId = "tagTemplateFieldId-1556835615";
- * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
- * TagTemplateField response =
- * dataCatalogClient.createTagTemplateField(parent, tagTemplateFieldId, tagTemplateField);
- * }
- * }
- *
- * @param parent Required. The name of the project and the template location
- * [region](https://cloud.google.com/data-catalog/docs/concepts/regions).
- * @param tagTemplateFieldId Required. The ID of the tag template field to create.
- * Note: Adding a required field to an existing template is *not* allowed. - *
Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores - * (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters - * long. Field IDs must also be unique within their template. - * @param tagTemplateField Required. The tag template field to create. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - 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. - * - *
You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * CreateTagTemplateFieldRequest request =
- * CreateTagTemplateFieldRequest.newBuilder()
- * .setParent(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
- * .setTagTemplateFieldId("tagTemplateFieldId-1556835615")
- * .setTagTemplateField(TagTemplateField.newBuilder().build())
- * .build();
- * TagTemplateField response = dataCatalogClient.createTagTemplateField(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplateField createTagTemplateField(CreateTagTemplateFieldRequest request) {
- return createTagTemplateFieldCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates a field in a tag template.
- *
- * You must enable the Data Catalog API in the project identified by the `parent` parameter. - * For more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * CreateTagTemplateFieldRequest request =
- * CreateTagTemplateFieldRequest.newBuilder()
- * .setParent(TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
- * .setTagTemplateFieldId("tagTemplateFieldId-1556835615")
- * .setTagTemplateField(TagTemplateField.newBuilder().build())
- * .build();
- * ApiFuture future =
- * dataCatalogClient.createTagTemplateFieldCallable().futureCall(request);
- * // Do something.
- * TagTemplateField response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableYou can't update the field type with this method. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * TagTemplateFieldName name =
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
- * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
- * TagTemplateField response = dataCatalogClient.updateTagTemplateField(name, tagTemplateField);
- * }
- * }
- *
- * @param name Required. The name of the tag template field.
- * @param tagTemplateField Required. The template to update.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplateField updateTagTemplateField(
- @Nullable 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.
- *
- * You can't update the field type with this method. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name =
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
- * .toString();
- * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
- * TagTemplateField response = dataCatalogClient.updateTagTemplateField(name, tagTemplateField);
- * }
- * }
- *
- * @param name Required. The name of the tag template field.
- * @param tagTemplateField Required. The template to update.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- 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.
- *
- * You can't update the field type with this method. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * TagTemplateFieldName name =
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
- * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
- * FieldMask updateMask = FieldMask.newBuilder().build();
- * TagTemplateField response =
- * dataCatalogClient.updateTagTemplateField(name, tagTemplateField, updateMask);
- * }
- * }
- *
- * @param name Required. The name of the tag template field.
- * @param tagTemplateField Required. The template to update.
- * @param updateMask Optional. Names of fields whose values to overwrite on an individual field of
- * a tag template. The following fields are modifiable:
- * If this parameter is absent or empty, all modifiable fields are overwritten. If such - * fields are non-required and omitted in the request body, their values are emptied with one - * exception: when updating an enum type, the provided values are merged with the existing - * values. Therefore, enum values can only be added, existing enum values cannot be deleted or - * renamed. - *
Additionally, updating a template field from optional to required is - *
You can't update the field type with this method. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name =
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
- * .toString();
- * TagTemplateField tagTemplateField = TagTemplateField.newBuilder().build();
- * FieldMask updateMask = FieldMask.newBuilder().build();
- * TagTemplateField response =
- * dataCatalogClient.updateTagTemplateField(name, tagTemplateField, updateMask);
- * }
- * }
- *
- * @param name Required. The name of the tag template field.
- * @param tagTemplateField Required. The template to update.
- * @param updateMask Optional. Names of fields whose values to overwrite on an individual field of
- * a tag template. The following fields are modifiable:
- * If this parameter is absent or empty, all modifiable fields are overwritten. If such - * fields are non-required and omitted in the request body, their values are emptied with one - * exception: when updating an enum type, the provided values are merged with the existing - * values. Therefore, enum values can only be added, existing enum values cannot be deleted or - * renamed. - *
Additionally, updating a template field from optional to required is - *
You can't update the field type with this method. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * UpdateTagTemplateFieldRequest request =
- * UpdateTagTemplateFieldRequest.newBuilder()
- * .setName(
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
- * .toString())
- * .setTagTemplateField(TagTemplateField.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * TagTemplateField response = dataCatalogClient.updateTagTemplateField(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplateField updateTagTemplateField(UpdateTagTemplateFieldRequest request) {
- return updateTagTemplateFieldCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates a field in a tag template.
- *
- * You can't update the field type with this method. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * UpdateTagTemplateFieldRequest request =
- * UpdateTagTemplateFieldRequest.newBuilder()
- * .setName(
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
- * .toString())
- * .setTagTemplateField(TagTemplateField.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * ApiFuture future =
- * dataCatalogClient.updateTagTemplateFieldCallable().futureCall(request);
- * // Do something.
- * TagTemplateField response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableYou must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource project] - * (https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * TagTemplateFieldName name =
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
- * String newTagTemplateFieldId = "newTagTemplateFieldId2008993953";
- * TagTemplateField response =
- * dataCatalogClient.renameTagTemplateField(name, newTagTemplateFieldId);
- * }
- * }
- *
- * @param name Required. The name of the tag template field.
- * @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
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplateField renameTagTemplateField(
- @Nullable 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.
- *
- * You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource project] - * (https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name =
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
- * .toString();
- * String newTagTemplateFieldId = "newTagTemplateFieldId2008993953";
- * TagTemplateField response =
- * dataCatalogClient.renameTagTemplateField(name, newTagTemplateFieldId);
- * }
- * }
- *
- * @param name Required. The name of the tag template field.
- * @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
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- 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.
- *
- * You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource project] - * (https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * RenameTagTemplateFieldRequest request =
- * RenameTagTemplateFieldRequest.newBuilder()
- * .setName(
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
- * .toString())
- * .setNewTagTemplateFieldId("newTagTemplateFieldId2008993953")
- * .build();
- * TagTemplateField response = dataCatalogClient.renameTagTemplateField(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplateField renameTagTemplateField(RenameTagTemplateFieldRequest request) {
- return renameTagTemplateFieldCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Renames a field in a tag template.
- *
- * You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource project] - * (https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * RenameTagTemplateFieldRequest request =
- * RenameTagTemplateFieldRequest.newBuilder()
- * .setName(
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
- * .toString())
- * .setNewTagTemplateFieldId("newTagTemplateFieldId2008993953")
- * .build();
- * ApiFuture future =
- * dataCatalogClient.renameTagTemplateFieldCallable().futureCall(request);
- * // Do something.
- * TagTemplateField response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableWithin a single enum field, enum values must be unique. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * TagTemplateFieldEnumValueName name =
- * TagTemplateFieldEnumValueName.of(
- * "[PROJECT]",
- * "[LOCATION]",
- * "[TAG_TEMPLATE]",
- * "[TAG_TEMPLATE_FIELD_ID]",
- * "[ENUM_VALUE_DISPLAY_NAME]");
- * String newEnumValueDisplayName = "newEnumValueDisplayName-1119629027";
- * TagTemplateField response =
- * dataCatalogClient.renameTagTemplateFieldEnumValue(name, newEnumValueDisplayName);
- * }
- * }
- *
- * @param name Required. The name of the enum field value.
- * @param newEnumValueDisplayName Required. The new display name of the enum value. For example,
- * `my_new_enum_value`.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplateField renameTagTemplateFieldEnumValue(
- @Nullable TagTemplateFieldEnumValueName name, String newEnumValueDisplayName) {
- RenameTagTemplateFieldEnumValueRequest request =
- RenameTagTemplateFieldEnumValueRequest.newBuilder()
- .setName(name == null ? null : name.toString())
- .setNewEnumValueDisplayName(newEnumValueDisplayName)
- .build();
- return renameTagTemplateFieldEnumValue(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Renames an enum value in a tag template.
- *
- * Within a single enum field, enum values must be unique. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name =
- * TagTemplateFieldEnumValueName.of(
- * "[PROJECT]",
- * "[LOCATION]",
- * "[TAG_TEMPLATE]",
- * "[TAG_TEMPLATE_FIELD_ID]",
- * "[ENUM_VALUE_DISPLAY_NAME]")
- * .toString();
- * String newEnumValueDisplayName = "newEnumValueDisplayName-1119629027";
- * TagTemplateField response =
- * dataCatalogClient.renameTagTemplateFieldEnumValue(name, newEnumValueDisplayName);
- * }
- * }
- *
- * @param name Required. The name of the enum field value.
- * @param newEnumValueDisplayName Required. The new display name of the enum value. For example,
- * `my_new_enum_value`.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplateField renameTagTemplateFieldEnumValue(
- String name, String newEnumValueDisplayName) {
- RenameTagTemplateFieldEnumValueRequest request =
- RenameTagTemplateFieldEnumValueRequest.newBuilder()
- .setName(name)
- .setNewEnumValueDisplayName(newEnumValueDisplayName)
- .build();
- return renameTagTemplateFieldEnumValue(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Renames an enum value in a tag template.
- *
- * Within a single enum field, enum values must be unique. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * RenameTagTemplateFieldEnumValueRequest request =
- * RenameTagTemplateFieldEnumValueRequest.newBuilder()
- * .setName(
- * TagTemplateFieldEnumValueName.of(
- * "[PROJECT]",
- * "[LOCATION]",
- * "[TAG_TEMPLATE]",
- * "[TAG_TEMPLATE_FIELD_ID]",
- * "[ENUM_VALUE_DISPLAY_NAME]")
- * .toString())
- * .setNewEnumValueDisplayName("newEnumValueDisplayName-1119629027")
- * .build();
- * TagTemplateField response = dataCatalogClient.renameTagTemplateFieldEnumValue(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TagTemplateField renameTagTemplateFieldEnumValue(
- RenameTagTemplateFieldEnumValueRequest request) {
- return renameTagTemplateFieldEnumValueCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Renames an enum value in a tag template.
- *
- * Within a single enum field, enum values must be unique. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * RenameTagTemplateFieldEnumValueRequest request =
- * RenameTagTemplateFieldEnumValueRequest.newBuilder()
- * .setName(
- * TagTemplateFieldEnumValueName.of(
- * "[PROJECT]",
- * "[LOCATION]",
- * "[TAG_TEMPLATE]",
- * "[TAG_TEMPLATE_FIELD_ID]",
- * "[ENUM_VALUE_DISPLAY_NAME]")
- * .toString())
- * .setNewEnumValueDisplayName("newEnumValueDisplayName-1119629027")
- * .build();
- * ApiFuture future =
- * dataCatalogClient.renameTagTemplateFieldEnumValueCallable().futureCall(request);
- * // Do something.
- * TagTemplateField response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableYou must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * TagTemplateFieldName name =
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]");
- * boolean force = true;
- * dataCatalogClient.deleteTagTemplateField(name, force);
- * }
- * }
- *
- * @param name Required. The name of the tag template field to delete.
- * @param force Required. If true, deletes this field from any tags that use it.
- * Currently, `true` is the only supported value. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final void deleteTagTemplateField(@Nullable 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 this field from the tags based on this - * template. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name =
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
- * .toString();
- * boolean force = true;
- * dataCatalogClient.deleteTagTemplateField(name, force);
- * }
- * }
- *
- * @param name Required. The name of the tag template field to delete.
- * @param force Required. If true, deletes this field from any tags that use it.
- * Currently, `true` is the only supported value. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - 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 this field from the tags based on this - * template. - * - *
You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * DeleteTagTemplateFieldRequest request =
- * DeleteTagTemplateFieldRequest.newBuilder()
- * .setName(
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
- * .toString())
- * .setForce(true)
- * .build();
- * dataCatalogClient.deleteTagTemplateField(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final void deleteTagTemplateField(DeleteTagTemplateFieldRequest request) {
- deleteTagTemplateFieldCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a field in a tag template and all uses of this field from the tags based on this
- * template.
- *
- * You must enable the Data Catalog API in the project identified by the `name` parameter. For - * more information, see [Data Catalog resource - * project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * DeleteTagTemplateFieldRequest request =
- * DeleteTagTemplateFieldRequest.newBuilder()
- * .setName(
- * TagTemplateFieldName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]", "[FIELD]")
- * .toString())
- * .setForce(true)
- * .build();
- * ApiFuture future =
- * dataCatalogClient.deleteTagTemplateFieldCallable().futureCall(request);
- * // Do something.
- * future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableNote: The project identified by the `parent` parameter for the [tag] - * (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) - * and the [tag template] - * (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) - * used to create the tag must be in the same organization. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryName parent = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
- * Tag tag = Tag.newBuilder().build();
- * Tag response = dataCatalogClient.createTag(parent, tag);
- * }
- * }
- *
- * @param parent Required. The name of the resource to attach this tag to.
- * Tags can be attached to entries or entry groups. An entry can have up to 1000 attached - * tags. - *
Note: The tag and its child resources might not be stored in the location specified in - * its name. - * @param tag Required. The tag to create. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final Tag createTag(@Nullable EntryName parent, Tag tag) { - CreateTagRequest request = - CreateTagRequest.newBuilder() - .setParent(parent == null ? null : parent.toString()) - .setTag(tag) - .build(); - return createTag(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Creates a tag and assigns it to: - * - *
Note: The project identified by the `parent` parameter for the [tag] - * (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) - * and the [tag template] - * (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) - * used to create the tag must be in the same organization. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String parent =
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
- * Tag tag = Tag.newBuilder().build();
- * Tag response = dataCatalogClient.createTag(parent, tag);
- * }
- * }
- *
- * @param parent Required. The name of the resource to attach this tag to.
- * Tags can be attached to entries or entry groups. An entry can have up to 1000 attached - * tags. - *
Note: The tag and its child resources might not be stored in the location specified in - * its name. - * @param tag Required. The tag to create. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - 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 and assigns it to: - * - *
Note: The project identified by the `parent` parameter for the [tag] - * (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) - * and the [tag template] - * (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) - * used to create the tag must be in the same organization. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * CreateTagRequest request =
- * CreateTagRequest.newBuilder()
- * .setParent(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setTag(Tag.newBuilder().build())
- * .build();
- * Tag response = dataCatalogClient.createTag(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Tag createTag(CreateTagRequest request) {
- return createTagCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates a tag and assigns it to:
- *
- * Note: The project identified by the `parent` parameter for the [tag] - * (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) - * and the [tag template] - * (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) - * used to create the tag must be in the same organization. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * CreateTagRequest request =
- * CreateTagRequest.newBuilder()
- * .setParent(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setTag(Tag.newBuilder().build())
- * .build();
- * ApiFuture future = dataCatalogClient.createTagCallable().futureCall(request);
- * // Do something.
- * Tag response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * Tag tag = Tag.newBuilder().build();
- * Tag response = dataCatalogClient.updateTag(tag);
- * }
- * }
- *
- * @param tag Required. The updated tag. The "name" field must be set.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Tag updateTag(Tag tag) {
- UpdateTagRequest request = UpdateTagRequest.newBuilder().setTag(tag).build();
- return updateTag(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates an existing tag.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * Tag tag = Tag.newBuilder().build();
- * FieldMask updateMask = FieldMask.newBuilder().build();
- * Tag response = dataCatalogClient.updateTag(tag, updateMask);
- * }
- * }
- *
- * @param tag Required. The updated tag. The "name" field must be set.
- * @param updateMask Names of fields whose values to overwrite on a tag. Currently, a tag has the
- * only modifiable field with the name `fields`.
- * In general, if this parameter is absent or empty, all modifiable fields are overwritten. - * If such fields are non-required and omitted in the request body, their values are emptied. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final Tag updateTag(Tag tag, FieldMask updateMask) { - UpdateTagRequest request = - UpdateTagRequest.newBuilder().setTag(tag).setUpdateMask(updateMask).build(); - return updateTag(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Updates an existing tag. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * UpdateTagRequest request =
- * UpdateTagRequest.newBuilder()
- * .setTag(Tag.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * Tag response = dataCatalogClient.updateTag(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Tag updateTag(UpdateTagRequest request) {
- return updateTagCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates an existing tag.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * UpdateTagRequest request =
- * UpdateTagRequest.newBuilder()
- * .setTag(Tag.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * ApiFuture future = dataCatalogClient.updateTagCallable().futureCall(request);
- * // Do something.
- * Tag response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
- * dataCatalogClient.deleteTag(name);
- * }
- * }
- *
- * @param name Required. The name of the tag to delete.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final void deleteTag(@Nullable EntryName name) {
- DeleteTagRequest request =
- DeleteTagRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- deleteTag(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a tag.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
- * dataCatalogClient.deleteTag(name);
- * }
- * }
- *
- * @param name Required. The name of the tag to delete.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final void deleteTag(String name) {
- DeleteTagRequest request = DeleteTagRequest.newBuilder().setName(name).build();
- deleteTag(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a tag.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * DeleteTagRequest request =
- * DeleteTagRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .build();
- * dataCatalogClient.deleteTag(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final void deleteTag(DeleteTagRequest request) {
- deleteTagCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a tag.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * DeleteTagRequest request =
- * DeleteTagRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .build();
- * ApiFuture future = dataCatalogClient.deleteTagCallable().futureCall(request);
- * // Do something.
- * future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryName parent = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
- * for (Tag element : dataCatalogClient.listTags(parent).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param parent Required. The name of the Data Catalog resource to list the tags of.
- * The resource can be an [Entry][google.cloud.datacatalog.v1.Entry] or an - * [EntryGroup][google.cloud.datacatalog.v1.EntryGroup] (without `/entries/{entries}` at the - * end). - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final ListTagsPagedResponse listTags(@Nullable EntryName parent) { - ListTagsRequest request = - ListTagsRequest.newBuilder().setParent(parent == null ? null : parent.toString()).build(); - return listTags(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The - * [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String parent =
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
- * for (Tag element : dataCatalogClient.listTags(parent).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param parent Required. The name of the Data Catalog resource to list the tags of.
- * The resource can be an [Entry][google.cloud.datacatalog.v1.Entry] or an - * [EntryGroup][google.cloud.datacatalog.v1.EntryGroup] (without `/entries/{entries}` at the - * end). - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - * @deprecated This method is deprecated and will be removed in the next major version update. - */ - @Deprecated - public final ListTagsPagedResponse listTags(String parent) { - ListTagsRequest request = ListTagsRequest.newBuilder().setParent(parent).build(); - return listTags(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The - * [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ListTagsRequest request =
- * ListTagsRequest.newBuilder()
- * .setParent(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .build();
- * for (Tag element : dataCatalogClient.listTags(request).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final ListTagsPagedResponse listTags(ListTagsRequest request) {
- return listTagsPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The
- * [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ListTagsRequest request =
- * ListTagsRequest.newBuilder()
- * .setParent(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .build();
- * ApiFuture future = dataCatalogClient.listTagsPagedCallable().futureCall(request);
- * // Do something.
- * for (Tag element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ListTagsRequest request =
- * ListTagsRequest.newBuilder()
- * .setParent(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .build();
- * while (true) {
- * ListTagsResponse response = dataCatalogClient.listTagsCallable().call(request);
- * for (Tag element : response.getTagsList()) {
- * // doThingsWith(element);
- * }
- * String nextPageToken = response.getNextPageToken();
- * if (!Strings.isNullOrEmpty(nextPageToken)) {
- * request = request.toBuilder().setPageToken(nextPageToken).build();
- * } else {
- * break;
- * }
- * }
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallable`ReconcileTags` returns a [long-running operation] [google.longrunning.Operation] resource - * that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] - * to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a - * [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ReconcileTagsRequest request =
- * ReconcileTagsRequest.newBuilder()
- * .setParent(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setTagTemplate(
- * TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
- * .setForceDeleteMissing(true)
- * .addAllTags(new ArrayList())
- * .build();
- * ReconcileTagsResponse response = dataCatalogClient.reconcileTagsAsync(request).get();
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final OperationFuture`ReconcileTags` returns a [long-running operation] [google.longrunning.Operation] resource - * that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] - * to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a - * [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ReconcileTagsRequest request =
- * ReconcileTagsRequest.newBuilder()
- * .setParent(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setTagTemplate(
- * TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
- * .setForceDeleteMissing(true)
- * .addAllTags(new ArrayList())
- * .build();
- * OperationFuture future =
- * dataCatalogClient.reconcileTagsOperationCallable().futureCall(request);
- * // Do something.
- * ReconcileTagsResponse response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final OperationCallable`ReconcileTags` returns a [long-running operation] [google.longrunning.Operation] resource - * that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] - * to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a - * [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ReconcileTagsRequest request =
- * ReconcileTagsRequest.newBuilder()
- * .setParent(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setTagTemplate(
- * TagTemplateName.of("[PROJECT]", "[LOCATION]", "[TAG_TEMPLATE]").toString())
- * .setForceDeleteMissing(true)
- * .addAllTags(new ArrayList())
- * .build();
- * ApiFuture future = dataCatalogClient.reconcileTagsCallable().futureCall(request);
- * // Do something.
- * Operation response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
- * StarEntryResponse response = dataCatalogClient.starEntry(name);
- * }
- * }
- *
- * @param name Required. The name of the entry to mark as starred.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final StarEntryResponse starEntry(@Nullable EntryName name) {
- StarEntryRequest request =
- StarEntryRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- return starEntry(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring
- * information is private to each user.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
- * StarEntryResponse response = dataCatalogClient.starEntry(name);
- * }
- * }
- *
- * @param name Required. The name of the entry to mark as starred.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final StarEntryResponse starEntry(String name) {
- StarEntryRequest request = StarEntryRequest.newBuilder().setName(name).build();
- return starEntry(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring
- * information is private to each user.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * StarEntryRequest request =
- * StarEntryRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .build();
- * StarEntryResponse response = dataCatalogClient.starEntry(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final StarEntryResponse starEntry(StarEntryRequest request) {
- return starEntryCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring
- * information is private to each user.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * StarEntryRequest request =
- * StarEntryRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .build();
- * ApiFuture future =
- * dataCatalogClient.starEntryCallable().futureCall(request);
- * // Do something.
- * StarEntryResponse response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * EntryName name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
- * UnstarEntryResponse response = dataCatalogClient.unstarEntry(name);
- * }
- * }
- *
- * @param name Required. The name of the entry to mark as **not** starred.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnstarEntryResponse unstarEntry(@Nullable EntryName name) {
- UnstarEntryRequest request =
- UnstarEntryRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- return unstarEntry(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user.
- * Starring information is private to each user.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String name = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
- * UnstarEntryResponse response = dataCatalogClient.unstarEntry(name);
- * }
- * }
- *
- * @param name Required. The name of the entry to mark as **not** starred.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnstarEntryResponse unstarEntry(String name) {
- UnstarEntryRequest request = UnstarEntryRequest.newBuilder().setName(name).build();
- return unstarEntry(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user.
- * Starring information is private to each user.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * UnstarEntryRequest request =
- * UnstarEntryRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .build();
- * UnstarEntryResponse response = dataCatalogClient.unstarEntry(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnstarEntryResponse unstarEntry(UnstarEntryRequest request) {
- return unstarEntryCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user.
- * Starring information is private to each user.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * UnstarEntryRequest request =
- * UnstarEntryRequest.newBuilder()
- * .setName(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .build();
- * ApiFuture future =
- * dataCatalogClient.unstarEntryCallable().futureCall(request);
- * // Do something.
- * UnstarEntryResponse response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSupported resources are: - * - *
- Tag templates - Entry groups - * - *
Note: This method sets policies only within Data Catalog and can't be used to manage - * policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform - * resources synced with the Data Catalog. - * - *
To call this method, you must have the following Google IAM permissions: - * - *
- `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - - * `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ResourceName resource = EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]");
- * Policy policy = Policy.newBuilder().build();
- * Policy response = dataCatalogClient.setIamPolicy(resource, policy);
- * }
- * }
- *
- * @param resource REQUIRED: The resource for which the policy is being specified. See the
- * operation documentation for the appropriate value for this field.
- * @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
- * policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud
- * Platform services (such as Projects) might reject them.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Policy setIamPolicy(@Nullable ResourceName resource, Policy policy) {
- SetIamPolicyRequest request =
- SetIamPolicyRequest.newBuilder()
- .setResource(resource == null ? null : resource.toString())
- .setPolicy(policy)
- .build();
- return setIamPolicy(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Sets an access control policy for a resource. Replaces any existing policy.
- *
- * Supported resources are: - * - *
- Tag templates - Entry groups - * - *
Note: This method sets policies only within Data Catalog and can't be used to manage - * policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform - * resources synced with the Data Catalog. - * - *
To call this method, you must have the following Google IAM permissions: - * - *
- `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - - * `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String resource =
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
- * Policy policy = Policy.newBuilder().build();
- * Policy response = dataCatalogClient.setIamPolicy(resource, policy);
- * }
- * }
- *
- * @param resource REQUIRED: The resource for which the policy is being specified. See the
- * operation documentation for the appropriate value for this field.
- * @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
- * policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud
- * Platform services (such as Projects) might reject them.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Policy setIamPolicy(String resource, Policy policy) {
- SetIamPolicyRequest request =
- SetIamPolicyRequest.newBuilder().setResource(resource).setPolicy(policy).build();
- return setIamPolicy(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Sets an access control policy for a resource. Replaces any existing policy.
- *
- * Supported resources are: - * - *
- Tag templates - Entry groups - * - *
Note: This method sets policies only within Data Catalog and can't be used to manage - * policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform - * resources synced with the Data Catalog. - * - *
To call this method, you must have the following Google IAM permissions: - * - *
- `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - - * `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * SetIamPolicyRequest request =
- * SetIamPolicyRequest.newBuilder()
- * .setResource(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setPolicy(Policy.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * Policy response = dataCatalogClient.setIamPolicy(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Policy setIamPolicy(SetIamPolicyRequest request) {
- return setIamPolicyCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Sets an access control policy for a resource. Replaces any existing policy.
- *
- * Supported resources are: - * - *
- Tag templates - Entry groups - * - *
Note: This method sets policies only within Data Catalog and can't be used to manage - * policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform - * resources synced with the Data Catalog. - * - *
To call this method, you must have the following Google IAM permissions: - * - *
- `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - - * `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * SetIamPolicyRequest request =
- * SetIamPolicyRequest.newBuilder()
- * .setResource(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setPolicy(Policy.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * ApiFuture future = dataCatalogClient.setIamPolicyCallable().futureCall(request);
- * // Do something.
- * Policy response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableMay return: - * - *
Supported resources are: - * - *
- Tag templates - Entry groups - * - *
Note: This method doesn't get policies from Google Cloud Platform resources ingested into - * Data Catalog. - * - *
To call this method, you must have the following Google IAM permissions: - * - *
- `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - - * `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ResourceName resource = EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]");
- * Policy response = dataCatalogClient.getIamPolicy(resource);
- * }
- * }
- *
- * @param resource REQUIRED: The resource for which the policy is being requested. See the
- * operation documentation for the appropriate value for this field.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Policy getIamPolicy(@Nullable ResourceName resource) {
- GetIamPolicyRequest request =
- GetIamPolicyRequest.newBuilder()
- .setResource(resource == null ? null : resource.toString())
- .build();
- return getIamPolicy(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets the access control policy for a resource.
- *
- * May return: - * - *
Supported resources are: - * - *
- Tag templates - Entry groups - * - *
Note: This method doesn't get policies from Google Cloud Platform resources ingested into - * Data Catalog. - * - *
To call this method, you must have the following Google IAM permissions: - * - *
- `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - - * `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * String resource =
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString();
- * Policy response = dataCatalogClient.getIamPolicy(resource);
- * }
- * }
- *
- * @param resource REQUIRED: The resource for which the policy is being requested. See the
- * operation documentation for the appropriate value for this field.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Policy getIamPolicy(String resource) {
- GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder().setResource(resource).build();
- return getIamPolicy(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets the access control policy for a resource.
- *
- * May return: - * - *
Supported resources are: - * - *
- Tag templates - Entry groups - * - *
Note: This method doesn't get policies from Google Cloud Platform resources ingested into - * Data Catalog. - * - *
To call this method, you must have the following Google IAM permissions: - * - *
- `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - - * `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * GetIamPolicyRequest request =
- * GetIamPolicyRequest.newBuilder()
- * .setResource(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setOptions(GetPolicyOptions.newBuilder().build())
- * .build();
- * Policy response = dataCatalogClient.getIamPolicy(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final Policy getIamPolicy(GetIamPolicyRequest request) {
- return getIamPolicyCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets the access control policy for a resource.
- *
- * May return: - * - *
Supported resources are: - * - *
- Tag templates - Entry groups - * - *
Note: This method doesn't get policies from Google Cloud Platform resources ingested into - * Data Catalog. - * - *
To call this method, you must have the following Google IAM permissions: - * - *
- `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - - * `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * GetIamPolicyRequest request =
- * GetIamPolicyRequest.newBuilder()
- * .setResource(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .setOptions(GetPolicyOptions.newBuilder().build())
- * .build();
- * ApiFuture future = dataCatalogClient.getIamPolicyCallable().futureCall(request);
- * // Do something.
- * Policy response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableReturns an empty set of permissions if the resource doesn't exist. - * - *
Supported resources are: - * - *
- Tag templates - Entry groups - * - *
Note: This method gets policies only within Data Catalog and can't be used to get policies - * from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources - * ingested into Data Catalog. - * - *
No Google IAM permissions are required to call this method. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * TestIamPermissionsRequest request =
- * TestIamPermissionsRequest.newBuilder()
- * .setResource(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .addAllPermissions(new ArrayList())
- * .build();
- * TestIamPermissionsResponse response = dataCatalogClient.testIamPermissions(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
- return testIamPermissionsCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets your permissions on a resource.
- *
- * Returns an empty set of permissions if the resource doesn't exist. - * - *
Supported resources are: - * - *
- Tag templates - Entry groups - * - *
Note: This method gets policies only within Data Catalog and can't be used to get policies - * from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources - * ingested into Data Catalog. - * - *
No Google IAM permissions are required to call this method. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * TestIamPermissionsRequest request =
- * TestIamPermissionsRequest.newBuilder()
- * .setResource(
- * EntryName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]", "[ENTRY]").toString())
- * .addAllPermissions(new ArrayList())
- * .build();
- * ApiFuture future =
- * dataCatalogClient.testIamPermissionsCallable().futureCall(request);
- * // Do something.
- * TestIamPermissionsResponse response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallable`ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be - * delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer - * messages of [DumpItem][google.cloud.datacatalog.v1.DumpItem] type. - * - *
`ImportEntries` returns a [long-running operation] [google.longrunning.Operation] resource - * that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] - * to return [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata] and an - * [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse] message. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ImportEntriesRequest request =
- * ImportEntriesRequest.newBuilder()
- * .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setJobId("jobId101296568")
- * .build();
- * ImportEntriesResponse response = dataCatalogClient.importEntriesAsync(request).get();
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final OperationFuture`ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be - * delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer - * messages of [DumpItem][google.cloud.datacatalog.v1.DumpItem] type. - * - *
`ImportEntries` returns a [long-running operation] [google.longrunning.Operation] resource - * that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] - * to return [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata] and an - * [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse] message. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ImportEntriesRequest request =
- * ImportEntriesRequest.newBuilder()
- * .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setJobId("jobId101296568")
- * .build();
- * OperationFuture future =
- * dataCatalogClient.importEntriesOperationCallable().futureCall(request);
- * // Do something.
- * ImportEntriesResponse response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final OperationCallable`ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be - * delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer - * messages of [DumpItem][google.cloud.datacatalog.v1.DumpItem] type. - * - *
`ImportEntries` returns a [long-running operation] [google.longrunning.Operation] resource - * that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] - * to return [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata] and an - * [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse] message. - * - *
Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * ImportEntriesRequest request =
- * ImportEntriesRequest.newBuilder()
- * .setParent(EntryGroupName.of("[PROJECT]", "[LOCATION]", "[ENTRY_GROUP]").toString())
- * .setJobId("jobId101296568")
- * .build();
- * ApiFuture future = dataCatalogClient.importEntriesCallable().futureCall(request);
- * // Do something.
- * Operation response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * SetConfigRequest request = SetConfigRequest.newBuilder().setName("name3373707").build();
- * MigrationConfig response = dataCatalogClient.setConfig(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final MigrationConfig setConfig(SetConfigRequest request) {
- return setConfigCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Sets the configuration related to the migration to Dataplex for an organization or project.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * SetConfigRequest request = SetConfigRequest.newBuilder().setName("name3373707").build();
- * ApiFuture future = dataCatalogClient.setConfigCallable().futureCall(request);
- * // Do something.
- * MigrationConfig response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * RetrieveConfigRequest request =
- * RetrieveConfigRequest.newBuilder().setName("name3373707").build();
- * OrganizationConfig response = dataCatalogClient.retrieveConfig(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final OrganizationConfig retrieveConfig(RetrieveConfigRequest request) {
- return retrieveConfigCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Retrieves the configuration related to the migration from Data Catalog to Dataplex for a
- * specific organization, including all the projects under it which have a separate configuration
- * set.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * RetrieveConfigRequest request =
- * RetrieveConfigRequest.newBuilder().setName("name3373707").build();
- * ApiFuture future =
- * dataCatalogClient.retrieveConfigCallable().futureCall(request);
- * // Do something.
- * OrganizationConfig response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableSample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * RetrieveEffectiveConfigRequest request =
- * RetrieveEffectiveConfigRequest.newBuilder().setName("name3373707").build();
- * MigrationConfig response = dataCatalogClient.retrieveEffectiveConfig(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final MigrationConfig retrieveEffectiveConfig(RetrieveEffectiveConfigRequest request) {
- return retrieveEffectiveConfigCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Retrieves the effective configuration related to the migration from Data Catalog to Dataplex
- * for a specific organization or project. If there is no specific configuration set for the
- * resource, the setting is checked hierarchicahlly through the ancestors of the resource,
- * starting from the resource itself.
- *
- * Sample code: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * RetrieveEffectiveConfigRequest request =
- * RetrieveEffectiveConfigRequest.newBuilder().setName("name3373707").build();
- * ApiFuture future =
- * dataCatalogClient.retrieveEffectiveConfigCallable().futureCall(request);
- * // Do something.
- * MigrationConfig response = future.get();
- * }
- * }
- *
- * @deprecated This method is deprecated and will be removed in the next major version update.
- */
- @Deprecated
- public final UnaryCallableThe 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 - * [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) - * of createEntryGroup: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * DataCatalogSettings.Builder dataCatalogSettingsBuilder = DataCatalogSettings.newBuilder();
- * dataCatalogSettingsBuilder
- * .createEntryGroupSettings()
- * .setRetrySettings(
- * dataCatalogSettingsBuilder
- * .createEntryGroupSettings()
- * .getRetrySettings()
- * .toBuilder()
- * .setInitialRetryDelayDuration(Duration.ofSeconds(1))
- * .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
- * .setMaxAttempts(5)
- * .setMaxRetryDelayDuration(Duration.ofSeconds(30))
- * .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
- * .setRetryDelayMultiplier(1.3)
- * .setRpcTimeoutMultiplier(1.5)
- * .setTotalTimeoutDuration(Duration.ofSeconds(300))
- * .build());
- * DataCatalogSettings dataCatalogSettings = dataCatalogSettingsBuilder.build();
- * }
- *
- * Please refer to the [Client Side Retry
- * Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
- * retries.
- *
- * To configure the RetrySettings of a Long Running Operation method, create an - * OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to - * configure the RetrySettings for reconcileTags: - * - *
{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * DataCatalogSettings.Builder dataCatalogSettingsBuilder = DataCatalogSettings.newBuilder();
- * TimedRetryAlgorithm timedRetryAlgorithm =
- * OperationalTimedPollAlgorithm.create(
- * RetrySettings.newBuilder()
- * .setInitialRetryDelayDuration(Duration.ofMillis(500))
- * .setRetryDelayMultiplier(1.5)
- * .setMaxRetryDelayDuration(Duration.ofMillis(5000))
- * .setTotalTimeoutDuration(Duration.ofHours(24))
- * .build());
- * dataCatalogSettingsBuilder
- * .createClusterOperationSettings()
- * .setPollingAlgorithm(timedRetryAlgorithm)
- * .build();
- * }
- *
- * @deprecated This class is deprecated and will be removed in the next major version update.
- */
-@NullMarked
-@Deprecated
-@Generated("by gapic-generator-java")
-public class DataCatalogSettings extends ClientSettingsNote: This method does not support applying settings to streaming methods.
- */
- public Builder applyToAllUnaryMethods(
- ApiFunction Policy tags are used to tag BigQuery columns and apply additional access control policies. A
- * taxonomy is a hierarchical grouping of policy tags that classify data along a common axis.
- *
- * 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:
- *
- * Note: close() needs to be called on the PolicyTagManagerClient object to clean up resources
- * such as threads. In the example above, try-with-resources is used, which automatically calls
- * close().
- *
- * CreateTaxonomy Creates a taxonomy in a specified project.
- * The taxonomy is initially empty, that is, it doesn't contain policy tags. Request object method variants only take one parameter, a request object, which must be constructed before the call. createTaxonomy(CreateTaxonomyRequest request)
- * "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createTaxonomy(LocationName parent, Taxonomy taxonomy)
- * createTaxonomy(String parent, Taxonomy taxonomy)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createTaxonomyCallable()
- * DeleteTaxonomy Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns. Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteTaxonomy(DeleteTaxonomyRequest request)
- * "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteTaxonomy(TaxonomyName name)
- * deleteTaxonomy(String name)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteTaxonomyCallable()
- * UpdateTaxonomy Updates a taxonomy, including its display name, description, and activated policy types. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateTaxonomy(UpdateTaxonomyRequest request)
- * "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateTaxonomy(Taxonomy taxonomy)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateTaxonomyCallable()
- * ListTaxonomies Lists all taxonomies in a project in a particular location that you have a permission to view. Request object method variants only take one parameter, a request object, which must be constructed before the call. listTaxonomies(ListTaxonomiesRequest request)
- * "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listTaxonomies(LocationName parent)
- * listTaxonomies(String parent)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listTaxonomiesPagedCallable()
- * listTaxonomiesCallable()
- * GetTaxonomy Gets a taxonomy. Request object method variants only take one parameter, a request object, which must be constructed before the call. getTaxonomy(GetTaxonomyRequest request)
- * "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getTaxonomy(TaxonomyName name)
- * getTaxonomy(String name)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getTaxonomyCallable()
- * CreatePolicyTag Creates a policy tag in a taxonomy. Request object method variants only take one parameter, a request object, which must be constructed before the call. createPolicyTag(CreatePolicyTagRequest request)
- * "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createPolicyTag(TaxonomyName parent, PolicyTag policyTag)
- * createPolicyTag(String parent, PolicyTag policyTag)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createPolicyTagCallable()
- * DeletePolicyTag Deletes a policy tag together with the following:
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. deletePolicyTag(DeletePolicyTagRequest request)
- * "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deletePolicyTag(PolicyTagName name)
- * deletePolicyTag(String name)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deletePolicyTagCallable()
- * UpdatePolicyTag Updates a policy tag, including its display name, description, and parent policy tag. Request object method variants only take one parameter, a request object, which must be constructed before the call. updatePolicyTag(UpdatePolicyTagRequest request)
- * "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updatePolicyTag(PolicyTag policyTag)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updatePolicyTagCallable()
- * ListPolicyTags Lists all policy tags in a taxonomy. Request object method variants only take one parameter, a request object, which must be constructed before the call. listPolicyTags(ListPolicyTagsRequest request)
- * "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listPolicyTags(TaxonomyName parent)
- * listPolicyTags(String parent)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPolicyTagsPagedCallable()
- * listPolicyTagsCallable()
- * GetPolicyTag Gets a policy tag. Request object method variants only take one parameter, a request object, which must be constructed before the call. getPolicyTag(GetPolicyTagRequest request)
- * "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getPolicyTag(PolicyTagName name)
- * getPolicyTag(String name)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getPolicyTagCallable()
- * GetIamPolicy Gets the IAM policy for a policy tag or a taxonomy. Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
- * SetIamPolicy Sets the IAM policy for a policy tag or a taxonomy. Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
- * TestIamPermissions Returns your permissions on a specified policy tag or taxonomy. Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()
- * See the individual methods for example code.
- *
- * Many parameters require resource names to be formatted in a particular way. To assist with
- * these names, this class includes a format method for each type of name, and additionally a parse
- * method to extract the individual identifiers contained within names that are returned.
- *
- * This class can be customized by passing in a custom instance of PolicyTagManagerSettings to
- * create(). For example:
- *
- * To customize credentials:
- *
- * To customize the endpoint:
- *
- * To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
- * the wire:
- *
- * Please refer to the GitHub repository's samples for more quickstart code snippets.
- */
-@NullMarked
-@Generated("by gapic-generator-java")
-public class PolicyTagManagerClient implements BackgroundResource {
- private final @Nullable PolicyTagManagerSettings settings;
- private final PolicyTagManagerStub stub;
-
- /** Constructs an instance of PolicyTagManagerClient with default settings. */
- public static final PolicyTagManagerClient create() throws IOException {
- return create(PolicyTagManagerSettings.newBuilder().build());
- }
-
- /**
- * Constructs an instance of PolicyTagManagerClient, 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 PolicyTagManagerClient create(PolicyTagManagerSettings settings)
- throws IOException {
- return new PolicyTagManagerClient(settings);
- }
-
- /**
- * Constructs an instance of PolicyTagManagerClient, using the given stub for making calls. This
- * is for advanced usage - prefer using create(PolicyTagManagerSettings).
- */
- public static final PolicyTagManagerClient create(PolicyTagManagerStub stub) {
- return new PolicyTagManagerClient(stub);
- }
-
- /**
- * Constructs an instance of PolicyTagManagerClient, 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 PolicyTagManagerClient(PolicyTagManagerSettings settings) throws IOException {
- this.settings = settings;
- this.stub = ((PolicyTagManagerStubSettings) settings.getStubSettings()).createStub();
- }
-
- protected PolicyTagManagerClient(PolicyTagManagerStub stub) {
- this.settings = null;
- this.stub = stub;
- }
-
- public final @Nullable PolicyTagManagerSettings getSettings() {
- return settings;
- }
-
- public PolicyTagManagerStub getStub() {
- return stub;
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates a taxonomy in a specified project.
- *
- * The taxonomy is initially empty, that is, it doesn't contain policy tags.
- *
- * Sample code:
- *
- * The taxonomy is initially empty, that is, it doesn't contain policy tags.
- *
- * Sample code:
- *
- * The taxonomy is initially empty, that is, it doesn't contain policy tags.
- *
- * Sample code:
- *
- * The taxonomy is initially empty, that is, it doesn't contain policy tags.
- *
- * Sample code:
- *
- * Sample code:
- *
- * Note: All policy tags in this taxonomy are also deleted.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteTaxonomy(@Nullable TaxonomyName name) {
- DeleteTaxonomyRequest request =
- DeleteTaxonomyRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- deleteTaxonomy(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and
- * the policy tags references from BigQuery columns.
- *
- * Sample code:
- *
- * Note: All policy tags in this taxonomy are also deleted.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteTaxonomy(String name) {
- DeleteTaxonomyRequest request = DeleteTaxonomyRequest.newBuilder().setName(name).build();
- deleteTaxonomy(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and
- * the policy tags references from BigQuery columns.
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Note: All of its descendant policy tags are also deleted.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deletePolicyTag(@Nullable PolicyTagName name) {
- DeletePolicyTagRequest request =
- DeletePolicyTagRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- deletePolicyTag(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a policy tag together with the following:
- *
- * Sample code:
- *
- * Note: All of its descendant policy tags are also deleted.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deletePolicyTag(String name) {
- DeletePolicyTagRequest request = DeletePolicyTagRequest.newBuilder().setName(name).build();
- deletePolicyTag(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a policy tag together with the following:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Sample code:
- *
- * Taxonomy is a hierarchical group of policy tags.
- *
- * This class provides the ability to make remote calls to the backing service through method
- * calls that map to API methods. Sample code to get started:
- *
- * Note: close() needs to be called on the PolicyTagManagerSerializationClient object to clean up
- * resources such as threads. In the example above, try-with-resources is used, which automatically
- * calls close().
- *
- * ReplaceTaxonomy Replaces (updates) a taxonomy and all its policy tags.
- * The taxonomy and its entire hierarchy of policy tags must be represented literally by `SerializedTaxonomy` and the nested `SerializedPolicyTag` messages.
- * This operation automatically does the following:
- * - Deletes the existing policy tags that are missing from the `SerializedPolicyTag`. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly. Request object method variants only take one parameter, a request object, which must be constructed before the call. replaceTaxonomy(ReplaceTaxonomyRequest request)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. replaceTaxonomyCallable()
- * ImportTaxonomies Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.
- * For a cross-regional source, new taxonomies are created by copying from a source in another region.
- * For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures. Request object method variants only take one parameter, a request object, which must be constructed before the call. importTaxonomies(ImportTaxonomiesRequest request)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importTaxonomiesCallable()
- * ExportTaxonomies Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project.
- * This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can be used as input for `ImportTaxonomies` calls. Request object method variants only take one parameter, a request object, which must be constructed before the call. exportTaxonomies(ExportTaxonomiesRequest request)
- * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. exportTaxonomiesCallable()
- * See the individual methods for example code.
- *
- * Many parameters require resource names to be formatted in a particular way. To assist with
- * these names, this class includes a format method for each type of name, and additionally a parse
- * method to extract the individual identifiers contained within names that are returned.
- *
- * This class can be customized by passing in a custom instance of
- * PolicyTagManagerSerializationSettings to create(). For example:
- *
- * To customize credentials:
- *
- * To customize the endpoint:
- *
- * To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
- * the wire:
- *
- * Please refer to the GitHub repository's samples for more quickstart code snippets.
- */
-@NullMarked
-@Generated("by gapic-generator-java")
-public class PolicyTagManagerSerializationClient implements BackgroundResource {
- private final @Nullable PolicyTagManagerSerializationSettings settings;
- private final PolicyTagManagerSerializationStub stub;
-
- /** Constructs an instance of PolicyTagManagerSerializationClient with default settings. */
- public static final PolicyTagManagerSerializationClient create() throws IOException {
- return create(PolicyTagManagerSerializationSettings.newBuilder().build());
- }
-
- /**
- * Constructs an instance of PolicyTagManagerSerializationClient, 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 PolicyTagManagerSerializationClient create(
- PolicyTagManagerSerializationSettings settings) throws IOException {
- return new PolicyTagManagerSerializationClient(settings);
- }
-
- /**
- * Constructs an instance of PolicyTagManagerSerializationClient, using the given stub for making
- * calls. This is for advanced usage - prefer using create(PolicyTagManagerSerializationSettings).
- */
- public static final PolicyTagManagerSerializationClient create(
- PolicyTagManagerSerializationStub stub) {
- return new PolicyTagManagerSerializationClient(stub);
- }
-
- /**
- * Constructs an instance of PolicyTagManagerSerializationClient, 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 PolicyTagManagerSerializationClient(PolicyTagManagerSerializationSettings settings)
- throws IOException {
- this.settings = settings;
- this.stub =
- ((PolicyTagManagerSerializationStubSettings) settings.getStubSettings()).createStub();
- }
-
- protected PolicyTagManagerSerializationClient(PolicyTagManagerSerializationStub stub) {
- this.settings = null;
- this.stub = stub;
- }
-
- public final @Nullable PolicyTagManagerSerializationSettings getSettings() {
- return settings;
- }
-
- public PolicyTagManagerSerializationStub getStub() {
- return stub;
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Replaces (updates) a taxonomy and all its policy tags.
- *
- * The taxonomy and its entire hierarchy of policy tags must be represented literally by
- * `SerializedTaxonomy` and the nested `SerializedPolicyTag` messages.
- *
- * This operation automatically does the following:
- *
- * - Deletes the existing policy tags that are missing from the `SerializedPolicyTag`. -
- * Creates policy tags that don't have resource names. They are considered new. - Updates policy
- * tags with valid resources names accordingly.
- *
- * Sample code:
- *
- * The taxonomy and its entire hierarchy of policy tags must be represented literally by
- * `SerializedTaxonomy` and the nested `SerializedPolicyTag` messages.
- *
- * This operation automatically does the following:
- *
- * - Deletes the existing policy tags that are missing from the `SerializedPolicyTag`. -
- * Creates policy tags that don't have resource names. They are considered new. - Updates policy
- * tags with valid resources names accordingly.
- *
- * Sample code:
- *
- * For a cross-regional source, new taxonomies are created by copying from a source in another
- * region.
- *
- * For an inlined source, taxonomies and policy tags are created in bulk using nested protocol
- * buffer structures.
- *
- * Sample code:
- *
- * For a cross-regional source, new taxonomies are created by copying from a source in another
- * region.
- *
- * For an inlined source, taxonomies and policy tags are created in bulk using nested protocol
- * buffer structures.
- *
- * Sample code:
- *
- * This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can
- * be used as input for `ImportTaxonomies` calls.
- *
- * Sample code:
- *
- * This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can
- * be used as input for `ImportTaxonomies` calls.
- *
- * Sample code:
- *
- * 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
- * [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings)
- * of replaceTaxonomy:
- *
- * Note: This method does not support applying settings to streaming methods.
- */
- public Builder applyToAllUnaryMethods(
- ApiFunction 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
- * [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings)
- * of createTaxonomy:
- *
- * Note: 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: Deprecated: Please use Dataplex Catalog instead.
- *
- * Data Catalog API service allows you to discover, understand, and manage your data.
- *
- * Sample for DataCatalogClient:
- *
- * ======================= PolicyTagManagerClient =======================
- *
- * Service Description: Policy Tag Manager API service allows you to manage your policy tags and
- * taxonomies.
- *
- * Policy tags are used to tag BigQuery columns and apply additional access control policies. A
- * taxonomy is a hierarchical grouping of policy tags that classify data along a common axis.
- *
- * Sample for PolicyTagManagerClient:
- *
- * ======================= PolicyTagManagerSerializationClient =======================
- *
- * Service Description: Policy Tag Manager Serialization API service allows you to manipulate
- * your policy tags and taxonomies in a serialized format.
- *
- * Taxonomy is a hierarchical group of policy tags.
- *
- * Sample for PolicyTagManagerSerializationClient:
- *
- * This class is for advanced usage and reflects the underlying API directly.
- *
- * @deprecated This class is deprecated and will be removed in the next major version update.
- */
-@NullMarked
-@Deprecated
-@Generated("by gapic-generator-java")
-public abstract class DataCatalogStub implements BackgroundResource {
-
- public @Nullable OperationsStub getOperationsStub() {
- return null;
- }
-
- public com.google.api.gax.httpjson.longrunning.stub.@Nullable OperationsStub
- getHttpJsonOperationsStub() {
- return null;
- }
-
- @Deprecated
- public UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
- * Taxonomy taxonomy = Taxonomy.newBuilder().build();
- * Taxonomy response = policyTagManagerClient.createTaxonomy(parent, taxonomy);
- * }
- * }
- *
- *
- *
- *
- *
- *
- * Method
- * Description
- * Method Variants
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * PolicyTagManagerSettings policyTagManagerSettings =
- * PolicyTagManagerSettings.newBuilder()
- * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
- * .build();
- * PolicyTagManagerClient policyTagManagerClient =
- * PolicyTagManagerClient.create(policyTagManagerSettings);
- * }
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * PolicyTagManagerSettings policyTagManagerSettings =
- * PolicyTagManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
- * PolicyTagManagerClient policyTagManagerClient =
- * PolicyTagManagerClient.create(policyTagManagerSettings);
- * }
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * PolicyTagManagerSettings policyTagManagerSettings =
- * PolicyTagManagerSettings.newHttpJsonBuilder().build();
- * PolicyTagManagerClient policyTagManagerClient =
- * PolicyTagManagerClient.create(policyTagManagerSettings);
- * }
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
- * Taxonomy taxonomy = Taxonomy.newBuilder().build();
- * Taxonomy response = policyTagManagerClient.createTaxonomy(parent, taxonomy);
- * }
- * }
- *
- * @param parent Required. Resource name of the project that the taxonomy will belong to.
- * @param taxonomy The taxonomy to create.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Taxonomy createTaxonomy(@Nullable LocationName parent, Taxonomy taxonomy) {
- CreateTaxonomyRequest request =
- CreateTaxonomyRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .setTaxonomy(taxonomy)
- .build();
- return createTaxonomy(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates a taxonomy in a specified project.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
- * Taxonomy taxonomy = Taxonomy.newBuilder().build();
- * Taxonomy response = policyTagManagerClient.createTaxonomy(parent, taxonomy);
- * }
- * }
- *
- * @param parent Required. Resource name of the project that the taxonomy will belong to.
- * @param taxonomy The taxonomy to create.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Taxonomy createTaxonomy(String parent, Taxonomy taxonomy) {
- CreateTaxonomyRequest request =
- CreateTaxonomyRequest.newBuilder().setParent(parent).setTaxonomy(taxonomy).build();
- return createTaxonomy(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates a taxonomy in a specified project.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * CreateTaxonomyRequest request =
- * CreateTaxonomyRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .setTaxonomy(Taxonomy.newBuilder().build())
- * .build();
- * Taxonomy response = policyTagManagerClient.createTaxonomy(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Taxonomy createTaxonomy(CreateTaxonomyRequest request) {
- return createTaxonomyCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates a taxonomy in a specified project.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * CreateTaxonomyRequest request =
- * CreateTaxonomyRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .setTaxonomy(Taxonomy.newBuilder().build())
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * TaxonomyName name = TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]");
- * policyTagManagerClient.deleteTaxonomy(name);
- * }
- * }
- *
- * @param name Required. Resource name of the taxonomy to delete.
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * String name = TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString();
- * policyTagManagerClient.deleteTaxonomy(name);
- * }
- * }
- *
- * @param name Required. Resource name of the taxonomy to delete.
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * DeleteTaxonomyRequest request =
- * DeleteTaxonomyRequest.newBuilder()
- * .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .build();
- * policyTagManagerClient.deleteTaxonomy(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteTaxonomy(DeleteTaxonomyRequest request) {
- deleteTaxonomyCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and
- * the policy tags references from BigQuery columns.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * DeleteTaxonomyRequest request =
- * DeleteTaxonomyRequest.newBuilder()
- * .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * Taxonomy taxonomy = Taxonomy.newBuilder().build();
- * Taxonomy response = policyTagManagerClient.updateTaxonomy(taxonomy);
- * }
- * }
- *
- * @param taxonomy The taxonomy to update. You can update only its description, display name, and
- * activated policy types.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Taxonomy updateTaxonomy(Taxonomy taxonomy) {
- UpdateTaxonomyRequest request =
- UpdateTaxonomyRequest.newBuilder().setTaxonomy(taxonomy).build();
- return updateTaxonomy(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates a taxonomy, including its display name, description, and activated policy types.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * UpdateTaxonomyRequest request =
- * UpdateTaxonomyRequest.newBuilder()
- * .setTaxonomy(Taxonomy.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * Taxonomy response = policyTagManagerClient.updateTaxonomy(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Taxonomy updateTaxonomy(UpdateTaxonomyRequest request) {
- return updateTaxonomyCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates a taxonomy, including its display name, description, and activated policy types.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * UpdateTaxonomyRequest request =
- * UpdateTaxonomyRequest.newBuilder()
- * .setTaxonomy(Taxonomy.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
- * for (Taxonomy element : policyTagManagerClient.listTaxonomies(parent).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param parent Required. Resource name of the project to list the taxonomies of.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListTaxonomiesPagedResponse listTaxonomies(@Nullable LocationName parent) {
- ListTaxonomiesRequest request =
- ListTaxonomiesRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .build();
- return listTaxonomies(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists all taxonomies in a project in a particular location that you have a permission to view.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
- * for (Taxonomy element : policyTagManagerClient.listTaxonomies(parent).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param parent Required. Resource name of the project to list the taxonomies of.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListTaxonomiesPagedResponse listTaxonomies(String parent) {
- ListTaxonomiesRequest request = ListTaxonomiesRequest.newBuilder().setParent(parent).build();
- return listTaxonomies(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists all taxonomies in a project in a particular location that you have a permission to view.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * ListTaxonomiesRequest request =
- * ListTaxonomiesRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .setFilter("filter-1274492040")
- * .build();
- * for (Taxonomy element : policyTagManagerClient.listTaxonomies(request).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListTaxonomiesPagedResponse listTaxonomies(ListTaxonomiesRequest request) {
- return listTaxonomiesPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists all taxonomies in a project in a particular location that you have a permission to view.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * ListTaxonomiesRequest request =
- * ListTaxonomiesRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .setFilter("filter-1274492040")
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * ListTaxonomiesRequest request =
- * ListTaxonomiesRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .setFilter("filter-1274492040")
- * .build();
- * while (true) {
- * ListTaxonomiesResponse response =
- * policyTagManagerClient.listTaxonomiesCallable().call(request);
- * for (Taxonomy element : response.getTaxonomiesList()) {
- * // doThingsWith(element);
- * }
- * String nextPageToken = response.getNextPageToken();
- * if (!Strings.isNullOrEmpty(nextPageToken)) {
- * request = request.toBuilder().setPageToken(nextPageToken).build();
- * } else {
- * break;
- * }
- * }
- * }
- * }
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * TaxonomyName name = TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]");
- * Taxonomy response = policyTagManagerClient.getTaxonomy(name);
- * }
- * }
- *
- * @param name Required. Resource name of the taxonomy to get.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Taxonomy getTaxonomy(@Nullable TaxonomyName name) {
- GetTaxonomyRequest request =
- GetTaxonomyRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- return getTaxonomy(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets a taxonomy.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * String name = TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString();
- * Taxonomy response = policyTagManagerClient.getTaxonomy(name);
- * }
- * }
- *
- * @param name Required. Resource name of the taxonomy to get.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Taxonomy getTaxonomy(String name) {
- GetTaxonomyRequest request = GetTaxonomyRequest.newBuilder().setName(name).build();
- return getTaxonomy(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets a taxonomy.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * GetTaxonomyRequest request =
- * GetTaxonomyRequest.newBuilder()
- * .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .build();
- * Taxonomy response = policyTagManagerClient.getTaxonomy(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Taxonomy getTaxonomy(GetTaxonomyRequest request) {
- return getTaxonomyCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets a taxonomy.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * GetTaxonomyRequest request =
- * GetTaxonomyRequest.newBuilder()
- * .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * TaxonomyName parent = TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]");
- * PolicyTag policyTag = PolicyTag.newBuilder().build();
- * PolicyTag response = policyTagManagerClient.createPolicyTag(parent, policyTag);
- * }
- * }
- *
- * @param parent Required. Resource name of the taxonomy that the policy tag will belong to.
- * @param policyTag The policy tag to create.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final PolicyTag createPolicyTag(@Nullable TaxonomyName parent, PolicyTag policyTag) {
- CreatePolicyTagRequest request =
- CreatePolicyTagRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .setPolicyTag(policyTag)
- .build();
- return createPolicyTag(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates a policy tag in a taxonomy.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * String parent = TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString();
- * PolicyTag policyTag = PolicyTag.newBuilder().build();
- * PolicyTag response = policyTagManagerClient.createPolicyTag(parent, policyTag);
- * }
- * }
- *
- * @param parent Required. Resource name of the taxonomy that the policy tag will belong to.
- * @param policyTag The policy tag to create.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final PolicyTag createPolicyTag(String parent, PolicyTag policyTag) {
- CreatePolicyTagRequest request =
- CreatePolicyTagRequest.newBuilder().setParent(parent).setPolicyTag(policyTag).build();
- return createPolicyTag(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates a policy tag in a taxonomy.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * CreatePolicyTagRequest request =
- * CreatePolicyTagRequest.newBuilder()
- * .setParent(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .setPolicyTag(PolicyTag.newBuilder().build())
- * .build();
- * PolicyTag response = policyTagManagerClient.createPolicyTag(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final PolicyTag createPolicyTag(CreatePolicyTagRequest request) {
- return createPolicyTagCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates a policy tag in a taxonomy.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * CreatePolicyTagRequest request =
- * CreatePolicyTagRequest.newBuilder()
- * .setParent(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .setPolicyTag(PolicyTag.newBuilder().build())
- * .build();
- * ApiFuture
- */
- public final UnaryCallable
- *
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * PolicyTagName name =
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]");
- * policyTagManagerClient.deletePolicyTag(name);
- * }
- * }
- *
- * @param name Required. Resource name of the policy tag to delete.
- *
- *
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * String name =
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]").toString();
- * policyTagManagerClient.deletePolicyTag(name);
- * }
- * }
- *
- * @param name Required. Resource name of the policy tag to delete.
- *
- *
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * DeletePolicyTagRequest request =
- * DeletePolicyTagRequest.newBuilder()
- * .setName(
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
- * .toString())
- * .build();
- * policyTagManagerClient.deletePolicyTag(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deletePolicyTag(DeletePolicyTagRequest request) {
- deletePolicyTagCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a policy tag together with the following:
- *
- *
- *
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * DeletePolicyTagRequest request =
- * DeletePolicyTagRequest.newBuilder()
- * .setName(
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
- * .toString())
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * PolicyTag policyTag = PolicyTag.newBuilder().build();
- * PolicyTag response = policyTagManagerClient.updatePolicyTag(policyTag);
- * }
- * }
- *
- * @param policyTag The policy tag to update. You can update only its description, display name,
- * and parent policy tag fields.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final PolicyTag updatePolicyTag(PolicyTag policyTag) {
- UpdatePolicyTagRequest request =
- UpdatePolicyTagRequest.newBuilder().setPolicyTag(policyTag).build();
- return updatePolicyTag(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates a policy tag, including its display name, description, and parent policy tag.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * UpdatePolicyTagRequest request =
- * UpdatePolicyTagRequest.newBuilder()
- * .setPolicyTag(PolicyTag.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * PolicyTag response = policyTagManagerClient.updatePolicyTag(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final PolicyTag updatePolicyTag(UpdatePolicyTagRequest request) {
- return updatePolicyTagCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates a policy tag, including its display name, description, and parent policy tag.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * UpdatePolicyTagRequest request =
- * UpdatePolicyTagRequest.newBuilder()
- * .setPolicyTag(PolicyTag.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * TaxonomyName parent = TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]");
- * for (PolicyTag element : policyTagManagerClient.listPolicyTags(parent).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param parent Required. Resource name of the taxonomy to list the policy tags of.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListPolicyTagsPagedResponse listPolicyTags(@Nullable TaxonomyName parent) {
- ListPolicyTagsRequest request =
- ListPolicyTagsRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .build();
- return listPolicyTags(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists all policy tags in a taxonomy.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * String parent = TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString();
- * for (PolicyTag element : policyTagManagerClient.listPolicyTags(parent).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param parent Required. Resource name of the taxonomy to list the policy tags of.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListPolicyTagsPagedResponse listPolicyTags(String parent) {
- ListPolicyTagsRequest request = ListPolicyTagsRequest.newBuilder().setParent(parent).build();
- return listPolicyTags(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists all policy tags in a taxonomy.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * ListPolicyTagsRequest request =
- * ListPolicyTagsRequest.newBuilder()
- * .setParent(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .build();
- * for (PolicyTag element : policyTagManagerClient.listPolicyTags(request).iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListPolicyTagsPagedResponse listPolicyTags(ListPolicyTagsRequest request) {
- return listPolicyTagsPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists all policy tags in a taxonomy.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * ListPolicyTagsRequest request =
- * ListPolicyTagsRequest.newBuilder()
- * .setParent(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * ListPolicyTagsRequest request =
- * ListPolicyTagsRequest.newBuilder()
- * .setParent(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .setPageSize(883849137)
- * .setPageToken("pageToken873572522")
- * .build();
- * while (true) {
- * ListPolicyTagsResponse response =
- * policyTagManagerClient.listPolicyTagsCallable().call(request);
- * for (PolicyTag element : response.getPolicyTagsList()) {
- * // doThingsWith(element);
- * }
- * String nextPageToken = response.getNextPageToken();
- * if (!Strings.isNullOrEmpty(nextPageToken)) {
- * request = request.toBuilder().setPageToken(nextPageToken).build();
- * } else {
- * break;
- * }
- * }
- * }
- * }
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * PolicyTagName name =
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]");
- * PolicyTag response = policyTagManagerClient.getPolicyTag(name);
- * }
- * }
- *
- * @param name Required. Resource name of the policy tag.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final PolicyTag getPolicyTag(@Nullable PolicyTagName name) {
- GetPolicyTagRequest request =
- GetPolicyTagRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- return getPolicyTag(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets a policy tag.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * String name =
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]").toString();
- * PolicyTag response = policyTagManagerClient.getPolicyTag(name);
- * }
- * }
- *
- * @param name Required. Resource name of the policy tag.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final PolicyTag getPolicyTag(String name) {
- GetPolicyTagRequest request = GetPolicyTagRequest.newBuilder().setName(name).build();
- return getPolicyTag(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets a policy tag.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * GetPolicyTagRequest request =
- * GetPolicyTagRequest.newBuilder()
- * .setName(
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
- * .toString())
- * .build();
- * PolicyTag response = policyTagManagerClient.getPolicyTag(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final PolicyTag getPolicyTag(GetPolicyTagRequest request) {
- return getPolicyTagCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets a policy tag.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * GetPolicyTagRequest request =
- * GetPolicyTagRequest.newBuilder()
- * .setName(
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
- * .toString())
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * GetIamPolicyRequest request =
- * GetIamPolicyRequest.newBuilder()
- * .setResource(
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
- * .toString())
- * .setOptions(GetPolicyOptions.newBuilder().build())
- * .build();
- * Policy response = policyTagManagerClient.getIamPolicy(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Policy getIamPolicy(GetIamPolicyRequest request) {
- return getIamPolicyCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets the IAM policy for a policy tag or a taxonomy.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * GetIamPolicyRequest request =
- * GetIamPolicyRequest.newBuilder()
- * .setResource(
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
- * .toString())
- * .setOptions(GetPolicyOptions.newBuilder().build())
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * SetIamPolicyRequest request =
- * SetIamPolicyRequest.newBuilder()
- * .setResource(
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
- * .toString())
- * .setPolicy(Policy.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * Policy response = policyTagManagerClient.setIamPolicy(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Policy setIamPolicy(SetIamPolicyRequest request) {
- return setIamPolicyCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Sets the IAM policy for a policy tag or a taxonomy.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * SetIamPolicyRequest request =
- * SetIamPolicyRequest.newBuilder()
- * .setResource(
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
- * .toString())
- * .setPolicy(Policy.newBuilder().build())
- * .setUpdateMask(FieldMask.newBuilder().build())
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * TestIamPermissionsRequest request =
- * TestIamPermissionsRequest.newBuilder()
- * .setResource(
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
- * .toString())
- * .addAllPermissions(new ArrayList
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
- return testIamPermissionsCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Returns your permissions on a specified policy tag or taxonomy.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * TestIamPermissionsRequest request =
- * TestIamPermissionsRequest.newBuilder()
- * .setResource(
- * PolicyTagName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]", "[POLICY_TAG]")
- * .toString())
- * .addAllPermissions(new ArrayList
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
- * PolicyTagManagerSerializationClient.create()) {
- * ReplaceTaxonomyRequest request =
- * ReplaceTaxonomyRequest.newBuilder()
- * .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .setSerializedTaxonomy(SerializedTaxonomy.newBuilder().build())
- * .build();
- * Taxonomy response = policyTagManagerSerializationClient.replaceTaxonomy(request);
- * }
- * }
- *
- *
- *
- *
- *
- *
- * Method
- * Description
- * Method Variants
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * PolicyTagManagerSerializationSettings policyTagManagerSerializationSettings =
- * PolicyTagManagerSerializationSettings.newBuilder()
- * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
- * .build();
- * PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
- * PolicyTagManagerSerializationClient.create(policyTagManagerSerializationSettings);
- * }
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * PolicyTagManagerSerializationSettings policyTagManagerSerializationSettings =
- * PolicyTagManagerSerializationSettings.newBuilder().setEndpoint(myEndpoint).build();
- * PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
- * PolicyTagManagerSerializationClient.create(policyTagManagerSerializationSettings);
- * }
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * PolicyTagManagerSerializationSettings policyTagManagerSerializationSettings =
- * PolicyTagManagerSerializationSettings.newHttpJsonBuilder().build();
- * PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
- * PolicyTagManagerSerializationClient.create(policyTagManagerSerializationSettings);
- * }
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
- * PolicyTagManagerSerializationClient.create()) {
- * ReplaceTaxonomyRequest request =
- * ReplaceTaxonomyRequest.newBuilder()
- * .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .setSerializedTaxonomy(SerializedTaxonomy.newBuilder().build())
- * .build();
- * Taxonomy response = policyTagManagerSerializationClient.replaceTaxonomy(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Taxonomy replaceTaxonomy(ReplaceTaxonomyRequest request) {
- return replaceTaxonomyCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Replaces (updates) a taxonomy and all its policy tags.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
- * PolicyTagManagerSerializationClient.create()) {
- * ReplaceTaxonomyRequest request =
- * ReplaceTaxonomyRequest.newBuilder()
- * .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .setSerializedTaxonomy(SerializedTaxonomy.newBuilder().build())
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
- * PolicyTagManagerSerializationClient.create()) {
- * ImportTaxonomiesRequest request =
- * ImportTaxonomiesRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .build();
- * ImportTaxonomiesResponse response =
- * policyTagManagerSerializationClient.importTaxonomies(request);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ImportTaxonomiesResponse importTaxonomies(ImportTaxonomiesRequest request) {
- return importTaxonomiesCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates new taxonomies (including their policy tags) in a given project by importing from
- * inlined or cross-regional sources.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
- * PolicyTagManagerSerializationClient.create()) {
- * ImportTaxonomiesRequest request =
- * ImportTaxonomiesRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .build();
- * ApiFuture
- */
- public final UnaryCallable{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
- * PolicyTagManagerSerializationClient.create()) {
- * ExportTaxonomiesRequest request =
- * ExportTaxonomiesRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .addAllTaxonomies(new ArrayList
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ExportTaxonomiesResponse exportTaxonomies(ExportTaxonomiesRequest request) {
- return exportTaxonomiesCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Exports taxonomies in the requested type and returns them, including their policy tags. The
- * requested taxonomies must belong to the same project.
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
- * PolicyTagManagerSerializationClient.create()) {
- * ExportTaxonomiesRequest request =
- * ExportTaxonomiesRequest.newBuilder()
- * .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
- * .addAllTaxonomies(new ArrayList
- */
- public final UnaryCallable
- *
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * PolicyTagManagerSerializationSettings.Builder policyTagManagerSerializationSettingsBuilder =
- * PolicyTagManagerSerializationSettings.newBuilder();
- * policyTagManagerSerializationSettingsBuilder
- * .replaceTaxonomySettings()
- * .setRetrySettings(
- * policyTagManagerSerializationSettingsBuilder
- * .replaceTaxonomySettings()
- * .getRetrySettings()
- * .toBuilder()
- * .setInitialRetryDelayDuration(Duration.ofSeconds(1))
- * .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
- * .setMaxAttempts(5)
- * .setMaxRetryDelayDuration(Duration.ofSeconds(30))
- * .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
- * .setRetryDelayMultiplier(1.3)
- * .setRpcTimeoutMultiplier(1.5)
- * .setTotalTimeoutDuration(Duration.ofSeconds(300))
- * .build());
- * PolicyTagManagerSerializationSettings policyTagManagerSerializationSettings =
- * policyTagManagerSerializationSettingsBuilder.build();
- * }
- *
- * Please refer to the [Client Side Retry
- * Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
- * retries.
- */
-@NullMarked
-@Generated("by gapic-generator-java")
-public class PolicyTagManagerSerializationSettings
- extends ClientSettings
- *
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * PolicyTagManagerSettings.Builder policyTagManagerSettingsBuilder =
- * PolicyTagManagerSettings.newBuilder();
- * policyTagManagerSettingsBuilder
- * .createTaxonomySettings()
- * .setRetrySettings(
- * policyTagManagerSettingsBuilder
- * .createTaxonomySettings()
- * .getRetrySettings()
- * .toBuilder()
- * .setInitialRetryDelayDuration(Duration.ofSeconds(1))
- * .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
- * .setMaxAttempts(5)
- * .setMaxRetryDelayDuration(Duration.ofSeconds(30))
- * .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
- * .setRetryDelayMultiplier(1.3)
- * .setRpcTimeoutMultiplier(1.5)
- * .setTotalTimeoutDuration(Duration.ofSeconds(300))
- * .build());
- * PolicyTagManagerSettings policyTagManagerSettings = policyTagManagerSettingsBuilder.build();
- * }
- *
- * Please refer to the [Client Side Retry
- * Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
- * retries.
- */
-@NullMarked
-@Generated("by gapic-generator-java")
-public class PolicyTagManagerSettings extends ClientSettings{@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
- * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
- * String entryGroupId = "entryGroupId1228924712";
- * EntryGroup entryGroup = EntryGroup.newBuilder().build();
- * EntryGroup response = dataCatalogClient.createEntryGroup(parent, entryGroupId, entryGroup);
- * }
- * }
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerClient policyTagManagerClient = PolicyTagManagerClient.create()) {
- * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
- * Taxonomy taxonomy = Taxonomy.newBuilder().build();
- * Taxonomy response = policyTagManagerClient.createTaxonomy(parent, taxonomy);
- * }
- * }
- *
- * {@code
- * // This snippet has been automatically generated and should be regarded as a code template only.
- * // It will require modifications to work:
- * // - It may require correct/in-range values for request initialization.
- * // - It may require specifying regional endpoints when creating the service client as shown in
- * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
- * try (PolicyTagManagerSerializationClient policyTagManagerSerializationClient =
- * PolicyTagManagerSerializationClient.create()) {
- * ReplaceTaxonomyRequest request =
- * ReplaceTaxonomyRequest.newBuilder()
- * .setName(TaxonomyName.of("[PROJECT]", "[LOCATION]", "[TAXONOMY]").toString())
- * .setSerializedTaxonomy(SerializedTaxonomy.newBuilder().build())
- * .build();
- * Taxonomy response = policyTagManagerSerializationClient.replaceTaxonomy(request);
- * }
- * }
- */
-@Generated("by gapic-generator-java")
-package com.google.cloud.datacatalog.v1;
-
-import javax.annotation.Generated;
diff --git a/java-datacatalog/google-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1/stub/DataCatalogStub.java b/java-datacatalog/google-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1/stub/DataCatalogStub.java
deleted file mode 100644
index 2612250f24ab..000000000000
--- a/java-datacatalog/google-cloud-datacatalog/src/main/java/com/google/cloud/datacatalog/v1/stub/DataCatalogStub.java
+++ /dev/null
@@ -1,342 +0,0 @@
-/*
- * Copyright 2026 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.gax.core.BackgroundResource;
-import com.google.api.gax.rpc.OperationCallable;
-import com.google.api.gax.rpc.UnaryCallable;
-import com.google.cloud.datacatalog.v1.Contacts;
-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.EntryOverview;
-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.ImportEntriesMetadata;
-import com.google.cloud.datacatalog.v1.ImportEntriesRequest;
-import com.google.cloud.datacatalog.v1.ImportEntriesResponse;
-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.MigrationConfig;
-import com.google.cloud.datacatalog.v1.ModifyEntryContactsRequest;
-import com.google.cloud.datacatalog.v1.ModifyEntryOverviewRequest;
-import com.google.cloud.datacatalog.v1.OrganizationConfig;
-import com.google.cloud.datacatalog.v1.ReconcileTagsMetadata;
-import com.google.cloud.datacatalog.v1.ReconcileTagsRequest;
-import com.google.cloud.datacatalog.v1.ReconcileTagsResponse;
-import com.google.cloud.datacatalog.v1.RenameTagTemplateFieldEnumValueRequest;
-import com.google.cloud.datacatalog.v1.RenameTagTemplateFieldRequest;
-import com.google.cloud.datacatalog.v1.RetrieveConfigRequest;
-import com.google.cloud.datacatalog.v1.RetrieveEffectiveConfigRequest;
-import com.google.cloud.datacatalog.v1.SearchCatalogRequest;
-import com.google.cloud.datacatalog.v1.SearchCatalogResponse;
-import com.google.cloud.datacatalog.v1.SetConfigRequest;
-import com.google.cloud.datacatalog.v1.StarEntryRequest;
-import com.google.cloud.datacatalog.v1.StarEntryResponse;
-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.UnstarEntryRequest;
-import com.google.cloud.datacatalog.v1.UnstarEntryResponse;
-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.longrunning.Operation;
-import com.google.longrunning.stub.OperationsStub;
-import com.google.protobuf.Empty;
-import javax.annotation.Generated;
-import org.jspecify.annotations.NullMarked;
-import org.jspecify.annotations.Nullable;
-
-// AUTO-GENERATED DOCUMENTATION AND CLASS.
-/**
- * Base stub class for the DataCatalog service API.
- *
- *