Class: Google::Apis::CloudtasksV2beta3::Queue

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



1160
1161
1162
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1160

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

Instance Attribute Details

#app_engine_http_queueGoogle::Apis::CloudtasksV2beta3::AppEngineHttpQueue

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



1092
1093
1094
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1092

def app_engine_http_queue
  @app_engine_http_queue
end

#nameString

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)


1113
1114
1115
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1113

def name
  @name
end

#purge_timeString

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)


1126
1127
1128
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1126

def purge_time
  @purge_time
end

#rate_limitsGoogle::Apis::CloudtasksV2beta3::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



1135
1136
1137
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1135

def rate_limits
  @rate_limits
end

#retry_configGoogle::Apis::CloudtasksV2beta3::RetryConfig

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



1141
1142
1143
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1141

def retry_config
  @retry_config
end

#stackdriver_logging_configGoogle::Apis::CloudtasksV2beta3::StackdriverLoggingConfig

Configuration options for writing logs to Stackdriver Logging. Corresponds to the JSON property stackdriverLoggingConfig



1147
1148
1149
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1147

def stackdriver_logging_config
  @stackdriver_logging_config
end

#stateString

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)


1158
1159
1160
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1158

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1165
1166
1167
1168
1169
1170
1171
1172
1173
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1165

def update!(**args)
  @app_engine_http_queue = args[:app_engine_http_queue] if args.key?(:app_engine_http_queue)
  @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)
  @stackdriver_logging_config = args[:stackdriver_logging_config] if args.key?(:stackdriver_logging_config)
  @state = args[:state] if args.key?(:state)
end