budgets

type ActionConfiguration struct {
	// <Databricks> action configuration ID.
	ActionConfigurationId *string
	// The type of the action.
	ActionType ActionConfigurationType
	// Target for the action. For example, an email address.
	Target *string
}

type ActionConfigurationType string

type AlertConfiguration struct {
	// <Databricks> alert configuration ID.
	AlertConfigurationId *string
	// The time window of usage data for the budget.
	TimePeriod AlertConfigurationTimePeriod
	// The evaluation method to determine when this budget alert is in a triggered
	// state.
	TriggerType AlertConfigurationTriggerType
	// The way to calculate cost for this budget alert. This is what
	// `quantity_threshold` is measured in.
	QuantityType AlertConfigurationQuantityType
	// The threshold for the budget alert to determine if it is in a triggered
	// state. The number is evaluated based on `quantity_type`.
	QuantityThreshold *string
	// Configured actions for this alert. These define what happens when an alert
	// enters a triggered state.
	ActionConfigurations []ActionConfiguration
	// How the alert threshold is evaluated. Determines whether spend is tracked in
	// aggregate or per individual user.
	ScopeType AlertConfigurationScopeType
	// Per-principal threshold overrides for this alert. Only applies to per-user
	// alerts (`scope_type` = `ALERT_CONFIGURATION_SCOPE_TYPE_PER_USER`); ignored
	// for shared alerts.
	PrincipalOverrides []PrincipalOverride
}

type AlertConfigurationQuantityType string

type AlertConfigurationScopeType string

type AlertConfigurationTimePeriod string

type AlertConfigurationTriggerType string

type BudgetConfiguration struct {
	// <Databricks> budget configuration ID.
	BudgetConfigurationId *string
	// <Databricks> account ID.
	AccountId *string
	// Creation time of this budget configuration.
	CreateTime *int64
	// Update time of this budget configuration.
	UpdateTime *int64
	// Alerts to configure when this budget is in a triggered state. Budgets must
	// have exactly one alert configuration.
	AlertConfigurations []AlertConfiguration
	// Configured filters for this budget. These are applied to your account's usage
	// to limit the scope of what is considered for this budget. Leave empty to
	// include all usage for this account. All provided filters must be matched for
	// usage to be included.
	Filter *BudgetConfigurationFilter
	// Human-readable name of budget configuration. Max Length: 128
	DisplayName *string
	// The resource scope for this budget. Determines whether the budget tracks all
	// resources or a specific resource.
	ResourceType BudgetResourceType
}

type BudgetConfigurationFilter struct {
	// If provided, usage must match with the provided <Databricks> workspace IDs.
	WorkspaceId *BudgetConfigurationFilter_WorkspaceIdClause
	// A list of tag keys and values that will limit the budget to usage that
	// includes those specific custom tags. Tags are case-sensitive and should be
	// entered exactly as they appear in your usage data.
	Tags []BudgetConfigurationFilter_TagClause
}

type BudgetConfigurationFilter_Clause struct {
	Operator BudgetConfigurationFilter_Operator
	Values   []string
}

type BudgetConfigurationFilter_Operator string

type BudgetConfigurationFilter_TagClause struct {
	Key   *string
	Value *BudgetConfigurationFilter_Clause
}

type BudgetConfigurationFilter_WorkspaceIdClause struct {
	Operator BudgetConfigurationFilter_Operator
	Values   []int64
}

type BudgetResourceType string

type Client struct {
	// contains filtered or unexported fields
}

type CreateBudgetConfigurationBudget struct {
	// <Databricks> budget configuration ID.
	BudgetConfigurationId *string
	// <Databricks> account ID.
	AccountId *string
	// Creation time of this budget configuration.
	CreateTime *int64
	// Update time of this budget configuration.
	UpdateTime *int64
	// Alerts to configure when this budget is in a triggered state. Budgets must
	// have exactly one alert configuration.
	AlertConfigurations []AlertConfiguration
	// Configured filters for this budget. These are applied to your account's usage
	// to limit the scope of what is considered for this budget. Leave empty to
	// include all usage for this account. All provided filters must be matched for
	// usage to be included.
	Filter *BudgetConfigurationFilter
	// Human-readable name of budget configuration. Max Length: 128
	DisplayName *string
	// The resource scope for this budget. Determines whether the budget tracks all
	// resources or a specific resource.
	ResourceType BudgetResourceType
}

type CreateBudgetConfigurationRequest struct {
	// Properties of the new budget configuration.
	Budget *CreateBudgetConfigurationBudget
}

type CreateBudgetConfigurationResponse struct {
	// The created budget configuration.
	Budget *BudgetConfiguration
}

type DeleteBudgetConfigurationRequest struct {
	// The <Databricks> budget configuration ID.
	BudgetId *string
	// <Databricks> account ID.
	AccountId *string
}

type DeleteBudgetConfigurationResponse struct {
}

type GetBudgetConfigurationRequest struct {
	// The budget configuration ID
	BudgetId *string
	// <Databricks> account ID.
	AccountId          *string
	IncludeSpendStatus *bool
}

type GetBudgetConfigurationResponse struct {
	Budget *BudgetConfiguration
}

type ListBudgetConfigurationsRequest struct {
	// <Databricks> account ID.
	AccountId *string
	// A page token received from a previous get all budget configurations call.
	// This token can be used to retrieve the subsequent page. Requests first page
	// if absent.
	PageToken               *string
	IncludeSpendStatus      *bool
	IncludeWorkspaceBudgets *bool
}

type ListBudgetConfigurationsResponse struct {
	Budgets []BudgetConfiguration
	// Token which can be sent as `page_token` to retrieve the next page of results.
	// If this field is omitted, there are no subsequent budgets.
	NextPageToken *string
}

type PrincipalOverride struct {
	// Account-level principal id (user, group, or service principal).
	PrincipalId *int64
	// Dollar amount that overrides the parent alert's quantity_threshold for this
	// principal.
	OverrideThreshold *string
}

type UpdateBudgetConfigurationBudget struct {
	// <Databricks> budget configuration ID.
	BudgetConfigurationId *string
	// <Databricks> account ID.
	AccountId *string
	// Creation time of this budget configuration.
	CreateTime *int64
	// Update time of this budget configuration.
	UpdateTime *int64
	// Alerts to configure when this budget is in a triggered state. Budgets must
	// have exactly one alert configuration.
	AlertConfigurations []AlertConfiguration
	// Configured filters for this budget. These are applied to your account's usage
	// to limit the scope of what is considered for this budget. Leave empty to
	// include all usage for this account. All provided filters must be matched for
	// usage to be included.
	Filter *BudgetConfigurationFilter
	// Human-readable name of budget configuration. Max Length: 128
	DisplayName *string
	// The resource scope for this budget. Determines whether the budget tracks all
	// resources or a specific resource.
	ResourceType BudgetResourceType
}

type UpdateBudgetConfigurationRequest struct {
	// The <Databricks> budget configuration ID.
	BudgetId *string
	// The updated budget. This will overwrite the budget specified by the budget
	// ID.
	Budget *UpdateBudgetConfigurationBudget
}

type UpdateBudgetConfigurationResponse struct {
	// The updated budget.
	Budget *BudgetConfiguration
}