Class GoogleAdsServiceSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<GoogleAdsServiceSettings>
-
- com.google.ads.googleads.v10.services.GoogleAdsServiceSettings
-
@Generated("by gapic-generator-java") public class GoogleAdsServiceSettings extends com.google.api.gax.rpc.ClientSettings<GoogleAdsServiceSettings>Settings class to configure an instance ofGoogleAdsServiceClient.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 mutate to 30 seconds:
GoogleAdsServiceSettings.Builder googleAdsServiceSettingsBuilder = GoogleAdsServiceSettings.newBuilder(); googleAdsServiceSettingsBuilder .mutateSettings() .setRetrySettings( googleAdsServiceSettingsBuilder .mutateSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); GoogleAdsServiceSettings googleAdsServiceSettings = googleAdsServiceSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGoogleAdsServiceSettings.BuilderBuilder for GoogleAdsServiceSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protectedGoogleAdsServiceSettings(GoogleAdsServiceSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GoogleAdsServiceSettingscreate(GoogleAdsServiceStubSettings 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()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<MutateGoogleAdsRequest,MutateGoogleAdsResponse>mutateSettings()Returns the object with the settings used for calls to mutate.static GoogleAdsServiceSettings.BuildernewBuilder()Returns a new builder for this class.static GoogleAdsServiceSettings.BuildernewBuilder(com.google.api.gax.rpc.ClientContext clientContext)Returns a new builder for this class.com.google.api.gax.rpc.PagedCallSettings<SearchGoogleAdsRequest,SearchGoogleAdsResponse,GoogleAdsServiceClient.SearchPagedResponse>searchSettings()Returns the object with the settings used for calls to search.com.google.api.gax.rpc.ServerStreamingCallSettings<SearchGoogleAdsStreamRequest,SearchGoogleAdsStreamResponse>searchStreamSettings()Returns the object with the settings used for calls to searchStream.GoogleAdsServiceSettings.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
-
GoogleAdsServiceSettings
protected GoogleAdsServiceSettings(GoogleAdsServiceSettings.Builder settingsBuilder) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
searchSettings
public com.google.api.gax.rpc.PagedCallSettings<SearchGoogleAdsRequest,SearchGoogleAdsResponse,GoogleAdsServiceClient.SearchPagedResponse> searchSettings()
Returns the object with the settings used for calls to search.
-
searchStreamSettings
public com.google.api.gax.rpc.ServerStreamingCallSettings<SearchGoogleAdsStreamRequest,SearchGoogleAdsStreamResponse> searchStreamSettings()
Returns the object with the settings used for calls to searchStream.
-
mutateSettings
public com.google.api.gax.rpc.UnaryCallSettings<MutateGoogleAdsRequest,MutateGoogleAdsResponse> mutateSettings()
Returns the object with the settings used for calls to mutate.
-
create
public static final GoogleAdsServiceSettings create(GoogleAdsServiceStubSettings 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 GoogleAdsServiceSettings.Builder newBuilder()
Returns a new builder for this class.
-
newBuilder
public static GoogleAdsServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public GoogleAdsServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classcom.google.api.gax.rpc.ClientSettings<GoogleAdsServiceSettings>
-
-