Package com.google.ads.googleads.v10.services.stub

Class AdServiceStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<AdServiceStubSettings>

com.google.ads.googleads.v10.services.stub.AdServiceStubSettings

@Generated("by gapic-generator-java")
public class AdServiceStubSettings
extends com.google.api.gax.rpc.StubSettings<AdServiceStubSettings>

Settings class to configure an instance of AdServiceStub.

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 getAd to 30 seconds:

 AdServiceStubSettings.Builder adServiceSettingsBuilder = AdServiceStubSettings.newBuilder();
 adServiceSettingsBuilder
     .getAdSettings()
     .setRetrySettings(
         adServiceSettingsBuilder
             .getAdSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AdServiceStubSettings adServiceSettings = adServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdServiceStubSettings.Builder	Builder for AdServiceStubSettings.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AdServiceStubSettings(AdServiceStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method	Description
AdServiceStub	createStub()
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder()	Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder()	Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder()	Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<GetAdRequest,Ad>	getAdSettings()	Returns the object with the settings used for calls to getAd.
static java.lang.String	getDefaultEndpoint()	Returns the default service endpoint.
static java.lang.String	getDefaultMtlsEndpoint()	Returns the default mTLS service endpoint.
static java.util.List<java.lang.String>	getDefaultServiceScopes()	Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<MutateAdsRequest,MutateAdsResponse>	mutateAdsSettings()	Returns the object with the settings used for calls to mutateAds.
static AdServiceStubSettings.Builder	newBuilder()	Returns a new builder for this class.
static AdServiceStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext)	Returns a new builder for this class.
AdServiceStubSettings.Builder	toBuilder()	Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AdServiceStubSettings

protected AdServiceStubSettings(AdServiceStubSettings.Builder settingsBuilder)
                         throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getAdSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetAdRequest,Ad> getAdSettings()

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

mutateAdsSettings

public com.google.api.gax.rpc.UnaryCallSettings<MutateAdsRequest,MutateAdsResponse> mutateAdsSettings()

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

createStub

@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public AdServiceStub createStub()
                         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.

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

@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 AdServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static AdServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public AdServiceStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<AdServiceStubSettings>