Cloud Run V2 API - Class Google::Cloud::Run::V2::Executions::Rest::Client (v0.17.0)

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

REST client for the Executions service.

Cloud Run Execution Control Plane API.

Inherits

  • Object

Includes

Methods

.configure

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

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

#cancel_execution

def cancel_execution(request, options = nil) -> ::Gapic::Operation
def cancel_execution(name: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation

Cancels an Execution.

Overloads 
def cancel_execution(request, options = nil) -> ::Gapic::Operation
Pass arguments to cancel_execution via a request object, either of type CancelExecutionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Run::V2::CancelExecutionRequest, ::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 cancel_execution(name: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to cancel_execution 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
  • name (::String) — Required. The name of the Execution to cancel. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, where {project} can be project id or number.
  • validate_only (::Boolean) — Indicates that the request should be validated without actually cancelling any resources.
  • etag (::String) — A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
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::Executions::Rest::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#configure

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

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

#delete_execution

def delete_execution(request, options = nil) -> ::Gapic::Operation
def delete_execution(name: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation

Deletes an Execution.

Overloads 
def delete_execution(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_execution via a request object, either of type DeleteExecutionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Run::V2::DeleteExecutionRequest, ::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_execution(name: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_execution 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
  • name (::String) — Required. The name of the Execution to delete. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, where {project} can be project id or number.
  • validate_only (::Boolean) — Indicates that the request should be validated without actually deleting any resources.
  • etag (::String) — A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
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::Executions::Rest::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_execution

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

Gets information about an Execution.

Overloads 
def get_execution(request, options = nil) -> ::Google::Cloud::Run::V2::Execution
Pass arguments to get_execution via a request object, either of type GetExecutionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Run::V2::GetExecutionRequest, ::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_execution(name: nil) -> ::Google::Cloud::Run::V2::Execution
Pass arguments to get_execution 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 Execution. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, where {project} can be project id or number.
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::Executions::Rest::Client.new

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

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

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

#initialize

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

Create a new Executions REST client object.

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

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

#list_executions

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

Lists Executions from a Job. Results are sorted by creation time, descending.

Overloads 
def list_executions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Run::V2::Execution>
Pass arguments to list_executions via a request object, either of type ListExecutionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Run::V2::ListExecutionsRequest, ::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_executions(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Run::V2::Execution>
Pass arguments to list_executions 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 Executions should be listed. To list all Executions across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}, where {project} can be project id or number.
  • page_size (::Integer) — Maximum number of Executions to return in this call.
  • page_token (::String) — A page token received from a previous call to ListExecutions. 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::Executions::Rest::Client.new

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

# Call the list_executions method.
result = client.list_executions 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::Execution.
  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)

#operations_client

def operations_client() -> ::Google::Cloud::Run::V2::Executions::Rest::Operations

Get the associated client for long-running operations.

Returns

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)