Class AlphaAnalyticsDataSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<AlphaAnalyticsDataSettings>
com.google.analytics.data.v1alpha.AlphaAnalyticsDataSettings
@BetaApi
@Generated("by gapic-generator-java")
public class AlphaAnalyticsDataSettings
extends ClientSettings<AlphaAnalyticsDataSettings>
Settings class to configure an instance of
AlphaAnalyticsDataClient.
The default instance has everything set to sensible defaults:
- The default service address (analyticsdata.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 runFunnelReport:
// 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
AlphaAnalyticsDataSettings.Builder alphaAnalyticsDataSettingsBuilder =
AlphaAnalyticsDataSettings.newBuilder();
alphaAnalyticsDataSettingsBuilder
.runFunnelReportSettings()
.setRetrySettings(
alphaAnalyticsDataSettingsBuilder
.runFunnelReportSettings()
.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());
AlphaAnalyticsDataSettings alphaAnalyticsDataSettings =
alphaAnalyticsDataSettingsBuilder.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 createAudienceList:
// 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
AlphaAnalyticsDataSettings.Builder alphaAnalyticsDataSettingsBuilder =
AlphaAnalyticsDataSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
alphaAnalyticsDataSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for AlphaAnalyticsDataSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAlphaAnalyticsDataSettings(AlphaAnalyticsDataSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final AlphaAnalyticsDataSettingsReturns the object with the settings used for calls to createAudienceList.Returns the object with the settings used for calls to createAudienceList.Returns the object with the settings used for calls to createRecurringAudienceList.Returns the object with the settings used for calls to createReportTask.Returns the object with the settings used for calls to createReportTask.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderReturns the object with the settings used for calls to getAudienceList.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getMetadata.Returns the object with the settings used for calls to getPropertyQuotasSnapshot.Returns the object with the settings used for calls to getRecurringAudienceList.Returns the object with the settings used for calls to getReportTask.PagedCallSettings<ListAudienceListsRequest,ListAudienceListsResponse, AlphaAnalyticsDataClient.ListAudienceListsPagedResponse> Returns the object with the settings used for calls to listAudienceLists.PagedCallSettings<ListRecurringAudienceListsRequest,ListRecurringAudienceListsResponse, AlphaAnalyticsDataClient.ListRecurringAudienceListsPagedResponse> Returns the object with the settings used for calls to listRecurringAudienceLists.PagedCallSettings<ListReportTasksRequest,ListReportTasksResponse, AlphaAnalyticsDataClient.ListReportTasksPagedResponse> Returns the object with the settings used for calls to listReportTasks.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to queryAudienceList.Returns the object with the settings used for calls to queryReportTask.Returns the object with the settings used for calls to runFunnelReport.Returns the object with the settings used for calls to runReport.Returns a builder containing all the values of this settings class.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
-
Constructor Details
-
AlphaAnalyticsDataSettings
protected AlphaAnalyticsDataSettings(AlphaAnalyticsDataSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
runFunnelReportSettings
Returns the object with the settings used for calls to runFunnelReport. -
createAudienceListSettings
Returns the object with the settings used for calls to createAudienceList. -
createAudienceListOperationSettings
public OperationCallSettings<CreateAudienceListRequest,AudienceList, createAudienceListOperationSettings()AudienceListMetadata> Returns the object with the settings used for calls to createAudienceList. -
queryAudienceListSettings
public UnaryCallSettings<QueryAudienceListRequest,QueryAudienceListResponse> queryAudienceListSettings()Returns the object with the settings used for calls to queryAudienceList. -
getAudienceListSettings
Returns the object with the settings used for calls to getAudienceList. -
listAudienceListsSettings
public PagedCallSettings<ListAudienceListsRequest,ListAudienceListsResponse, listAudienceListsSettings()AlphaAnalyticsDataClient.ListAudienceListsPagedResponse> Returns the object with the settings used for calls to listAudienceLists. -
createRecurringAudienceListSettings
public UnaryCallSettings<CreateRecurringAudienceListRequest,RecurringAudienceList> createRecurringAudienceListSettings()Returns the object with the settings used for calls to createRecurringAudienceList. -
getRecurringAudienceListSettings
public UnaryCallSettings<GetRecurringAudienceListRequest,RecurringAudienceList> getRecurringAudienceListSettings()Returns the object with the settings used for calls to getRecurringAudienceList. -
listRecurringAudienceListsSettings
public PagedCallSettings<ListRecurringAudienceListsRequest,ListRecurringAudienceListsResponse, listRecurringAudienceListsSettings()AlphaAnalyticsDataClient.ListRecurringAudienceListsPagedResponse> Returns the object with the settings used for calls to listRecurringAudienceLists. -
getPropertyQuotasSnapshotSettings
public UnaryCallSettings<GetPropertyQuotasSnapshotRequest,PropertyQuotasSnapshot> getPropertyQuotasSnapshotSettings()Returns the object with the settings used for calls to getPropertyQuotasSnapshot. -
createReportTaskSettings
Returns the object with the settings used for calls to createReportTask. -
createReportTaskOperationSettings
public OperationCallSettings<CreateReportTaskRequest,ReportTask, createReportTaskOperationSettings()ReportTaskMetadata> Returns the object with the settings used for calls to createReportTask. -
queryReportTaskSettings
Returns the object with the settings used for calls to queryReportTask. -
getReportTaskSettings
Returns the object with the settings used for calls to getReportTask. -
listReportTasksSettings
public PagedCallSettings<ListReportTasksRequest,ListReportTasksResponse, listReportTasksSettings()AlphaAnalyticsDataClient.ListReportTasksPagedResponse> Returns the object with the settings used for calls to listReportTasks. -
runReportSettings
Returns the object with the settings used for calls to runReport. -
getMetadataSettings
Returns the object with the settings used for calls to getMetadata. -
create
public static final AlphaAnalyticsDataSettings create(AlphaAnalyticsDataStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<AlphaAnalyticsDataSettings>
-