Cloud Tasks V2 API - Class Google::Cloud::Tasks::V2::Queue (v0.6.0)

Version 0.6.0

• 1.0.1 (latest)
• 1.0.0
• 0.11.0
• 0.10.2
• 0.9.0
• 0.8.2
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.6

Reference documentation and code samples for the Cloud Tasks V2 API class Google::Cloud::Tasks::V2::Queue.

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.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#app_engine_routing_override

def app_engine_routing_override() -> ::Google::Cloud::Tasks::V2::AppEngineRouting

Returns

• (::Google::Cloud::Tasks::V2::AppEngineRouting) — Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected.

  If set, app_engine_routing_override is used for all App Engine tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

#app_engine_routing_override=

def app_engine_routing_override=(value) -> ::Google::Cloud::Tasks::V2::AppEngineRouting

Parameter

• value (::Google::Cloud::Tasks::V2::AppEngineRouting) — Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected.

  If set, app_engine_routing_override is used for all App Engine tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

Returns

• (::Google::Cloud::Tasks::V2::AppEngineRouting) — Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected.

  If set, app_engine_routing_override is used for all App Engine tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

#name

def name() -> ::String

Returns

• (::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][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.

#name=

def name=(value) -> ::String

Parameter

• value (::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][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.

Returns

• (::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][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.

#purge_time

def purge_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — 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.

#purge_time=

def purge_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — 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.

Returns

• (::Google::Protobuf::Timestamp) — 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.

#rate_limits

def rate_limits() -> ::Google::Cloud::Tasks::V2::RateLimits

Returns

• (::Google::Cloud::Tasks::V2::RateLimits) —

  Rate limits for task dispatches.

  rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:

  • rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry).
  • retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc).

  The queue's actual dispatch rate is the result of:

  • Number of tasks in the queue
  • User-specified throttling: rate_limits, retry_config, and the [queue's state][google.cloud.tasks.v2.Queue.state].
  • System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.

#rate_limits=

def rate_limits=(value) -> ::Google::Cloud::Tasks::V2::RateLimits

Parameter

• value (::Google::Cloud::Tasks::V2::RateLimits) —

  Rate limits for task dispatches.

  rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:

  • rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry).
  • retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc).

  The queue's actual dispatch rate is the result of:

  • Number of tasks in the queue
  • User-specified throttling: rate_limits, retry_config, and the [queue's state][google.cloud.tasks.v2.Queue.state].
  • System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.

Returns

• (::Google::Cloud::Tasks::V2::RateLimits) —

  Rate limits for task dispatches.

  rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:

  • rate_limits controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry).
  • retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc).

  The queue's actual dispatch rate is the result of:

  • Number of tasks in the queue
  • User-specified throttling: rate_limits, retry_config, and the [queue's state][google.cloud.tasks.v2.Queue.state].
  • System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.

#retry_config

def retry_config() -> ::Google::Cloud::Tasks::V2::RetryConfig

Returns

• (::Google::Cloud::Tasks::V2::RetryConfig) —

  Settings that determine the retry behavior.

  • For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks.
  • For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See App Engine documentation.

#retry_config=

def retry_config=(value) -> ::Google::Cloud::Tasks::V2::RetryConfig

Parameter

• value (::Google::Cloud::Tasks::V2::RetryConfig) —

  Settings that determine the retry behavior.

  • For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks.
  • For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See App Engine documentation.

Returns

• (::Google::Cloud::Tasks::V2::RetryConfig) —

  Settings that determine the retry behavior.

  • For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks.
  • For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See App Engine documentation.

#stackdriver_logging_config

def stackdriver_logging_config() -> ::Google::Cloud::Tasks::V2::StackdriverLoggingConfig

Returns

• (::Google::Cloud::Tasks::V2::StackdriverLoggingConfig) — Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.

#stackdriver_logging_config=

def stackdriver_logging_config=(value) -> ::Google::Cloud::Tasks::V2::StackdriverLoggingConfig

Parameter

• value (::Google::Cloud::Tasks::V2::StackdriverLoggingConfig) — Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.

Returns

• (::Google::Cloud::Tasks::V2::StackdriverLoggingConfig) — Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.

#state

def state() -> ::Google::Cloud::Tasks::V2::Queue::State

Returns

• (::Google::Cloud::Tasks::V2::Queue::State) — 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.

#state=

def state=(value) -> ::Google::Cloud::Tasks::V2::Queue::State

Parameter

• value (::Google::Cloud::Tasks::V2::Queue::State) — 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.

Returns

• (::Google::Cloud::Tasks::V2::Queue::State) — 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.