|
4 | 4 |
|
5 | 5 | .. py:class:: BudgetsAPI |
6 | 6 |
|
7 | | - These APIs manage budget configurations for this account. Budgets enable you to monitor usage across your |
8 | | - account. You can set up budgets to either track account-wide spending, or apply filters to track the |
9 | | - spending of specific teams, projects, or workspaces. |
| 7 | + These APIs manage budget configuration including notifications for exceeding a budget for a period. They |
| 8 | + can also retrieve the status of each budget. |
10 | 9 |
|
11 | | - .. py:method:: create(budget: CreateBudgetConfigurationBudget) -> CreateBudgetConfigurationResponse |
| 10 | + .. py:method:: create(budget: Budget) -> WrappedBudgetWithStatus |
12 | 11 |
|
13 | 12 |
|
14 | 13 | Usage: |
|
46 | 45 | # cleanup |
47 | 46 | a.budgets.delete(budget_id=created.budget.budget_configuration_id) |
48 | 47 |
|
49 | | - Create new budget. |
| 48 | + Create a new budget. |
50 | 49 |
|
51 | | - Create a new budget configuration for an account. For full details, see |
52 | | - https://docs.databricks.com/en/admin/account-settings/budgets.html. |
| 50 | + Creates a new budget in the specified account. |
53 | 51 |
|
54 | | - :param budget: :class:`CreateBudgetConfigurationBudget` |
55 | | - Properties of the new budget configuration. |
| 52 | + :param budget: :class:`Budget` |
| 53 | + Budget configuration to be created. |
56 | 54 |
|
57 | | - :returns: :class:`CreateBudgetConfigurationResponse` |
| 55 | + :returns: :class:`WrappedBudgetWithStatus` |
58 | 56 |
|
59 | 57 |
|
60 | 58 | .. py:method:: delete(budget_id: str) |
61 | 59 |
|
62 | 60 | Delete budget. |
63 | 61 |
|
64 | | - Deletes a budget configuration for an account. Both account and budget configuration are specified by |
65 | | - ID. This cannot be undone. |
| 62 | + Deletes the budget specified by its UUID. |
66 | 63 |
|
67 | 64 | :param budget_id: str |
68 | | - The Databricks budget configuration ID. |
| 65 | + Budget ID |
69 | 66 |
|
70 | 67 |
|
71 | 68 |
|
72 | 69 |
|
73 | | - .. py:method:: get(budget_id: str) -> GetBudgetConfigurationResponse |
| 70 | + .. py:method:: get(budget_id: str) -> WrappedBudgetWithStatus |
74 | 71 |
|
75 | 72 |
|
76 | 73 | Usage: |
|
110 | 107 | # cleanup |
111 | 108 | a.budgets.delete(budget_id=created.budget.budget_configuration_id) |
112 | 109 |
|
113 | | - Get budget. |
| 110 | + Get budget and its status. |
114 | 111 |
|
115 | | - Gets a budget configuration for an account. Both account and budget configuration are specified by ID. |
| 112 | + Gets the budget specified by its UUID, including noncumulative status for each day that the budget is |
| 113 | + configured to include. |
116 | 114 |
|
117 | 115 | :param budget_id: str |
118 | | - The Databricks budget configuration ID. |
| 116 | + Budget ID |
119 | 117 |
|
120 | | - :returns: :class:`GetBudgetConfigurationResponse` |
| 118 | + :returns: :class:`WrappedBudgetWithStatus` |
121 | 119 |
|
122 | 120 |
|
123 | | - .. py:method:: list( [, page_token: Optional[str]]) -> Iterator[BudgetConfiguration] |
| 121 | + .. py:method:: list() -> Iterator[BudgetWithStatus] |
124 | 122 |
|
125 | 123 |
|
126 | 124 | Usage: |
|
136 | 134 |
|
137 | 135 | Get all budgets. |
138 | 136 |
|
139 | | - Gets all budgets associated with this account. |
| 137 | + Gets all budgets associated with this account, including noncumulative status for each day that the |
| 138 | + budget is configured to include. |
140 | 139 |
|
141 | | - :param page_token: str (optional) |
142 | | - A page token received from a previous get all budget configurations call. This token can be used to |
143 | | - retrieve the subsequent page. Requests first page if absent. |
144 | | - |
145 | | - :returns: Iterator over :class:`BudgetConfiguration` |
| 140 | + :returns: Iterator over :class:`BudgetWithStatus` |
146 | 141 |
|
147 | 142 |
|
148 | | - .. py:method:: update(budget_id: str, budget: UpdateBudgetConfigurationBudget) -> UpdateBudgetConfigurationResponse |
| 143 | + .. py:method:: update(budget_id: str, budget: Budget) |
149 | 144 |
|
150 | 145 |
|
151 | 146 | Usage: |
|
206 | 201 |
|
207 | 202 | Modify budget. |
208 | 203 |
|
209 | | - Updates a budget configuration for an account. Both account and budget configuration are specified by |
210 | | - ID. |
| 204 | + Modifies a budget in this account. Budget properties are completely overwritten. |
211 | 205 |
|
212 | 206 | :param budget_id: str |
213 | | - The Databricks budget configuration ID. |
214 | | - :param budget: :class:`UpdateBudgetConfigurationBudget` |
215 | | - The updated budget. This will overwrite the budget specified by the budget ID. |
| 207 | + Budget ID |
| 208 | + :param budget: :class:`Budget` |
| 209 | + Budget configuration to be created. |
| 210 | + |
216 | 211 |
|
217 | | - :returns: :class:`UpdateBudgetConfigurationResponse` |
218 | 212 |
|
0 commit comments