Struct Queue 

#[non_exhaustive]
pub struct Queue {
    pub name: String,
    pub app_engine_routing_override: Option<AppEngineRouting>,
    pub rate_limits: Option<RateLimits>,
    pub retry_config: Option<RetryConfig>,
    pub state: State,
    pub purge_time: Option<Timestamp>,
    pub stackdriver_logging_config: Option<StackdriverLoggingConfig>,
    /* private fields */
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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][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.

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

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.

state: State

Output only. The state of the queue.

state can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state.

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

stackdriver_logging_config: Option<StackdriverLoggingConfig>

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

Implementations

impl Queue

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_app_engine_routing_override<T>(self, v: T) -> Self

where T: Into<AppEngineRouting>,

Sets the value of app_engine_routing_override.

pub fn set_or_clear_app_engine_routing_override<T>(self, v: Option<T>) -> Self

where T: Into<AppEngineRouting>,

Sets or clears the value of app_engine_routing_override.

pub fn set_rate_limits<T>(self, v: T) -> Self

where T: Into<RateLimits>,

Sets the value of rate_limits.

pub fn set_or_clear_rate_limits<T>(self, v: Option<T>) -> Self

where T: Into<RateLimits>,

Sets or clears the value of rate_limits.

pub fn set_retry_config<T>(self, v: T) -> Self

where T: Into<RetryConfig>,

Sets the value of retry_config.

pub fn set_or_clear_retry_config<T>(self, v: Option<T>) -> Self

where T: Into<RetryConfig>,

Sets or clears the value of retry_config.

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

pub fn set_purge_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of purge_time.

pub fn set_or_clear_purge_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of purge_time.

pub fn set_stackdriver_logging_config<T>(self, v: T) -> Self

where T: Into<StackdriverLoggingConfig>,

Sets the value of stackdriver_logging_config.

pub fn set_or_clear_stackdriver_logging_config<T>(self, v: Option<T>) -> Self

where T: Into<StackdriverLoggingConfig>,

Sets or clears the value of stackdriver_logging_config.

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 Message for Queue

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Queue

fn eq(&self, other: &Queue) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Queue