Cloud Scheduler V1 API - Class Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client (v1.0.1)

Reference documentation and code samples for the Cloud Scheduler V1 API class Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.

REST client for the CloudScheduler service.

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

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the CloudScheduler Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all CloudScheduler clients
::Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

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 Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_job

def create_job(request, options = nil) -> ::Google::Cloud::Scheduler::V1::Job
def create_job(parent: nil, job: nil) -> ::Google::Cloud::Scheduler::V1::Job

Creates a job.

Overloads 
def create_job(request, options = nil) -> ::Google::Cloud::Scheduler::V1::Job
Pass arguments to create_job via a request object, either of type Google::Cloud::Scheduler::V1::CreateJobRequest or an equivalent Hash.
Parameters
  • 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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_job(parent: nil, job: nil) -> ::Google::Cloud::Scheduler::V1::Job
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).
Parameters
  • parent (::String) — Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.
  • job (::Google::Cloud::Scheduler::V1::Job, ::Hash) — Required. The job to add. The user can optionally specify a name for the job in 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 (name) in the response.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/scheduler/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Scheduler::V1::CreateJobRequest.new

# Call the create_job method.
result = client.create_job request

# The returned object is of type Google::Cloud::Scheduler::V1::Job.
p result

#delete_job

def delete_job(request, options = nil) -> ::Google::Protobuf::Empty
def delete_job(name: nil) -> ::Google::Protobuf::Empty

Deletes a job.

Overloads 
def delete_job(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_job via a request object, either of type DeleteJobRequest or an equivalent Hash.
Parameters
  • 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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_job(name: nil) -> ::Google::Protobuf::Empty
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).
Parameter
  • name (::String) — Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/scheduler/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Scheduler::V1::DeleteJobRequest.new

# Call the delete_job method.
result = client.delete_job request

# The returned object is of type Google::Protobuf::Empty.
p result

#get_job

def get_job(request, options = nil) -> ::Google::Cloud::Scheduler::V1::Job
def get_job(name: nil) -> ::Google::Cloud::Scheduler::V1::Job

Gets a job.

Overloads 
def get_job(request, options = nil) -> ::Google::Cloud::Scheduler::V1::Job
Pass arguments to get_job via a request object, either of type GetJobRequest or an equivalent Hash.
Parameters
  • 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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_job(name: nil) -> ::Google::Cloud::Scheduler::V1::Job
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).
Parameter
  • name (::String) — Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/scheduler/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Scheduler::V1::GetJobRequest.new

# Call the get_job method.
result = client.get_job request

# The returned object is of type Google::Cloud::Scheduler::V1::Job.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new CloudScheduler REST client object.

Yields
  • (config) — Configure the CloudScheduler client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.new

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

#list_jobs

def list_jobs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Scheduler::V1::Job>
def list_jobs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Scheduler::V1::Job>

Lists jobs.

Overloads 
def list_jobs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Scheduler::V1::Job>
Pass arguments to list_jobs via a request object, either of type ListJobsRequest or an equivalent Hash.
Parameters
  • 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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_jobs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Scheduler::V1::Job>
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).
Parameters
  • parent (::String) — Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.
  • 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.

  • 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 next_page_token returned from the previous call to 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/scheduler/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Scheduler::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 elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Scheduler::V1::Job.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#pause_job

def pause_job(request, options = nil) -> ::Google::Cloud::Scheduler::V1::Job
def pause_job(name: nil) -> ::Google::Cloud::Scheduler::V1::Job

Pauses a job.

If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused.

Overloads 
def pause_job(request, options = nil) -> ::Google::Cloud::Scheduler::V1::Job
Pass arguments to pause_job via a request object, either of type PauseJobRequest or an equivalent Hash.
Parameters
  • 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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def pause_job(name: nil) -> ::Google::Cloud::Scheduler::V1::Job
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).
Parameter
  • name (::String) — Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/scheduler/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Scheduler::V1::PauseJobRequest.new

# Call the pause_job method.
result = client.pause_job request

# The returned object is of type Google::Cloud::Scheduler::V1::Job.
p result

#resume_job

def resume_job(request, options = nil) -> ::Google::Cloud::Scheduler::V1::Job
def resume_job(name: nil) -> ::Google::Cloud::Scheduler::V1::Job

Resume a job.

This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed.

Overloads 
def resume_job(request, options = nil) -> ::Google::Cloud::Scheduler::V1::Job
Pass arguments to resume_job via a request object, either of type ResumeJobRequest or an equivalent Hash.
Parameters
  • 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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def resume_job(name: nil) -> ::Google::Cloud::Scheduler::V1::Job
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).
Parameter
  • name (::String) — Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/scheduler/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Scheduler::V1::ResumeJobRequest.new

# Call the resume_job method.
result = client.resume_job request

# The returned object is of type Google::Cloud::Scheduler::V1::Job.
p result

#run_job

def run_job(request, options = nil) -> ::Google::Cloud::Scheduler::V1::Job
def run_job(name: nil) -> ::Google::Cloud::Scheduler::V1::Job

Forces a job to run now.

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

Overloads 
def run_job(request, options = nil) -> ::Google::Cloud::Scheduler::V1::Job
Pass arguments to run_job via a request object, either of type RunJobRequest or an equivalent Hash.
Parameters
  • 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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def run_job(name: nil) -> ::Google::Cloud::Scheduler::V1::Job
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).
Parameter
  • name (::String) — Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/scheduler/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Scheduler::V1::RunJobRequest.new

# Call the run_job method.
result = client.run_job request

# The returned object is of type Google::Cloud::Scheduler::V1::Job.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_job

def update_job(request, options = nil) -> ::Google::Cloud::Scheduler::V1::Job
def update_job(job: nil, update_mask: nil) -> ::Google::Cloud::Scheduler::V1::Job

Updates a job.

If successful, the updated 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 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.

Overloads 
def update_job(request, options = nil) -> ::Google::Cloud::Scheduler::V1::Job
Pass arguments to update_job via a request object, either of type UpdateJobRequest or an equivalent Hash.
Parameters
  • 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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_job(job: nil, update_mask: nil) -> ::Google::Cloud::Scheduler::V1::Job
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).
Parameters
  • job (::Google::Cloud::Scheduler::V1::Job, ::Hash) — Required. The new job properties. name must be specified.

    Output only fields cannot be modified using UpdateJob. Any value specified for an output only field will be ignored.

  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — A mask used to specify which fields of the job are being updated.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/scheduler/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Scheduler::V1::UpdateJobRequest.new

# Call the update_job method.
result = client.update_job request

# The returned object is of type Google::Cloud::Scheduler::V1::Job.
p result