Class ReachPlanServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<ReachPlanServiceSettings>
com.google.ads.googleads.v18.services.ReachPlanServiceSettings
@Generated("by gapic-generator-java")
public class ReachPlanServiceSettings
extends com.google.api.gax.rpc.ClientSettings<ReachPlanServiceSettings>
Settings class to configure an instance of
ReachPlanServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (googleads.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 listPlannableLocations:
// 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
ReachPlanServiceSettings.Builder reachPlanServiceSettingsBuilder =
ReachPlanServiceSettings.newBuilder();
reachPlanServiceSettingsBuilder
.listPlannableLocationsSettings()
.setRetrySettings(
reachPlanServiceSettingsBuilder
.listPlannableLocationsSettings()
.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());
ReachPlanServiceSettings reachPlanServiceSettings = reachPlanServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for
additional support in setting retries.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for ReachPlanServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedReachPlanServiceSettings(ReachPlanServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final ReachPlanServiceSettingsstatic com.google.api.gax.rpc.ApiClientHeaderProvider.Builderstatic com.google.api.gax.core.GoogleCredentialsProvider.BuilderReturns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.BuilderReturns a builder for the default ExecutorProvider for this service.static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.BuilderReturns a builder for the default ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvidercom.google.api.gax.rpc.UnaryCallSettings<GenerateReachForecastRequest,GenerateReachForecastResponse> Returns the object with the settings used for calls to generateReachForecast.static StringReturns the default service endpoint.Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<ListPlannableLocationsRequest,ListPlannableLocationsResponse> Returns the object with the settings used for calls to listPlannableLocations.com.google.api.gax.rpc.UnaryCallSettings<ListPlannableProductsRequest,ListPlannableProductsResponse> Returns the object with the settings used for calls to listPlannableProducts.Returns a new builder for this class.newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.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
-
ReachPlanServiceSettings
protected ReachPlanServiceSettings(ReachPlanServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listPlannableLocationsSettings
public com.google.api.gax.rpc.UnaryCallSettings<ListPlannableLocationsRequest,ListPlannableLocationsResponse> listPlannableLocationsSettings()Returns the object with the settings used for calls to listPlannableLocations. -
listPlannableProductsSettings
public com.google.api.gax.rpc.UnaryCallSettings<ListPlannableProductsRequest,ListPlannableProductsResponse> listPlannableProductsSettings()Returns the object with the settings used for calls to listPlannableProducts. -
generateReachForecastSettings
public com.google.api.gax.rpc.UnaryCallSettings<GenerateReachForecastRequest,GenerateReachForecastResponse> generateReachForecastSettings()Returns the object with the settings used for calls to generateReachForecast. -
create
public static final ReachPlanServiceSettings create(ReachPlanServiceStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider() -
defaultApiClientHeaderProviderBuilder
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() -
newBuilder
Returns a new builder for this class. -
newBuilder
public static ReachPlanServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classcom.google.api.gax.rpc.ClientSettings<ReachPlanServiceSettings>
-