Cloud Scheduler API - Module Google::Cloud::Scheduler (v2.3.0)

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

Methods

.cloud_scheduler

def self.cloud_scheduler(version: :v1, &block) -> CloudScheduler::Client

Create a new client object for CloudScheduler.

By default, this returns an instance of Google::Cloud::Scheduler::V1::CloudScheduler::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the CloudScheduler service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About CloudScheduler

The Cloud Scheduler API allows external entities to reliably schedule asynchronous jobs.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (CloudScheduler::Client) — A client object for the specified version.

.configure

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

Configure the google-cloud-scheduler 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 gRPC 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.scheduler)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

Constants

VERSION

value: "2.3.0"