Cloud Run V2 API - Class Google::Cloud::Run::V2::Tasks::Rest::Client (v0.16.1)

Reference documentation and code samples for the Cloud Run V2 API class Google::Cloud::Run::V2::Tasks::Rest::Client.

REST client for the Tasks service.

Cloud Run Task Control Plane API.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the Tasks 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 Tasks clients
::Google::Cloud::Run::V2::Tasks::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

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

Configure the Tasks 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

#get_task

def get_task(request, options = nil) -> ::Google::Cloud::Run::V2::Task
def get_task(name: nil) -> ::Google::Cloud::Run::V2::Task

Gets information about a Task.

Overloads 
def get_task(request, options = nil) -> ::Google::Cloud::Run::V2::Task
Pass arguments to get_task via a request object, either of type GetTaskRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Run::V2::GetTaskRequest, ::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_task(name: nil) -> ::Google::Cloud::Run::V2::Task
Pass arguments to get_task 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 full name of the Task. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}/tasks/{task}
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/run/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Run::V2::Tasks::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Run::V2::GetTaskRequest.new

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

# The returned object is of type Google::Cloud::Run::V2::Task.
p result

#initialize

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

Create a new Tasks REST client object.

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

# Create a client using a custom configuration
client = ::Google::Cloud::Run::V2::Tasks::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_tasks

def list_tasks(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Run::V2::Task>
def list_tasks(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Run::V2::Task>

Lists Tasks from an Execution of a Job.

Overloads 
def list_tasks(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Run::V2::Task>
Pass arguments to list_tasks via a request object, either of type ListTasksRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Run::V2::ListTasksRequest, ::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_tasks(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Run::V2::Task>
Pass arguments to list_tasks 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 Execution from which the Tasks should be listed. To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}
  • page_size (::Integer) — Maximum number of Tasks to return in this call.
  • page_token (::String) — A page token received from a previous call to ListTasks. All other parameters must match.
  • show_deleted (::Boolean) — If true, returns deleted (but unexpired) resources along with active ones.
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/run/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Run::V2::Tasks::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Run::V2::ListTasksRequest.new

# Call the list_tasks method.
result = client.list_tasks 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::Run::V2::Task.
  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)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)