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

Class KeywordPlanIdeaServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<KeywordPlanIdeaServiceSettings>

com.google.ads.googleads.v10.services.KeywordPlanIdeaServiceSettings

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

Settings class to configure an instance of KeywordPlanIdeaServiceClient.

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

 KeywordPlanIdeaServiceSettings.Builder keywordPlanIdeaServiceSettingsBuilder =
     KeywordPlanIdeaServiceSettings.newBuilder();
 keywordPlanIdeaServiceSettingsBuilder
     .generateKeywordIdeasSettings()
     .setRetrySettings(
         keywordPlanIdeaServiceSettingsBuilder
             .generateKeywordIdeasSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 KeywordPlanIdeaServiceSettings keywordPlanIdeaServiceSettings =
     keywordPlanIdeaServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeywordPlanIdeaServiceSettings(KeywordPlanIdeaServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method	Description
static KeywordPlanIdeaServiceSettings	create(KeywordPlanIdeaServiceStubSettings stub)
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.PagedCallSettings<GenerateKeywordIdeasRequest,GenerateKeywordIdeaResponse,KeywordPlanIdeaServiceClient.GenerateKeywordIdeasPagedResponse>	generateKeywordIdeasSettings()	Returns the object with the settings used for calls to generateKeywordIdeas.
static java.lang.String	getDefaultEndpoint()	Returns the default service endpoint.
static java.util.List<java.lang.String>	getDefaultServiceScopes()	Returns the default service scopes.
static KeywordPlanIdeaServiceSettings.Builder	newBuilder()	Returns a new builder for this class.
static KeywordPlanIdeaServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext)	Returns a new builder for this class.
KeywordPlanIdeaServiceSettings.Builder	toBuilder()	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

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordPlanIdeaServiceSettings

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

Throws:

java.io.IOException

Method Detail

generateKeywordIdeasSettings

public com.google.api.gax.rpc.PagedCallSettings<GenerateKeywordIdeasRequest,GenerateKeywordIdeaResponse,KeywordPlanIdeaServiceClient.GenerateKeywordIdeasPagedResponse> generateKeywordIdeasSettings()

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

create

public static final KeywordPlanIdeaServiceSettings create(KeywordPlanIdeaServiceStubSettings 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 KeywordPlanIdeaServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public KeywordPlanIdeaServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<KeywordPlanIdeaServiceSettings>