Cloud Run API - Module Google::Cloud::Run (v0.4.0)

Reference documentation and code samples for the Cloud Run API module Google::Cloud::Run.

Methods

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-run-client library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.run)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.executions

def self.executions(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for Executions.

By default, this returns an instance of Google::Cloud::Run::V2::Executions::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the Executions service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Executions

Cloud Run Execution Control Plane API.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.jobs

def self.jobs(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for Jobs.

By default, this returns an instance of Google::Cloud::Run::V2::Jobs::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the Jobs service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Jobs

Cloud Run Job Control Plane API.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.revisions

def self.revisions(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for Revisions.

By default, this returns an instance of Google::Cloud::Run::V2::Revisions::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the Revisions service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Revisions

Cloud Run Revision Control Plane API.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.services

def self.services(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for Services.

By default, this returns an instance of Google::Cloud::Run::V2::Services::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the Services service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Services

Cloud Run Service Control Plane API

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.tasks

def self.tasks(version: :v2, transport: :grpc, &block) -> ::Object

Create a new client object for Tasks.

By default, this returns an instance of Google::Cloud::Run::V2::Tasks::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the Tasks service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Tasks

Cloud Run Task Control Plane API.

Parameters
  • version (::String, ::Symbol) (defaults to: :v2) — The API version to connect to. Optional. Defaults to :v2.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.