Package com.google.analytics.data.v1beta
Class BetaAnalyticsDataSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<BetaAnalyticsDataSettings>
com.google.analytics.data.v1beta.BetaAnalyticsDataSettings
@BetaApi
@Generated("by gapic-generator-java")
public class BetaAnalyticsDataSettings
extends ClientSettings<BetaAnalyticsDataSettings>
Settings class to configure an instance of
BetaAnalyticsDataClient.
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 runReport:
// 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
BetaAnalyticsDataSettings.Builder betaAnalyticsDataSettingsBuilder =
BetaAnalyticsDataSettings.newBuilder();
betaAnalyticsDataSettingsBuilder
.runReportSettings()
.setRetrySettings(
betaAnalyticsDataSettingsBuilder
.runReportSettings()
.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());
BetaAnalyticsDataSettings betaAnalyticsDataSettings = betaAnalyticsDataSettingsBuilder.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 createAudienceExport:
// 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
BetaAnalyticsDataSettings.Builder betaAnalyticsDataSettingsBuilder =
BetaAnalyticsDataSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
betaAnalyticsDataSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for BetaAnalyticsDataSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedBetaAnalyticsDataSettings(BetaAnalyticsDataSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to batchRunPivotReports.Returns the object with the settings used for calls to batchRunReports.Returns the object with the settings used for calls to checkCompatibility.static final BetaAnalyticsDataSettingsReturns the object with the settings used for calls to createAudienceExport.Returns the object with the settings used for calls to createAudienceExport.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 getAudienceExport.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getMetadata.PagedCallSettings<ListAudienceExportsRequest,ListAudienceExportsResponse, BetaAnalyticsDataClient.ListAudienceExportsPagedResponse> Returns the object with the settings used for calls to listAudienceExports.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 queryAudienceExport.Returns the object with the settings used for calls to runPivotReport.Returns the object with the settings used for calls to runRealtimeReport.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
-
BetaAnalyticsDataSettings
protected BetaAnalyticsDataSettings(BetaAnalyticsDataSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
runReportSettings
Returns the object with the settings used for calls to runReport. -
runPivotReportSettings
Returns the object with the settings used for calls to runPivotReport. -
batchRunReportsSettings
Returns the object with the settings used for calls to batchRunReports. -
batchRunPivotReportsSettings
public UnaryCallSettings<BatchRunPivotReportsRequest,BatchRunPivotReportsResponse> batchRunPivotReportsSettings()Returns the object with the settings used for calls to batchRunPivotReports. -
getMetadataSettings
Returns the object with the settings used for calls to getMetadata. -
runRealtimeReportSettings
public UnaryCallSettings<RunRealtimeReportRequest,RunRealtimeReportResponse> runRealtimeReportSettings()Returns the object with the settings used for calls to runRealtimeReport. -
checkCompatibilitySettings
public UnaryCallSettings<CheckCompatibilityRequest,CheckCompatibilityResponse> checkCompatibilitySettings()Returns the object with the settings used for calls to checkCompatibility. -
createAudienceExportSettings
Returns the object with the settings used for calls to createAudienceExport. -
createAudienceExportOperationSettings
public OperationCallSettings<CreateAudienceExportRequest,AudienceExport, createAudienceExportOperationSettings()AudienceExportMetadata> Returns the object with the settings used for calls to createAudienceExport. -
queryAudienceExportSettings
public UnaryCallSettings<QueryAudienceExportRequest,QueryAudienceExportResponse> queryAudienceExportSettings()Returns the object with the settings used for calls to queryAudienceExport. -
getAudienceExportSettings
Returns the object with the settings used for calls to getAudienceExport. -
listAudienceExportsSettings
public PagedCallSettings<ListAudienceExportsRequest,ListAudienceExportsResponse, listAudienceExportsSettings()BetaAnalyticsDataClient.ListAudienceExportsPagedResponse> Returns the object with the settings used for calls to listAudienceExports. -
create
public static final BetaAnalyticsDataSettings create(BetaAnalyticsDataStubSettings 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<BetaAnalyticsDataSettings>
-