budget

package
v27.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 3, 2020 License: Apache-2.0, UPL-1.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var GetAlertRuleLifecycleStateEnumValues = GetLifecycleStateEnumValues

GetAlertRuleLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum Consider using GetLifecycleStateEnumValue Deprecated

View Source 
var GetAlertRuleSummaryLifecycleStateEnumValues = GetLifecycleStateEnumValues

GetAlertRuleSummaryLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum Consider using GetLifecycleStateEnumValue Deprecated

View Source 
var GetAlertRuleSummaryThresholdTypeEnumValues = GetThresholdTypeEnumValues

GetAlertRuleSummaryThresholdTypeEnumValues Enumerates the set of values for ThresholdTypeEnum Consider using GetThresholdTypeEnumValue Deprecated

View Source 
var GetAlertRuleSummaryTypeEnumValues = GetAlertTypeEnumValues

GetAlertRuleSummaryTypeEnumValues Enumerates the set of values for AlertTypeEnum Consider using GetAlertTypeEnumValue Deprecated

View Source 
var GetAlertRuleThresholdTypeEnumValues = GetThresholdTypeEnumValues

GetAlertRuleThresholdTypeEnumValues Enumerates the set of values for ThresholdTypeEnum Consider using GetThresholdTypeEnumValue Deprecated

View Source 
var GetAlertRuleTypeEnumValues = GetAlertTypeEnumValues

GetAlertRuleTypeEnumValues Enumerates the set of values for AlertTypeEnum Consider using GetAlertTypeEnumValue Deprecated

View Source 
var GetBudgetLifecycleStateEnumValues = GetLifecycleStateEnumValues

GetBudgetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum Consider using GetLifecycleStateEnumValue Deprecated

View Source 
var GetBudgetResetPeriodEnumValues = GetResetPeriodEnumValues

GetBudgetResetPeriodEnumValues Enumerates the set of values for ResetPeriodEnum Consider using GetResetPeriodEnumValue Deprecated

View Source 
var GetBudgetSummaryLifecycleStateEnumValues = GetLifecycleStateEnumValues

GetBudgetSummaryLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum Consider using GetLifecycleStateEnumValue Deprecated

View Source 
var GetBudgetSummaryResetPeriodEnumValues = GetResetPeriodEnumValues

GetBudgetSummaryResetPeriodEnumValues Enumerates the set of values for ResetPeriodEnum Consider using GetResetPeriodEnumValue Deprecated

View Source 
var GetBudgetSummaryTargetTypeEnumValues = GetTargetTypeEnumValues

GetBudgetSummaryTargetTypeEnumValues Enumerates the set of values for TargetTypeEnum Consider using GetTargetTypeEnumValue Deprecated

View Source 
var GetBudgetTargetTypeEnumValues = GetTargetTypeEnumValues

GetBudgetTargetTypeEnumValues Enumerates the set of values for TargetTypeEnum Consider using GetTargetTypeEnumValue Deprecated

View Source 
var GetCreateAlertRuleDetailsThresholdTypeEnumValues = GetThresholdTypeEnumValues

GetCreateAlertRuleDetailsThresholdTypeEnumValues Enumerates the set of values for ThresholdTypeEnum Consider using GetThresholdTypeEnumValue Deprecated

View Source 
var GetCreateAlertRuleDetailsTypeEnumValues = GetAlertTypeEnumValues

GetCreateAlertRuleDetailsTypeEnumValues Enumerates the set of values for AlertTypeEnum Consider using GetAlertTypeEnumValue Deprecated

View Source 
var GetCreateBudgetDetailsResetPeriodEnumValues = GetResetPeriodEnumValues

GetCreateBudgetDetailsResetPeriodEnumValues Enumerates the set of values for ResetPeriodEnum Consider using GetResetPeriodEnumValue Deprecated

View Source 
var GetCreateBudgetDetailsTargetTypeEnumValues = GetTargetTypeEnumValues

GetCreateBudgetDetailsTargetTypeEnumValues Enumerates the set of values for TargetTypeEnum Consider using GetTargetTypeEnumValue Deprecated

View Source 
var GetUpdateAlertRuleDetailsThresholdTypeEnumValues = GetThresholdTypeEnumValues

GetUpdateAlertRuleDetailsThresholdTypeEnumValues Enumerates the set of values for ThresholdTypeEnum Consider using GetThresholdTypeEnumValue Deprecated

View Source 
var GetUpdateAlertRuleDetailsTypeEnumValues = GetAlertTypeEnumValues

GetUpdateAlertRuleDetailsTypeEnumValues Enumerates the set of values for AlertTypeEnum Consider using GetAlertTypeEnumValue Deprecated

View Source 
var GetUpdateBudgetDetailsResetPeriodEnumValues = GetResetPeriodEnumValues

GetUpdateBudgetDetailsResetPeriodEnumValues Enumerates the set of values for ResetPeriodEnum Consider using GetResetPeriodEnumValue Deprecated

Functions

This section is empty.

Types

type AlertRule 

