budget

package
v5.3.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Apr 9, 2019 License: Apache-2.0, UPL-1.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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 AlertRuleTypeEnum `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 AlertRuleThresholdTypeEnum `mandatory:"true" json:"thresholdType"`

	// The current state of the alert rule.
	LifecycleState AlertRuleLifecycleStateEnum `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 string

AlertRuleLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for AlertRuleLifecycleStateEnum

func GetAlertRuleLifecycleStateEnumValues

func GetAlertRuleLifecycleStateEnumValues() []AlertRuleLifecycleStateEnum

GetAlertRuleLifecycleStateEnumValues Enumerates the set of values for AlertRuleLifecycleStateEnum

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 AlertRuleSummaryTypeEnum `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 AlertRuleSummaryThresholdTypeEnum `mandatory:"true" json:"thresholdType"`

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

	// The audience that will received 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 string

AlertRuleSummaryLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for AlertRuleSummaryLifecycleStateEnum

func GetAlertRuleSummaryLifecycleStateEnumValues

func GetAlertRuleSummaryLifecycleStateEnumValues() []AlertRuleSummaryLifecycleStateEnum

GetAlertRuleSummaryLifecycleStateEnumValues Enumerates the set of values for AlertRuleSummaryLifecycleStateEnum

type AlertRuleSummaryThresholdTypeEnum

type AlertRuleSummaryThresholdTypeEnum string

AlertRuleSummaryThresholdTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for AlertRuleSummaryThresholdTypeEnum

func GetAlertRuleSummaryThresholdTypeEnumValues

func GetAlertRuleSummaryThresholdTypeEnumValues() []AlertRuleSummaryThresholdTypeEnum

GetAlertRuleSummaryThresholdTypeEnumValues Enumerates the set of values for AlertRuleSummaryThresholdTypeEnum

type AlertRuleSummaryTypeEnum

type AlertRuleSummaryTypeEnum string

AlertRuleSummaryTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for AlertRuleSummaryTypeEnum

func GetAlertRuleSummaryTypeEnumValues

func GetAlertRuleSummaryTypeEnumValues() []AlertRuleSummaryTypeEnum

GetAlertRuleSummaryTypeEnumValues Enumerates the set of values for AlertRuleSummaryTypeEnum

type AlertRuleThresholdTypeEnum

type AlertRuleThresholdTypeEnum string

AlertRuleThresholdTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for AlertRuleThresholdTypeEnum

func GetAlertRuleThresholdTypeEnumValues

func GetAlertRuleThresholdTypeEnumValues() []AlertRuleThresholdTypeEnum

GetAlertRuleThresholdTypeEnumValues Enumerates the set of values for AlertRuleThresholdTypeEnum

type AlertRuleTypeEnum

type AlertRuleTypeEnum string

AlertRuleTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for AlertRuleTypeEnum

func GetAlertRuleTypeEnumValues

func GetAlertRuleTypeEnumValues() []AlertRuleTypeEnum

GetAlertRuleTypeEnumValues Enumerates the set of values for AlertRuleTypeEnum

type AlertType

type AlertType struct {
}

AlertType Valid values are ACTUAL (the alert will trigger based on actual usage) or FORECAST (the alert will trigger based on predicted usage).

func (AlertType) String

func (m AlertType) String() string

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 OCID of the compartment on which budget is applied
	TargetCompartmentId *string `mandatory:"true" json:"targetCompartmentId"`

	// 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 BudgetResetPeriodEnum `mandatory:"true" json:"resetPeriod"`

	// The current state of the budget.
	LifecycleState BudgetLifecycleStateEnum `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"`

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

	// 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 (*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 all Budgets in a compartment.

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 string

BudgetLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for BudgetLifecycleStateEnum

func GetBudgetLifecycleStateEnumValues

func GetBudgetLifecycleStateEnumValues() []BudgetLifecycleStateEnum

GetBudgetLifecycleStateEnumValues Enumerates the set of values for BudgetLifecycleStateEnum

type BudgetResetPeriodEnum

type BudgetResetPeriodEnum string

BudgetResetPeriodEnum Enum with underlying type: string

const (
	BudgetResetPeriodMonthly BudgetResetPeriodEnum = "MONTHLY"
)

Set of constants representing the allowable values for BudgetResetPeriodEnum

func GetBudgetResetPeriodEnumValues

func GetBudgetResetPeriodEnumValues() []BudgetResetPeriodEnum

GetBudgetResetPeriodEnumValues Enumerates the set of values for BudgetResetPeriodEnum

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 OCID of the compartment on which budget is applied
	TargetCompartmentId *string `mandatory:"true" json:"targetCompartmentId"`

	// 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 BudgetSummaryResetPeriodEnum `mandatory:"true" json:"resetPeriod"`

	// The current state of the budget.
	LifecycleState BudgetSummaryLifecycleStateEnum `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"`

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

	// 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 string

BudgetSummaryLifecycleStateEnum Enum with underlying type: string

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

Set of constants representing the allowable values for BudgetSummaryLifecycleStateEnum

func GetBudgetSummaryLifecycleStateEnumValues

func GetBudgetSummaryLifecycleStateEnumValues() []BudgetSummaryLifecycleStateEnum

GetBudgetSummaryLifecycleStateEnumValues Enumerates the set of values for BudgetSummaryLifecycleStateEnum

type BudgetSummaryResetPeriodEnum

type BudgetSummaryResetPeriodEnum string

BudgetSummaryResetPeriodEnum Enum with underlying type: string

const (
	BudgetSummaryResetPeriodMonthly BudgetSummaryResetPeriodEnum = "MONTHLY"
)

