com.google.cloud.datacatalog.v1beta1.DataCatalogSettings Maven / Gradle / Ivy
Show all versions of google-cloud-datacatalog Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.datacatalog.v1beta1;
import static com.google.cloud.datacatalog.v1beta1.DataCatalogClient.ListEntriesPagedResponse;
import static com.google.cloud.datacatalog.v1beta1.DataCatalogClient.ListEntryGroupsPagedResponse;
import static com.google.cloud.datacatalog.v1beta1.DataCatalogClient.ListTagsPagedResponse;
import static com.google.cloud.datacatalog.v1beta1.DataCatalogClient.SearchCatalogPagedResponse;
import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.ClientSettings;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.datacatalog.v1beta1.stub.DataCatalogStubSettings;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Settings class to configure an instance of {@link DataCatalogClient}.
*
* The default instance has everything set to sensible defaults:
*
*
* - The default service address (datacatalog.googleapis.com) and default port (443) are used.
*
- Credentials are acquired automatically through Application Default Credentials.
*
- Retries are configured for idempotent methods but not for non-idempotent methods.
*
*
* 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://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for
* additional support in setting retries.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class DataCatalogSettings extends ClientSettings {
/** Returns the object with the settings used for calls to searchCatalog. */
public PagedCallSettings
searchCatalogSettings() {
return ((DataCatalogStubSettings) getStubSettings()).searchCatalogSettings();
}
/** Returns the object with the settings used for calls to createEntryGroup. */
public UnaryCallSettings createEntryGroupSettings() {
return ((DataCatalogStubSettings) getStubSettings()).createEntryGroupSettings();
}
/** Returns the object with the settings used for calls to updateEntryGroup. */
public UnaryCallSettings updateEntryGroupSettings() {
return ((DataCatalogStubSettings) getStubSettings()).updateEntryGroupSettings();
}
/** Returns the object with the settings used for calls to getEntryGroup. */
public UnaryCallSettings getEntryGroupSettings() {
return ((DataCatalogStubSettings) getStubSettings()).getEntryGroupSettings();
}
/** Returns the object with the settings used for calls to deleteEntryGroup. */
public UnaryCallSettings deleteEntryGroupSettings() {
return ((DataCatalogStubSettings) getStubSettings()).deleteEntryGroupSettings();
}
/** Returns the object with the settings used for calls to listEntryGroups. */
public PagedCallSettings<
ListEntryGroupsRequest, ListEntryGroupsResponse, ListEntryGroupsPagedResponse>
listEntryGroupsSettings() {
return ((DataCatalogStubSettings) getStubSettings()).listEntryGroupsSettings();
}
/** Returns the object with the settings used for calls to createEntry. */
public UnaryCallSettings createEntrySettings() {
return ((DataCatalogStubSettings) getStubSettings()).createEntrySettings();
}
/** Returns the object with the settings used for calls to updateEntry. */
public UnaryCallSettings updateEntrySettings() {
return ((DataCatalogStubSettings) getStubSettings()).updateEntrySettings();
}
/** Returns the object with the settings used for calls to deleteEntry. */
public UnaryCallSettings deleteEntrySettings() {
return ((DataCatalogStubSettings) getStubSettings()).deleteEntrySettings();
}
/** Returns the object with the settings used for calls to getEntry. */
public UnaryCallSettings getEntrySettings() {
return ((DataCatalogStubSettings) getStubSettings()).getEntrySettings();
}
/** Returns the object with the settings used for calls to lookupEntry. */
public UnaryCallSettings lookupEntrySettings() {
return ((DataCatalogStubSettings) getStubSettings()).lookupEntrySettings();
}
/** Returns the object with the settings used for calls to listEntries. */
public PagedCallSettings
listEntriesSettings() {
return ((DataCatalogStubSettings) getStubSettings()).listEntriesSettings();
}
/** Returns the object with the settings used for calls to createTagTemplate. */
public UnaryCallSettings createTagTemplateSettings() {
return ((DataCatalogStubSettings) getStubSettings()).createTagTemplateSettings();
}
/** Returns the object with the settings used for calls to getTagTemplate. */
public UnaryCallSettings getTagTemplateSettings() {
return ((DataCatalogStubSettings) getStubSettings()).getTagTemplateSettings();
}
/** Returns the object with the settings used for calls to updateTagTemplate. */
public UnaryCallSettings updateTagTemplateSettings() {
return ((DataCatalogStubSettings) getStubSettings()).updateTagTemplateSettings();
}
/** Returns the object with the settings used for calls to deleteTagTemplate. */
public UnaryCallSettings deleteTagTemplateSettings() {
return ((DataCatalogStubSettings) getStubSettings()).deleteTagTemplateSettings();
}
/** Returns the object with the settings used for calls to createTagTemplateField. */
public UnaryCallSettings
createTagTemplateFieldSettings() {
return ((DataCatalogStubSettings) getStubSettings()).createTagTemplateFieldSettings();
}
/** Returns the object with the settings used for calls to updateTagTemplateField. */
public UnaryCallSettings
updateTagTemplateFieldSettings() {
return ((DataCatalogStubSettings) getStubSettings()).updateTagTemplateFieldSettings();
}
/** Returns the object with the settings used for calls to renameTagTemplateField. */
public UnaryCallSettings
renameTagTemplateFieldSettings() {
return ((DataCatalogStubSettings) getStubSettings()).renameTagTemplateFieldSettings();
}
/** Returns the object with the settings used for calls to renameTagTemplateFieldEnumValue. */
public UnaryCallSettings
renameTagTemplateFieldEnumValueSettings() {
return ((DataCatalogStubSettings) getStubSettings()).renameTagTemplateFieldEnumValueSettings();
}
/** Returns the object with the settings used for calls to deleteTagTemplateField. */
public UnaryCallSettings deleteTagTemplateFieldSettings() {
return ((DataCatalogStubSettings) getStubSettings()).deleteTagTemplateFieldSettings();
}
/** Returns the object with the settings used for calls to createTag. */
public UnaryCallSettings createTagSettings() {
return ((DataCatalogStubSettings) getStubSettings()).createTagSettings();
}
/** Returns the object with the settings used for calls to updateTag. */
public UnaryCallSettings updateTagSettings() {
return ((DataCatalogStubSettings) getStubSettings()).updateTagSettings();
}
/** Returns the object with the settings used for calls to deleteTag. */
public UnaryCallSettings deleteTagSettings() {
return ((DataCatalogStubSettings) getStubSettings()).deleteTagSettings();
}
/** Returns the object with the settings used for calls to listTags. */
public PagedCallSettings
listTagsSettings() {
return ((DataCatalogStubSettings) getStubSettings()).listTagsSettings();
}
/** Returns the object with the settings used for calls to setIamPolicy. */
public UnaryCallSettings setIamPolicySettings() {
return ((DataCatalogStubSettings) getStubSettings()).setIamPolicySettings();
}
/** Returns the object with the settings used for calls to getIamPolicy. */
public UnaryCallSettings getIamPolicySettings() {
return ((DataCatalogStubSettings) getStubSettings()).getIamPolicySettings();
}
/** Returns the object with the settings used for calls to testIamPermissions. */
public UnaryCallSettings
testIamPermissionsSettings() {
return ((DataCatalogStubSettings) getStubSettings()).testIamPermissionsSettings();
}
public static final DataCatalogSettings create(DataCatalogStubSettings stub) throws IOException {
return new DataCatalogSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return DataCatalogStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return DataCatalogStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return DataCatalogStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return DataCatalogStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return DataCatalogStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return DataCatalogStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return DataCatalogStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return DataCatalogStubSettings.defaultApiClientHeaderProviderBuilder();
}
/** Returns a new gRPC builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** Returns a new REST builder for this class. */
public static Builder newHttpJsonBuilder() {
return Builder.createHttpJsonDefault();
}
/** Returns a new builder for this class. */
public static Builder newBuilder(ClientContext clientContext) {
return new Builder(clientContext);
}
/** Returns a builder containing all the values of this settings class. */
public Builder toBuilder() {
return new Builder(this);
}
protected DataCatalogSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for DataCatalogSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(DataCatalogStubSettings.newBuilder(clientContext));
}
protected Builder(DataCatalogSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(DataCatalogStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(DataCatalogStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(DataCatalogStubSettings.newHttpJsonBuilder());
}
public DataCatalogStubSettings.Builder getStubSettingsBuilder() {
return ((DataCatalogStubSettings.Builder) getStubSettings());
}
/**
* Applies the given settings updater function to all of the unary API methods in this service.
*
* Note: This method does not support applying settings to streaming methods.
*/
public Builder applyToAllUnaryMethods(
ApiFunction, Void> settingsUpdater) {
super.applyToAllUnaryMethods(
getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
return this;
}
/** Returns the builder for the settings used for calls to searchCatalog. */
public PagedCallSettings.Builder<
SearchCatalogRequest, SearchCatalogResponse, SearchCatalogPagedResponse>
searchCatalogSettings() {
return getStubSettingsBuilder().searchCatalogSettings();
}
/** Returns the builder for the settings used for calls to createEntryGroup. */
public UnaryCallSettings.Builder
createEntryGroupSettings() {
return getStubSettingsBuilder().createEntryGroupSettings();
}
/** Returns the builder for the settings used for calls to updateEntryGroup. */
public UnaryCallSettings.Builder
updateEntryGroupSettings() {
return getStubSettingsBuilder().updateEntryGroupSettings();
}
/** Returns the builder for the settings used for calls to getEntryGroup. */
public UnaryCallSettings.Builder getEntryGroupSettings() {
return getStubSettingsBuilder().getEntryGroupSettings();
}
/** Returns the builder for the settings used for calls to deleteEntryGroup. */
public UnaryCallSettings.Builder deleteEntryGroupSettings() {
return getStubSettingsBuilder().deleteEntryGroupSettings();
}
/** Returns the builder for the settings used for calls to listEntryGroups. */
public PagedCallSettings.Builder<
ListEntryGroupsRequest, ListEntryGroupsResponse, ListEntryGroupsPagedResponse>
listEntryGroupsSettings() {
return getStubSettingsBuilder().listEntryGroupsSettings();
}
/** Returns the builder for the settings used for calls to createEntry. */
public UnaryCallSettings.Builder createEntrySettings() {
return getStubSettingsBuilder().createEntrySettings();
}
/** Returns the builder for the settings used for calls to updateEntry. */
public UnaryCallSettings.Builder updateEntrySettings() {
return getStubSettingsBuilder().updateEntrySettings();
}
/** Returns the builder for the settings used for calls to deleteEntry. */
public UnaryCallSettings.Builder deleteEntrySettings() {
return getStubSettingsBuilder().deleteEntrySettings();
}
/** Returns the builder for the settings used for calls to getEntry. */
public UnaryCallSettings.Builder getEntrySettings() {
return getStubSettingsBuilder().getEntrySettings();
}
/** Returns the builder for the settings used for calls to lookupEntry. */
public UnaryCallSettings.Builder lookupEntrySettings() {
return getStubSettingsBuilder().lookupEntrySettings();
}
/** Returns the builder for the settings used for calls to listEntries. */
public PagedCallSettings.Builder<
ListEntriesRequest, ListEntriesResponse, ListEntriesPagedResponse>
listEntriesSettings() {
return getStubSettingsBuilder().listEntriesSettings();
}
/** Returns the builder for the settings used for calls to createTagTemplate. */
public UnaryCallSettings.Builder
createTagTemplateSettings() {
return getStubSettingsBuilder().createTagTemplateSettings();
}
/** Returns the builder for the settings used for calls to getTagTemplate. */
public UnaryCallSettings.Builder getTagTemplateSettings() {
return getStubSettingsBuilder().getTagTemplateSettings();
}
/** Returns the builder for the settings used for calls to updateTagTemplate. */
public UnaryCallSettings.Builder
updateTagTemplateSettings() {
return getStubSettingsBuilder().updateTagTemplateSettings();
}
/** Returns the builder for the settings used for calls to deleteTagTemplate. */
public UnaryCallSettings.Builder deleteTagTemplateSettings() {
return getStubSettingsBuilder().deleteTagTemplateSettings();
}
/** Returns the builder for the settings used for calls to createTagTemplateField. */
public UnaryCallSettings.Builder
createTagTemplateFieldSettings() {
return getStubSettingsBuilder().createTagTemplateFieldSettings();
}
/** Returns the builder for the settings used for calls to updateTagTemplateField. */
public UnaryCallSettings.Builder
updateTagTemplateFieldSettings() {
return getStubSettingsBuilder().updateTagTemplateFieldSettings();
}
/** Returns the builder for the settings used for calls to renameTagTemplateField. */
public UnaryCallSettings.Builder
renameTagTemplateFieldSettings() {
return getStubSettingsBuilder().renameTagTemplateFieldSettings();
}
/** Returns the builder for the settings used for calls to renameTagTemplateFieldEnumValue. */
public UnaryCallSettings.Builder
renameTagTemplateFieldEnumValueSettings() {
return getStubSettingsBuilder().renameTagTemplateFieldEnumValueSettings();
}
/** Returns the builder for the settings used for calls to deleteTagTemplateField. */
public UnaryCallSettings.Builder
deleteTagTemplateFieldSettings() {
return getStubSettingsBuilder().deleteTagTemplateFieldSettings();
}
/** Returns the builder for the settings used for calls to createTag. */
public UnaryCallSettings.Builder createTagSettings() {
return getStubSettingsBuilder().createTagSettings();
}
/** Returns the builder for the settings used for calls to updateTag. */
public UnaryCallSettings.Builder updateTagSettings() {
return getStubSettingsBuilder().updateTagSettings();
}
/** Returns the builder for the settings used for calls to deleteTag. */
public UnaryCallSettings.Builder deleteTagSettings() {
return getStubSettingsBuilder().deleteTagSettings();
}
/** Returns the builder for the settings used for calls to listTags. */
public PagedCallSettings.Builder
listTagsSettings() {
return getStubSettingsBuilder().listTagsSettings();
}
/** Returns the builder for the settings used for calls to setIamPolicy. */
public UnaryCallSettings.Builder setIamPolicySettings() {
return getStubSettingsBuilder().setIamPolicySettings();
}
/** Returns the builder for the settings used for calls to getIamPolicy. */
public UnaryCallSettings.Builder getIamPolicySettings() {
return getStubSettingsBuilder().getIamPolicySettings();
}
/** Returns the builder for the settings used for calls to testIamPermissions. */
public UnaryCallSettings.Builder
testIamPermissionsSettings() {
return getStubSettingsBuilder().testIamPermissionsSettings();
}
@Override
public DataCatalogSettings build() throws IOException {
return new DataCatalogSettings(this);
}
}
}