Skip to content

UpdateLimitRequest

Source code in docs_src/capo_deadline/types/update_limit_request.py 
15
16
17
18
19
20
21
22
23
24
25
class UpdateLimitRequest(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 to update.</p>"""
    display_name: NotRequired["capo_deadline.types.resource_name.ResourceName"]
    """<p>The new display name of 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>"""
    description: NotRequired["capo_deadline.types.description.Description"]
    """<p>The new description of 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>"""
    max_count: NotRequired["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>If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.</p> <p>The <code>maxCount</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>"""

description instance-attribute 

description: NotRequired[Description]

The new description of 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.

display_name instance-attribute 

display_name: NotRequired[ResourceName]

The new display name of 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 to update.

max_count instance-attribute 

max_count: NotRequired[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.

If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.

The maxCount 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.