- 0.64.0 (latest)
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.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.35.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.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
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 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 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)
.setMaxRetryDelay(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
betaAnalyticsDataSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(BetaAnalyticsDataStubSettings stub)
public static final BetaAnalyticsDataSettings create(BetaAnalyticsDataStubSettings stub)
Parameter | |
---|---|
Name | Description |
stub |
BetaAnalyticsDataStubSettings |
Returns | |
---|---|
Type | Description |
BetaAnalyticsDataSettings |
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()
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 BetaAnalyticsDataSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
Returns | |
---|---|
Type | Description |
BetaAnalyticsDataSettings.Builder |
newBuilder(ClientContext clientContext)
public static BetaAnalyticsDataSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
Parameter | |
---|---|
Name | Description |
clientContext |
ClientContext |
Returns | |
---|---|
Type | Description |
BetaAnalyticsDataSettings.Builder |
newHttpJsonBuilder()
public static BetaAnalyticsDataSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
Returns | |
---|---|
Type | Description |
BetaAnalyticsDataSettings.Builder |
Constructors
BetaAnalyticsDataSettings(BetaAnalyticsDataSettings.Builder settingsBuilder)
protected BetaAnalyticsDataSettings(BetaAnalyticsDataSettings.Builder settingsBuilder)
Parameter | |
---|---|
Name | Description |
settingsBuilder |
BetaAnalyticsDataSettings.Builder |
Methods
batchRunPivotReportsSettings()
public UnaryCallSettings<BatchRunPivotReportsRequest,BatchRunPivotReportsResponse> batchRunPivotReportsSettings()
Returns the object with the settings used for calls to batchRunPivotReports.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<BatchRunPivotReportsRequest,BatchRunPivotReportsResponse> |
batchRunReportsSettings()
public UnaryCallSettings<BatchRunReportsRequest,BatchRunReportsResponse> batchRunReportsSettings()
Returns the object with the settings used for calls to batchRunReports.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<BatchRunReportsRequest,BatchRunReportsResponse> |
checkCompatibilitySettings()
public UnaryCallSettings<CheckCompatibilityRequest,CheckCompatibilityResponse> checkCompatibilitySettings()
Returns the object with the settings used for calls to checkCompatibility.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<CheckCompatibilityRequest,CheckCompatibilityResponse> |
createAudienceExportOperationSettings()
public OperationCallSettings<CreateAudienceExportRequest,AudienceExport,AudienceExportMetadata> createAudienceExportOperationSettings()
Returns the object with the settings used for calls to createAudienceExport.
Returns | |
---|---|
Type | Description |
OperationCallSettings<CreateAudienceExportRequest,AudienceExport,AudienceExportMetadata> |
createAudienceExportSettings()
public UnaryCallSettings<CreateAudienceExportRequest,Operation> createAudienceExportSettings()
Returns the object with the settings used for calls to createAudienceExport.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<CreateAudienceExportRequest,Operation> |
getAudienceExportSettings()
public UnaryCallSettings<GetAudienceExportRequest,AudienceExport> getAudienceExportSettings()
Returns the object with the settings used for calls to getAudienceExport.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetAudienceExportRequest,AudienceExport> |
getMetadataSettings()
public UnaryCallSettings<GetMetadataRequest,Metadata> getMetadataSettings()
Returns the object with the settings used for calls to getMetadata.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetMetadataRequest,Metadata> |
listAudienceExportsSettings()
public PagedCallSettings<ListAudienceExportsRequest,ListAudienceExportsResponse,BetaAnalyticsDataClient.ListAudienceExportsPagedResponse> listAudienceExportsSettings()
Returns the object with the settings used for calls to listAudienceExports.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListAudienceExportsRequest,ListAudienceExportsResponse,ListAudienceExportsPagedResponse> |
queryAudienceExportSettings()
public UnaryCallSettings<QueryAudienceExportRequest,QueryAudienceExportResponse> queryAudienceExportSettings()
Returns the object with the settings used for calls to queryAudienceExport.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<QueryAudienceExportRequest,QueryAudienceExportResponse> |
runPivotReportSettings()
public UnaryCallSettings<RunPivotReportRequest,RunPivotReportResponse> runPivotReportSettings()
Returns the object with the settings used for calls to runPivotReport.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<RunPivotReportRequest,RunPivotReportResponse> |
runRealtimeReportSettings()
public UnaryCallSettings<RunRealtimeReportRequest,RunRealtimeReportResponse> runRealtimeReportSettings()
Returns the object with the settings used for calls to runRealtimeReport.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<RunRealtimeReportRequest,RunRealtimeReportResponse> |
runReportSettings()
public UnaryCallSettings<RunReportRequest,RunReportResponse> runReportSettings()
Returns the object with the settings used for calls to runReport.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<RunReportRequest,RunReportResponse> |
toBuilder()
public BetaAnalyticsDataSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
Returns | |
---|---|
Type | Description |
BetaAnalyticsDataSettings.Builder |