com.google.cloud.bigquery.analyticshub.v1

Class AnalyticsHubServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<AnalyticsHubServiceSettings>

com.google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceSettings

@Generated(value="by gapic-generator-java")
public class AnalyticsHubServiceSettings
extends com.google.api.gax.rpc.ClientSettings<AnalyticsHubServiceSettings>

Settings class to configure an instance of 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:

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

 // 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)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 analyticsHubServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnalyticsHubServiceSettings.Builder Builder for AnalyticsHubServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnalyticsHubServiceSettings(AnalyticsHubServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static AnalyticsHubServiceSettings	create(AnalyticsHubServiceStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateDataExchangeRequest,DataExchange>	createDataExchangeSettings() Returns the object with the settings used for calls to createDataExchange.
com.google.api.gax.rpc.UnaryCallSettings<CreateListingRequest,Listing>	createListingSettings() Returns the object with the settings used for calls to createListing.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteDataExchangeRequest,com.google.protobuf.Empty>	deleteDataExchangeSettings() Returns the object with the settings used for calls to deleteDataExchange.
com.google.api.gax.rpc.UnaryCallSettings<DeleteListingRequest,com.google.protobuf.Empty>	deleteListingSettings() Returns the object with the settings used for calls to deleteListing.
com.google.api.gax.rpc.OperationCallSettings<DeleteSubscriptionRequest,com.google.protobuf.Empty,OperationMetadata>	deleteSubscriptionOperationSettings() Returns the object with the settings used for calls to deleteSubscription.
com.google.api.gax.rpc.UnaryCallSettings<DeleteSubscriptionRequest,com.google.longrunning.Operation>	deleteSubscriptionSettings() Returns the object with the settings used for calls to deleteSubscription.
com.google.api.gax.rpc.UnaryCallSettings<GetDataExchangeRequest,DataExchange>	getDataExchangeSettings() Returns the object with the settings used for calls to getDataExchange.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetListingRequest,Listing>	getListingSettings() Returns the object with the settings used for calls to getListing.
com.google.api.gax.rpc.UnaryCallSettings<GetSubscriptionRequest,Subscription>	getSubscriptionSettings() Returns the object with the settings used for calls to getSubscription.
com.google.api.gax.rpc.PagedCallSettings<ListDataExchangesRequest,ListDataExchangesResponse,AnalyticsHubServiceClient.ListDataExchangesPagedResponse>	listDataExchangesSettings() Returns the object with the settings used for calls to listDataExchanges.
com.google.api.gax.rpc.PagedCallSettings<ListListingsRequest,ListListingsResponse,AnalyticsHubServiceClient.ListListingsPagedResponse>	listListingsSettings() Returns the object with the settings used for calls to listListings.
com.google.api.gax.rpc.PagedCallSettings<ListOrgDataExchangesRequest,ListOrgDataExchangesResponse,AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse>	listOrgDataExchangesSettings() Returns the object with the settings used for calls to listOrgDataExchanges.
com.google.api.gax.rpc.PagedCallSettings<ListSharedResourceSubscriptionsRequest,ListSharedResourceSubscriptionsResponse,AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse>	listSharedResourceSubscriptionsSettings() Returns the object with the settings used for calls to listSharedResourceSubscriptions.
com.google.api.gax.rpc.PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,AnalyticsHubServiceClient.ListSubscriptionsPagedResponse>	listSubscriptionsSettings() Returns the object with the settings used for calls to listSubscriptions.
static AnalyticsHubServiceSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static AnalyticsHubServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static AnalyticsHubServiceSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.OperationCallSettings<RefreshSubscriptionRequest,RefreshSubscriptionResponse,OperationMetadata>	refreshSubscriptionOperationSettings() Returns the object with the settings used for calls to refreshSubscription.
com.google.api.gax.rpc.UnaryCallSettings<RefreshSubscriptionRequest,com.google.longrunning.Operation>	refreshSubscriptionSettings() Returns the object with the settings used for calls to refreshSubscription.
com.google.api.gax.rpc.UnaryCallSettings<RevokeSubscriptionRequest,RevokeSubscriptionResponse>	revokeSubscriptionSettings() Returns the object with the settings used for calls to revokeSubscription.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.OperationCallSettings<SubscribeDataExchangeRequest,SubscribeDataExchangeResponse,OperationMetadata>	subscribeDataExchangeOperationSettings() Returns the object with the settings used for calls to subscribeDataExchange.
com.google.api.gax.rpc.UnaryCallSettings<SubscribeDataExchangeRequest,com.google.longrunning.Operation>	subscribeDataExchangeSettings() Returns the object with the settings used for calls to subscribeDataExchange.
com.google.api.gax.rpc.UnaryCallSettings<SubscribeListingRequest,SubscribeListingResponse>	subscribeListingSettings() Returns the object with the settings used for calls to subscribeListing.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
AnalyticsHubServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateDataExchangeRequest,DataExchange>	updateDataExchangeSettings() Returns the object with the settings used for calls to updateDataExchange.
com.google.api.gax.rpc.UnaryCallSettings<UpdateListingRequest,Listing>	updateListingSettings() Returns the object with the settings used for calls to updateListing.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AnalyticsHubServiceSettings

protected AnalyticsHubServiceSettings(AnalyticsHubServiceSettings.Builder settingsBuilder)
                               throws IOException

Throws:

IOException

Method Detail

listDataExchangesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListDataExchangesRequest,ListDataExchangesResponse,AnalyticsHubServiceClient.ListDataExchangesPagedResponse> listDataExchangesSettings()

Returns the object with the settings used for calls to listDataExchanges.

listOrgDataExchangesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListOrgDataExchangesRequest,ListOrgDataExchangesResponse,AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse> listOrgDataExchangesSettings()

Returns the object with the settings used for calls to listOrgDataExchanges.

getDataExchangeSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetDataExchangeRequest,DataExchange> getDataExchangeSettings()

Returns the object with the settings used for calls to getDataExchange.

createDataExchangeSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateDataExchangeRequest,DataExchange> createDataExchangeSettings()

Returns the object with the settings used for calls to createDataExchange.

updateDataExchangeSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateDataExchangeRequest,DataExchange> updateDataExchangeSettings()

Returns the object with the settings used for calls to updateDataExchange.

deleteDataExchangeSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteDataExchangeRequest,com.google.protobuf.Empty> deleteDataExchangeSettings()

Returns the object with the settings used for calls to deleteDataExchange.

listListingsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListListingsRequest,ListListingsResponse,AnalyticsHubServiceClient.ListListingsPagedResponse> listListingsSettings()

Returns the object with the settings used for calls to listListings.

getListingSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetListingRequest,Listing> getListingSettings()

Returns the object with the settings used for calls to getListing.

createListingSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateListingRequest,Listing> createListingSettings()

Returns the object with the settings used for calls to createListing.

updateListingSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateListingRequest,Listing> updateListingSettings()

Returns the object with the settings used for calls to updateListing.

deleteListingSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteListingRequest,com.google.protobuf.Empty> deleteListingSettings()

Returns the object with the settings used for calls to deleteListing.

subscribeListingSettings

public com.google.api.gax.rpc.UnaryCallSettings<SubscribeListingRequest,SubscribeListingResponse> subscribeListingSettings()

Returns the object with the settings used for calls to subscribeListing.

subscribeDataExchangeSettings

public com.google.api.gax.rpc.UnaryCallSettings<SubscribeDataExchangeRequest,com.google.longrunning.Operation> subscribeDataExchangeSettings()

Returns the object with the settings used for calls to subscribeDataExchange.

subscribeDataExchangeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SubscribeDataExchangeRequest,SubscribeDataExchangeResponse,OperationMetadata> subscribeDataExchangeOperationSettings()

Returns the object with the settings used for calls to subscribeDataExchange.

refreshSubscriptionSettings

public com.google.api.gax.rpc.UnaryCallSettings<RefreshSubscriptionRequest,com.google.longrunning.Operation> refreshSubscriptionSettings()

Returns the object with the settings used for calls to refreshSubscription.

refreshSubscriptionOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<RefreshSubscriptionRequest,RefreshSubscriptionResponse,OperationMetadata> refreshSubscriptionOperationSettings()

Returns the object with the settings used for calls to refreshSubscription.

getSubscriptionSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetSubscriptionRequest,Subscription> getSubscriptionSettings()

Returns the object with the settings used for calls to getSubscription.

listSubscriptionsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,AnalyticsHubServiceClient.ListSubscriptionsPagedResponse> listSubscriptionsSettings()

Returns the object with the settings used for calls to listSubscriptions.

listSharedResourceSubscriptionsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListSharedResourceSubscriptionsRequest,ListSharedResourceSubscriptionsResponse,AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse> listSharedResourceSubscriptionsSettings()

Returns the object with the settings used for calls to listSharedResourceSubscriptions.

revokeSubscriptionSettings

public com.google.api.gax.rpc.UnaryCallSettings<RevokeSubscriptionRequest,RevokeSubscriptionResponse> revokeSubscriptionSettings()

Returns the object with the settings used for calls to revokeSubscription.

deleteSubscriptionSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteSubscriptionRequest,com.google.longrunning.Operation> deleteSubscriptionSettings()

Returns the object with the settings used for calls to deleteSubscription.

deleteSubscriptionOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteSubscriptionRequest,com.google.protobuf.Empty,OperationMetadata> deleteSubscriptionOperationSettings()

Returns the object with the settings used for calls to deleteSubscription.

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

Returns the object with the settings used for calls to getIamPolicy.

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

Returns the object with the settings used for calls to setIamPolicy.

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

Returns the object with the settings used for calls to testIamPermissions.

create

public static final AnalyticsHubServiceSettings create(AnalyticsHubServiceStubSettings stub)
                                                throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static AnalyticsHubServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static AnalyticsHubServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static AnalyticsHubServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public AnalyticsHubServiceSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<AnalyticsHubServiceSettings>