Class: Google::Apis::CloudtasksV2::Queue

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudtasks_v2/classes.rb,
generated/google/apis/cloudtasks_v2/representations.rb,
generated/google/apis/cloudtasks_v2/representations.rb

Overview

A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, queue types, and others.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Queue

Returns a new instance of Queue



884
885
886
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 884

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#app_engine_routing_override ⇒ Google::Apis::CloudtasksV2::AppEngineRouting

App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see An Overview of App Engine, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing. Using AppEngineRouting requires appengine.applications.get Google IAM permission for the project and the following scope: https://www.googleapis.com/auth/cloud-platform Corresponds to the JSON property appEngineRoutingOverride

Returns:



822
823
824
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 822

def app_engine_routing_override
  @app_engine_routing_override
end

#name ⇒ String

Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

  • PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
  • LOCATION_ID is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.
  • QUEUE_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. Corresponds to the JSON property name

Returns:

  • (String) 


843
844
845
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 843

def name
  @name
end

#purge_time ⇒ String

Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console. Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. Corresponds to the JSON property purgeTime

Returns:

  • (String) 


856
857
858
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 856

def purge_time
  @purge_time
end

#rate_limits ⇒ Google::Apis::CloudtasksV2::RateLimits

Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. Corresponds to the JSON property rateLimits

Returns:



865
866
867
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 865

def rate_limits
  @rate_limits
end

#retry_config ⇒ Google::Apis::CloudtasksV2::RetryConfig

Retry config. These settings determine when a failed task attempt is retried. Corresponds to the JSON property retryConfig

Returns:



871
872
873
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 871

def retry_config
  @retry_config
end

#state ⇒ String

Output only. The state of the queue. state can only be changed by called PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state. Corresponds to the JSON property state

Returns:

  • (String) 


882
883
884
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 882

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



889
890
891
892
893
894
895
896
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 889

def update!(**args)
  @app_engine_routing_override = args[:app_engine_routing_override] if args.key?(:app_engine_routing_override)
  @name = args[:name] if args.key?(:name)
  @purge_time = args[:purge_time] if args.key?(:purge_time)
  @rate_limits = args[:rate_limits] if args.key?(:rate_limits)
  @retry_config = args[:retry_config] if args.key?(:retry_config)
  @state = args[:state] if args.key?(:state)
end