type AlertRule struct {

	// The OCID of the alert rule
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the budget
	BudgetId *string `mandatory:"true" json:"budgetId"`

	// The name of the alert rule.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The type of alert. Valid values are ACTUAL (the alert will trigger based on actual usage) or
	// FORECAST (the alert will trigger based on predicted usage).
	Type AlertTypeEnum `mandatory:"true" json:"type"`

	// The threshold for triggering the alert. If thresholdType is PERCENTAGE, the maximum value is 10000.
	Threshold *float32 `mandatory:"true" json:"threshold"`

	// The type of threshold.
	ThresholdType ThresholdTypeEnum `mandatory:"true" json:"thresholdType"`

	// The current state of the alert rule.
	LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Delimited list of email addresses to receive the alert when it triggers.
	// Delimiter character can be comma, space, TAB, or semicolon.
	Recipients *string `mandatory:"true" json:"recipients"`

	// Time budget was created
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Time budget was updated
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// Custom message sent when alert is triggered
	Message *string `mandatory:"false" json:"message"`

	// The description of the alert rule.
	Description *string `mandatory:"false" json:"description"`

	// Version of the alert rule. Starts from 1 and increments by 1.
	Version *int `mandatory:"false" json:"version"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

AlertRule The alert rule.

func (AlertRule) String 

func (m AlertRule) String() string

type AlertRuleLifecycleStateEnum 

type AlertRuleLifecycleStateEnum = LifecycleStateEnum

AlertRuleLifecycleStateEnum is an alias to type: LifecycleStateEnum Consider using LifecycleStateEnum instead Deprecated

type AlertRuleSummary 

type AlertRuleSummary struct {

	// The OCID of the alert rule
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the budget
	BudgetId *string `mandatory:"true" json:"budgetId"`

	// The name of the alert rule.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// ACTUAL means the alert will trigger based on actual usage.
	// FORECAST means the alert will trigger based on predicted usage.
	Type AlertTypeEnum `mandatory:"true" json:"type"`

	// The threshold for triggering the alert. If thresholdType is PERCENTAGE, the maximum value is 10000.
	Threshold *float32 `mandatory:"true" json:"threshold"`

	// The type of threshold.
	ThresholdType ThresholdTypeEnum `mandatory:"true" json:"thresholdType"`

	// The current state of the alert rule.
	LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The audience that will receive the alert when it triggers.
	Recipients *string `mandatory:"true" json:"recipients"`

	// Time when budget was created
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Time when budget was updated
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// Custom message that will be sent when alert is triggered
	Message *string `mandatory:"false" json:"message"`

	// The description of the alert rule.
	Description *string `mandatory:"false" json:"description"`

	// Version of the alert rule. Starts from 1 and increments by 1.
	Version *int `mandatory:"false" json:"version"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

AlertRuleSummary The alert rule.

func (AlertRuleSummary) String 

func (m AlertRuleSummary) String() string

type AlertRuleSummaryLifecycleStateEnum 

type AlertRuleSummaryLifecycleStateEnum = LifecycleStateEnum

AlertRuleSummaryLifecycleStateEnum is an alias to type: LifecycleStateEnum Consider using LifecycleStateEnum instead Deprecated

type AlertRuleSummaryThresholdTypeEnum 

type AlertRuleSummaryThresholdTypeEnum = ThresholdTypeEnum

AlertRuleSummaryThresholdTypeEnum is an alias to type: ThresholdTypeEnum Consider using ThresholdTypeEnum instead Deprecated

type AlertRuleSummaryTypeEnum 

type AlertRuleSummaryTypeEnum = AlertTypeEnum

AlertRuleSummaryTypeEnum is an alias to type: AlertTypeEnum Consider using AlertTypeEnum instead Deprecated

type AlertRuleThresholdTypeEnum 

type AlertRuleThresholdTypeEnum = ThresholdTypeEnum

AlertRuleThresholdTypeEnum is an alias to type: ThresholdTypeEnum Consider using ThresholdTypeEnum instead Deprecated

type AlertRuleTypeEnum 

type AlertRuleTypeEnum = AlertTypeEnum

AlertRuleTypeEnum is an alias to type: AlertTypeEnum Consider using AlertTypeEnum instead Deprecated

type AlertTypeEnum 

type AlertTypeEnum string

AlertTypeEnum Enum with underlying type: string 

const (
	AlertRuleTypeActual   AlertTypeEnum = "ACTUAL"
	AlertRuleTypeForecast AlertTypeEnum = "FORECAST"
)

Set of constants representing the allowable values for AlertTypeEnum Deprecated 

const (
	AlertRuleSummaryTypeActual   AlertTypeEnum = "ACTUAL"
	AlertRuleSummaryTypeForecast AlertTypeEnum = "FORECAST"
)

Set of constants representing the allowable values for AlertTypeEnum Deprecated 

const (
	AlertTypeActual   AlertTypeEnum = "ACTUAL"
	AlertTypeForecast AlertTypeEnum = "FORECAST"
)

Set of constants representing the allowable values for AlertTypeEnum 

const (
	CreateAlertRuleDetailsTypeActual   AlertTypeEnum = "ACTUAL"
	CreateAlertRuleDetailsTypeForecast AlertTypeEnum = "FORECAST"
)

Set of constants representing the allowable values for AlertTypeEnum Deprecated 

const (
	UpdateAlertRuleDetailsTypeActual   AlertTypeEnum = "ACTUAL"
	UpdateAlertRuleDetailsTypeForecast AlertTypeEnum = "FORECAST"
)

Set of constants representing the allowable values for AlertTypeEnum Deprecated

func GetAlertTypeEnumValues 

func GetAlertTypeEnumValues() []AlertTypeEnum

GetAlertTypeEnumValues Enumerates the set of values for AlertTypeEnum

type Budget 

type Budget struct {

	// The OCID of the budget
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The display name of the budget.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The amount of the budget expressed in the currency of the customer's rate card.
	Amount *float32 `mandatory:"true" json:"amount"`

	// The reset period for the budget.
	ResetPeriod ResetPeriodEnum `mandatory:"true" json:"resetPeriod"`

	// The current state of the budget.
	LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Total number of alert rules in the budget
	AlertRuleCount *int `mandatory:"true" json:"alertRuleCount"`

	// Time that budget was created
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Time that budget was updated
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// This is DEPRECATED. For backwards compatability, the property will be populated when
	// targetType is "COMPARTMENT" AND targets contains EXACT ONE target compartment ocid.
	// For all other scenarios, this property will be left empty.
	TargetCompartmentId *string `mandatory:"false" json:"targetCompartmentId"`

	// The description of the budget.
	Description *string `mandatory:"false" json:"description"`

	// The type of target on which the budget is applied.
	TargetType TargetTypeEnum `mandatory:"false" json:"targetType,omitempty"`

	// The list of targets on which the budget is applied.
	//   If targetType is "COMPARTMENT", targets contains list of compartment OCIDs.
	//   If targetType is "TAG", targets contains list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".
	Targets []string `mandatory:"false" json:"targets"`

	// Version of the budget. Starts from 1 and increments by 1.
	Version *int `mandatory:"false" json:"version"`

	// The actual spend in currency for the current budget cycle
	ActualSpend *float32 `mandatory:"false" json:"actualSpend"`

	// The forecasted spend in currency by the end of the current budget cycle
	ForecastedSpend *float32 `mandatory:"false" json:"forecastedSpend"`

	// The time that the budget spend was last computed
	TimeSpendComputed *common.SDKTime `mandatory:"false" json:"timeSpendComputed"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Budget A budget.

func (Budget) String 

func (m Budget) String() string

type BudgetClient 

type BudgetClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

BudgetClient a client for Budget

func NewBudgetClientWithConfigurationProvider 

func NewBudgetClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client BudgetClient, err error)

NewBudgetClientWithConfigurationProvider Creates a new default Budget client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewBudgetClientWithOboToken 

func NewBudgetClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client BudgetClient, err error)

NewBudgetClientWithOboToken Creates a new default Budget client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer 

as well as reading the region

func (*BudgetClient) ConfigurationProvider 

func (client *BudgetClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (BudgetClient) CreateAlertRule 

func (client BudgetClient) CreateAlertRule(ctx context.Context, request CreateAlertRuleRequest) (response CreateAlertRuleResponse, err error)

CreateAlertRule Creates a new Alert Rule.

func (BudgetClient) CreateBudget 

func (client BudgetClient) CreateBudget(ctx context.Context, request CreateBudgetRequest) (response CreateBudgetResponse, err error)

CreateBudget Creates a new Budget.

func (BudgetClient) DeleteAlertRule 

func (client BudgetClient) DeleteAlertRule(ctx context.Context, request DeleteAlertRuleRequest) (response DeleteAlertRuleResponse, err error)

DeleteAlertRule Deletes a specified Alert Rule resource.

func (BudgetClient) DeleteBudget 

func (client BudgetClient) DeleteBudget(ctx context.Context, request DeleteBudgetRequest) (response DeleteBudgetResponse, err error)

DeleteBudget Deletes a specified Budget resource

func (BudgetClient) GetAlertRule 

func (client BudgetClient) GetAlertRule(ctx context.Context, request GetAlertRuleRequest) (response GetAlertRuleResponse, err error)

GetAlertRule Gets an Alert Rule for a specified Budget.

func (BudgetClient) GetBudget 

func (client BudgetClient) GetBudget(ctx context.Context, request GetBudgetRequest) (response GetBudgetResponse, err error)

GetBudget Gets a Budget by identifier

func (BudgetClient) ListAlertRules 

func (client BudgetClient) ListAlertRules(ctx context.Context, request ListAlertRulesRequest) (response ListAlertRulesResponse, err error)

ListAlertRules Returns a list of Alert Rules for a specified Budget.

func (BudgetClient) ListBudgets 

func (client BudgetClient) ListBudgets(ctx context.Context, request ListBudgetsRequest) (response ListBudgetsResponse, err error)

ListBudgets Gets a list of Budgets in a compartment. By default, ListBudgets returns budgets of 'COMPARTMENT' target type and the budget records with only ONE target compartment OCID. To list ALL budgets, set the targetType query parameter to ALL. Example: 

'targetType=ALL'

Additional targetTypes would be available in future releases. Clients should ignore new targetType or upgrade to latest version of client SDK to handle new targetType.

func (*BudgetClient) SetRegion 

func (client *BudgetClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (BudgetClient) UpdateAlertRule 

func (client BudgetClient) UpdateAlertRule(ctx context.Context, request UpdateAlertRuleRequest) (response UpdateAlertRuleResponse, err error)

UpdateAlertRule Update an Alert Rule for the budget identified by the OCID.

func (BudgetClient) UpdateBudget 

func (client BudgetClient) UpdateBudget(ctx context.Context, request UpdateBudgetRequest) (response UpdateBudgetResponse, err error)

UpdateBudget Update a Budget identified by the OCID

type BudgetLifecycleStateEnum 

type BudgetLifecycleStateEnum = LifecycleStateEnum

BudgetLifecycleStateEnum is an alias to type: LifecycleStateEnum Consider using LifecycleStateEnum instead Deprecated

type BudgetResetPeriodEnum 

type BudgetResetPeriodEnum = ResetPeriodEnum

BudgetResetPeriodEnum is an alias to type: ResetPeriodEnum Consider using ResetPeriodEnum instead Deprecated

type BudgetSummary 

type BudgetSummary struct {

	// The OCID of the budget
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The display name of the budget.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The amount of the budget expressed in the currency of the customer's rate card.
	Amount *float32 `mandatory:"true" json:"amount"`

	// The reset period for the budget.
	ResetPeriod ResetPeriodEnum `mandatory:"true" json:"resetPeriod"`

	// The current state of the budget.
	LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Total number of alert rules in the budget
	AlertRuleCount *int `mandatory:"true" json:"alertRuleCount"`

	// Time budget was created
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Time budget was updated
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// This is DEPRECATED. For backwards compatability, the property will be populated when
	// targetType is "COMPARTMENT" AND targets contains EXACT ONE target compartment ocid.
	// For all other scenarios, this property will be left empty.
	TargetCompartmentId *string `mandatory:"false" json:"targetCompartmentId"`

	// The description of the budget.
	Description *string `mandatory:"false" json:"description"`

	// The type of target on which the budget is applied.
	TargetType TargetTypeEnum `mandatory:"false" json:"targetType,omitempty"`

	// The list of targets on which the budget is applied.
	//   If targetType is "COMPARTMENT", targets contains list of compartment OCIDs.
	//   If targetType is "TAG", targets contains list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".
	Targets []string `mandatory:"false" json:"targets"`

	// Version of the budget. Starts from 1 and increments by 1.
	Version *int `mandatory:"false" json:"version"`

	// The actual spend in currency for the current budget cycle
	ActualSpend *float32 `mandatory:"false" json:"actualSpend"`

	// The forecasted spend in currency by the end of the current budget cycle
	ForecastedSpend *float32 `mandatory:"false" json:"forecastedSpend"`

	// Time budget spend was last computed
	TimeSpendComputed *common.SDKTime `mandatory:"false" json:"timeSpendComputed"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

BudgetSummary A budget.

func (BudgetSummary) String 

func (m BudgetSummary) String() string

type BudgetSummaryLifecycleStateEnum 

type BudgetSummaryLifecycleStateEnum = LifecycleStateEnum

BudgetSummaryLifecycleStateEnum is an alias to type: LifecycleStateEnum Consider using LifecycleStateEnum instead Deprecated

type BudgetSummaryResetPeriodEnum 

type BudgetSummaryResetPeriodEnum = ResetPeriodEnum

BudgetSummaryResetPeriodEnum is an alias to type: ResetPeriodEnum Consider using ResetPeriodEnum instead Deprecated

type BudgetSummaryTargetTypeEnum 

type BudgetSummaryTargetTypeEnum = TargetTypeEnum

BudgetSummaryTargetTypeEnum is an alias to type: TargetTypeEnum Consider using TargetTypeEnum instead Deprecated

type BudgetTargetTypeEnum 

type BudgetTargetTypeEnum = TargetTypeEnum

BudgetTargetTypeEnum is an alias to type: TargetTypeEnum Consider using TargetTypeEnum instead Deprecated

type CreateAlertRuleDetails 

type CreateAlertRuleDetails struct {

	// Type of alert. Valid values are ACTUAL (the alert will trigger based on actual usage) or
	// FORECAST (the alert will trigger based on predicted usage).
	Type AlertTypeEnum `mandatory:"true" json:"type"`

	// The threshold for triggering the alert expressed as a whole number or decimal value.
	// If thresholdType is ABSOLUTE, threshold can have at most 12 digits before the decimal point and up to 2 digits after the decimal point.
	// If thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to 2 digits after the decimal point.
	Threshold *float32 `mandatory:"true" json:"threshold"`

	// The type of threshold.
	ThresholdType ThresholdTypeEnum `mandatory:"true" json:"thresholdType"`

	// The name of the alert rule.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The description of the alert rule.
	Description *string `mandatory:"false" json:"description"`

	// The audience that will receive the alert when it triggers. An empty string is interpreted as null.
	Recipients *string `mandatory:"false" json:"recipients"`

	// The message to be sent to the recipients when alert rule is triggered.
	Message *string `mandatory:"false" json:"message"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateAlertRuleDetails The create alert rule details. This is a batch-create.

func (CreateAlertRuleDetails) String 

func (m CreateAlertRuleDetails) String() string

type CreateAlertRuleDetailsThresholdTypeEnum 

type CreateAlertRuleDetailsThresholdTypeEnum = ThresholdTypeEnum

CreateAlertRuleDetailsThresholdTypeEnum is an alias to type: ThresholdTypeEnum Consider using ThresholdTypeEnum instead Deprecated

type CreateAlertRuleDetailsTypeEnum 

type CreateAlertRuleDetailsTypeEnum = AlertTypeEnum

CreateAlertRuleDetailsTypeEnum is an alias to type: AlertTypeEnum Consider using AlertTypeEnum instead Deprecated

type CreateAlertRuleRequest 

type CreateAlertRuleRequest struct {

	// The unique Budget OCID
	BudgetId *string `mandatory:"true" contributesTo:"path" name:"budgetId"`

	// Details for the new Alert Rule.
	CreateAlertRuleDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateAlertRuleRequest wrapper for the CreateAlertRule operation

func (CreateAlertRuleRequest) HTTPRequest 

func (request CreateAlertRuleRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateAlertRuleRequest) RetryPolicy 

func (request CreateAlertRuleRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateAlertRuleRequest) String 

func (request CreateAlertRuleRequest) String() string

type CreateAlertRuleResponse 

type CreateAlertRuleResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AlertRule instance
	AlertRule `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If
	// you need to contact Oracle about a particular request,
	// please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateAlertRuleResponse wrapper for the CreateAlertRule operation

func (CreateAlertRuleResponse) HTTPResponse 

func (response CreateAlertRuleResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateAlertRuleResponse) String 

func (response CreateAlertRuleResponse) String() string

type CreateBudgetDetails 

type CreateBudgetDetails struct {

	// The OCID of the compartment
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The amount of the budget expressed as a whole number in the currency of the customer's rate card.
	Amount *float32 `mandatory:"true" json:"amount"`

	// The reset period for the budget.
	ResetPeriod ResetPeriodEnum `mandatory:"true" json:"resetPeriod"`

	// This is DEPRECTAED. Set the target compartment id in targets instead.
	TargetCompartmentId *string `mandatory:"false" json:"targetCompartmentId"`

	// The displayName of the budget.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The description of the budget.
	Description *string `mandatory:"false" json:"description"`

	// The type of target on which the budget is applied.
	TargetType TargetTypeEnum `mandatory:"false" json:"targetType,omitempty"`

	// The list of targets on which the budget is applied.
	//   If targetType is "COMPARTMENT", targets contains list of compartment OCIDs.
	//   If targetType is "TAG", targets contains list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".
	// Curerntly, the array should contain EXACT ONE item.
	Targets []string `mandatory:"false" json:"targets"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateBudgetDetails The create budget details. Client should use 'targetType' & 'targets' to specify the target type and list of targets on which the budget is applied. For backwards compatibility, 'targetCompartmentId' will still be supported for all existing clients. However, this is considered deprecreated and all clients be upgraded to use 'targetType' & 'targets'. Specifying both 'targetCompartmentId' and 'targets' will cause a Bad Request.

func (CreateBudgetDetails) String 

func (m CreateBudgetDetails) String() string

type CreateBudgetDetailsResetPeriodEnum 

type CreateBudgetDetailsResetPeriodEnum = ResetPeriodEnum

CreateBudgetDetailsResetPeriodEnum is an alias to type: ResetPeriodEnum Consider using ResetPeriodEnum instead Deprecated

type CreateBudgetDetailsTargetTypeEnum 

type CreateBudgetDetailsTargetTypeEnum = TargetTypeEnum

CreateBudgetDetailsTargetTypeEnum is an alias to type: TargetTypeEnum Consider using TargetTypeEnum instead Deprecated

type CreateBudgetRequest 

type CreateBudgetRequest struct {

	// Details for the new Budget.
	CreateBudgetDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateBudgetRequest wrapper for the CreateBudget operation

func (CreateBudgetRequest) HTTPRequest 

func (request CreateBudgetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBudgetRequest) RetryPolicy 

func (request CreateBudgetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateBudgetRequest) String 

func (request CreateBudgetRequest) String() string

type CreateBudgetResponse 

type CreateBudgetResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Budget instance
	Budget `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If
	// you need to contact Oracle about a particular request,
	// please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateBudgetResponse wrapper for the CreateBudget operation

func (CreateBudgetResponse) HTTPResponse 

func (response CreateBudgetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateBudgetResponse) String 

func (response CreateBudgetResponse) String() string

type DeleteAlertRuleRequest 

type DeleteAlertRuleRequest struct {

	// The unique Budget OCID
	BudgetId *string `mandatory:"true" contributesTo:"path" name:"budgetId"`

	// The unique Alert Rule OCID
	AlertRuleId *string `mandatory:"true" contributesTo:"path" name:"alertRuleId"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

DeleteAlertRuleRequest wrapper for the DeleteAlertRule operation

func (DeleteAlertRuleRequest) HTTPRequest 

func (request DeleteAlertRuleRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteAlertRuleRequest) RetryPolicy 

func (request DeleteAlertRuleRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteAlertRuleRequest) String 

func (request DeleteAlertRuleRequest) String() string

type DeleteAlertRuleResponse 

type DeleteAlertRuleResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If
	// you need to contact Oracle about a particular request,
	// please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteAlertRuleResponse wrapper for the DeleteAlertRule operation

func (DeleteAlertRuleResponse) HTTPResponse 

func (response DeleteAlertRuleResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteAlertRuleResponse) String 

func (response DeleteAlertRuleResponse) String() string

type DeleteBudgetRequest 

type DeleteBudgetRequest struct {

	// The unique Budget OCID
	BudgetId *string `mandatory:"true" contributesTo:"path" name:"budgetId"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

DeleteBudgetRequest wrapper for the DeleteBudget operation

func (DeleteBudgetRequest) HTTPRequest 

func (request DeleteBudgetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBudgetRequest) RetryPolicy 

func (request DeleteBudgetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteBudgetRequest) String 

func (request DeleteBudgetRequest) String() string

type DeleteBudgetResponse 

type DeleteBudgetResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If
	// you need to contact Oracle about a particular request,
	// please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteBudgetResponse wrapper for the DeleteBudget operation

func (DeleteBudgetResponse) HTTPResponse 

func (response DeleteBudgetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteBudgetResponse) String 

func (response DeleteBudgetResponse) String() string

type GetAlertRuleRequest 

type GetAlertRuleRequest struct {

	// The unique Budget OCID
	BudgetId *string `mandatory:"true" contributesTo:"path" name:"budgetId"`

	// The unique Alert Rule OCID
	AlertRuleId *string `mandatory:"true" contributesTo:"path" name:"alertRuleId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetAlertRuleRequest wrapper for the GetAlertRule operation

func (GetAlertRuleRequest) HTTPRequest 

func (request GetAlertRuleRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAlertRuleRequest) RetryPolicy 

func (request GetAlertRuleRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetAlertRuleRequest) String 

func (request GetAlertRuleRequest) String() string

type GetAlertRuleResponse 

type GetAlertRuleResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AlertRule instance
	AlertRule `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If
	// you need to contact Oracle about a particular request,
	// please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetAlertRuleResponse wrapper for the GetAlertRule operation

func (GetAlertRuleResponse) HTTPResponse 

func (response GetAlertRuleResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetAlertRuleResponse) String 

func (response GetAlertRuleResponse) String() string

type GetBudgetRequest 

type GetBudgetRequest struct {

	// The unique Budget OCID
	BudgetId *string `mandatory:"true" contributesTo:"path" name:"budgetId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetBudgetRequest wrapper for the GetBudget operation

func (GetBudgetRequest) HTTPRequest 

func (request GetBudgetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBudgetRequest) RetryPolicy 

func (request GetBudgetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBudgetRequest) String 

func (request GetBudgetRequest) String() string

type GetBudgetResponse 

type GetBudgetResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Budget instance
	Budget `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If
	// you need to contact Oracle about a particular request,
	// please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetBudgetResponse wrapper for the GetBudget operation

func (GetBudgetResponse) HTTPResponse 

func (response GetBudgetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBudgetResponse) String 

func (response GetBudgetResponse) String() string

type LifecycleStateEnum 

type LifecycleStateEnum string

LifecycleStateEnum Enum with underlying type: string 

const (
	AlertRuleLifecycleStateActive   LifecycleStateEnum = "ACTIVE"
	AlertRuleLifecycleStateInactive LifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for LifecycleStateEnum Deprecated 

const (
	AlertRuleSummaryLifecycleStateActive   LifecycleStateEnum = "ACTIVE"
	AlertRuleSummaryLifecycleStateInactive LifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for LifecycleStateEnum Deprecated 

const (
	BudgetLifecycleStateActive   LifecycleStateEnum = "ACTIVE"
	BudgetLifecycleStateInactive LifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for LifecycleStateEnum Deprecated 

const (
	BudgetSummaryLifecycleStateActive   LifecycleStateEnum = "ACTIVE"
	BudgetSummaryLifecycleStateInactive LifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for LifecycleStateEnum Deprecated 

const (
	LifecycleStateActive   LifecycleStateEnum = "ACTIVE"
	LifecycleStateInactive LifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for LifecycleStateEnum

func GetLifecycleStateEnumValues 

func GetLifecycleStateEnumValues() []LifecycleStateEnum

GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum

type ListAlertRulesLifecycleStateEnum 

type ListAlertRulesLifecycleStateEnum string

ListAlertRulesLifecycleStateEnum Enum with underlying type: string 

const (
	ListAlertRulesLifecycleStateActive   ListAlertRulesLifecycleStateEnum = "ACTIVE"
	ListAlertRulesLifecycleStateInactive ListAlertRulesLifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for ListAlertRulesLifecycleStateEnum

func GetListAlertRulesLifecycleStateEnumValues 

func GetListAlertRulesLifecycleStateEnumValues() []ListAlertRulesLifecycleStateEnum

GetListAlertRulesLifecycleStateEnumValues Enumerates the set of values for ListAlertRulesLifecycleStateEnum

type ListAlertRulesRequest 

type ListAlertRulesRequest struct {

	// The unique Budget OCID
	BudgetId *string `mandatory:"true" contributesTo:"path" name:"budgetId"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'asc' or 'desc'.
	SortOrder ListAlertRulesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. If not specified, the default is timeCreated.
	// The default sort order for timeCreated is DESC.
	// The default sort order for displayName is ASC in alphanumeric order.
	SortBy ListAlertRulesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The current state of the resource to filter by.
	LifecycleState ListAlertRulesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Example: `My new resource`
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListAlertRulesRequest wrapper for the ListAlertRules operation

func (ListAlertRulesRequest) HTTPRequest 

func (request ListAlertRulesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAlertRulesRequest) RetryPolicy 

func (request ListAlertRulesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAlertRulesRequest) String 

func (request ListAlertRulesRequest) String() string

type ListAlertRulesResponse 

type ListAlertRulesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []AlertRuleSummary instances
	Items []AlertRuleSummary `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If
	// you need to contact Oracle about a particular request,
	// please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For pagination of a list of `AlertRuleSummary`s. If this header appears in the response, then this
	// is a partial list of AlertRuleSummaries. Include this value as the `page` parameter in a subsequent
	// GET request to get the next batch of AlertRuleSummaries.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListAlertRulesResponse wrapper for the ListAlertRules operation

func (ListAlertRulesResponse) HTTPResponse 

func (response ListAlertRulesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAlertRulesResponse) String 

func (response ListAlertRulesResponse) String() string

type ListAlertRulesSortByEnum 

type ListAlertRulesSortByEnum string

ListAlertRulesSortByEnum Enum with underlying type: string 

const (
	ListAlertRulesSortByTimecreated ListAlertRulesSortByEnum = "timeCreated"
	ListAlertRulesSortByDisplayname ListAlertRulesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListAlertRulesSortByEnum

func GetListAlertRulesSortByEnumValues 

func GetListAlertRulesSortByEnumValues() []ListAlertRulesSortByEnum

GetListAlertRulesSortByEnumValues Enumerates the set of values for ListAlertRulesSortByEnum

type ListAlertRulesSortOrderEnum 

type ListAlertRulesSortOrderEnum string

ListAlertRulesSortOrderEnum Enum with underlying type: string 

const (
	ListAlertRulesSortOrderAsc  ListAlertRulesSortOrderEnum = "ASC"
	ListAlertRulesSortOrderDesc ListAlertRulesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAlertRulesSortOrderEnum

func GetListAlertRulesSortOrderEnumValues 

func GetListAlertRulesSortOrderEnumValues() []ListAlertRulesSortOrderEnum

GetListAlertRulesSortOrderEnumValues Enumerates the set of values for ListAlertRulesSortOrderEnum

type ListBudgetsLifecycleStateEnum 

type ListBudgetsLifecycleStateEnum string

ListBudgetsLifecycleStateEnum Enum with underlying type: string 

const (
	ListBudgetsLifecycleStateActive   ListBudgetsLifecycleStateEnum = "ACTIVE"
	ListBudgetsLifecycleStateInactive ListBudgetsLifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for ListBudgetsLifecycleStateEnum

func GetListBudgetsLifecycleStateEnumValues 

func GetListBudgetsLifecycleStateEnumValues() []ListBudgetsLifecycleStateEnum

GetListBudgetsLifecycleStateEnumValues Enumerates the set of values for ListBudgetsLifecycleStateEnum

type ListBudgetsRequest 

type ListBudgetsRequest struct {

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either 'asc' or 'desc'.
	SortOrder ListBudgetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. If not specified, the default is timeCreated.
	// The default sort order for timeCreated is DESC.
	// The default sort order for displayName is ASC in alphanumeric order.
	SortBy ListBudgetsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The current state of the resource to filter by.
	LifecycleState ListBudgetsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Example: `My new resource`
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The type of target to filter by.
	//   * ALL - List all budgets
	//   * COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
	//   * TAG - List all budgets with targetType == "TAG"
	TargetType ListBudgetsTargetTypeEnum `mandatory:"false" contributesTo:"query" name:"targetType" omitEmpty:"true"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListBudgetsRequest wrapper for the ListBudgets operation

func (ListBudgetsRequest) HTTPRequest 

func (request ListBudgetsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBudgetsRequest) RetryPolicy 

func (request ListBudgetsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBudgetsRequest) String 

func (request ListBudgetsRequest) String() string

type ListBudgetsResponse 

type ListBudgetsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []BudgetSummary instances
	Items []BudgetSummary `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If
	// you need to contact Oracle about a particular request,
	// please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For pagination of a list of `Budget`s. If this header appears in the response, then this
	// is a partial list of Budgets. Include this value as the `page` parameter in a subsequent
	// GET request to get the next batch of Budgets.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListBudgetsResponse wrapper for the ListBudgets operation

func (ListBudgetsResponse) HTTPResponse 

func (response ListBudgetsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBudgetsResponse) String 

func (response ListBudgetsResponse) String() string

type ListBudgetsSortByEnum 

type ListBudgetsSortByEnum string

ListBudgetsSortByEnum Enum with underlying type: string 

const (
	ListBudgetsSortByTimecreated ListBudgetsSortByEnum = "timeCreated"
	ListBudgetsSortByDisplayname ListBudgetsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListBudgetsSortByEnum

func GetListBudgetsSortByEnumValues 

func GetListBudgetsSortByEnumValues() []ListBudgetsSortByEnum

GetListBudgetsSortByEnumValues Enumerates the set of values for ListBudgetsSortByEnum

type ListBudgetsSortOrderEnum 

type ListBudgetsSortOrderEnum string

ListBudgetsSortOrderEnum Enum with underlying type: string 

const (
	ListBudgetsSortOrderAsc  ListBudgetsSortOrderEnum = "ASC"
	ListBudgetsSortOrderDesc ListBudgetsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBudgetsSortOrderEnum

func GetListBudgetsSortOrderEnumValues 

func GetListBudgetsSortOrderEnumValues() []ListBudgetsSortOrderEnum

GetListBudgetsSortOrderEnumValues Enumerates the set of values for ListBudgetsSortOrderEnum

type ListBudgetsTargetTypeEnum 

type ListBudgetsTargetTypeEnum string

ListBudgetsTargetTypeEnum Enum with underlying type: string 

const (
	ListBudgetsTargetTypeAll         ListBudgetsTargetTypeEnum = "ALL"
	ListBudgetsTargetTypeCompartment ListBudgetsTargetTypeEnum = "COMPARTMENT"
	ListBudgetsTargetTypeTag         ListBudgetsTargetTypeEnum = "TAG"
)

Set of constants representing the allowable values for ListBudgetsTargetTypeEnum

func GetListBudgetsTargetTypeEnumValues 

func GetListBudgetsTargetTypeEnumValues() []ListBudgetsTargetTypeEnum

GetListBudgetsTargetTypeEnumValues Enumerates the set of values for ListBudgetsTargetTypeEnum

type ResetPeriodEnum 

type ResetPeriodEnum string

ResetPeriodEnum Enum with underlying type: string 

const (
	BudgetResetPeriodMonthly ResetPeriodEnum = "MONTHLY"
)

Set of constants representing the allowable values for ResetPeriodEnum Deprecated 

const (
	BudgetSummaryResetPeriodMonthly ResetPeriodEnum = "MONTHLY"
)

Set of constants representing the allowable values for ResetPeriodEnum Deprecated 

const (
	CreateBudgetDetailsResetPeriodMonthly ResetPeriodEnum = "MONTHLY"
)

Set of constants representing the allowable values for ResetPeriodEnum Deprecated 

const (
	ResetPeriodMonthly ResetPeriodEnum = "MONTHLY"
)

Set of constants representing the allowable values for ResetPeriodEnum 

const (
	UpdateBudgetDetailsResetPeriodMonthly ResetPeriodEnum = "MONTHLY"
)

Set of constants representing the allowable values for ResetPeriodEnum Deprecated

func GetResetPeriodEnumValues 

func GetResetPeriodEnumValues() []ResetPeriodEnum

GetResetPeriodEnumValues Enumerates the set of values for ResetPeriodEnum

type SortByEnum 

type SortByEnum string

SortByEnum Enum with underlying type: string 

const (
	SortByTimeCreated SortByEnum = "timeCreated"
	SortByDisplayName SortByEnum = "displayName"
)

Set of constants representing the allowable values for SortByEnum

func GetSortByEnumValues 

func GetSortByEnumValues() []SortByEnum

GetSortByEnumValues Enumerates the set of values for SortByEnum

type SortOrderEnum 

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string 

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetSortOrderEnumValues 

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type TargetTypeEnum 

type TargetTypeEnum string

TargetTypeEnum Enum with underlying type: string 

const (
	BudgetTargetTypeCompartment TargetTypeEnum = "COMPARTMENT"
	BudgetTargetTypeTag         TargetTypeEnum = "TAG"
)

Set of constants representing the allowable values for TargetTypeEnum Deprecated 

const (
	BudgetSummaryTargetTypeCompartment TargetTypeEnum = "COMPARTMENT"
	BudgetSummaryTargetTypeTag         TargetTypeEnum = "TAG"
)

Set of constants representing the allowable values for TargetTypeEnum Deprecated 

const (
	CreateBudgetDetailsTargetTypeCompartment TargetTypeEnum = "COMPARTMENT"
	CreateBudgetDetailsTargetTypeTag         TargetTypeEnum = "TAG"
)

Set of constants representing the allowable values for TargetTypeEnum Deprecated 

const (
	TargetTypeCompartment TargetTypeEnum = "COMPARTMENT"
	TargetTypeTag         TargetTypeEnum = "TAG"
)

Set of constants representing the allowable values for TargetTypeEnum

func GetTargetTypeEnumValues 

func GetTargetTypeEnumValues() []TargetTypeEnum

GetTargetTypeEnumValues Enumerates the set of values for TargetTypeEnum

type ThresholdTypeEnum 

type ThresholdTypeEnum string

ThresholdTypeEnum Enum with underlying type: string 

const (
	AlertRuleThresholdTypePercentage ThresholdTypeEnum = "PERCENTAGE"
	AlertRuleThresholdTypeAbsolute   ThresholdTypeEnum = "ABSOLUTE"
)

Set of constants representing the allowable values for ThresholdTypeEnum Deprecated 

const (
	AlertRuleSummaryThresholdTypePercentage ThresholdTypeEnum = "PERCENTAGE"
	AlertRuleSummaryThresholdTypeAbsolute   ThresholdTypeEnum = "ABSOLUTE"
)

Set of constants representing the allowable values for ThresholdTypeEnum Deprecated 

const (
	CreateAlertRuleDetailsThresholdTypePercentage ThresholdTypeEnum = "PERCENTAGE"
	CreateAlertRuleDetailsThresholdTypeAbsolute   ThresholdTypeEnum = "ABSOLUTE"
)

Set of constants representing the allowable values for ThresholdTypeEnum Deprecated 

const (
	ThresholdTypePercentage ThresholdTypeEnum = "PERCENTAGE"
	ThresholdTypeAbsolute   ThresholdTypeEnum = "ABSOLUTE"
)

Set of constants representing the allowable values for ThresholdTypeEnum 

const (
	UpdateAlertRuleDetailsThresholdTypePercentage ThresholdTypeEnum = "PERCENTAGE"
	UpdateAlertRuleDetailsThresholdTypeAbsolute   ThresholdTypeEnum = "ABSOLUTE"
)

Set of constants representing the allowable values for ThresholdTypeEnum Deprecated

func GetThresholdTypeEnumValues 

func GetThresholdTypeEnumValues() []ThresholdTypeEnum

GetThresholdTypeEnumValues Enumerates the set of values for ThresholdTypeEnum

type UpdateAlertRuleDetails 

type UpdateAlertRuleDetails struct {

	// The name of the alert rule.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Type of alert. Valid values are ACTUAL (the alert will trigger based on actual usage) or
	// FORECAST (the alert will trigger based on predicted usage).
	Type AlertTypeEnum `mandatory:"false" json:"type,omitempty"`

	// The threshold for triggering the alert expressed as a whole number or decimal value.
	// If thresholdType is ABSOLUTE, threshold can have at most 12 digits before the decimal point and up to 2 digits after the decimal point.
	// If thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to 2 digits after the decimal point.
	Threshold *float32 `mandatory:"false" json:"threshold"`

	// The type of threshold.
	ThresholdType ThresholdTypeEnum `mandatory:"false" json:"thresholdType,omitempty"`

	// The audience that will receive the alert when it triggers. If you need to clear out this value, please pass in an empty string instead of null.
	Recipients *string `mandatory:"false" json:"recipients"`

	// The description of the alert rule
	Description *string `mandatory:"false" json:"description"`

	// The message to be delivered to the recipients when alert is triggered
	Message *string `mandatory:"false" json:"message"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateAlertRuleDetails The update alert rule details.

func (UpdateAlertRuleDetails) String 

func (m UpdateAlertRuleDetails) String() string

type UpdateAlertRuleDetailsThresholdTypeEnum 

type UpdateAlertRuleDetailsThresholdTypeEnum = ThresholdTypeEnum

UpdateAlertRuleDetailsThresholdTypeEnum is an alias to type: ThresholdTypeEnum Consider using ThresholdTypeEnum instead Deprecated

type UpdateAlertRuleDetailsTypeEnum 

type UpdateAlertRuleDetailsTypeEnum = AlertTypeEnum

UpdateAlertRuleDetailsTypeEnum is an alias to type: AlertTypeEnum Consider using AlertTypeEnum instead Deprecated

type UpdateAlertRuleRequest 

type UpdateAlertRuleRequest struct {

	// The unique Budget OCID
	BudgetId *string `mandatory:"true" contributesTo:"path" name:"budgetId"`

	// The unique Alert Rule OCID
	AlertRuleId *string `mandatory:"true" contributesTo:"path" name:"alertRuleId"`

	// The information to be updated.
	UpdateAlertRuleDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateAlertRuleRequest wrapper for the UpdateAlertRule operation

func (UpdateAlertRuleRequest) HTTPRequest 

func (request UpdateAlertRuleRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateAlertRuleRequest) RetryPolicy 

func (request UpdateAlertRuleRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateAlertRuleRequest) String 

func (request UpdateAlertRuleRequest) String() string

type UpdateAlertRuleResponse 

type UpdateAlertRuleResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AlertRule instance
	AlertRule `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If
	// you need to contact Oracle about a particular request,
	// please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateAlertRuleResponse wrapper for the UpdateAlertRule operation

func (UpdateAlertRuleResponse) HTTPResponse 

func (response UpdateAlertRuleResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateAlertRuleResponse) String 

func (response UpdateAlertRuleResponse) String() string

type UpdateBudgetDetails 

type UpdateBudgetDetails struct {

	// The displayName of the budget.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The description of the budget.
	Description *string `mandatory:"false" json:"description"`

	// The amount of the budget expressed as a whole number in the currency of the customer's rate card.
	Amount *float32 `mandatory:"false" json:"amount"`

	// The reset period for the budget.
	ResetPeriod ResetPeriodEnum `mandatory:"false" json:"resetPeriod,omitempty"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateBudgetDetails The update budget details.

func (UpdateBudgetDetails) String 

func (m UpdateBudgetDetails) String() string

type UpdateBudgetDetailsResetPeriodEnum 

type UpdateBudgetDetailsResetPeriodEnum = ResetPeriodEnum

UpdateBudgetDetailsResetPeriodEnum is an alias to type: ResetPeriodEnum Consider using ResetPeriodEnum instead Deprecated

type UpdateBudgetRequest 

type UpdateBudgetRequest struct {

	// The unique Budget OCID
	BudgetId *string `mandatory:"true" contributesTo:"path" name:"budgetId"`

	// The information to be updated.
	UpdateBudgetDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateBudgetRequest wrapper for the UpdateBudget operation

func (UpdateBudgetRequest) HTTPRequest 

func (request UpdateBudgetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBudgetRequest) RetryPolicy 

func (request UpdateBudgetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBudgetRequest) String 

func (request UpdateBudgetRequest) String() string

type UpdateBudgetResponse 

type UpdateBudgetResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Budget instance
	Budget `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If
	// you need to contact Oracle about a particular request,
	// please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateBudgetResponse wrapper for the UpdateBudget operation

func (UpdateBudgetResponse) HTTPResponse 

func (response UpdateBudgetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBudgetResponse) String 

func (response UpdateBudgetResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.