Class GoogleAdsServiceStubSettings
- java.lang.Object
-
- com.google.api.gax.rpc.StubSettings<GoogleAdsServiceStubSettings>
-
- com.google.ads.googleads.v15.services.stub.GoogleAdsServiceStubSettings
-
@Generated("by gapic-generator-java") public class GoogleAdsServiceStubSettings extends com.google.api.gax.rpc.StubSettings<GoogleAdsServiceStubSettings>Settings class to configure an instance ofGoogleAdsServiceStub.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:
// 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 GoogleAdsServiceStubSettings.Builder googleAdsServiceSettingsBuilder = GoogleAdsServiceStubSettings.newBuilder(); googleAdsServiceSettingsBuilder .mutateSettings() .setRetrySettings( googleAdsServiceSettingsBuilder .mutateSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); GoogleAdsServiceStubSettings googleAdsServiceSettings = googleAdsServiceSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGoogleAdsServiceStubSettings.BuilderBuilder for GoogleAdsServiceStubSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protectedGoogleAdsServiceStubSettings(GoogleAdsServiceStubSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description GoogleAdsServiceStubcreateStub()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.lang.StringgetDefaultMtlsEndpoint()Returns the default mTLS service endpoint.static java.util.List<java.lang.String>getDefaultServiceScopes()Returns the default service scopes.java.lang.StringgetEndpoint()Returns the endpoint set by the user or the the service's default endpoint.java.lang.StringgetServiceName()Returns the default service name.com.google.api.gax.rpc.UnaryCallSettings<MutateGoogleAdsRequest,MutateGoogleAdsResponse>mutateSettings()Returns the object with the settings used for calls to mutate.static GoogleAdsServiceStubSettings.BuildernewBuilder()Returns a new builder for this class.static GoogleAdsServiceStubSettings.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.GoogleAdsServiceStubSettings.BuildertoBuilder()Returns a builder containing all the values of this settings class.-
Methods inherited from class com.google.api.gax.rpc.StubSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
-
-
-
Constructor Detail
-
GoogleAdsServiceStubSettings
protected GoogleAdsServiceStubSettings(GoogleAdsServiceStubSettings.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.
-
createStub
public GoogleAdsServiceStub createStub() throws java.io.IOException
- Throws:
java.io.IOException
-
getEndpoint
public java.lang.String getEndpoint()
Returns the endpoint set by the user or the the service's default endpoint.- Overrides:
getEndpointin classcom.google.api.gax.rpc.StubSettings<GoogleAdsServiceStubSettings>
-
getServiceName
public java.lang.String getServiceName()
Returns the default service name.- Overrides:
getServiceNamein classcom.google.api.gax.rpc.StubSettings<GoogleAdsServiceStubSettings>
-
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.
-
getDefaultMtlsEndpoint
public static java.lang.String getDefaultMtlsEndpoint()
Returns the default mTLS 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
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static GoogleAdsServiceStubSettings.Builder newBuilder()
Returns a new builder for this class.
-
newBuilder
public static GoogleAdsServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public GoogleAdsServiceStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classcom.google.api.gax.rpc.StubSettings<GoogleAdsServiceStubSettings>
-
-