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
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the Executions Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all Executions clients ::Google::Cloud::Run::V2::Executions::Rest::Client.configure do |config| config.timeout = 10.0 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.
- (config) — Configure the Client client.
- config (Client::Configuration)
#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.
def delete_execution(request, options = nil) -> ::Gapic::Operation
delete_execution
via a request object, either of type
DeleteExecutionRequest or an equivalent Hash.
- 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
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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#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.
def get_execution(request, options = nil) -> ::Google::Cloud::Run::V2::Execution
get_execution
via a request object, either of type
GetExecutionRequest or an equivalent Hash.
- 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
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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Run::V2::Execution)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#initialize
def initialize() { |config| ... } -> Client
Create a new Executions REST client object.
- (config) — Configure the Executions client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# 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.
def list_executions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Run::V2::Execution>
list_executions
via a request object, either of type
ListExecutionsRequest or an equivalent Hash.
- 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>
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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Run::V2::Execution>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Run::V2::Execution>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#location_client
def location_client() -> Google::Cloud::Location::Locations::Rest::Client
Get the associated client for mix-in of the Locations.
- (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.