Skip to content

CreateBudgetRequest

Source code in docs_src/capo_deadline/types/create_budget_request.py
class CreateBudgetRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID to include in this budget.</p>"""
    display_name: "capo_deadline.types.resource_name.ResourceName"
    """<p>The display name of the budget.</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: "capo_deadline.types.description.Description"
    """<p>The description of the budget.</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>"""
    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>"""
    usage_tracking_resource: (
        "capo_deadline.types.usage_tracking_resource.UsageTrackingResource"
    )
    """<p>The queue ID provided to this budget to track usage.</p>"""
    approximate_dollar_limit: (
        "capo_deadline.types.consumed_usage_limit.ConsumedUsageLimit"
    )
    """<p>The dollar limit based on consumed usage.</p>"""
    actions: "capo_deadline.types.budget_actions_to_add.BudgetActionsToAdd"
    """<p>The budget actions to specify what happens when the budget runs out.</p>"""
    schedule: "capo_deadline.types.budget_schedule.BudgetSchedule"
    """<p>The schedule to associate with this budget.</p>"""
    tags: NotRequired["capo_deadline.types.tags.Tags"]
    """<p>Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.</p>"""

actions instance-attribute

The budget actions to specify what happens when the budget runs out.

approximate_dollar_limit instance-attribute

approximate_dollar_limit: ConsumedUsageLimit

The dollar limit based on consumed usage.

client_token instance-attribute

client_token: NotRequired[ClientToken]

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

description instance-attribute

description: Description

The description of the budget.

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: ResourceName

The display name of the budget.

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 to include in this budget.

schedule instance-attribute

schedule: BudgetSchedule

The schedule to associate with this budget.

tags instance-attribute

tags: NotRequired[Tags]

Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

usage_tracking_resource instance-attribute

usage_tracking_resource: UsageTrackingResource

The queue ID provided to this budget to track usage.