Batch V1 API - Class Google::Cloud::Batch::V1::BatchService::Rest::ServiceStub (v0.19.0)

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

REST service stub for the BatchService 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::Batch::V1::Job

Baseline implementation for the create_job REST call

Parameters

request_pb (::Google::Cloud::Batch::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

result (::Google::Cloud::Batch::V1::Job)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Batch::V1::Job) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#delete_job

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

Baseline implementation for the delete_job REST call

Parameters

request_pb (::Google::Cloud::Batch::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

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#get_job

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

Baseline implementation for the get_job REST call

Parameters

request_pb (::Google::Cloud::Batch::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

result (::Google::Cloud::Batch::V1::Job)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Batch::V1::Job) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_task

def get_task(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Batch::V1::Task

Baseline implementation for the get_task REST call

Parameters

request_pb (::Google::Cloud::Batch::V1::GetTaskRequest) — 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::Batch::V1::Task)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Batch::V1::Task) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#initialize

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

Returns

(ServiceStub) — a new instance of ServiceStub

#list_jobs

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

Baseline implementation for the list_jobs REST call

Parameters

request_pb (::Google::Cloud::Batch::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

result (::Google::Cloud::Batch::V1::ListJobsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Batch::V1::ListJobsResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#list_tasks

def list_tasks(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Batch::V1::ListTasksResponse

Baseline implementation for the list_tasks REST call

Parameters

request_pb (::Google::Cloud::Batch::V1::ListTasksRequest) — 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::Batch::V1::ListTasksResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Batch::V1::ListTasksResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)