Class KeywordPlanServiceSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<KeywordPlanServiceSettings>
-
- com.google.ads.googleads.v10.services.KeywordPlanServiceSettings
-
@Generated("by gapic-generator-java") public class KeywordPlanServiceSettings extends com.google.api.gax.rpc.ClientSettings<KeywordPlanServiceSettings>Settings class to configure an instance ofKeywordPlanServiceClient.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 total timeout of mutateKeywordPlans to 30 seconds:
KeywordPlanServiceSettings.Builder keywordPlanServiceSettingsBuilder = KeywordPlanServiceSettings.newBuilder(); keywordPlanServiceSettingsBuilder .mutateKeywordPlansSettings() .setRetrySettings( keywordPlanServiceSettingsBuilder .mutateKeywordPlansSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); KeywordPlanServiceSettings keywordPlanServiceSettings = keywordPlanServiceSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classKeywordPlanServiceSettings.BuilderBuilder for KeywordPlanServiceSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protectedKeywordPlanServiceSettings(KeywordPlanServiceSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static KeywordPlanServiceSettingscreate(KeywordPlanServiceStubSettings stub)static com.google.api.gax.rpc.ApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()static com.google.api.gax.core.GoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProviderdefaultTransportChannelProvider()com.google.api.gax.rpc.UnaryCallSettings<GenerateForecastCurveRequest,GenerateForecastCurveResponse>generateForecastCurveSettings()Returns the object with the settings used for calls to generateForecastCurve.com.google.api.gax.rpc.UnaryCallSettings<GenerateForecastMetricsRequest,GenerateForecastMetricsResponse>generateForecastMetricsSettings()Returns the object with the settings used for calls to generateForecastMetrics.com.google.api.gax.rpc.UnaryCallSettings<GenerateForecastTimeSeriesRequest,GenerateForecastTimeSeriesResponse>generateForecastTimeSeriesSettings()Returns the object with the settings used for calls to generateForecastTimeSeries.com.google.api.gax.rpc.UnaryCallSettings<GenerateHistoricalMetricsRequest,GenerateHistoricalMetricsResponse>generateHistoricalMetricsSettings()Returns the object with the settings used for calls to generateHistoricalMetrics.static java.lang.StringgetDefaultEndpoint()Returns the default service endpoint.static java.util.List<java.lang.String>getDefaultServiceScopes()Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<MutateKeywordPlansRequest,MutateKeywordPlansResponse>mutateKeywordPlansSettings()Returns the object with the settings used for calls to mutateKeywordPlans.static KeywordPlanServiceSettings.BuildernewBuilder()Returns a new builder for this class.static KeywordPlanServiceSettings.BuildernewBuilder(com.google.api.gax.rpc.ClientContext clientContext)Returns a new builder for this class.KeywordPlanServiceSettings.BuildertoBuilder()Returns a builder containing all the values of this settings class.-
Methods inherited from class com.google.api.gax.rpc.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
KeywordPlanServiceSettings
protected KeywordPlanServiceSettings(KeywordPlanServiceSettings.Builder settingsBuilder) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
mutateKeywordPlansSettings
public com.google.api.gax.rpc.UnaryCallSettings<MutateKeywordPlansRequest,MutateKeywordPlansResponse> mutateKeywordPlansSettings()
Returns the object with the settings used for calls to mutateKeywordPlans.
-
generateForecastCurveSettings
public com.google.api.gax.rpc.UnaryCallSettings<GenerateForecastCurveRequest,GenerateForecastCurveResponse> generateForecastCurveSettings()
Returns the object with the settings used for calls to generateForecastCurve.
-
generateForecastTimeSeriesSettings
public com.google.api.gax.rpc.UnaryCallSettings<GenerateForecastTimeSeriesRequest,GenerateForecastTimeSeriesResponse> generateForecastTimeSeriesSettings()
Returns the object with the settings used for calls to generateForecastTimeSeries.
-
generateForecastMetricsSettings
public com.google.api.gax.rpc.UnaryCallSettings<GenerateForecastMetricsRequest,GenerateForecastMetricsResponse> generateForecastMetricsSettings()
Returns the object with the settings used for calls to generateForecastMetrics.
-
generateHistoricalMetricsSettings
public com.google.api.gax.rpc.UnaryCallSettings<GenerateHistoricalMetricsRequest,GenerateHistoricalMetricsResponse> generateHistoricalMetricsSettings()
Returns the object with the settings used for calls to generateHistoricalMetrics.
-
create
public static final KeywordPlanServiceSettings create(KeywordPlanServiceStubSettings stub) throws java.io.IOException
- Throws:
java.io.IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
-
getDefaultEndpoint
public static java.lang.String getDefaultEndpoint()
Returns the default service endpoint.
-
getDefaultServiceScopes
public static java.util.List<java.lang.String> 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
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static KeywordPlanServiceSettings.Builder newBuilder()
Returns a new builder for this class.
-
newBuilder
public static KeywordPlanServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public KeywordPlanServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classcom.google.api.gax.rpc.ClientSettings<KeywordPlanServiceSettings>
-
-