Struct QueueSummary

#[non_exhaustive]
pub struct QueueSummary {
    pub farm_id: String,
    pub queue_id: String,
    pub display_name: String,
    pub status: QueueStatus,
    pub default_budget_action: DefaultQueueBudgetAction,
    pub blocked_reason: Option<QueueBlockedReason>,
    pub created_at: DateTime,
    pub created_by: String,
    pub updated_at: Option<DateTime>,
    pub updated_by: Option<String>,
}

The details of a queue summary.

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.

farm_id: String

The farm ID.

queue_id: String

The queue ID.

display_name: String

The display name of the queue summary to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

status: QueueStatus

That status of the queue.

default_budget_action: DefaultQueueBudgetAction

The default action taken on a queue summary if a budget wasn't configured.

blocked_reason: Option<QueueBlockedReason>

The reason the queue is blocked, if applicable.

created_at: DateTime

The date and time the resource was created.

created_by: String

The user or system that created this resource.

updated_at: Option<DateTime>

The date and time the resource was updated.

updated_by: Option<String>

The user or system that updated this resource.

Implementations

impl QueueSummary

pub fn farm_id(&self) -> &str

The farm ID.

pub fn queue_id(&self) -> &str

The queue ID.

pub fn display_name(&self) -> &str

The display name of the queue summary to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

pub fn status(&self) -> &QueueStatus

That status of the queue.

pub fn default_budget_action(&self) -> &DefaultQueueBudgetAction

The default action taken on a queue summary if a budget wasn't configured.

pub fn blocked_reason(&self) -> Option<&QueueBlockedReason>

The reason the queue is blocked, if applicable.

pub fn created_at(&self) -> &DateTime

The date and time the resource was created.

pub fn created_by(&self) -> &str

The user or system that created this resource.

pub fn updated_at(&self) -> Option<&DateTime>

The date and time the resource was updated.

pub fn updated_by(&self) -> Option<&str>

The user or system that updated this resource.

impl QueueSummary

pub fn builder() -> QueueSummaryBuilder

Creates a new builder-style object to manufacture QueueSummary.

Trait Implementations

impl Clone for QueueSummary

fn clone(&self) -> QueueSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueueSummary

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

Formats the value using the given formatter.

impl PartialEq for QueueSummary

fn eq(&self, other: &QueueSummary) -> 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 QueueSummary