Skip to content

CreateQueueEnvironmentRequest

Source code in docs_src/capo_deadline/types/create_queue_environment_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class CreateQueueEnvironmentRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID of the farm to connect to the environment.</p>"""
    queue_id: "capo_deadline.types.queue_id.QueueId"
    """<p>The queue ID to connect the queue and environment.</p>"""
    client_token: NotRequired["capo_deadline.types.client_token.ClientToken"]
    """<p>The unique token which the server uses to recognize retries of the same request.</p>"""
    priority: "capo_deadline.types.priority.Priority"
    """<p>Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority (activated first and deactivated last). If two environments share the same priority value, the environment created first takes higher priority.</p>"""
    template_type: (
        "capo_deadline.types.environment_template_type.EnvironmentTemplateType"
    )
    """<p>The template's file type, <code>JSON</code> or <code>YAML</code>.</p>"""
    template: "capo_deadline.types.environment_template.EnvironmentTemplate"
    """<p>The environment template to use in the queue.</p>"""

client_token instance-attribute 

client_token: NotRequired[ClientToken]

The unique token which the server uses to recognize retries of the same request.

farm_id instance-attribute 

farm_id: FarmId

The farm ID of the farm to connect to the environment.

priority instance-attribute 

priority: Priority

Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority (activated first and deactivated last). If two environments share the same priority value, the environment created first takes higher priority.

queue_id instance-attribute 

queue_id: QueueId

The queue ID to connect the queue and environment.

template instance-attribute 

template: EnvironmentTemplate

The environment template to use in the queue.

template_type instance-attribute 

template_type: EnvironmentTemplateType

The template's file type, JSON or YAML.