Skip to content

LimitSummary

Source code in docs_src/capo_deadline/types/limit_summary.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class LimitSummary(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The unique identifier of the farm that contains the limit.</p>"""
    limit_id: "capo_deadline.types.limit_id.LimitId"
    """<p>The unique identifier of the limit.</p>"""
    current_count: "capo_deadline.types.min_zero_max_integer.MinZeroMaxInteger"
    """<p>The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.</p>"""
    created_at: "capo_deadline.types.created_at.CreatedAt"
    """<p>The Unix timestamp of the date and time that the limit was created.</p>"""
    created_by: "capo_deadline.types.created_by.CreatedBy"
    """<p>The user identifier of the person that created the limit.</p>"""
    updated_at: NotRequired["capo_deadline.types.updated_at.UpdatedAt"]
    """<p>The Unix timestamp of the date and time that the limit was last updated.</p>"""
    updated_by: NotRequired["capo_deadline.types.updated_by.UpdatedBy"]
    """<p>The user identifier of the person that last updated the limit.</p>"""
    display_name: "capo_deadline.types.resource_name.ResourceName"
    """<p>The name of the limit used in lists to identify the limit.</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>"""
    amount_requirement_name: (
        "capo_deadline.types.amount_requirement_name.AmountRequirementName"
    )
    """<p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of the <code>hostRequirements</code> in a step of a job template to declare the limit requirement.</p>"""
    max_count: "capo_deadline.types.max_count.MaxCount"
    """<p>The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.</p> <p>The <code>maxValue</code> must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.</p>"""

amount_requirement_name instance-attribute 

amount_requirement_name: AmountRequirementName

The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.

created_at instance-attribute 

created_at: CreatedAt

The Unix timestamp of the date and time that the limit was created.

created_by instance-attribute 

created_by: CreatedBy

The user identifier of the person that created the limit.

current_count instance-attribute 

current_count: MinZeroMaxInteger

The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.

display_name instance-attribute 

display_name: ResourceName

The name of the limit used in lists to identify the limit.

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 unique identifier of the farm that contains the limit.

limit_id instance-attribute 

limit_id: LimitId

The unique identifier of the limit.

max_count instance-attribute 

max_count: MaxCount

The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

updated_at instance-attribute 

updated_at: NotRequired[UpdatedAt]

The Unix timestamp of the date and time that the limit was last updated.

updated_by instance-attribute 

updated_by: NotRequired[UpdatedBy]

The user identifier of the person that last updated the limit.