Struct Queue

pub struct Queue {
    pub app_engine_http_queue: Option<AppEngineHttpQueue>,
    pub http_target: Option<HttpTarget>,
    pub name: Option<String>,
    pub purge_time: Option<DateTime<Utc>>,
    pub rate_limits: Option<RateLimits>,
    pub retry_config: Option<RetryConfig>,
    pub stackdriver_logging_config: Option<StackdriverLoggingConfig>,
    pub state: Option<String>,
    pub stats: Option<QueueStats>,
    pub task_ttl: Option<Duration>,
    pub tombstone_ttl: Option<Duration>,
    pub type_: Option<String>,
}

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.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• locations queues create projects (request|response)
• locations queues get projects (response)
• locations queues patch projects (request|response)
• locations queues pause projects (response)
• locations queues purge projects (response)
• locations queues resume projects (response)

Fields

app_engine_http_queue: Option<AppEngineHttpQueue>

AppEngineHttpQueue settings apply only to App Engine tasks in this queue. Http tasks are not affected by this proto.

http_target: Option<HttpTarget>

Modifies HTTP target for HTTP tasks.

name: Option<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.

purge_time: Option<DateTime<Utc>>

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: Option<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. * 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: Option<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: Option<StackdriverLoggingConfig>

Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.

state: Option<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.

stats: Option<QueueStats>

Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.

task_ttl: Option<Duration>

The maximum amount of time that a task will be retained in this queue. After a task has lived for task_ttl, the task will be deleted regardless of whether it was dispatched or not. The minimum value is 10 days. The maximum value is 10 years. The value must be given as a string that indicates the length of time (in seconds) followed by s (for “seconds”). For more information on the format, see the documentation for Duration. Queues created by Cloud Tasks have a default task_ttl of 31 days. . Queues created by queue.yaml/xml have a fixed task_ttl of the maximum duration, because there is a storage quota for these queues.

tombstone_ttl: Option<Duration>

The task tombstone time to live (TTL). After a task is deleted or executed, the task’s tombstone is retained for the length of time specified by tombstone_ttl. The tombstone is used by task de-duplication; another task with the same name can’t be created until the tombstone has expired. For more information about task de-duplication, see the documentation for CreateTaskRequest. The minimum value is 1 hour. The maximum value is 9 days. The value must be given as a string that indicates the length of time (in seconds) followed by s (for “seconds”). For more information on the format, see the documentation for Duration. Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.

type_: Option<String>

Immutable. The type of a queue (push or pull). Queue.type is an immutable property of the queue that is set at the queue creation time. When left unspecified, the default value of PUSH is selected.

Trait Implementations

impl Clone for Queue

fn clone(&self) -> Queue

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Queue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Queue

fn default() -> Queue

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Queue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Queue

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for Queue

impl ResponseResult for Queue