Module: Google::Cloud::Run

Defined in:
lib/google/cloud/run.rb,
lib/google/cloud/run/client/version.rb

Defined Under Namespace

Modules: Client

Class Method Summary collapse

Class Method Details

.builds(version: :v2, transport: :grpc, &block) ⇒ ::Object

Create a new client object for Builds.

By default, this returns an instance of Google::Cloud::Run::V2::Builds::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 Builds 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 Builds

Cloud Run Build 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.



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/run.rb', line 70

def self.builds version: :v2, transport: :grpc, &block
  require "google/cloud/run/#{version.to_s.downcase}"

  package_name = Google::Cloud::Run
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Run.const_get(package_name).const_get(:Builds)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.configure {|::Google::Cloud.configure.run| ... } ⇒ ::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:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



280
281
282
283
284
 
# File 'lib/google/cloud/run.rb', line 280

def self.configure
  yield ::Google::Cloud.configure.run if block_given?

  ::Google::Cloud.configure.run
end

.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.



104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/google/cloud/run.rb', line 104

def self.executions version: :v2, transport: :grpc, &block
  require "google/cloud/run/#{version.to_s.downcase}"

  package_name = Google::Cloud::Run
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Run.const_get(package_name).const_get(:Executions)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.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.



138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/google/cloud/run.rb', line 138

def self.jobs version: :v2, transport: :grpc, &block
  require "google/cloud/run/#{version.to_s.downcase}"

  package_name = Google::Cloud::Run
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Run.const_get(package_name).const_get(:Jobs)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.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.



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/google/cloud/run.rb', line 172

def self.revisions version: :v2, transport: :grpc, &block
  require "google/cloud/run/#{version.to_s.downcase}"

  package_name = Google::Cloud::Run
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Run.const_get(package_name).const_get(:Revisions)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.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.



206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/google/cloud/run.rb', line 206

def self.services version: :v2, transport: :grpc, &block
  require "google/cloud/run/#{version.to_s.downcase}"

  package_name = Google::Cloud::Run
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Run.const_get(package_name).const_get(:Services)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.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.



240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/google/cloud/run.rb', line 240

def self.tasks version: :v2, transport: :grpc, &block
  require "google/cloud/run/#{version.to_s.downcase}"

  package_name = Google::Cloud::Run
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Run.const_get(package_name).const_get(:Tasks)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end