Class: Google::Apis::CloudtasksV2beta2::Queue

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudtasks_v2beta2/classes.rb,
generated/google/apis/cloudtasks_v2beta2/representations.rb,
generated/google/apis/cloudtasks_v2beta2/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, target 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



991
992
993
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 991

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

Instance Attribute Details

#app_engine_http_target ⇒ Google::Apis::CloudtasksV2beta2::AppEngineHttpTarget

App Engine HTTP target. The task will be delivered to the App Engine application hostname specified by its AppEngineHttpTarget and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed. Using AppEngineHttpTarget 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 appEngineHttpTarget

Returns:



929
930
931
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 929

def app_engine_http_target
  @app_engine_http_target
end

#name ⇒ String

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 google.cloud.location.Locations.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. Caller-specified and required in CreateQueueRequest, after which it becomes output only. Corresponds to the JSON property name

Returns:

  • (String) 


949
950
951
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 949

def name
  @name
end

#pull_target ⇒ Google::Apis::CloudtasksV2beta2::PullTarget

Pull target. Corresponds to the JSON property pullTarget

Returns:



954
955
956
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 954

def pull_target
  @pull_target
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 CloudTasks.PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console . Purge time will be truncated to the nearest microsecond. Purge time will be zero if the queue has never been purged. Corresponds to the JSON property purgeTime

Returns:

  • (String) 


967
968
969
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 967

def purge_time
  @purge_time
end

#rate_limits ⇒ Google::Apis::CloudtasksV2beta2::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. Corresponds to the JSON property rateLimits

Returns:



974
975
976
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 974

def rate_limits
  @rate_limits
end

#retry_config ⇒ Google::Apis::CloudtasksV2beta2::RetryConfig

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

Returns:



980
981
982
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 980

def retry_config
  @retry_config
end

#state ⇒ String

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

Returns:

  • (String) 


989
990
991
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 989

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



996
997
998
999
1000
1001
1002
1003
1004
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 996

def update!(**args)
  @app_engine_http_target = args[:app_engine_http_target] if args.key?(:app_engine_http_target)
  @name = args[:name] if args.key?(:name)
  @pull_target = args[:pull_target] if args.key?(:pull_target)
  @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