Cloud Scheduler V1 API - Class Google::Cloud::Scheduler::V1::CloudScheduler::Rest::ServiceStub (v1.1.0)

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

REST service stub for the CloudScheduler service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

  • Object

Methods

#create_job

def create_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Scheduler::V1::Job

Baseline implementation for the create_job REST call

Parameters
  • request_pb (::Google::Cloud::Scheduler::V1::CreateJobRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_job

def delete_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_job REST call

Parameters
  • request_pb (::Google::Cloud::Scheduler::V1::DeleteJobRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#get_job

def get_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Scheduler::V1::Job

Baseline implementation for the get_job REST call

Parameters
  • request_pb (::Google::Cloud::Scheduler::V1::GetJobRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_jobs

def list_jobs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Scheduler::V1::ListJobsResponse

Baseline implementation for the list_jobs REST call

Parameters
  • request_pb (::Google::Cloud::Scheduler::V1::ListJobsRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#logger

def logger(stub: false) -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#pause_job

def pause_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Scheduler::V1::Job

Baseline implementation for the pause_job REST call

Parameters
  • request_pb (::Google::Cloud::Scheduler::V1::PauseJobRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#resume_job

def resume_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Scheduler::V1::Job

Baseline implementation for the resume_job REST call

Parameters
  • request_pb (::Google::Cloud::Scheduler::V1::ResumeJobRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#run_job

def run_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Scheduler::V1::Job

Baseline implementation for the run_job REST call

Parameters
  • request_pb (::Google::Cloud::Scheduler::V1::RunJobRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_job

def update_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Scheduler::V1::Job

Baseline implementation for the update_job REST call

Parameters
  • request_pb (::Google::Cloud::Scheduler::V1::UpdateJobRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)