Class ReportServiceStubSettings (0.13.0) 

public class ReportServiceStubSettings extends StubSettings<ReportServiceStubSettings>

Settings class to configure an instance of ReportServiceStub.

The default instance has everything set to sensible defaults:

  • The default service address (admanager.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 getReport:


 // 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
 ReportServiceStubSettings.Builder reportServiceSettingsBuilder =
     ReportServiceStubSettings.newBuilder();
 reportServiceSettingsBuilder
     .getReportSettings()
     .setRetrySettings(
         reportServiceSettingsBuilder
             .getReportSettings()
             .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());
 ReportServiceStubSettings reportServiceSettings = reportServiceSettingsBuilder.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 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
 ReportServiceStubSettings.Builder reportServiceSettingsBuilder =
     ReportServiceStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 reportServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > StubSettings > ReportServiceStubSettings

Static Methods

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

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default 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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 ReportServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
ReportServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static ReportServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ReportServiceStubSettings.Builder

Constructors

ReportServiceStubSettings(ReportServiceStubSettings.Builder settingsBuilder)

protected ReportServiceStubSettings(ReportServiceStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder ReportServiceStubSettings.Builder

Methods

createReportSettings()

public UnaryCallSettings<CreateReportRequest,Report> createReportSettings()

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

Returns
Type Description
UnaryCallSettings<CreateReportRequest,Report>

createStub()

public ReportServiceStub createStub()
Returns
Type Description
ReportServiceStub
Exceptions
Type Description
IOException

fetchReportResultRowsSettings()

public PagedCallSettings<FetchReportResultRowsRequest,FetchReportResultRowsResponse,ReportServiceClient.FetchReportResultRowsPagedResponse> fetchReportResultRowsSettings()

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

Returns
Type Description
PagedCallSettings<FetchReportResultRowsRequest,FetchReportResultRowsResponse,FetchReportResultRowsPagedResponse>

getReportSettings()

public UnaryCallSettings<GetReportRequest,Report> getReportSettings()

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

Returns
Type Description
UnaryCallSettings<GetReportRequest,Report>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

listReportsSettings()

public PagedCallSettings<ListReportsRequest,ListReportsResponse,ReportServiceClient.ListReportsPagedResponse> listReportsSettings()

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

Returns
Type Description
PagedCallSettings<ListReportsRequest,ListReportsResponse,ListReportsPagedResponse>

runReportOperationSettings()

public OperationCallSettings<RunReportRequest,RunReportResponse,RunReportMetadata> runReportOperationSettings()

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

Returns
Type Description
OperationCallSettings<RunReportRequest,RunReportResponse,RunReportMetadata>

runReportSettings()

public UnaryCallSettings<RunReportRequest,Operation> runReportSettings()

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

Returns
Type Description
UnaryCallSettings<RunReportRequest,Operation>

toBuilder()

public ReportServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
ReportServiceStubSettings.Builder
Overrides

updateReportSettings()

public UnaryCallSettings<UpdateReportRequest,Report> updateReportSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateReportRequest,Report>