Class BudgetsClient

Index

Constructors

Methods

createBudgetConfiguration deleteBudgetConfiguration getBudgetConfiguration listBudgetConfigurations listBudgetConfigurationsIter updateBudgetConfiguration

Constructors

constructor

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

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

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

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

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

listBudgetConfigurationsIter

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

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