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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Builds service. You can determine whether the method will succeed by calling builds_available?.

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.



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/cloud/run.rb', line 75

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

.builds_available?(version: :v2, transport: :grpc) ⇒ boolean

Determines whether the Builds service is supported by the current client. If true, you can retrieve a client object by calling builds. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Builds service, or if the versioned client gem needs an update to support the Builds service.

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:

  • (boolean) —

    Whether the service is available.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/google/cloud/run.rb', line 99

def self.builds_available? version: :v2, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::Run.const_get package_name
  return false unless service_module.const_defined? :Builds
  service_module = service_module.const_get :Builds
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
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



566
567
568
569
570
 
# File 'lib/google/cloud/run.rb', line 566

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Executions service. You can determine whether the method will succeed by calling executions_available?.

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.



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/google/cloud/run.rb', line 145

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

.executions_available?(version: :v2, transport: :grpc) ⇒ boolean

Determines whether the Executions service is supported by the current client. If true, you can retrieve a client object by calling executions. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Executions service, or if the versioned client gem needs an update to support the Executions service.

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:

  • (boolean) —

    Whether the service is available.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/google/cloud/run.rb', line 169

def self.executions_available? version: :v2, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::Run.const_get package_name
  return false unless service_module.const_defined? :Executions
  service_module = service_module.const_get :Executions
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Jobs service. You can determine whether the method will succeed by calling jobs_available?.

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.



215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/google/cloud/run.rb', line 215

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

.jobs_available?(version: :v2, transport: :grpc) ⇒ boolean

Determines whether the Jobs service is supported by the current client. If true, you can retrieve a client object by calling jobs. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Jobs service, or if the versioned client gem needs an update to support the Jobs service.

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:

  • (boolean) —

    Whether the service is available.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/google/cloud/run.rb', line 239

def self.jobs_available? version: :v2, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::Run.const_get package_name
  return false unless service_module.const_defined? :Jobs
  service_module = service_module.const_get :Jobs
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Revisions service. You can determine whether the method will succeed by calling revisions_available?.

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.



285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/google/cloud/run.rb', line 285

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

.revisions_available?(version: :v2, transport: :grpc) ⇒ boolean

Determines whether the Revisions service is supported by the current client. If true, you can retrieve a client object by calling revisions. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Revisions service, or if the versioned client gem needs an update to support the Revisions service.

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:

  • (boolean) —

    Whether the service is available.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/google/cloud/run.rb', line 309

def self.revisions_available? version: :v2, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::Run.const_get package_name
  return false unless service_module.const_defined? :Revisions
  service_module = service_module.const_get :Revisions
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Services service. You can determine whether the method will succeed by calling services_available?.

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.



355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/google/cloud/run.rb', line 355

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

.services_available?(version: :v2, transport: :grpc) ⇒ boolean

Determines whether the Services service is supported by the current client. If true, you can retrieve a client object by calling services. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Services service, or if the versioned client gem needs an update to support the Services service.

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:

  • (boolean) —

    Whether the service is available.



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/google/cloud/run.rb', line 379

def self.services_available? version: :v2, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::Run.const_get package_name
  return false unless service_module.const_defined? :Services
  service_module = service_module.const_get :Services
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Tasks service. You can determine whether the method will succeed by calling tasks_available?.

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.



425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/google/cloud/run.rb', line 425

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

.tasks_available?(version: :v2, transport: :grpc) ⇒ boolean

Determines whether the Tasks service is supported by the current client. If true, you can retrieve a client object by calling tasks. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Tasks service, or if the versioned client gem needs an update to support the Tasks service.

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:

  • (boolean) —

    Whether the service is available.



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/google/cloud/run.rb', line 449

def self.tasks_available? version: :v2, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::Run.const_get package_name
  return false unless service_module.const_defined? :Tasks
  service_module = service_module.const_get :Tasks
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

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

Create a new client object for WorkerPools.

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

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the WorkerPools service. You can determine whether the method will succeed by calling worker_pools_available?.

About WorkerPools

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



495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/google/cloud/run.rb', line 495

def self.worker_pools 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(:WorkerPools)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.worker_pools_available?(version: :v2, transport: :grpc) ⇒ boolean

Determines whether the WorkerPools service is supported by the current client. If true, you can retrieve a client object by calling worker_pools. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the WorkerPools service, or if the versioned client gem needs an update to support the WorkerPools service.

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:

  • (boolean) —

    Whether the service is available.



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/google/cloud/run.rb', line 519

def self.worker_pools_available? version: :v2, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::Run.const_get package_name
  return false unless service_module.const_defined? :WorkerPools
  service_module = service_module.const_get :WorkerPools
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end