Class BudgetsClient

Index

Constructors

Methods

createBudgetConfiguration deleteBudgetConfiguration getBudgetConfiguration getBudgetSpendStatus listBudgetConfigurations listBudgetConfigurationsIter listBudgetSpendStatuses updateBudgetConfiguration

Constructors

constructor

new BudgetsClient(options: ClientOptions): BudgetsClient
Parameters
- options: ClientOptions
Returns BudgetsClient
- Defined in client.ts:66

Methods

createBudgetConfiguration

createBudgetConfiguration(
req: CreateBudgetConfigurationRequest,
options?: CallOptions,
): Promise<CreateBudgetConfigurationResponse>
Create a new budget configuration for an account. For full details, see https://docs.databricks.com/en/admin/account-settings/budgets.html.
Parameters
- req: CreateBudgetConfigurationRequest
- Optionaloptions: CallOptions
Returns Promise<CreateBudgetConfigurationResponse>
- Defined in client.ts:82

deleteBudgetConfiguration

deleteBudgetConfiguration(
req: DeleteBudgetConfigurationRequest,
options?: CallOptions,
): Promise<DeleteBudgetConfigurationResponse>
Deletes a budget configuration for an account. Both account and budget configuration are specified by ID. This cannot be undone.
Parameters
- req: DeleteBudgetConfigurationRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteBudgetConfigurationResponse>
- Defined in client.ts:115

getBudgetConfiguration

getBudgetConfiguration(
req: GetBudgetConfigurationRequest,
options?: CallOptions,
): Promise<GetBudgetConfigurationResponse>
Gets a budget configuration for an account. Both account and budget configuration are specified by ID.
Parameters
- req: GetBudgetConfigurationRequest
- Optionaloptions: CallOptions
Returns Promise<GetBudgetConfigurationResponse>
- Defined in client.ts:144

getBudgetSpendStatus

getBudgetSpendStatus(
req: GetBudgetSpendStatusRequest,
options?: CallOptions,
): Promise<BudgetSpendStatus>
Get the calling user's live spend against the blocking thresholds of a single Unity Gateway budget. Any account user can call this for their own spend. Spend is reported in USD at list price and is near-real-time, so it may differ slightly from billing data. Returns NOT_FOUND if the budget doesn't exist or has no blocking thresholds.
Parameters
- req: GetBudgetSpendStatusRequest
- Optionaloptions: CallOptions
Returns Promise<BudgetSpendStatus>
- Defined in client.ts:178

listBudgetConfigurations

listBudgetConfigurations(
req: ListBudgetConfigurationsRequest,
options?: CallOptions,
): Promise<ListBudgetConfigurationsResponse>
Gets all budgets associated with this account.
Parameters
- req: ListBudgetConfigurationsRequest
- Optionaloptions: CallOptions
Returns Promise<ListBudgetConfigurationsResponse>
- Defined in client.ts:207

listBudgetConfigurationsIter

listBudgetConfigurationsIter(
req: ListBudgetConfigurationsRequest,
options?: CallOptions,
): AsyncGenerator<BudgetConfiguration>
Parameters
- req: ListBudgetConfigurationsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<BudgetConfiguration>
- Defined in client.ts:241

listBudgetSpendStatuses

listBudgetSpendStatuses(
req: ListBudgetSpendStatusesRequest,
options?: CallOptions,
): Promise<ListBudgetSpendStatusesResponse>
List the calling user's live spend against the blocking thresholds across the account's Unity Gateway budgets. Any account user can call this for their own spend. Spend is reported in USD at list price and is near-real-time, so it may differ slightly from billing data. By default, returns every budget in the account that has a blocking threshold. Use filter to narrow results by workspace.
Parameters
- req: ListBudgetSpendStatusesRequest
- Optionaloptions: CallOptions
Returns Promise<ListBudgetSpendStatusesResponse>
- Defined in client.ts:265

updateBudgetConfiguration

updateBudgetConfiguration(
req: UpdateBudgetConfigurationRequest,
options?: CallOptions,
): Promise<UpdateBudgetConfigurationResponse>
Updates a budget configuration for an account. Both account and budget configuration are specified by ID.
Parameters
- req: UpdateBudgetConfigurationRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateBudgetConfigurationResponse>
- Defined in client.ts:309