UpdateBudgetRequest ¶

class UpdateBudgetRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID of the budget to update.</p>"""
    budget_id: "capo_deadline.types.budget_id.BudgetId"
    """<p>The budget ID to update.</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>"""
    display_name: NotRequired["capo_deadline.types.resource_name.ResourceName"]
    """<p>The display name of the budget 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>"""
    description: NotRequired["capo_deadline.types.description.Description"]
    """<p>The description of the budget 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: NotRequired["capo_deadline.types.budget_status.BudgetStatus"]
    """<p>Updates the status of the budget.</p> <ul> <li> <p> <code>ACTIVE</code>–The budget is being evaluated.</p> </li> <li> <p> <code>INACTIVE</code>–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.</p> </li> </ul>"""
    approximate_dollar_limit: NotRequired[
        "capo_deadline.types.consumed_usage_limit.ConsumedUsageLimit"
    ]
    """<p>The dollar limit to update on the budget. Based on consumed usage.</p>"""
    actions_to_add: NotRequired[
        "capo_deadline.types.budget_actions_to_add.BudgetActionsToAdd"
    ]
    """<p>The budget actions to add. Budget actions specify what happens when the budget runs out.</p>"""
    actions_to_remove: NotRequired[
        "capo_deadline.types.budget_actions_to_remove.BudgetActionsToRemove"
    ]
    """<p>The budget actions to remove from the budget.</p>"""
    schedule: NotRequired["capo_deadline.types.budget_schedule.BudgetSchedule"]
    """<p>The schedule to update.</p>"""