Cloud Run V2 API - Class Google::Cloud::Run::V2::Revisions::Client (v0.2.0)

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

Client for the Revisions service.

Cloud Run Revision Control Plane API.

Inherits

  • Object

Includes

Methods

.configure

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

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

#configure

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

Configure the Revisions 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_revision

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

Delete a Revision.

Overloads 
def delete_revision(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_revision via a request object, either of type DeleteRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Run::V2::DeleteRevisionRequest, ::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_revision(name: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_revision 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 Revision to delete. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}
  • 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::Revisions::Client.new

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

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

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

#get_revision

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

Gets information about a Revision.

Overloads 
def get_revision(request, options = nil) -> ::Google::Cloud::Run::V2::Revision
Pass arguments to get_revision via a request object, either of type GetRevisionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Run::V2::GetRevisionRequest, ::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_revision(name: nil) -> ::Google::Cloud::Run::V2::Revision
Pass arguments to get_revision 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 Revision. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::Revisions::Client.new

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

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

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

#initialize

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

Create a new Revisions client object.

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

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

#list_revisions

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

List Revisions from a given Service, or from a given location.

Overloads 
def list_revisions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Run::V2::Revision>
Pass arguments to list_revisions via a request object, either of type ListRevisionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Run::V2::ListRevisionsRequest, ::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_revisions(parent: nil, page_size: nil, page_token: nil, show_deleted: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Run::V2::Revision>
Pass arguments to list_revisions 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 Service from which the Revisions should be listed. To list all Revisions across Services, use "-" instead of Service name. Format: projects/{project}/locations/{location}/services/{service}
  • page_size (::Integer) — Maximum number of revisions to return in this call.
  • page_token (::String) — A page token received from a previous call to ListRevisions. All other parameters must match.
  • show_deleted (::Boolean) — If true, returns deleted (but unexpired) resources along with active ones.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::Revisions::Client.new

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

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Run::V2::Revision.
  p response
end

#operations_client

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

Get the associated client for long-running operations.

Returns