Set of constants representing the allowable values for BudgetSummaryResetPeriodEnum

func GetBudgetSummaryResetPeriodEnumValues

func GetBudgetSummaryResetPeriodEnumValues() []BudgetSummaryResetPeriodEnum

GetBudgetSummaryResetPeriodEnumValues Enumerates the set of values for BudgetSummaryResetPeriodEnum

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 CreateAlertRuleDetailsTypeEnum `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 CreateAlertRuleDetailsThresholdTypeEnum `mandatory:"true" json:"thresholdType"`

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

	// 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 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 string

CreateAlertRuleDetailsThresholdTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for CreateAlertRuleDetailsThresholdTypeEnum

func GetCreateAlertRuleDetailsThresholdTypeEnumValues

func GetCreateAlertRuleDetailsThresholdTypeEnumValues() []CreateAlertRuleDetailsThresholdTypeEnum

GetCreateAlertRuleDetailsThresholdTypeEnumValues Enumerates the set of values for CreateAlertRuleDetailsThresholdTypeEnum

type CreateAlertRuleDetailsTypeEnum

type CreateAlertRuleDetailsTypeEnum string

CreateAlertRuleDetailsTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for CreateAlertRuleDetailsTypeEnum

func GetCreateAlertRuleDetailsTypeEnumValues

func GetCreateAlertRuleDetailsTypeEnumValues() []CreateAlertRuleDetailsTypeEnum

GetCreateAlertRuleDetailsTypeEnumValues Enumerates the set of values for CreateAlertRuleDetailsTypeEnum

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 OCID of the compartment on which budget is applied
	TargetCompartmentId *string `mandatory:"true" json:"targetCompartmentId"`

	// 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 CreateBudgetDetailsResetPeriodEnum `mandatory:"true" json:"resetPeriod"`

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

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

	// 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.

func (CreateBudgetDetails) String

func (m CreateBudgetDetails) String() string

type CreateBudgetDetailsResetPeriodEnum

type CreateBudgetDetailsResetPeriodEnum string

CreateBudgetDetailsResetPeriodEnum Enum with underlying type: string

const (
	CreateBudgetDetailsResetPeriodMonthly CreateBudgetDetailsResetPeriodEnum = "MONTHLY"
)

Set of constants representing the allowable values for CreateBudgetDetailsResetPeriodEnum

func GetCreateBudgetDetailsResetPeriodEnumValues

func GetCreateBudgetDetailsResetPeriodEnumValues() []CreateBudgetDetailsResetPeriodEnum

GetCreateBudgetDetailsResetPeriodEnumValues Enumerates the set of values for CreateBudgetDetailsResetPeriodEnum

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 LifecycleState

type LifecycleState struct {
}

LifecycleState The current state of the resource.

func (LifecycleState) String

func (m LifecycleState) String() string

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 *string `mandatory:"false" contributesTo:"query" name:"sortBy"`

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

	// 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 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 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 *string `mandatory:"false" contributesTo:"query" name:"sortBy"`

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

	// 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
}

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 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 ResetPeriod

type ResetPeriod struct {
}

ResetPeriod The reset period for the budget. Valid value is MONTHLY.

func (ResetPeriod) String

func (m ResetPeriod) String() string

type SortBy

type SortBy struct {
}

SortBy 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.

func (SortBy) String

func (m SortBy) String() string

type SortOrder

type SortOrder struct {
}

SortOrder The sort order to use. Valid values are 'asc' or 'desc'.

func (SortOrder) String

func (m SortOrder) String() string

type ThresholdType

type ThresholdType struct {
}

ThresholdType The type of threshold. Valid values are PERCENTAGE or ABSOLUTE.

func (ThresholdType) String

func (m ThresholdType) String() string

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 UpdateAlertRuleDetailsTypeEnum `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 UpdateAlertRuleDetailsThresholdTypeEnum `mandatory:"false" json:"thresholdType,omitempty"`

	// The audience that will received the alert when it triggers.
	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 string

UpdateAlertRuleDetailsThresholdTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for UpdateAlertRuleDetailsThresholdTypeEnum

func GetUpdateAlertRuleDetailsThresholdTypeEnumValues

func GetUpdateAlertRuleDetailsThresholdTypeEnumValues() []UpdateAlertRuleDetailsThresholdTypeEnum

GetUpdateAlertRuleDetailsThresholdTypeEnumValues Enumerates the set of values for UpdateAlertRuleDetailsThresholdTypeEnum

type UpdateAlertRuleDetailsTypeEnum

type UpdateAlertRuleDetailsTypeEnum string

UpdateAlertRuleDetailsTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for UpdateAlertRuleDetailsTypeEnum

func GetUpdateAlertRuleDetailsTypeEnumValues

func GetUpdateAlertRuleDetailsTypeEnumValues() []UpdateAlertRuleDetailsTypeEnum

GetUpdateAlertRuleDetailsTypeEnumValues Enumerates the set of values for UpdateAlertRuleDetailsTypeEnum

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 UpdateBudgetDetailsResetPeriodEnum `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 string

UpdateBudgetDetailsResetPeriodEnum Enum with underlying type: string

const (
	UpdateBudgetDetailsResetPeriodMonthly UpdateBudgetDetailsResetPeriodEnum = "MONTHLY"
)

Set of constants representing the allowable values for UpdateBudgetDetailsResetPeriodEnum

func GetUpdateBudgetDetailsResetPeriodEnumValues

func GetUpdateBudgetDetailsResetPeriodEnumValues() []UpdateBudgetDetailsResetPeriodEnum

GetUpdateBudgetDetailsResetPeriodEnumValues Enumerates the set of values for UpdateBudgetDetailsResetPeriodEnum

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL