Class AnalyticsHubServiceSettings (0.52.0)

Version latest

• 0.52.0 (latest)
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public class AnalyticsHubServiceSettings extends 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 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 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();
 

Inheritance

java.lang.Object > ClientSettings > AnalyticsHubServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(AnalyticsHubServiceStubSettings stub)

public static final AnalyticsHubServiceSettings create(AnalyticsHubServiceStubSettings stub)

Parameter
Name	Description
stub	AnalyticsHubServiceStubSettings

Returns
Type	Description
AnalyticsHubServiceSettings

Exceptions
Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Returns
Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
List<String>

newBuilder()

public static AnalyticsHubServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
AnalyticsHubServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static AnalyticsHubServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
AnalyticsHubServiceSettings.Builder

newHttpJsonBuilder()

public static AnalyticsHubServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
AnalyticsHubServiceSettings.Builder

Constructors

AnalyticsHubServiceSettings(AnalyticsHubServiceSettings.Builder settingsBuilder)

protected AnalyticsHubServiceSettings(AnalyticsHubServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	AnalyticsHubServiceSettings.Builder

Methods

createDataExchangeSettings()

public UnaryCallSettings<CreateDataExchangeRequest,DataExchange> createDataExchangeSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateDataExchangeRequest,DataExchange>

createListingSettings()

public UnaryCallSettings<CreateListingRequest,Listing> createListingSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateListingRequest,Listing>

deleteDataExchangeSettings()

public UnaryCallSettings<DeleteDataExchangeRequest,Empty> deleteDataExchangeSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteDataExchangeRequest,Empty>

deleteListingSettings()

public UnaryCallSettings<DeleteListingRequest,Empty> deleteListingSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteListingRequest,Empty>

deleteSubscriptionOperationSettings()

public OperationCallSettings<DeleteSubscriptionRequest,Empty,OperationMetadata> deleteSubscriptionOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteSubscriptionRequest,Empty,OperationMetadata>

deleteSubscriptionSettings()

public UnaryCallSettings<DeleteSubscriptionRequest,Operation> deleteSubscriptionSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteSubscriptionRequest,Operation>

getDataExchangeSettings()

public UnaryCallSettings<GetDataExchangeRequest,DataExchange> getDataExchangeSettings()

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

Returns
Type	Description
UnaryCallSettings<GetDataExchangeRequest,DataExchange>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getListingSettings()

public UnaryCallSettings<GetListingRequest,Listing> getListingSettings()

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

Returns
Type	Description
UnaryCallSettings<GetListingRequest,Listing>

getSubscriptionSettings()

public UnaryCallSettings<GetSubscriptionRequest,Subscription> getSubscriptionSettings()

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

Returns
Type	Description
UnaryCallSettings<GetSubscriptionRequest,Subscription>

listDataExchangesSettings()

public PagedCallSettings<ListDataExchangesRequest,ListDataExchangesResponse,AnalyticsHubServiceClient.ListDataExchangesPagedResponse> listDataExchangesSettings()

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

Returns
Type	Description
PagedCallSettings<ListDataExchangesRequest,ListDataExchangesResponse,ListDataExchangesPagedResponse>

listListingsSettings()

public PagedCallSettings<ListListingsRequest,ListListingsResponse,AnalyticsHubServiceClient.ListListingsPagedResponse> listListingsSettings()

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

Returns
Type	Description
PagedCallSettings<ListListingsRequest,ListListingsResponse,ListListingsPagedResponse>

listOrgDataExchangesSettings()

public PagedCallSettings<ListOrgDataExchangesRequest,ListOrgDataExchangesResponse,AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse> listOrgDataExchangesSettings()

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

Returns
Type	Description
PagedCallSettings<ListOrgDataExchangesRequest,ListOrgDataExchangesResponse,ListOrgDataExchangesPagedResponse>

listSharedResourceSubscriptionsSettings()

public PagedCallSettings<ListSharedResourceSubscriptionsRequest,ListSharedResourceSubscriptionsResponse,AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse> listSharedResourceSubscriptionsSettings()

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

Returns
Type	Description
PagedCallSettings<ListSharedResourceSubscriptionsRequest,ListSharedResourceSubscriptionsResponse,ListSharedResourceSubscriptionsPagedResponse>

listSubscriptionsSettings()

public PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,AnalyticsHubServiceClient.ListSubscriptionsPagedResponse> listSubscriptionsSettings()

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

Returns
Type	Description
PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,ListSubscriptionsPagedResponse>

refreshSubscriptionOperationSettings()

public OperationCallSettings<RefreshSubscriptionRequest,RefreshSubscriptionResponse,OperationMetadata> refreshSubscriptionOperationSettings()

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

Returns
Type	Description
OperationCallSettings<RefreshSubscriptionRequest,RefreshSubscriptionResponse,OperationMetadata>

refreshSubscriptionSettings()

public UnaryCallSettings<RefreshSubscriptionRequest,Operation> refreshSubscriptionSettings()

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

Returns
Type	Description
UnaryCallSettings<RefreshSubscriptionRequest,Operation>

revokeSubscriptionSettings()

public UnaryCallSettings<RevokeSubscriptionRequest,RevokeSubscriptionResponse> revokeSubscriptionSettings()

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

Returns
Type	Description
UnaryCallSettings<RevokeSubscriptionRequest,RevokeSubscriptionResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

subscribeDataExchangeOperationSettings()

public OperationCallSettings<SubscribeDataExchangeRequest,SubscribeDataExchangeResponse,OperationMetadata> subscribeDataExchangeOperationSettings()

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

Returns
Type	Description
OperationCallSettings<SubscribeDataExchangeRequest,SubscribeDataExchangeResponse,OperationMetadata>

subscribeDataExchangeSettings()

public UnaryCallSettings<SubscribeDataExchangeRequest,Operation> subscribeDataExchangeSettings()

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

Returns
Type	Description
UnaryCallSettings<SubscribeDataExchangeRequest,Operation>

subscribeListingSettings()

public UnaryCallSettings<SubscribeListingRequest,SubscribeListingResponse> subscribeListingSettings()

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

Returns
Type	Description
UnaryCallSettings<SubscribeListingRequest,SubscribeListingResponse>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public AnalyticsHubServiceSettings.Builder toBuilder()

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

Returns
Type	Description
AnalyticsHubServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateDataExchangeSettings()

public UnaryCallSettings<UpdateDataExchangeRequest,DataExchange> updateDataExchangeSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateDataExchangeRequest,DataExchange>

updateListingSettings()

public UnaryCallSettings<UpdateListingRequest,Listing> updateListingSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateListingRequest,Listing>