# frozen_string_literal: true # Copyright 2022 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/cloud/errors" require "google/cloud/batch/v1/batch_pb" require "google/cloud/location" require "google/iam/v1" module Google module Cloud module Batch module V1 module BatchService ## # Client for the BatchService service. # # Google Batch Service. # The service manages user submitted batch jobs and allocates Google Compute # Engine VM instances to run the jobs. # class Client include Paths # @private attr_reader :batch_service_stub ## # Configure the BatchService Client class. # # See {::Google::Cloud::Batch::V1::BatchService::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all BatchService clients # ::Google::Cloud::Batch::V1::BatchService::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 namespace = ["Google", "Cloud", "Batch", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.create_job.timeout = 60.0 default_config.rpcs.get_job.timeout = 60.0 default_config.rpcs.get_job.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.delete_job.timeout = 60.0 default_config.rpcs.list_jobs.timeout = 60.0 default_config.rpcs.list_jobs.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.get_task.timeout = 60.0 default_config.rpcs.get_task.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.list_tasks.timeout = 60.0 default_config.rpcs.list_tasks.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end ## # Configure the BatchService 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::Cloud::Batch::V1::BatchService::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 ## # Create a new BatchService client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::Batch::V1::BatchService::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::Batch::V1::BatchService::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the BatchService 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/cloud/batch/v1/batch_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 == Client.configure.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 end @location_client = Google::Cloud::Location::Locations::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @batch_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Batch::V1::BatchService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::Batch::V1::BatchService::Operations] # attr_reader :operations_client ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Client] # attr_reader :location_client ## # Get the associated client for mix-in of the IAMPolicy. # # @return [Google::Iam::V1::IAMPolicy::Client] # attr_reader :iam_policy_client # Service calls ## # Create a Job. # # @overload create_job(request, options = nil) # Pass arguments to `create_job` via a request object, either of type # {::Google::Cloud::Batch::V1::CreateJobRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Batch::V1::CreateJobRequest, ::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 create_job(parent: nil, job_id: nil, job: nil, request_id: nil) # Pass arguments to `create_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 parent [::String] # Required. The parent resource name where the Job will be created. # Pattern: "projects/\\{project}/locations/\\{location}" # @param job_id [::String] # ID used to uniquely identify the Job within its parent scope. # This field should contain at most 63 characters. # Only alphanumeric characters or '-' are accepted. # The '-' character cannot be the first or the last one. # A system generated ID will be used if the field is not set. # # The job.name field in the request will be ignored and the created resource # name of the Job will be "\\{parent}/jobs/\\{job_id}". # @param job [::Google::Cloud::Batch::V1::Job, ::Hash] # Required. The Job to create. # @param request_id [::String] # Optional. An optional request ID to identify requests. Specify a unique request ID # so that if you must retry your request, the server will know to ignore # the request if it has already been completed. The server will guarantee # that for at least 60 minutes since the first request. # # For example, consider a situation where you make an initial request and t # he request times out. If you make the request again with the same request # ID, the server can check if original operation with the same request ID # was received, and if so, will ignore the second request. This prevents # clients from accidentally creating duplicate commitments. # # The request ID must be a valid UUID with the exception that zero UUID is # not supported (00000000-0000-0000-0000-000000000000). # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Batch::V1::Job] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Batch::V1::Job] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/batch/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Batch::V1::BatchService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Batch::V1::CreateJobRequest.new # # # Call the create_job method. # result = client.create_job request # # # The returned object is of type Google::Cloud::Batch::V1::Job. # p result # def create_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Batch::V1::CreateJobRequest # 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.create_job.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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::Cloud::Batch::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent 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.create_job.timeout, metadata: metadata, retry_policy: @config.rpcs.create_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @batch_service_stub.call_rpc :create_job, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Get a Job specified by its resource name. # # @overload get_job(request, options = nil) # Pass arguments to `get_job` via a request object, either of type # {::Google::Cloud::Batch::V1::GetJobRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Batch::V1::GetJobRequest, ::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 get_job(name: nil) # Pass arguments to `get_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 name [::String] # Required. Job name. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Batch::V1::Job] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Batch::V1::Job] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/batch/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Batch::V1::BatchService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Batch::V1::GetJobRequest.new # # # Call the get_job method. # result = client.get_job request # # # The returned object is of type Google::Cloud::Batch::V1::Job. # p result # def get_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Batch::V1::GetJobRequest # 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.get_job.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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::Cloud::Batch::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.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.get_job.timeout, metadata: metadata, retry_policy: @config.rpcs.get_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @batch_service_stub.call_rpc :get_job, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Delete a Job. # # @overload delete_job(request, options = nil) # Pass arguments to `delete_job` via a request object, either of type # {::Google::Cloud::Batch::V1::DeleteJobRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Batch::V1::DeleteJobRequest, ::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 delete_job(name: nil, reason: nil, request_id: nil) # Pass arguments to `delete_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 name [::String] # Job name. # @param reason [::String] # Optional. Reason for this deletion. # @param request_id [::String] # Optional. An optional request ID to identify requests. Specify a unique request ID # so that if you must retry your request, the server will know to ignore # the request if it has already been completed. The server will guarantee # that for at least 60 minutes after the first request. # # For example, consider a situation where you make an initial request and t # he request times out. If you make the request again with the same request # ID, the server can check if original operation with the same request ID # was received, and if so, will ignore the second request. This prevents # clients from accidentally creating duplicate commitments. # # The request ID must be a valid UUID with the exception that zero UUID is # not supported (00000000-0000-0000-0000-000000000000). # # @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::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/batch/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Batch::V1::BatchService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Batch::V1::DeleteJobRequest.new # # # Call the delete_job method. # result = client.delete_job request # # # The returned object is of type Gapic::Operation. You can use this # # object to check the status of an operation, cancel it, or wait # # for results. Here is how to block until completion: # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "Error!" # end # def delete_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Batch::V1::DeleteJobRequest # 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.delete_job.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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::Cloud::Batch::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.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.delete_job.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @batch_service_stub.call_rpc :delete_job, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # List all Jobs for a project within a region. # # @overload list_jobs(request, options = nil) # Pass arguments to `list_jobs` via a request object, either of type # {::Google::Cloud::Batch::V1::ListJobsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Batch::V1::ListJobsRequest, ::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_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil) # Pass arguments to `list_jobs` 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 parent [::String] # Parent path. # @param filter [::String] # List filter. # @param page_size [::Integer] # Page size. # @param page_token [::String] # Page token. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Batch::V1::Job>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::Batch::V1::Job>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/batch/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Batch::V1::BatchService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Batch::V1::ListJobsRequest.new # # # Call the list_jobs method. # result = client.list_jobs request # # # The returned object is of type Gapic::PagedEnumerable. You can # # iterate over all elements by calling #each, and the enumerable # # will lazily make API calls to fetch subsequent pages. Other # # methods are also available for managing paging directly. # result.each do |response| # # Each element is of type ::Google::Cloud::Batch::V1::Job. # p response # end # def list_jobs request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Batch::V1::ListJobsRequest # 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_jobs.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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::Cloud::Batch::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent 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_jobs.timeout, metadata: metadata, retry_policy: @config.rpcs.list_jobs.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @batch_service_stub.call_rpc :list_jobs, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @batch_service_stub, :list_jobs, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Return a single Task. # # @overload get_task(request, options = nil) # Pass arguments to `get_task` via a request object, either of type # {::Google::Cloud::Batch::V1::GetTaskRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Batch::V1::GetTaskRequest, ::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 get_task(name: nil) # Pass arguments to `get_task` 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 name [::String] # Required. Task name. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Batch::V1::Task] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Batch::V1::Task] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/batch/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Batch::V1::BatchService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Batch::V1::GetTaskRequest.new # # # Call the get_task method. # result = client.get_task request # # # The returned object is of type Google::Cloud::Batch::V1::Task. # p result # def get_task request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Batch::V1::GetTaskRequest # 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.get_task.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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::Cloud::Batch::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.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.get_task.timeout, metadata: metadata, retry_policy: @config.rpcs.get_task.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @batch_service_stub.call_rpc :get_task, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # List Tasks associated with a job. # # @overload list_tasks(request, options = nil) # Pass arguments to `list_tasks` via a request object, either of type # {::Google::Cloud::Batch::V1::ListTasksRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Batch::V1::ListTasksRequest, ::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_tasks(parent: nil, filter: nil, page_size: nil, page_token: nil) # Pass arguments to `list_tasks` 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 parent [::String] # Required. Name of a TaskGroup from which Tasks are being requested. # Pattern: # "projects/\\{project}/locations/\\{location}/jobs/\\{job}/taskGroups/\\{task_group}" # @param filter [::String] # Task filter, null filter matches all Tasks. # Filter string should be of the format State=TaskStatus.State e.g. # State=RUNNING # @param page_size [::Integer] # Page size. # @param page_token [::String] # Page token. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Batch::V1::Task>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::Batch::V1::Task>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/batch/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Batch::V1::BatchService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Batch::V1::ListTasksRequest.new # # # Call the list_tasks method. # result = client.list_tasks request # # # The returned object is of type Gapic::PagedEnumerable. You can # # iterate over all elements by calling #each, and the enumerable # # will lazily make API calls to fetch subsequent pages. Other # # methods are also available for managing paging directly. # result.each do |response| # # Each element is of type ::Google::Cloud::Batch::V1::Task. # p response # end # def list_tasks request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Batch::V1::ListTasksRequest # 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_tasks.metadata.to_h # Set x-goog-api-client and x-goog-user-project 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::Cloud::Batch::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent 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_tasks.timeout, metadata: metadata, retry_policy: @config.rpcs.list_tasks.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @batch_service_stub.call_rpc :list_tasks, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @batch_service_stub, :list_tasks, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the BatchService API. # # This class represents the configuration for BatchService, # 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::Cloud::Batch::V1::BatchService::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 # # create_job to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::Batch::V1::BatchService::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.create_job.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::Batch::V1::BatchService::Client.new do |config| # config.timeout = 10.0 # config.rpcs.create_job.timeout = 20.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"batch.googleapis.com"`. # @return [::String] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html)) # * (`GRPC::Core::Channel`) a gRPC channel with included credentials # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object # * (`nil`) indicating no 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. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # class Configuration extend ::Gapic::Config config_attr :endpoint, "batch.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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 # @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 RPC class for the BatchService 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. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `create_job` # @return [::Gapic::Config::Method] # attr_reader :create_job ## # RPC-specific configuration for `get_job` # @return [::Gapic::Config::Method] # attr_reader :get_job ## # RPC-specific configuration for `delete_job` # @return [::Gapic::Config::Method] # attr_reader :delete_job ## # RPC-specific configuration for `list_jobs` # @return [::Gapic::Config::Method] # attr_reader :list_jobs ## # RPC-specific configuration for `get_task` # @return [::Gapic::Config::Method] # attr_reader :get_task ## # RPC-specific configuration for `list_tasks` # @return [::Gapic::Config::Method] # attr_reader :list_tasks # @private def initialize parent_rpcs = nil create_job_config = parent_rpcs.create_job if parent_rpcs.respond_to? :create_job @create_job = ::Gapic::Config::Method.new create_job_config get_job_config = parent_rpcs.get_job if parent_rpcs.respond_to? :get_job @get_job = ::Gapic::Config::Method.new get_job_config delete_job_config = parent_rpcs.delete_job if parent_rpcs.respond_to? :delete_job @delete_job = ::Gapic::Config::Method.new delete_job_config list_jobs_config = parent_rpcs.list_jobs if parent_rpcs.respond_to? :list_jobs @list_jobs = ::Gapic::Config::Method.new list_jobs_config get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task @get_task = ::Gapic::Config::Method.new get_task_config list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks @list_tasks = ::Gapic::Config::Method.new list_tasks_config yield self if block_given? end end end end end end end end end