google-ads-googleads 43.0.0 → 44.0.0

data/lib/google/ads/google_ads/v21/services/batch_job_service/client.rb

@@ -1,859 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2026 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
-
-# require "google/ads/google_ads/error"
-require "google/ads/google_ads/v21/services/batch_job_service_pb"
-
-module Google
-  module Ads
-    module GoogleAds
-      module V21
-        module Services
-          module BatchJobService
-            ##
-            # Client for the BatchJobService service.
-            #
-            # Service to manage batch jobs.
-            #
-            class Client
-              # @private
-              API_VERSION = ""
-
-              # @private
-              DEFAULT_ENDPOINT_TEMPLATE = "googleads.$UNIVERSE_DOMAIN$"
-
-              include Paths
-
-              # @private
-              attr_reader :batch_job_service_stub
-
-              ##
-              # Configure the BatchJobService Client class.
-              #
-              # See {::Google::Ads::GoogleAds::V21::Services::BatchJobService::Client::Configuration}
-              # for a description of the configuration fields.
-              #
-              # @example
-              #
-              #   # Modify the configuration for all BatchJobService clients
-              #   ::Google::Ads::GoogleAds::V21::Services::BatchJobService::Client.configure do |config|
-              #     config.timeout = 10.0
-              #   end
-              #
-              # @yield [config] Configure the Client client.
-              # @yieldparam config [Client::Configuration]
-              #
-              # @return [Client::Configuration]
-              #
-              def self.configure
-                @configure ||= begin
-                  default_config = Client::Configuration.new
-
-                  default_config.timeout = 14_400.0
-                  default_config.retry_policy = {
-                    initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
-                  }
-
-                  default_config
-                end
-                yield @configure if block_given?
-                @configure
-              end
-
-              ##
-              # Configure the BatchJobService Client instance.
-              #
-              # The configuration is set to the derived mode, meaning that values can be changed,
-              # but structural changes (adding new fields, etc.) are not allowed. Structural changes
-              # should be made on {Client.configure}.
-              #
-              # See {::Google::Ads::GoogleAds::V21::Services::BatchJobService::Client::Configuration}
-              # for a description of the configuration fields.
-              #
-              # @yield [config] Configure the Client client.
-              # @yieldparam config [Client::Configuration]
-              #
-              # @return [Client::Configuration]
-              #
-              def configure
-                yield @config if block_given?
-                @config
-              end
-
-              ##
-              # The effective universe domain
-              #
-              # @return [String]
-              #
-              def universe_domain
-                @batch_job_service_stub.universe_domain
-              end
-
-              ##
-              # Create a new BatchJobService client object.
-              #
-              # @example
-              #
-              #   # Create a client using the default configuration
-              #   client = ::Google::Ads::GoogleAds::V21::Services::BatchJobService::Client.new
-              #
-              #   # Create a client using a custom configuration
-              #   client = ::Google::Ads::GoogleAds::V21::Services::BatchJobService::Client.new do |config|
-              #     config.timeout = 10.0
-              #   end
-              #
-              # @yield [config] Configure the BatchJobService client.
-              # @yieldparam config [Client::Configuration]
-              #
-              def initialize
-                # These require statements are intentionally placed here to initialize
-                # the gRPC module only when it's required.
-                # See https://github.com/googleapis/toolkit/issues/446
-                require "gapic/grpc"
-                require "google/ads/google_ads/v21/services/batch_job_service_services_pb"
-
-                # Create the configuration object
-                @config = Configuration.new Client.configure
-
-                # Yield the configuration if needed
-                yield @config if block_given?
-
-                # Create credentials
-                credentials = @config.credentials
-                # Use self-signed JWT if the endpoint is unchanged from default,
-                # but only if the default endpoint does not have a region prefix.
-                enable_self_signed_jwt = @config.endpoint.nil? ||
-                                         (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
-                                         !@config.endpoint.split(".").first.include?("-"))
-                credentials ||= Credentials.default scope: @config.scope,
-                                                    enable_self_signed_jwt: enable_self_signed_jwt
-                if credentials.is_a?(::String) || credentials.is_a?(::Hash)
-                  credentials = Credentials.new credentials, scope: @config.scope
-                end
-                @quota_project_id = @config.quota_project
-                @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
-
-                @operations_client = Operations.new do |config|
-                  config.credentials = credentials
-                  config.quota_project = @quota_project_id
-                  config.endpoint = @config.endpoint
-                  config.universe_domain = @config.universe_domain
-                end
-
-                @batch_job_service_stub = ::Gapic::ServiceStub.new(
-                  ::Google::Ads::GoogleAds::V21::Services::BatchJobService::Stub,
-                  credentials: credentials,
-                  endpoint: @config.endpoint,
-                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
-                  universe_domain: @config.universe_domain,
-                  channel_args: @config.channel_args,
-                  interceptors: @config.interceptors,
-                  channel_pool_config: @config.channel_pool,
-                  logger: @config.logger
-                )
-
-                @batch_job_service_stub.stub_logger&.info do |entry|
-                  entry.set_system_name
-                  entry.set_service
-                  entry.message = "Created client for #{entry.service}"
-                  entry.set_credentials_fields credentials
-                  entry.set "customEndpoint", @config.endpoint if @config.endpoint
-                  entry.set "defaultTimeout", @config.timeout if @config.timeout
-                  entry.set "quotaProject", @quota_project_id if @quota_project_id
-                end
-              end
-
-              ##
-              # Get the associated client for long-running operations.
-              #
-              # @return [::Google::Ads::GoogleAds::V21::Services::BatchJobService::Operations]
-              #
-              attr_reader :operations_client
-
-              ##
-              # The logger used for request/response debug logging.
-              #
-              # @return [Logger]
-              #
-              def logger
-                @batch_job_service_stub.logger
-              end
-
-              # Service calls
-
-              ##
-              # Mutates a batch job.
-              #
-              # List of thrown errors:
-              #   [AuthenticationError]()
-              #   [AuthorizationError]()
-              #   [HeaderError]()
-              #   [InternalError]()
-              #   [QuotaError]()
-              #   [RequestError]()
-              #   [ResourceCountLimitExceededError]()
-              #
-              # @overload mutate_batch_job(request, options = nil)
-              #   Pass arguments to `mutate_batch_job` via a request object, either of type
-              #   {::Google::Ads::GoogleAds::V21::Services::MutateBatchJobRequest} or an equivalent Hash.
-              #
-              #   @param request [::Google::Ads::GoogleAds::V21::Services::MutateBatchJobRequest, ::Hash]
-              #     A request object representing the call parameters. Required. To specify no
-              #     parameters, or to keep all the default parameter values, pass an empty Hash.
-              #   @param options [::Gapic::CallOptions, ::Hash]
-              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
-              #
-              # @overload mutate_batch_job(customer_id: nil, operation: nil)
-              #   Pass arguments to `mutate_batch_job` via keyword arguments. Note that at
-              #   least one keyword argument is required. To specify no parameters, or to keep all
-              #   the default parameter values, pass an empty Hash as a request object (see above).
-              #
-              #   @param customer_id [::String]
-              #     Required. The ID of the customer for which to create a batch job.
-              #   @param operation [::Google::Ads::GoogleAds::V21::Services::BatchJobOperation, ::Hash]
-              #     Required. The operation to perform on an individual batch job.
-              #
-              # @yield [response, operation] Access the result along with the RPC operation
-              # @yieldparam response [::Google::Ads::GoogleAds::V21::Services::MutateBatchJobResponse]
-              # @yieldparam operation [::GRPC::ActiveCall::Operation]
-              #
-              # @return [::Google::Ads::GoogleAds::V21::Services::MutateBatchJobResponse]
-              #
-              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
-              #
-              # @example Basic example
-              #   require "google/ads/google_ads/v21/services"
-              #
-              #   # Create a client object. The client can be reused for multiple calls.
-              #   client = Google::Ads::GoogleAds::V21::Services::BatchJobService::Client.new
-              #
-              #   # Create a request. To set request fields, pass in keyword arguments.
-              #   request = Google::Ads::GoogleAds::V21::Services::MutateBatchJobRequest.new
-              #
-              #   # Call the mutate_batch_job method.
-              #   result = client.mutate_batch_job request
-              #
-              #   # The returned object is of type Google::Ads::GoogleAds::V21::Services::MutateBatchJobResponse.
-              #   p result
-              #
-              def mutate_batch_job request, options = nil
-                raise ::ArgumentError, "request must be provided" if request.nil?
-
-                request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V21::Services::MutateBatchJobRequest
-
-                # Converts hash and nil to an options object
-                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
-
-                # Customize the options with defaults
-                metadata = @config.rpcs.mutate_batch_job.metadata.to_h
-
-                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
-                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
-                  lib_name: @config.lib_name, lib_version: @config.lib_version,
-                  gapic_version: ::Google::Ads::GoogleAds::VERSION
-                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
-                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
-
-                header_params = {}
-                if request.customer_id
-                  header_params["customer_id"] = request.customer_id
-                end
-
-                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
-                metadata[:"x-goog-request-params"] ||= request_params_header
-
-                options.apply_defaults timeout:      @config.rpcs.mutate_batch_job.timeout,
-                                       metadata:     metadata,
-                                       retry_policy: @config.rpcs.mutate_batch_job.retry_policy
-
-                options.apply_defaults timeout:      @config.timeout,
-                                       metadata:     @config.metadata,
-                                       retry_policy: @config.retry_policy
-
-                @batch_job_service_stub.call_rpc :mutate_batch_job, request, options: options do |response, operation|
-                  yield response, operation if block_given?
-                end
-                # rescue GRPC::BadStatus => grpc_error
-                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
-              end
-
-              ##
-              # Returns the results of the batch job. The job must be done.
-              # Supports standard list paging.
-              #
-              # List of thrown errors:
-              #   [AuthenticationError]()
-              #   [AuthorizationError]()
-              #   [BatchJobError]()
-              #   [HeaderError]()
-              #   [InternalError]()
-              #   [QuotaError]()
-              #   [RequestError]()
-              #
-              # @overload list_batch_job_results(request, options = nil)
-              #   Pass arguments to `list_batch_job_results` via a request object, either of type
-              #   {::Google::Ads::GoogleAds::V21::Services::ListBatchJobResultsRequest} or an equivalent Hash.
-              #
-              #   @param request [::Google::Ads::GoogleAds::V21::Services::ListBatchJobResultsRequest, ::Hash]
-              #     A request object representing the call parameters. Required. To specify no
-              #     parameters, or to keep all the default parameter values, pass an empty Hash.
-              #   @param options [::Gapic::CallOptions, ::Hash]
-              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
-              #
-              # @overload list_batch_job_results(resource_name: nil, page_token: nil, page_size: nil, response_content_type: nil)
-              #   Pass arguments to `list_batch_job_results` via keyword arguments. Note that at
-              #   least one keyword argument is required. To specify no parameters, or to keep all
-              #   the default parameter values, pass an empty Hash as a request object (see above).
-              #
-              #   @param resource_name [::String]
-              #     Required. The resource name of the batch job whose results are being
-              #     listed.
-              #   @param page_token [::String]
-              #     Token of the page to retrieve. If not specified, the first
-              #     page of results will be returned. Use the value obtained from
-              #     `next_page_token` in the previous response in order to request
-              #     the next page of results.
-              #   @param page_size [::Integer]
-              #     Number of elements to retrieve in a single page.
-              #     When a page request is too large, the server may decide to
-              #     further limit the number of returned resources.
-              #   @param response_content_type [::Google::Ads::GoogleAds::V21::Enums::ResponseContentTypeEnum::ResponseContentType]
-              #     The response content type setting. Determines whether the mutable resource
-              #     or just the resource name should be returned.
-              #
-              # @yield [response, operation] Access the result along with the RPC operation
-              # @yieldparam response [::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V21::Services::BatchJobResult>]
-              # @yieldparam operation [::GRPC::ActiveCall::Operation]
-              #
-              # @return [::Gapic::PagedEnumerable<::Google::Ads::GoogleAds::V21::Services::BatchJobResult>]
-              #
-              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
-              #
-              # @example Basic example
-              #   require "google/ads/google_ads/v21/services"
-              #
-              #   # Create a client object. The client can be reused for multiple calls.
-              #   client = Google::Ads::GoogleAds::V21::Services::BatchJobService::Client.new
-              #
-              #   # Create a request. To set request fields, pass in keyword arguments.
-              #   request = Google::Ads::GoogleAds::V21::Services::ListBatchJobResultsRequest.new
-              #
-              #   # Call the list_batch_job_results method.
-              #   result = client.list_batch_job_results request
-              #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
-              #   # over elements, and API calls will be issued to fetch pages as needed.
-              #   result.each do |item|
-              #     # Each element is of type ::Google::Ads::GoogleAds::V21::Services::BatchJobResult.
-              #     p item
-              #   end
-              #
-              def list_batch_job_results request, options = nil
-                raise ::ArgumentError, "request must be provided" if request.nil?
-
-                request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V21::Services::ListBatchJobResultsRequest
-
-                # Converts hash and nil to an options object
-                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
-
-                # Customize the options with defaults
-                metadata = @config.rpcs.list_batch_job_results.metadata.to_h
-
-                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
-                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
-                  lib_name: @config.lib_name, lib_version: @config.lib_version,
-                  gapic_version: ::Google::Ads::GoogleAds::VERSION
-                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
-                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
-
-                header_params = {}
-                if request.resource_name
-                  header_params["resource_name"] = request.resource_name
-                end
-
-                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
-                metadata[:"x-goog-request-params"] ||= request_params_header
-
-                options.apply_defaults timeout:      @config.rpcs.list_batch_job_results.timeout,
-                                       metadata:     metadata,
-                                       retry_policy: @config.rpcs.list_batch_job_results.retry_policy
-
-                options.apply_defaults timeout:      @config.timeout,
-                                       metadata:     @config.metadata,
-                                       retry_policy: @config.retry_policy
-
-                @batch_job_service_stub.call_rpc :list_batch_job_results, request,
-                                                 options: options do |response, operation|
-                  response = ::Gapic::PagedEnumerable.new @batch_job_service_stub, :list_batch_job_results, request,
-                                                          response, operation, options
-                  yield response, operation if block_given?
-                  throw :response, response
-                end
-                # rescue GRPC::BadStatus => grpc_error
-                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
-              end
-
-              ##
-              # Runs the batch job.
-              #
-              # The Operation.metadata field type is BatchJobMetadata. When finished, the
-              # long running operation will not contain errors or a response. Instead, use
-              # ListBatchJobResults to get the results of the job.
-              #
-              # List of thrown errors:
-              #   [AuthenticationError]()
-              #   [AuthorizationError]()
-              #   [BatchJobError]()
-              #   [HeaderError]()
-              #   [InternalError]()
-              #   [QuotaError]()
-              #   [RequestError]()
-              #
-              # @overload run_batch_job(request, options = nil)
-              #   Pass arguments to `run_batch_job` via a request object, either of type
-              #   {::Google::Ads::GoogleAds::V21::Services::RunBatchJobRequest} or an equivalent Hash.
-              #
-              #   @param request [::Google::Ads::GoogleAds::V21::Services::RunBatchJobRequest, ::Hash]
-              #     A request object representing the call parameters. Required. To specify no
-              #     parameters, or to keep all the default parameter values, pass an empty Hash.
-              #   @param options [::Gapic::CallOptions, ::Hash]
-              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
-              #
-              # @overload run_batch_job(resource_name: nil)
-              #   Pass arguments to `run_batch_job` via keyword arguments. Note that at
-              #   least one keyword argument is required. To specify no parameters, or to keep all
-              #   the default parameter values, pass an empty Hash as a request object (see above).
-              #
-              #   @param resource_name [::String]
-              #     Required. The resource name of the BatchJob to run.
-              #
-              # @yield [response, operation] Access the result along with the RPC operation
-              # @yieldparam response [::Gapic::Operation]
-              # @yieldparam operation [::GRPC::ActiveCall::Operation]
-              #
-              # @return [::Gapic::Operation]
-              #
-              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
-              #
-              # @example Basic example
-              #   require "google/ads/google_ads/v21/services"
-              #
-              #   # Create a client object. The client can be reused for multiple calls.
-              #   client = Google::Ads::GoogleAds::V21::Services::BatchJobService::Client.new
-              #
-              #   # Create a request. To set request fields, pass in keyword arguments.
-              #   request = Google::Ads::GoogleAds::V21::Services::RunBatchJobRequest.new
-              #
-              #   # Call the run_batch_job method.
-              #   result = client.run_batch_job request
-              #
-              #   # The returned object is of type Gapic::Operation. You can use it to
-              #   # check the status of an operation, cancel it, or wait for results.
-              #   # Here is how to wait for a response.
-              #   result.wait_until_done! timeout: 60
-              #   if result.response?
-              #     p result.response
-              #   else
-              #     puts "No response received."
-              #   end
-              #
-              def run_batch_job request, options = nil
-                raise ::ArgumentError, "request must be provided" if request.nil?
-
-                request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V21::Services::RunBatchJobRequest
-
-                # Converts hash and nil to an options object
-                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
-
-                # Customize the options with defaults
-                metadata = @config.rpcs.run_batch_job.metadata.to_h
-
-                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
-                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
-                  lib_name: @config.lib_name, lib_version: @config.lib_version,
-                  gapic_version: ::Google::Ads::GoogleAds::VERSION
-                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
-                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
-
-                header_params = {}
-                if request.resource_name
-                  header_params["resource_name"] = request.resource_name
-                end
-
-                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
-                metadata[:"x-goog-request-params"] ||= request_params_header
-
-                options.apply_defaults timeout:      @config.rpcs.run_batch_job.timeout,
-                                       metadata:     metadata,
-                                       retry_policy: @config.rpcs.run_batch_job.retry_policy
-
-                options.apply_defaults timeout:      @config.timeout,
-                                       metadata:     @config.metadata,
-                                       retry_policy: @config.retry_policy
-
-                @batch_job_service_stub.call_rpc :run_batch_job, request, options: options do |response, operation|
-                  response = ::Gapic::Operation.new response, @operations_client, options: options
-                  yield response, operation if block_given?
-                  throw :response, response
-                end
-                # rescue GRPC::BadStatus => grpc_error
-                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
-              end
-
-              ##
-              # Add operations to the batch job.
-              #
-              # List of thrown errors:
-              #   [AuthenticationError]()
-              #   [AuthorizationError]()
-              #   [BatchJobError]()
-              #   [HeaderError]()
-              #   [InternalError]()
-              #   [QuotaError]()
-              #   [RequestError]()
-              #   [ResourceCountLimitExceededError]()
-              #
-              # @overload add_batch_job_operations(request, options = nil)
-              #   Pass arguments to `add_batch_job_operations` via a request object, either of type
-              #   {::Google::Ads::GoogleAds::V21::Services::AddBatchJobOperationsRequest} or an equivalent Hash.
-              #
-              #   @param request [::Google::Ads::GoogleAds::V21::Services::AddBatchJobOperationsRequest, ::Hash]
-              #     A request object representing the call parameters. Required. To specify no
-              #     parameters, or to keep all the default parameter values, pass an empty Hash.
-              #   @param options [::Gapic::CallOptions, ::Hash]
-              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
-              #
-              # @overload add_batch_job_operations(resource_name: nil, sequence_token: nil, mutate_operations: nil)
-              #   Pass arguments to `add_batch_job_operations` via keyword arguments. Note that at
-              #   least one keyword argument is required. To specify no parameters, or to keep all
-              #   the default parameter values, pass an empty Hash as a request object (see above).
-              #
-              #   @param resource_name [::String]
-              #     Required. The resource name of the batch job.
-              #   @param sequence_token [::String]
-              #     A token used to enforce sequencing.
-              #
-              #     The first AddBatchJobOperations request for a batch job should not set
-              #     sequence_token. Subsequent requests must set sequence_token to the value of
-              #     next_sequence_token received in the previous AddBatchJobOperations
-              #     response.
-              #   @param mutate_operations [::Array<::Google::Ads::GoogleAds::V21::Services::MutateOperation, ::Hash>]
-              #     Required. The list of mutates being added.
-              #
-              #     Operations can use negative integers as temp ids to signify dependencies
-              #     between entities created in this batch job. For example, a customer with
-              #     id = 1234 can create a campaign and an ad group in that same campaign by
-              #     creating a campaign in the first operation with the resource name
-              #     explicitly set to "customers/1234/campaigns/-1", and creating an ad group
-              #     in the second operation with the campaign field also set to
-              #     "customers/1234/campaigns/-1".
-              #
-              # @yield [response, operation] Access the result along with the RPC operation
-              # @yieldparam response [::Google::Ads::GoogleAds::V21::Services::AddBatchJobOperationsResponse]
-              # @yieldparam operation [::GRPC::ActiveCall::Operation]
-              #
-              # @return [::Google::Ads::GoogleAds::V21::Services::AddBatchJobOperationsResponse]
-              #
-              # @raise [Google::Ads::GoogleAds::Error] if the RPC is aborted.
-              #
-              # @example Basic example
-              #   require "google/ads/google_ads/v21/services"
-              #
-              #   # Create a client object. The client can be reused for multiple calls.
-              #   client = Google::Ads::GoogleAds::V21::Services::BatchJobService::Client.new
-              #
-              #   # Create a request. To set request fields, pass in keyword arguments.
-              #   request = Google::Ads::GoogleAds::V21::Services::AddBatchJobOperationsRequest.new
-              #
-              #   # Call the add_batch_job_operations method.
-              #   result = client.add_batch_job_operations request
-              #
-              #   # The returned object is of type Google::Ads::GoogleAds::V21::Services::AddBatchJobOperationsResponse.
-              #   p result
-              #
-              def add_batch_job_operations request, options = nil
-                raise ::ArgumentError, "request must be provided" if request.nil?
-
-                request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::GoogleAds::V21::Services::AddBatchJobOperationsRequest
-
-                # Converts hash and nil to an options object
-                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
-
-                # Customize the options with defaults
-                metadata = @config.rpcs.add_batch_job_operations.metadata.to_h
-
-                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
-                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
-                  lib_name: @config.lib_name, lib_version: @config.lib_version,
-                  gapic_version: ::Google::Ads::GoogleAds::VERSION
-                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
-                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
-
-                header_params = {}
-                if request.resource_name
-                  header_params["resource_name"] = request.resource_name
-                end
-
-                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
-                metadata[:"x-goog-request-params"] ||= request_params_header
-
-                options.apply_defaults timeout:      @config.rpcs.add_batch_job_operations.timeout,
-                                       metadata:     metadata,
-                                       retry_policy: @config.rpcs.add_batch_job_operations.retry_policy
-
-                options.apply_defaults timeout:      @config.timeout,
-                                       metadata:     @config.metadata,
-                                       retry_policy: @config.retry_policy
-
-                @batch_job_service_stub.call_rpc :add_batch_job_operations, request,
-                                                 options: options do |response, operation|
-                  yield response, operation if block_given?
-                end
-                # rescue GRPC::BadStatus => grpc_error
-                #  raise Google::Ads::GoogleAds::Error.new grpc_error.message
-              end
-
-              ##
-              # Configuration class for the BatchJobService API.
-              #
-              # This class represents the configuration for BatchJobService,
-              # providing control over timeouts, retry behavior, logging, transport
-              # parameters, and other low-level controls. Certain parameters can also be
-              # applied individually to specific RPCs. See
-              # {::Google::Ads::GoogleAds::V21::Services::BatchJobService::Client::Configuration::Rpcs}
-              # for a list of RPCs that can be configured independently.
-              #
-              # Configuration can be applied globally to all clients, or to a single client
-              # on construction.
-              #
-              # @example
-              #
-              #   # Modify the global config, setting the timeout for
-              #   # mutate_batch_job to 20 seconds,
-              #   # and all remaining timeouts to 10 seconds.
-              #   ::Google::Ads::GoogleAds::V21::Services::BatchJobService::Client.configure do |config|
-              #     config.timeout = 10.0
-              #     config.rpcs.mutate_batch_job.timeout = 20.0
-              #   end
-              #
-              #   # Apply the above configuration only to a new client.
-              #   client = ::Google::Ads::GoogleAds::V21::Services::BatchJobService::Client.new do |config|
-              #     config.timeout = 10.0
-              #     config.rpcs.mutate_batch_job.timeout = 20.0
-              #   end
-              #
-              # @!attribute [rw] endpoint
-              #   A custom service endpoint, as a hostname or hostname:port. The default is
-              #   nil, indicating to use the default endpoint in the current universe domain.
-              #   @return [::String,nil]
-              # @!attribute [rw] credentials
-              #   Credentials to send with calls. You may provide any of the following types:
-              #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
-              #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
-              #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
-              #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
-              #    *  (`nil`) indicating no credentials
-              #
-              #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
-              #     is deprecated. Providing an unvalidated credential configuration to
-              #     Google APIs can compromise the security of your systems and data.
-              #
-              #   @example
-              #
-              #     # The recommended way to provide credentials is to use the `make_creds` method
-              #     # on the appropriate credentials class for your environment.
-              #
-              #     require "googleauth"
-              #
-              #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
-              #       json_key_io: ::File.open("/path/to/keyfile.json")
-              #     )
-              #
-              #     client = ::Google::Ads::GoogleAds::V21::Services::BatchJobService::Client.new do |config|
-              #       config.credentials = credentials
-              #     end
-              #
-              #   @note Warning: If you accept a credential configuration (JSON file or Hash) from an
-              #   external source for authentication to Google Cloud, you must validate it before
-              #   providing it to a Google API client library. Providing an unvalidated credential
-              #   configuration to Google APIs can compromise the security of your systems and data.
-              #   For more information, refer to [Validate credential configurations from external
-              #   sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
-              #   @return [::Object]
-              # @!attribute [rw] scope
-              #   The OAuth scopes
-              #   @return [::Array<::String>]
-              # @!attribute [rw] lib_name
-              #   The library name as recorded in instrumentation and logging
-              #   @return [::String]
-              # @!attribute [rw] lib_version
-              #   The library version as recorded in instrumentation and logging
-              #   @return [::String]
-              # @!attribute [rw] channel_args
-              #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
-              #   `GRPC::Core::Channel` object is provided as the credential.
-              #   @return [::Hash]
-              # @!attribute [rw] interceptors
-              #   An array of interceptors that are run before calls are executed.
-              #   @return [::Array<::GRPC::ClientInterceptor>]
-              # @!attribute [rw] timeout
-              #   The call timeout in seconds.
-              #   @return [::Numeric]
-              # @!attribute [rw] metadata
-              #   Additional gRPC headers to be sent with the call.
-              #   @return [::Hash{::Symbol=>::String}]
-              # @!attribute [rw] retry_policy
-              #   The retry policy. The value is a hash with the following keys:
-              #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
-              #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
-              #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
-              #    *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
-              #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
-              #       trigger a retry.
-              #   @return [::Hash]
-              # @!attribute [rw] quota_project
-              #   A separate project against which to charge quota.
-              #   @return [::String]
-              # @!attribute [rw] universe_domain
-              #   The universe domain within which to make requests. This determines the
-              #   default endpoint URL. The default value of nil uses the environment
-              #   universe (usually the default "googleapis.com" universe).
-              #   @return [::String,nil]
-              # @!attribute [rw] logger
-              #   A custom logger to use for request/response debug logging, or the value
-              #   `:default` (the default) to construct a default logger, or `nil` to
-              #   explicitly disable logging.
-              #   @return [::Logger,:default,nil]
-              #
-              class Configuration
-                extend ::Gapic::Config
-
-                # @private
-                # The endpoint specific to the default "googleapis.com" universe. Deprecated.
-                DEFAULT_ENDPOINT = "googleads.googleapis.com"
-
-                config_attr :endpoint,      nil, ::String, nil
-                config_attr :credentials,   nil do |value|
-                  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials,
-                             ::Google::Auth::BaseClient, ::Signet::OAuth2::Client, nil]
-                  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC::Core::Channel
-                  allowed.any? { |klass| klass === value }
-                end
-                config_attr :scope,         nil, ::String, ::Array, nil
-                config_attr :lib_name,      nil, ::String, nil
-                config_attr :lib_version,   nil, ::String, nil
-                config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
-                config_attr :interceptors,  nil, ::Array, nil
-                config_attr :timeout,       nil, ::Numeric, nil
-                config_attr :metadata,      nil, ::Hash, nil
-                config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
-                config_attr :quota_project, nil, ::String, nil
-                config_attr :universe_domain, nil, ::String, nil
-                config_attr :logger, :default, ::Logger, nil, :default
-
-                # @private
-                def initialize parent_config = nil
-                  @parent_config = parent_config unless parent_config.nil?
-
-                  yield self if block_given?
-                end
-
-                ##
-                # Configurations for individual RPCs
-                # @return [Rpcs]
-                #
-                def rpcs
-                  @rpcs ||= begin
-                    parent_rpcs = nil
-                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
-                    Rpcs.new parent_rpcs
-                  end
-                end
-
-                ##
-                # Configuration for the channel pool
-                # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
-                #
-                def channel_pool
-                  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
-                end
-
-                ##
-                # Configuration RPC class for the BatchJobService API.
-                #
-                # Includes fields providing the configuration for each RPC in this service.
-                # Each configuration object is of type `Gapic::Config::Method` and includes
-                # the following configuration fields:
-                #
-                #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
-                #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
-                #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
-                #     include the following keys:
-                #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
-                #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
-                #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
-                #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
-                #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
-                #         trigger a retry.
-                #
-                class Rpcs
-                  ##
-                  # RPC-specific configuration for `mutate_batch_job`
-                  # @return [::Gapic::Config::Method]
-                  #
-                  attr_reader :mutate_batch_job
-                  ##
-                  # RPC-specific configuration for `list_batch_job_results`
-                  # @return [::Gapic::Config::Method]
-                  #
-                  attr_reader :list_batch_job_results
-                  ##
-                  # RPC-specific configuration for `run_batch_job`
-                  # @return [::Gapic::Config::Method]
-                  #
-                  attr_reader :run_batch_job
-                  ##
-                  # RPC-specific configuration for `add_batch_job_operations`
-                  # @return [::Gapic::Config::Method]
-                  #
-                  attr_reader :add_batch_job_operations
-
-                  # @private
-                  def initialize parent_rpcs = nil
-                    mutate_batch_job_config = parent_rpcs.mutate_batch_job if parent_rpcs.respond_to? :mutate_batch_job
-                    @mutate_batch_job = ::Gapic::Config::Method.new mutate_batch_job_config
-                    list_batch_job_results_config = parent_rpcs.list_batch_job_results if parent_rpcs.respond_to? :list_batch_job_results
-                    @list_batch_job_results = ::Gapic::Config::Method.new list_batch_job_results_config
-                    run_batch_job_config = parent_rpcs.run_batch_job if parent_rpcs.respond_to? :run_batch_job
-                    @run_batch_job = ::Gapic::Config::Method.new run_batch_job_config
-                    add_batch_job_operations_config = parent_rpcs.add_batch_job_operations if parent_rpcs.respond_to? :add_batch_job_operations
-                    @add_batch_job_operations = ::Gapic::Config::Method.new add_batch_job_operations_config
-
-                    yield self if block_given?
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end