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

Class BatchJobServiceSettings

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

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 mutateBatchJob: 


 // 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
 BatchJobServiceSettings.Builder batchJobServiceSettingsBuilder =
     BatchJobServiceSettings.newBuilder();
 batchJobServiceSettingsBuilder
     .mutateBatchJobSettings()
     .setRetrySettings(
         batchJobServiceSettingsBuilder
             .mutateBatchJobSettings()
             .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());
 BatchJobServiceSettings batchJobServiceSettings = batchJobServiceSettingsBuilder.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.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for runBatchJob: 


 // 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
 BatchJobServiceSettings.Builder batchJobServiceSettingsBuilder =
     BatchJobServiceSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 batchJobServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

  • Constructor Details

  • Method Details

    • mutateBatchJobSettings

      public com.google.api.gax.rpc.UnaryCallSettings<MutateBatchJobRequest,MutateBatchJobResponse> mutateBatchJobSettings()
      Returns the object with the settings used for calls to mutateBatchJob.

    • listBatchJobResultsSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListBatchJobResultsRequest,ListBatchJobResultsResponse,BatchJobServiceClient.ListBatchJobResultsPagedResponse> listBatchJobResultsSettings()
      Returns the object with the settings used for calls to listBatchJobResults.

    • runBatchJobSettings

      public com.google.api.gax.rpc.UnaryCallSettings<RunBatchJobRequest,com.google.longrunning.Operation> runBatchJobSettings()
      Returns the object with the settings used for calls to runBatchJob.

    • runBatchJobOperationSettings

      public com.google.api.gax.rpc.OperationCallSettings<RunBatchJobRequest,com.google.protobuf.Empty,BatchJob.BatchJobMetadata> runBatchJobOperationSettings()
      Returns the object with the settings used for calls to runBatchJob.

    • addBatchJobOperationsSettings

      public com.google.api.gax.rpc.UnaryCallSettings<AddBatchJobOperationsRequest,AddBatchJobOperationsResponse> addBatchJobOperationsSettings()
      Returns the object with the settings used for calls to addBatchJobOperations.

    • create

      public static final BatchJobServiceSettings create(BatchJobServiceStubSettings stub) throws IOException
      Throws:
      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 String getDefaultEndpoint()
      Returns the default 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 BatchJobServiceSettings.Builder newBuilder()
      Returns a new builder for this class.

    • newBuilder

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

    • toBuilder

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