Skip to content

QueueSummary

Source code in docs_src/capo_deadline/types/queue_summary.py
class QueueSummary(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID.</p>"""
    queue_id: "capo_deadline.types.queue_id.QueueId"
    """<p>The queue ID.</p>"""
    display_name: "capo_deadline.types.resource_name.ResourceName"
    """<p>The display name of the queue summary to update.</p> <important> <p>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.</p> </important>"""
    status: "capo_deadline.types.queue_status.QueueStatus"
    """<p>That status of the queue.</p>"""
    default_budget_action: (
        "capo_deadline.types.default_queue_budget_action.DefaultQueueBudgetAction"
    )
    """<p>The default action taken on a queue summary if a budget wasn't configured.</p>"""
    blocked_reason: NotRequired[
        "capo_deadline.types.queue_blocked_reason.QueueBlockedReason"
    ]
    """<p>The reason the queue is blocked, if applicable.</p>"""
    created_at: "capo_deadline.types.created_at.CreatedAt"
    """<p>The date and time the resource was created.</p>"""
    created_by: "capo_deadline.types.created_by.CreatedBy"
    """<p>The user or system that created this resource.</p>"""
    updated_at: NotRequired["capo_deadline.types.updated_at.UpdatedAt"]
    """<p>The date and time the resource was updated.</p>"""
    updated_by: NotRequired["capo_deadline.types.updated_by.UpdatedBy"]
    """<p>The user or system that updated this resource.</p>"""

blocked_reason instance-attribute

blocked_reason: NotRequired[QueueBlockedReason]

The reason the queue is blocked, if applicable.

created_at instance-attribute

created_at: CreatedAt

The date and time the resource was created.

created_by instance-attribute

created_by: CreatedBy

The user or system that created this resource.

default_budget_action instance-attribute

default_budget_action: DefaultQueueBudgetAction

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

display_name instance-attribute

display_name: ResourceName

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.

farm_id instance-attribute

farm_id: FarmId

The farm ID.

queue_id instance-attribute

queue_id: QueueId

The queue ID.

status instance-attribute

status: QueueStatus

That status of the queue.

updated_at instance-attribute

updated_at: NotRequired[UpdatedAt]

The date and time the resource was updated.

updated_by instance-attribute

updated_by: NotRequired[UpdatedBy]

The user or system that updated this resource.