Cloud Scheduler V1beta1 API - Class Google::Cloud::Scheduler::V1beta1::CloudScheduler::Rest::ServiceStub (v0.8.1)

Version 0.8.1

• 0.11.1 (latest)
• 0.11.0
• 0.10.2
• 0.9.1
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.5

Reference documentation and code samples for the Cloud Scheduler V1beta1 API class Google::Cloud::Scheduler::V1beta1::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::V1beta1::Job

Baseline implementation for the create_job REST call

Parameters

• request_pb (::Google::Cloud::Scheduler::V1beta1::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

• result (::Google::Cloud::Scheduler::V1beta1::Job)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Scheduler::V1beta1::Job) — A result object deserialized from the server's reply

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::V1beta1::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

• result (::Google::Protobuf::Empty)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_job

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

Baseline implementation for the get_job REST call

Parameters

• request_pb (::Google::Cloud::Scheduler::V1beta1::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

• result (::Google::Cloud::Scheduler::V1beta1::Job)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Scheduler::V1beta1::Job) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_jobs

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

Baseline implementation for the list_jobs REST call

Parameters

• request_pb (::Google::Cloud::Scheduler::V1beta1::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

• result (::Google::Cloud::Scheduler::V1beta1::ListJobsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Scheduler::V1beta1::ListJobsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#pause_job

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

Baseline implementation for the pause_job REST call

Parameters

• request_pb (::Google::Cloud::Scheduler::V1beta1::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

• result (::Google::Cloud::Scheduler::V1beta1::Job)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Scheduler::V1beta1::Job) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#resume_job

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

Baseline implementation for the resume_job REST call

Parameters

• request_pb (::Google::Cloud::Scheduler::V1beta1::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

• result (::Google::Cloud::Scheduler::V1beta1::Job)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Scheduler::V1beta1::Job) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#run_job

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

Baseline implementation for the run_job REST call

Parameters

• request_pb (::Google::Cloud::Scheduler::V1beta1::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

• result (::Google::Cloud::Scheduler::V1beta1::Job)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Scheduler::V1beta1::Job) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_job

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

Baseline implementation for the update_job REST call

Parameters

• request_pb (::Google::Cloud::Scheduler::V1beta1::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

• result (::Google::Cloud::Scheduler::V1beta1::Job)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Scheduler::V1beta1::Job) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)