Module: Google::Cloud::Tasks
- Defined in:
- lib/google/cloud/tasks.rb,
lib/google/cloud/tasks/version.rb
Constant Summary collapse
- VERSION =
"2.1.3"
Class Method Summary collapse
-
.cloud_tasks(version: :v2, &block) ⇒ CloudTasks::Client
Create a new client object for CloudTasks.
-
.configure {|::Google::Cloud.configure.tasks| ... } ⇒ ::Google::Cloud::Config
Configure the google-cloud-tasks library.
Class Method Details
.cloud_tasks(version: :v2, &block) ⇒ CloudTasks::Client
Create a new client object for CloudTasks.
By default, this returns an instance of
Google::Cloud::Tasks::V2::CloudTasks::Client
for version V2 of the API.
However, you can specify specify a different API version by passing it in the
version
parameter. If the CloudTasks service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
About CloudTasks
Cloud Tasks allows developers to manage the execution of background work in their applications.
67 68 69 70 71 72 73 74 75 76 |
# File 'lib/google/cloud/tasks.rb', line 67 def self.cloud_tasks version: :v2, &block require "google/cloud/tasks/#{version.to_s.downcase}" package_name = Google::Cloud::Tasks .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Tasks.const_get package_name package_module.const_get(:CloudTasks).const_get(:Client).new(&block) end |
.configure {|::Google::Cloud.configure.tasks| ... } ⇒ ::Google::Cloud::Config
Configure the google-cloud-tasks 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.
106 107 108 109 110 |
# File 'lib/google/cloud/tasks.rb', line 106 def self.configure yield ::Google::Cloud.configure.tasks if block_given? ::Google::Cloud.configure.tasks end |