com.google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceSettings Maven / Gradle / Ivy
/*
* 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.bigquery.analyticshub.v1;
import static com.google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient.ListDataExchangesPagedResponse;
import static com.google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient.ListListingsPagedResponse;
import static com.google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse;
import static com.google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse;
import static com.google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient.ListSubscriptionsPagedResponse;
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.OperationCallSettings;
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.bigquery.analyticshub.v1.stub.AnalyticsHubServiceStubSettings;
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.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 AnalyticsHubServiceClient}.
*
* The default instance has everything set to sensible defaults:
*
*
* - The default service address (analyticshub.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 getDataExchange:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* AnalyticsHubServiceSettings.Builder analyticsHubServiceSettingsBuilder =
* AnalyticsHubServiceSettings.newBuilder();
* analyticsHubServiceSettingsBuilder
* .getDataExchangeSettings()
* .setRetrySettings(
* analyticsHubServiceSettingsBuilder
* .getDataExchangeSettings()
* .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());
* AnalyticsHubServiceSettings analyticsHubServiceSettings =
* analyticsHubServiceSettingsBuilder.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.
*
* 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 subscribeDataExchange:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* AnalyticsHubServiceSettings.Builder analyticsHubServiceSettingsBuilder =
* AnalyticsHubServiceSettings.newBuilder();
* TimedRetryAlgorithm timedRetryAlgorithm =
* OperationalTimedPollAlgorithm.create(
* RetrySettings.newBuilder()
* .setInitialRetryDelayDuration(Duration.ofMillis(500))
* .setRetryDelayMultiplier(1.5)
* .setMaxRetryDelay(Duration.ofMillis(5000))
* .setTotalTimeoutDuration(Duration.ofHours(24))
* .build());
* analyticsHubServiceSettingsBuilder
* .createClusterOperationSettings()
* .setPollingAlgorithm(timedRetryAlgorithm)
* .build();
* }
*/
@Generated("by gapic-generator-java")
public class AnalyticsHubServiceSettings extends ClientSettings {
/** Returns the object with the settings used for calls to listDataExchanges. */
public PagedCallSettings<
ListDataExchangesRequest, ListDataExchangesResponse, ListDataExchangesPagedResponse>
listDataExchangesSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).listDataExchangesSettings();
}
/** Returns the object with the settings used for calls to listOrgDataExchanges. */
public PagedCallSettings<
ListOrgDataExchangesRequest,
ListOrgDataExchangesResponse,
ListOrgDataExchangesPagedResponse>
listOrgDataExchangesSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).listOrgDataExchangesSettings();
}
/** Returns the object with the settings used for calls to getDataExchange. */
public UnaryCallSettings getDataExchangeSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).getDataExchangeSettings();
}
/** Returns the object with the settings used for calls to createDataExchange. */
public UnaryCallSettings createDataExchangeSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).createDataExchangeSettings();
}
/** Returns the object with the settings used for calls to updateDataExchange. */
public UnaryCallSettings updateDataExchangeSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).updateDataExchangeSettings();
}
/** Returns the object with the settings used for calls to deleteDataExchange. */
public UnaryCallSettings deleteDataExchangeSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).deleteDataExchangeSettings();
}
/** Returns the object with the settings used for calls to listListings. */
public PagedCallSettings
listListingsSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).listListingsSettings();
}
/** Returns the object with the settings used for calls to getListing. */
public UnaryCallSettings getListingSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).getListingSettings();
}
/** Returns the object with the settings used for calls to createListing. */
public UnaryCallSettings createListingSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).createListingSettings();
}
/** Returns the object with the settings used for calls to updateListing. */
public UnaryCallSettings updateListingSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).updateListingSettings();
}
/** Returns the object with the settings used for calls to deleteListing. */
public UnaryCallSettings deleteListingSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).deleteListingSettings();
}
/** Returns the object with the settings used for calls to subscribeListing. */
public UnaryCallSettings
subscribeListingSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).subscribeListingSettings();
}
/** Returns the object with the settings used for calls to subscribeDataExchange. */
public UnaryCallSettings
subscribeDataExchangeSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).subscribeDataExchangeSettings();
}
/** Returns the object with the settings used for calls to subscribeDataExchange. */
public OperationCallSettings<
SubscribeDataExchangeRequest, SubscribeDataExchangeResponse, OperationMetadata>
subscribeDataExchangeOperationSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings())
.subscribeDataExchangeOperationSettings();
}
/** Returns the object with the settings used for calls to refreshSubscription. */
public UnaryCallSettings refreshSubscriptionSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).refreshSubscriptionSettings();
}
/** Returns the object with the settings used for calls to refreshSubscription. */
public OperationCallSettings<
RefreshSubscriptionRequest, RefreshSubscriptionResponse, OperationMetadata>
refreshSubscriptionOperationSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings())
.refreshSubscriptionOperationSettings();
}
/** Returns the object with the settings used for calls to getSubscription. */
public UnaryCallSettings getSubscriptionSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).getSubscriptionSettings();
}
/** Returns the object with the settings used for calls to listSubscriptions. */
public PagedCallSettings<
ListSubscriptionsRequest, ListSubscriptionsResponse, ListSubscriptionsPagedResponse>
listSubscriptionsSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).listSubscriptionsSettings();
}
/** Returns the object with the settings used for calls to listSharedResourceSubscriptions. */
public PagedCallSettings<
ListSharedResourceSubscriptionsRequest,
ListSharedResourceSubscriptionsResponse,
ListSharedResourceSubscriptionsPagedResponse>
listSharedResourceSubscriptionsSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings())
.listSharedResourceSubscriptionsSettings();
}
/** Returns the object with the settings used for calls to revokeSubscription. */
public UnaryCallSettings
revokeSubscriptionSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).revokeSubscriptionSettings();
}
/** Returns the object with the settings used for calls to deleteSubscription. */
public UnaryCallSettings deleteSubscriptionSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).deleteSubscriptionSettings();
}
/** Returns the object with the settings used for calls to deleteSubscription. */
public OperationCallSettings
deleteSubscriptionOperationSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings())
.deleteSubscriptionOperationSettings();
}
/** Returns the object with the settings used for calls to getIamPolicy. */
public UnaryCallSettings getIamPolicySettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).getIamPolicySettings();
}
/** Returns the object with the settings used for calls to setIamPolicy. */
public UnaryCallSettings setIamPolicySettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).setIamPolicySettings();
}
/** Returns the object with the settings used for calls to testIamPermissions. */
public UnaryCallSettings
testIamPermissionsSettings() {
return ((AnalyticsHubServiceStubSettings) getStubSettings()).testIamPermissionsSettings();
}
public static final AnalyticsHubServiceSettings create(AnalyticsHubServiceStubSettings stub)
throws IOException {
return new AnalyticsHubServiceSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return AnalyticsHubServiceStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return AnalyticsHubServiceStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return AnalyticsHubServiceStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return AnalyticsHubServiceStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return AnalyticsHubServiceStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return AnalyticsHubServiceStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return AnalyticsHubServiceStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return AnalyticsHubServiceStubSettings.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 AnalyticsHubServiceSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for AnalyticsHubServiceSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(AnalyticsHubServiceStubSettings.newBuilder(clientContext));
}
protected Builder(AnalyticsHubServiceSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(AnalyticsHubServiceStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(AnalyticsHubServiceStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(AnalyticsHubServiceStubSettings.newHttpJsonBuilder());
}
public AnalyticsHubServiceStubSettings.Builder getStubSettingsBuilder() {
return ((AnalyticsHubServiceStubSettings.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 listDataExchanges. */
public PagedCallSettings.Builder<
ListDataExchangesRequest, ListDataExchangesResponse, ListDataExchangesPagedResponse>
listDataExchangesSettings() {
return getStubSettingsBuilder().listDataExchangesSettings();
}
/** Returns the builder for the settings used for calls to listOrgDataExchanges. */
public PagedCallSettings.Builder<
ListOrgDataExchangesRequest,
ListOrgDataExchangesResponse,
ListOrgDataExchangesPagedResponse>
listOrgDataExchangesSettings() {
return getStubSettingsBuilder().listOrgDataExchangesSettings();
}
/** Returns the builder for the settings used for calls to getDataExchange. */
public UnaryCallSettings.Builder
getDataExchangeSettings() {
return getStubSettingsBuilder().getDataExchangeSettings();
}
/** Returns the builder for the settings used for calls to createDataExchange. */
public UnaryCallSettings.Builder
createDataExchangeSettings() {
return getStubSettingsBuilder().createDataExchangeSettings();
}
/** Returns the builder for the settings used for calls to updateDataExchange. */
public UnaryCallSettings.Builder
updateDataExchangeSettings() {
return getStubSettingsBuilder().updateDataExchangeSettings();
}
/** Returns the builder for the settings used for calls to deleteDataExchange. */
public UnaryCallSettings.Builder
deleteDataExchangeSettings() {
return getStubSettingsBuilder().deleteDataExchangeSettings();
}
/** Returns the builder for the settings used for calls to listListings. */
public PagedCallSettings.Builder<
ListListingsRequest, ListListingsResponse, ListListingsPagedResponse>
listListingsSettings() {
return getStubSettingsBuilder().listListingsSettings();
}
/** Returns the builder for the settings used for calls to getListing. */
public UnaryCallSettings.Builder getListingSettings() {
return getStubSettingsBuilder().getListingSettings();
}
/** Returns the builder for the settings used for calls to createListing. */
public UnaryCallSettings.Builder createListingSettings() {
return getStubSettingsBuilder().createListingSettings();
}
/** Returns the builder for the settings used for calls to updateListing. */
public UnaryCallSettings.Builder updateListingSettings() {
return getStubSettingsBuilder().updateListingSettings();
}
/** Returns the builder for the settings used for calls to deleteListing. */
public UnaryCallSettings.Builder deleteListingSettings() {
return getStubSettingsBuilder().deleteListingSettings();
}
/** Returns the builder for the settings used for calls to subscribeListing. */
public UnaryCallSettings.Builder
subscribeListingSettings() {
return getStubSettingsBuilder().subscribeListingSettings();
}
/** Returns the builder for the settings used for calls to subscribeDataExchange. */
public UnaryCallSettings.Builder
subscribeDataExchangeSettings() {
return getStubSettingsBuilder().subscribeDataExchangeSettings();
}
/** Returns the builder for the settings used for calls to subscribeDataExchange. */
public OperationCallSettings.Builder<
SubscribeDataExchangeRequest, SubscribeDataExchangeResponse, OperationMetadata>
subscribeDataExchangeOperationSettings() {
return getStubSettingsBuilder().subscribeDataExchangeOperationSettings();
}
/** Returns the builder for the settings used for calls to refreshSubscription. */
public UnaryCallSettings.Builder
refreshSubscriptionSettings() {
return getStubSettingsBuilder().refreshSubscriptionSettings();
}
/** Returns the builder for the settings used for calls to refreshSubscription. */
public OperationCallSettings.Builder<
RefreshSubscriptionRequest, RefreshSubscriptionResponse, OperationMetadata>
refreshSubscriptionOperationSettings() {
return getStubSettingsBuilder().refreshSubscriptionOperationSettings();
}
/** Returns the builder for the settings used for calls to getSubscription. */
public UnaryCallSettings.Builder
getSubscriptionSettings() {
return getStubSettingsBuilder().getSubscriptionSettings();
}
/** Returns the builder for the settings used for calls to listSubscriptions. */
public PagedCallSettings.Builder<
ListSubscriptionsRequest, ListSubscriptionsResponse, ListSubscriptionsPagedResponse>
listSubscriptionsSettings() {
return getStubSettingsBuilder().listSubscriptionsSettings();
}
/** Returns the builder for the settings used for calls to listSharedResourceSubscriptions. */
public PagedCallSettings.Builder<
ListSharedResourceSubscriptionsRequest,
ListSharedResourceSubscriptionsResponse,
ListSharedResourceSubscriptionsPagedResponse>
listSharedResourceSubscriptionsSettings() {
return getStubSettingsBuilder().listSharedResourceSubscriptionsSettings();
}
/** Returns the builder for the settings used for calls to revokeSubscription. */
public UnaryCallSettings.Builder
revokeSubscriptionSettings() {
return getStubSettingsBuilder().revokeSubscriptionSettings();
}
/** Returns the builder for the settings used for calls to deleteSubscription. */
public UnaryCallSettings.Builder
deleteSubscriptionSettings() {
return getStubSettingsBuilder().deleteSubscriptionSettings();
}
/** Returns the builder for the settings used for calls to deleteSubscription. */
public OperationCallSettings.Builder
deleteSubscriptionOperationSettings() {
return getStubSettingsBuilder().deleteSubscriptionOperationSettings();
}
/** 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 setIamPolicy. */
public UnaryCallSettings.Builder setIamPolicySettings() {
return getStubSettingsBuilder().setIamPolicySettings();
}
/** Returns the builder for the settings used for calls to testIamPermissions. */
public UnaryCallSettings.Builder
testIamPermissionsSettings() {
return getStubSettingsBuilder().testIamPermissionsSettings();
}
@Override
public AnalyticsHubServiceSettings build() throws IOException {
return new AnalyticsHubServiceSettings(this);
}
}
}