class Google::Cloud::Scheduler::V1::CloudScheduler::Client

Client for the CloudScheduler service.

The Cloud Scheduler API allows external entities to reliably schedule asynchronous jobs.

Attributes

cloud_scheduler_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the CloudScheduler Client class.

See {::Google::Cloud::Scheduler::V1::CloudScheduler::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all CloudScheduler clients
::Google::Cloud::Scheduler::V1::CloudScheduler::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb, line 57
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Scheduler", "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.list_jobs.timeout = 600.0
    default_config.rpcs.list_jobs.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_job.timeout = 600.0
    default_config.rpcs.get_job.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.create_job.timeout = 600.0

    default_config.rpcs.update_job.timeout = 600.0

    default_config.rpcs.delete_job.timeout = 600.0
    default_config.rpcs.delete_job.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.pause_job.timeout = 600.0

    default_config.rpcs.resume_job.timeout = 600.0

    default_config.rpcs.run_job.timeout = 600.0

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new CloudScheduler client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Scheduler::V1::CloudScheduler::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Scheduler::V1::CloudScheduler::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the CloudScheduler client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb, line 135
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/scheduler/v1/cloudscheduler_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

  @cloud_scheduler_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Scheduler::V1::CloudScheduler::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the CloudScheduler 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::Scheduler::V1::CloudScheduler::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb, line 114
def configure
  yield @config if block_given?
  @config
end
create_job(request, options = nil) { |response, operation| ... } click to toggle source

Creates a job.

@overload create_job(request, options = nil)

Pass arguments to `create_job` via a request object, either of type
{::Google::Cloud::Scheduler::V1::CreateJobRequest} or an equivalent Hash.

@param request [::Google::Cloud::Scheduler::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: 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 location name. For example:
  `projects/PROJECT_ID/locations/LOCATION_ID`.
@param job [::Google::Cloud::Scheduler::V1::Job, ::Hash]
  Required. The job to add. The user can optionally specify a name for the
  job in {::Google::Cloud::Scheduler::V1::Job#name name}. {::Google::Cloud::Scheduler::V1::Job#name name} cannot be the same as an
  existing job. If a name is not specified then the system will
  generate a random unique name that will be returned
  ({::Google::Cloud::Scheduler::V1::Job#name name}) in the response.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Scheduler::V1::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Scheduler::V1::Job]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb, line 363
def create_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Scheduler::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::Scheduler::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  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

  @cloud_scheduler_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
delete_job(request, options = nil) { |response, operation| ... } click to toggle source

Deletes a job.

@overload delete_job(request, options = nil)

Pass arguments to `delete_job` via a request object, either of type
{::Google::Cloud::Scheduler::V1::DeleteJobRequest} or an equivalent Hash.

@param request [::Google::Cloud::Scheduler::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)

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]
  Required. The job name. For example:
  `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Protobuf::Empty]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb, line 513
def delete_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Scheduler::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::Scheduler::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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

  @cloud_scheduler_stub.call_rpc :delete_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_job(request, options = nil) { |response, operation| ... } click to toggle source

Gets a job.

@overload get_job(request, options = nil)

Pass arguments to `get_job` via a request object, either of type
{::Google::Cloud::Scheduler::V1::GetJobRequest} or an equivalent Hash.

@param request [::Google::Cloud::Scheduler::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. The job name. For example:
  `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Scheduler::V1::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Scheduler::V1::Job]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb, line 288
def get_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Scheduler::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::Scheduler::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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

  @cloud_scheduler_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
list_jobs(request, options = nil) { |response, operation| ... } click to toggle source

Lists jobs.

@overload list_jobs(request, options = nil)

Pass arguments to `list_jobs` via a request object, either of type
{::Google::Cloud::Scheduler::V1::ListJobsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Scheduler::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, 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]
  Required. The location name. For example:
  `projects/PROJECT_ID/locations/LOCATION_ID`.
@param page_size [::Integer]
  Requested page size.

  The maximum page size is 500. If unspecified, the page size will
  be the maximum. Fewer jobs than requested might be returned,
  even if more jobs exist; use next_page_token to determine if more
  jobs exist.
@param page_token [::String]
  A token identifying a page of results the server will return. To
  request the first page results, page_token must be empty. To
  request the next page of results, page_token must be the value of
  {::Google::Cloud::Scheduler::V1::ListJobsResponse#next_page_token next_page_token} returned from
  the previous call to {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#list_jobs ListJobs}. It is an error to
  switch the value of [filter][google.cloud.scheduler.v1.ListJobsRequest.filter] or
  [order_by][google.cloud.scheduler.v1.ListJobsRequest.order_by] while iterating through pages.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Scheduler::V1::Job>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Scheduler::V1::Job>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb, line 218
def list_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Scheduler::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::Scheduler::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  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

  @cloud_scheduler_stub.call_rpc :list_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @cloud_scheduler_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
pause_job(request, options = nil) { |response, operation| ... } click to toggle source

Pauses a job.

If a job is paused then the system will stop executing the job until it is re-enabled via {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#resume_job ResumeJob}. The state of the job is stored in {::Google::Cloud::Scheduler::V1::Job#state state}; if paused it will be set to {::Google::Cloud::Scheduler::V1::Job::State::PAUSED Job.State.PAUSED}. A job must be in {::Google::Cloud::Scheduler::V1::Job::State::ENABLED Job.State.ENABLED} to be paused.

@overload pause_job(request, options = nil)

Pass arguments to `pause_job` via a request object, either of type
{::Google::Cloud::Scheduler::V1::PauseJobRequest} or an equivalent Hash.

@param request [::Google::Cloud::Scheduler::V1::PauseJobRequest, ::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 pause_job(name: nil)

Pass arguments to `pause_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. The job name. For example:
  `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Scheduler::V1::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Scheduler::V1::Job]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb, line 588
def pause_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Scheduler::V1::PauseJobRequest

  # 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.pause_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::Scheduler::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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.pause_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.pause_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_scheduler_stub.call_rpc :pause_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
resume_job(request, options = nil) { |response, operation| ... } click to toggle source

Resume a job.

This method reenables a job after it has been {::Google::Cloud::Scheduler::V1::Job::State::PAUSED Job.State.PAUSED}. The state of a job is stored in {::Google::Cloud::Scheduler::V1::Job#state Job.state}; after calling this method it will be set to {::Google::Cloud::Scheduler::V1::Job::State::ENABLED Job.State.ENABLED}. A job must be in {::Google::Cloud::Scheduler::V1::Job::State::PAUSED Job.State.PAUSED} to be resumed.

@overload resume_job(request, options = nil)

Pass arguments to `resume_job` via a request object, either of type
{::Google::Cloud::Scheduler::V1::ResumeJobRequest} or an equivalent Hash.

@param request [::Google::Cloud::Scheduler::V1::ResumeJobRequest, ::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 resume_job(name: nil)

Pass arguments to `resume_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. The job name. For example:
  `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Scheduler::V1::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Scheduler::V1::Job]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb, line 662
def resume_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Scheduler::V1::ResumeJobRequest

  # 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.resume_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::Scheduler::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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.resume_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.resume_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_scheduler_stub.call_rpc :resume_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
run_job(request, options = nil) { |response, operation| ... } click to toggle source

Forces a job to run now.

When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

@overload run_job(request, options = nil)

Pass arguments to `run_job` via a request object, either of type
{::Google::Cloud::Scheduler::V1::RunJobRequest} or an equivalent Hash.

@param request [::Google::Cloud::Scheduler::V1::RunJobRequest, ::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_job(name: nil)

Pass arguments to `run_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. The job name. For example:
  `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Scheduler::V1::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Scheduler::V1::Job]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb, line 734
def run_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Scheduler::V1::RunJobRequest

  # 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_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::Scheduler::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.run_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_scheduler_stub.call_rpc :run_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
update_job(request, options = nil) { |response, operation| ... } click to toggle source

Updates a job.

If successful, the updated {::Google::Cloud::Scheduler::V1::Job Job} is returned. If the job does not exist, `NOT_FOUND` is returned.

If UpdateJob does not successfully return, it is possible for the job to be in an {::Google::Cloud::Scheduler::V1::Job::State::UPDATE_FAILED Job.State.UPDATE_FAILED} state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.

@overload update_job(request, options = nil)

Pass arguments to `update_job` via a request object, either of type
{::Google::Cloud::Scheduler::V1::UpdateJobRequest} or an equivalent Hash.

@param request [::Google::Cloud::Scheduler::V1::UpdateJobRequest, ::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 update_job(job: nil, update_mask: nil)

Pass arguments to `update_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 job [::Google::Cloud::Scheduler::V1::Job, ::Hash]
  Required. The new job properties. {::Google::Cloud::Scheduler::V1::Job#name name} must be specified.

  Output only fields cannot be modified using UpdateJob.
  Any value specified for an output only field will be ignored.
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  A  mask used to specify which fields of the job are being updated.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Scheduler::V1::Job] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Scheduler::V1::Job]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb, line 444
def update_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Scheduler::V1::UpdateJobRequest

  # 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.update_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::Scheduler::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "job.name" => request.job.name
  }
  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.update_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_scheduler_stub.call_rpc :update_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