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

Class GoogleAdsFieldServiceStubSettings

java.lang.Object
com.google.api.gax.rpc.StubSettings<GoogleAdsFieldServiceStubSettings>
com.google.ads.googleads.v18.services.stub.GoogleAdsFieldServiceStubSettings
@Generated("by gapic-generator-java") public class GoogleAdsFieldServiceStubSettings extends com.google.api.gax.rpc.StubSettings<GoogleAdsFieldServiceStubSettings>
Settings class to configure an instance of GoogleAdsFieldServiceStub.

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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getGoogleAdsField: 


 // 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
 GoogleAdsFieldServiceStubSettings.Builder googleAdsFieldServiceSettingsBuilder =
     GoogleAdsFieldServiceStubSettings.newBuilder();
 googleAdsFieldServiceSettingsBuilder
     .getGoogleAdsFieldSettings()
     .setRetrySettings(
         googleAdsFieldServiceSettingsBuilder
             .getGoogleAdsFieldSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 GoogleAdsFieldServiceStubSettings googleAdsFieldServiceSettings =
     googleAdsFieldServiceSettingsBuilder.build();
Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

  • Constructor Details

  • Method Details

    • getGoogleAdsFieldSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetGoogleAdsFieldRequest,GoogleAdsField> getGoogleAdsFieldSettings()
      Returns the object with the settings used for calls to getGoogleAdsField.

    • searchGoogleAdsFieldsSettings

      public com.google.api.gax.rpc.PagedCallSettings<SearchGoogleAdsFieldsRequest,SearchGoogleAdsFieldsResponse,GoogleAdsFieldServiceClient.SearchGoogleAdsFieldsPagedResponse> searchGoogleAdsFieldsSettings()
      Returns the object with the settings used for calls to searchGoogleAdsFields.

    • createStub

      public GoogleAdsFieldServiceStub createStub() throws IOException
      Throws:
      IOException

    • getServiceName

      public String getServiceName()
      Returns the default service name.
      Overrides:
      getServiceName in class com.google.api.gax.rpc.StubSettings<GoogleAdsFieldServiceStubSettings>

    • defaultExecutorProviderBuilder

      public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
      Returns a builder for the default ExecutorProvider for this service.

    • getDefaultEndpoint

      @ObsoleteApi("Use getEndpoint() instead") public static String getDefaultEndpoint()
      Returns the default service endpoint.

    • getDefaultMtlsEndpoint

      public static String getDefaultMtlsEndpoint()
      Returns the default mTLS service endpoint.

    • getDefaultServiceScopes

      public static List<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 GoogleAdsFieldServiceStubSettings.Builder newBuilder()
      Returns a new builder for this class.

    • newBuilder

      public static GoogleAdsFieldServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
      Returns a new builder for this class.

    • toBuilder

      public GoogleAdsFieldServiceStubSettings.Builder toBuilder()
      Returns a builder containing all the values of this settings class.
      Specified by:
      toBuilder in class com.google.api.gax.rpc.StubSettings<GoogleAdsFieldServiceStubSettings>