GetAlertRuleLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum Consider using GetLifecycleStateEnumValue Deprecated
var GetAlertRuleLifecycleStateEnumValues = GetLifecycleStateEnumValues
GetAlertRuleSummaryLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum Consider using GetLifecycleStateEnumValue Deprecated
var GetAlertRuleSummaryLifecycleStateEnumValues = GetLifecycleStateEnumValues
GetAlertRuleSummaryThresholdTypeEnumValues Enumerates the set of values for ThresholdTypeEnum Consider using GetThresholdTypeEnumValue Deprecated
var GetAlertRuleSummaryThresholdTypeEnumValues = GetThresholdTypeEnumValues
GetAlertRuleSummaryTypeEnumValues Enumerates the set of values for AlertTypeEnum Consider using GetAlertTypeEnumValue Deprecated
var GetAlertRuleSummaryTypeEnumValues = GetAlertTypeEnumValues
GetAlertRuleThresholdTypeEnumValues Enumerates the set of values for ThresholdTypeEnum Consider using GetThresholdTypeEnumValue Deprecated
var GetAlertRuleThresholdTypeEnumValues = GetThresholdTypeEnumValues
GetAlertRuleTypeEnumValues Enumerates the set of values for AlertTypeEnum Consider using GetAlertTypeEnumValue Deprecated
var GetAlertRuleTypeEnumValues = GetAlertTypeEnumValues
GetBudgetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum Consider using GetLifecycleStateEnumValue Deprecated
var GetBudgetLifecycleStateEnumValues = GetLifecycleStateEnumValues
GetBudgetResetPeriodEnumValues Enumerates the set of values for ResetPeriodEnum Consider using GetResetPeriodEnumValue Deprecated
var GetBudgetResetPeriodEnumValues = GetResetPeriodEnumValues
GetBudgetSummaryLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum Consider using GetLifecycleStateEnumValue Deprecated
var GetBudgetSummaryLifecycleStateEnumValues = GetLifecycleStateEnumValues
GetBudgetSummaryResetPeriodEnumValues Enumerates the set of values for ResetPeriodEnum Consider using GetResetPeriodEnumValue Deprecated
var GetBudgetSummaryResetPeriodEnumValues = GetResetPeriodEnumValues
GetBudgetSummaryTargetTypeEnumValues Enumerates the set of values for TargetTypeEnum Consider using GetTargetTypeEnumValue Deprecated
var GetBudgetSummaryTargetTypeEnumValues = GetTargetTypeEnumValues
GetBudgetTargetTypeEnumValues Enumerates the set of values for TargetTypeEnum Consider using GetTargetTypeEnumValue Deprecated
var GetBudgetTargetTypeEnumValues = GetTargetTypeEnumValues
GetCreateAlertRuleDetailsThresholdTypeEnumValues Enumerates the set of values for ThresholdTypeEnum Consider using GetThresholdTypeEnumValue Deprecated
var GetCreateAlertRuleDetailsThresholdTypeEnumValues = GetThresholdTypeEnumValues
GetCreateAlertRuleDetailsTypeEnumValues Enumerates the set of values for AlertTypeEnum Consider using GetAlertTypeEnumValue Deprecated
var GetCreateAlertRuleDetailsTypeEnumValues = GetAlertTypeEnumValues
GetCreateBudgetDetailsResetPeriodEnumValues Enumerates the set of values for ResetPeriodEnum Consider using GetResetPeriodEnumValue Deprecated
var GetCreateBudgetDetailsResetPeriodEnumValues = GetResetPeriodEnumValues
GetCreateBudgetDetailsTargetTypeEnumValues Enumerates the set of values for TargetTypeEnum Consider using GetTargetTypeEnumValue Deprecated
var GetCreateBudgetDetailsTargetTypeEnumValues = GetTargetTypeEnumValues
GetUpdateAlertRuleDetailsThresholdTypeEnumValues Enumerates the set of values for ThresholdTypeEnum Consider using GetThresholdTypeEnumValue Deprecated
var GetUpdateAlertRuleDetailsThresholdTypeEnumValues = GetThresholdTypeEnumValues
GetUpdateAlertRuleDetailsTypeEnumValues Enumerates the set of values for AlertTypeEnum Consider using GetAlertTypeEnumValue Deprecated
var GetUpdateAlertRuleDetailsTypeEnumValues = GetAlertTypeEnumValues
GetUpdateBudgetDetailsResetPeriodEnumValues Enumerates the set of values for ResetPeriodEnum Consider using GetResetPeriodEnumValue Deprecated
var GetUpdateBudgetDetailsResetPeriodEnumValues = GetResetPeriodEnumValues
AlertRule The alert rule.
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"` }
func (m AlertRule) String() string
AlertRuleLifecycleStateEnum is an alias to type: LifecycleStateEnum Consider using LifecycleStateEnum instead Deprecated
type AlertRuleLifecycleStateEnum = LifecycleStateEnum
AlertRuleSummary The alert rule.
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"` }
func (m AlertRuleSummary) String() string
AlertRuleSummaryLifecycleStateEnum is an alias to type: LifecycleStateEnum Consider using LifecycleStateEnum instead Deprecated
type AlertRuleSummaryLifecycleStateEnum = LifecycleStateEnum
AlertRuleSummaryThresholdTypeEnum is an alias to type: ThresholdTypeEnum Consider using ThresholdTypeEnum instead Deprecated
type AlertRuleSummaryThresholdTypeEnum = ThresholdTypeEnum
AlertRuleSummaryTypeEnum is an alias to type: AlertTypeEnum Consider using AlertTypeEnum instead Deprecated
type AlertRuleSummaryTypeEnum = AlertTypeEnum
AlertRuleThresholdTypeEnum is an alias to type: ThresholdTypeEnum Consider using ThresholdTypeEnum instead Deprecated
type AlertRuleThresholdTypeEnum = ThresholdTypeEnum
AlertRuleTypeEnum is an alias to type: AlertTypeEnum Consider using AlertTypeEnum instead Deprecated
type AlertRuleTypeEnum = AlertTypeEnum
AlertTypeEnum Enum with underlying type: string
type AlertTypeEnum string
Set of constants representing the allowable values for AlertTypeEnum Deprecated
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
const ( AlertTypeActual AlertTypeEnum = "ACTUAL" AlertTypeForecast AlertTypeEnum = "FORECAST" )
Set of constants representing the allowable values for AlertTypeEnum Deprecated
const ( CreateAlertRuleDetailsTypeActual AlertTypeEnum = "ACTUAL" CreateAlertRuleDetailsTypeForecast AlertTypeEnum = "FORECAST" )
Set of constants representing the allowable values for AlertTypeEnum Deprecated
const ( UpdateAlertRuleDetailsTypeActual AlertTypeEnum = "ACTUAL" UpdateAlertRuleDetailsTypeForecast AlertTypeEnum = "FORECAST" )
func GetAlertTypeEnumValues() []AlertTypeEnum
GetAlertTypeEnumValues Enumerates the set of values for AlertTypeEnum
Budget A 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 number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight. BudgetProcessingPeriodStartOffset *int `mandatory:"false" json:"budgetProcessingPeriodStartOffset"` // 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"` }
func (m Budget) String() string
BudgetClient a client for Budget
type BudgetClient struct { common.BaseClient // contains filtered or unexported fields }
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(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 (client *BudgetClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client BudgetClient) CreateAlertRule(ctx context.Context, request CreateAlertRuleRequest) (response CreateAlertRuleResponse, err error)
CreateAlertRule Creates a new Alert Rule.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/CreateAlertRule.go.html to see an example of how to use CreateAlertRule API.
func (client BudgetClient) CreateBudget(ctx context.Context, request CreateBudgetRequest) (response CreateBudgetResponse, err error)
CreateBudget Creates a new Budget.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/CreateBudget.go.html to see an example of how to use CreateBudget API.
func (client BudgetClient) DeleteAlertRule(ctx context.Context, request DeleteAlertRuleRequest) (response DeleteAlertRuleResponse, err error)
DeleteAlertRule Deletes a specified Alert Rule resource.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/DeleteAlertRule.go.html to see an example of how to use DeleteAlertRule API.
func (client BudgetClient) DeleteBudget(ctx context.Context, request DeleteBudgetRequest) (response DeleteBudgetResponse, err error)
DeleteBudget Deletes a specified Budget resource
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/DeleteBudget.go.html to see an example of how to use DeleteBudget API.
func (client BudgetClient) GetAlertRule(ctx context.Context, request GetAlertRuleRequest) (response GetAlertRuleResponse, err error)
GetAlertRule Gets an Alert Rule for a specified Budget.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/GetAlertRule.go.html to see an example of how to use GetAlertRule API.
func (client BudgetClient) GetBudget(ctx context.Context, request GetBudgetRequest) (response GetBudgetResponse, err error)
GetBudget Gets a Budget by identifier
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/GetBudget.go.html to see an example of how to use GetBudget API.
func (client BudgetClient) ListAlertRules(ctx context.Context, request ListAlertRulesRequest) (response ListAlertRulesResponse, err error)
ListAlertRules Returns a list of Alert Rules for a specified Budget.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/ListAlertRules.go.html to see an example of how to use ListAlertRules API.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/ListBudgets.go.html to see an example of how to use ListBudgets API.
func (client *BudgetClient) SetRegion(region string)
SetRegion overrides the region of this client.
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.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/UpdateAlertRule.go.html to see an example of how to use UpdateAlertRule API.
func (client BudgetClient) UpdateBudget(ctx context.Context, request UpdateBudgetRequest) (response UpdateBudgetResponse, err error)
UpdateBudget Update a Budget identified by the OCID
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/UpdateBudget.go.html to see an example of how to use UpdateBudget API.
BudgetLifecycleStateEnum is an alias to type: LifecycleStateEnum Consider using LifecycleStateEnum instead Deprecated
type BudgetLifecycleStateEnum = LifecycleStateEnum
BudgetResetPeriodEnum is an alias to type: ResetPeriodEnum Consider using ResetPeriodEnum instead Deprecated
type BudgetResetPeriodEnum = ResetPeriodEnum
BudgetSummary A budget.
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 number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight. BudgetProcessingPeriodStartOffset *int `mandatory:"false" json:"budgetProcessingPeriodStartOffset"` // 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"` }
func (m BudgetSummary) String() string
BudgetSummaryLifecycleStateEnum is an alias to type: LifecycleStateEnum Consider using LifecycleStateEnum instead Deprecated
type BudgetSummaryLifecycleStateEnum = LifecycleStateEnum
BudgetSummaryResetPeriodEnum is an alias to type: ResetPeriodEnum Consider using ResetPeriodEnum instead Deprecated
type BudgetSummaryResetPeriodEnum = ResetPeriodEnum
BudgetSummaryTargetTypeEnum is an alias to type: TargetTypeEnum Consider using TargetTypeEnum instead Deprecated
type BudgetSummaryTargetTypeEnum = TargetTypeEnum
BudgetTargetTypeEnum is an alias to type: TargetTypeEnum Consider using TargetTypeEnum instead Deprecated
type BudgetTargetTypeEnum = TargetTypeEnum
CreateAlertRuleDetails The create alert rule details. This is a batch-create.
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"` }
func (m CreateAlertRuleDetails) String() string
CreateAlertRuleDetailsThresholdTypeEnum is an alias to type: ThresholdTypeEnum Consider using ThresholdTypeEnum instead Deprecated
type CreateAlertRuleDetailsThresholdTypeEnum = ThresholdTypeEnum
CreateAlertRuleDetailsTypeEnum is an alias to type: AlertTypeEnum Consider using AlertTypeEnum instead Deprecated
type CreateAlertRuleDetailsTypeEnum = AlertTypeEnum
CreateAlertRuleRequest wrapper for the CreateAlertRule operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/CreateAlertRule.go.html to see an example of how to use 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 }
func (request CreateAlertRuleRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAlertRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAlertRuleRequest) String() string
CreateAlertRuleResponse wrapper for the CreateAlertRule operation
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"` }
func (response CreateAlertRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAlertRuleResponse) String() string
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.
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 number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight. BudgetProcessingPeriodStartOffset *int `mandatory:"false" json:"budgetProcessingPeriodStartOffset"` // 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"` }
func (m CreateBudgetDetails) String() string
CreateBudgetDetailsResetPeriodEnum is an alias to type: ResetPeriodEnum Consider using ResetPeriodEnum instead Deprecated
type CreateBudgetDetailsResetPeriodEnum = ResetPeriodEnum
CreateBudgetDetailsTargetTypeEnum is an alias to type: TargetTypeEnum Consider using TargetTypeEnum instead Deprecated
type CreateBudgetDetailsTargetTypeEnum = TargetTypeEnum
CreateBudgetRequest wrapper for the CreateBudget operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/CreateBudget.go.html to see an example of how to use 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 }
func (request CreateBudgetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBudgetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBudgetRequest) String() string
CreateBudgetResponse wrapper for the CreateBudget operation
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"` }
func (response CreateBudgetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBudgetResponse) String() string
DeleteAlertRuleRequest wrapper for the DeleteAlertRule operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/DeleteAlertRule.go.html to see an example of how to use 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 }
func (request DeleteAlertRuleRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAlertRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAlertRuleRequest) String() string
DeleteAlertRuleResponse wrapper for the DeleteAlertRule operation
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"` }
func (response DeleteAlertRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAlertRuleResponse) String() string
DeleteBudgetRequest wrapper for the DeleteBudget operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/DeleteBudget.go.html to see an example of how to use 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 }
func (request DeleteBudgetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBudgetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBudgetRequest) String() string
DeleteBudgetResponse wrapper for the DeleteBudget operation
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"` }
func (response DeleteBudgetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBudgetResponse) String() string
GetAlertRuleRequest wrapper for the GetAlertRule operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/GetAlertRule.go.html to see an example of how to use 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 }
func (request GetAlertRuleRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAlertRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAlertRuleRequest) String() string
GetAlertRuleResponse wrapper for the GetAlertRule operation
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"` }
func (response GetAlertRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAlertRuleResponse) String() string
GetBudgetRequest wrapper for the GetBudget operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/GetBudget.go.html to see an example of how to use 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 }
func (request GetBudgetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBudgetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBudgetRequest) String() string
GetBudgetResponse wrapper for the GetBudget operation
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"` }
func (response GetBudgetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBudgetResponse) String() string
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum Deprecated
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
const ( LifecycleStateActive LifecycleStateEnum = "ACTIVE" LifecycleStateInactive LifecycleStateEnum = "INACTIVE" )
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
ListAlertRulesLifecycleStateEnum Enum with underlying type: string
type ListAlertRulesLifecycleStateEnum string
Set of constants representing the allowable values for ListAlertRulesLifecycleStateEnum
const ( ListAlertRulesLifecycleStateActive ListAlertRulesLifecycleStateEnum = "ACTIVE" ListAlertRulesLifecycleStateInactive ListAlertRulesLifecycleStateEnum = "INACTIVE" )
func GetListAlertRulesLifecycleStateEnumValues() []ListAlertRulesLifecycleStateEnum
GetListAlertRulesLifecycleStateEnumValues Enumerates the set of values for ListAlertRulesLifecycleStateEnum
ListAlertRulesRequest wrapper for the ListAlertRules operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/ListAlertRules.go.html to see an example of how to use 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 }
func (request ListAlertRulesRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAlertRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAlertRulesRequest) String() string
ListAlertRulesResponse wrapper for the ListAlertRules operation
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"` }
func (response ListAlertRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAlertRulesResponse) String() string
ListAlertRulesSortByEnum Enum with underlying type: string
type ListAlertRulesSortByEnum string
Set of constants representing the allowable values for ListAlertRulesSortByEnum
const ( ListAlertRulesSortByTimecreated ListAlertRulesSortByEnum = "timeCreated" ListAlertRulesSortByDisplayname ListAlertRulesSortByEnum = "displayName" )
func GetListAlertRulesSortByEnumValues() []ListAlertRulesSortByEnum
GetListAlertRulesSortByEnumValues Enumerates the set of values for ListAlertRulesSortByEnum
ListAlertRulesSortOrderEnum Enum with underlying type: string
type ListAlertRulesSortOrderEnum string
Set of constants representing the allowable values for ListAlertRulesSortOrderEnum
const ( ListAlertRulesSortOrderAsc ListAlertRulesSortOrderEnum = "ASC" ListAlertRulesSortOrderDesc ListAlertRulesSortOrderEnum = "DESC" )
func GetListAlertRulesSortOrderEnumValues() []ListAlertRulesSortOrderEnum
GetListAlertRulesSortOrderEnumValues Enumerates the set of values for ListAlertRulesSortOrderEnum
ListBudgetsLifecycleStateEnum Enum with underlying type: string
type ListBudgetsLifecycleStateEnum string
Set of constants representing the allowable values for ListBudgetsLifecycleStateEnum
const ( ListBudgetsLifecycleStateActive ListBudgetsLifecycleStateEnum = "ACTIVE" ListBudgetsLifecycleStateInactive ListBudgetsLifecycleStateEnum = "INACTIVE" )
func GetListBudgetsLifecycleStateEnumValues() []ListBudgetsLifecycleStateEnum
GetListBudgetsLifecycleStateEnumValues Enumerates the set of values for ListBudgetsLifecycleStateEnum
ListBudgetsRequest wrapper for the ListBudgets operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/ListBudgets.go.html to see an example of how to use 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 }
func (request ListBudgetsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBudgetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBudgetsRequest) String() string
ListBudgetsResponse wrapper for the ListBudgets operation
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"` }
func (response ListBudgetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBudgetsResponse) String() string
ListBudgetsSortByEnum Enum with underlying type: string
type ListBudgetsSortByEnum string
Set of constants representing the allowable values for ListBudgetsSortByEnum
const ( ListBudgetsSortByTimecreated ListBudgetsSortByEnum = "timeCreated" ListBudgetsSortByDisplayname ListBudgetsSortByEnum = "displayName" )
func GetListBudgetsSortByEnumValues() []ListBudgetsSortByEnum
GetListBudgetsSortByEnumValues Enumerates the set of values for ListBudgetsSortByEnum
ListBudgetsSortOrderEnum Enum with underlying type: string
type ListBudgetsSortOrderEnum string
Set of constants representing the allowable values for ListBudgetsSortOrderEnum
const ( ListBudgetsSortOrderAsc ListBudgetsSortOrderEnum = "ASC" ListBudgetsSortOrderDesc ListBudgetsSortOrderEnum = "DESC" )
func GetListBudgetsSortOrderEnumValues() []ListBudgetsSortOrderEnum
GetListBudgetsSortOrderEnumValues Enumerates the set of values for ListBudgetsSortOrderEnum
ListBudgetsTargetTypeEnum Enum with underlying type: string
type ListBudgetsTargetTypeEnum string
Set of constants representing the allowable values for ListBudgetsTargetTypeEnum
const ( ListBudgetsTargetTypeAll ListBudgetsTargetTypeEnum = "ALL" ListBudgetsTargetTypeCompartment ListBudgetsTargetTypeEnum = "COMPARTMENT" ListBudgetsTargetTypeTag ListBudgetsTargetTypeEnum = "TAG" )
func GetListBudgetsTargetTypeEnumValues() []ListBudgetsTargetTypeEnum
GetListBudgetsTargetTypeEnumValues Enumerates the set of values for ListBudgetsTargetTypeEnum
ResetPeriodEnum Enum with underlying type: string
type ResetPeriodEnum string
Set of constants representing the allowable values for ResetPeriodEnum Deprecated
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
const ( ResetPeriodMonthly ResetPeriodEnum = "MONTHLY" )
Set of constants representing the allowable values for ResetPeriodEnum Deprecated
const ( UpdateBudgetDetailsResetPeriodMonthly ResetPeriodEnum = "MONTHLY" )
func GetResetPeriodEnumValues() []ResetPeriodEnum
GetResetPeriodEnumValues Enumerates the set of values for ResetPeriodEnum
SortByEnum Enum with underlying type: string
type SortByEnum string
Set of constants representing the allowable values for SortByEnum
const ( SortByTimeCreated SortByEnum = "timeCreated" SortByDisplayName SortByEnum = "displayName" )
func GetSortByEnumValues() []SortByEnum
GetSortByEnumValues Enumerates the set of values for SortByEnum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const ( SortOrderAsc SortOrderEnum = "ASC" SortOrderDesc SortOrderEnum = "DESC" )
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
TargetTypeEnum Enum with underlying type: string
type TargetTypeEnum string
Set of constants representing the allowable values for TargetTypeEnum Deprecated
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
const ( TargetTypeCompartment TargetTypeEnum = "COMPARTMENT" TargetTypeTag TargetTypeEnum = "TAG" )
func GetTargetTypeEnumValues() []TargetTypeEnum
GetTargetTypeEnumValues Enumerates the set of values for TargetTypeEnum
ThresholdTypeEnum Enum with underlying type: string
type ThresholdTypeEnum string
Set of constants representing the allowable values for ThresholdTypeEnum Deprecated
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
const ( ThresholdTypePercentage ThresholdTypeEnum = "PERCENTAGE" ThresholdTypeAbsolute ThresholdTypeEnum = "ABSOLUTE" )
Set of constants representing the allowable values for ThresholdTypeEnum Deprecated
const ( UpdateAlertRuleDetailsThresholdTypePercentage ThresholdTypeEnum = "PERCENTAGE" UpdateAlertRuleDetailsThresholdTypeAbsolute ThresholdTypeEnum = "ABSOLUTE" )
func GetThresholdTypeEnumValues() []ThresholdTypeEnum
GetThresholdTypeEnumValues Enumerates the set of values for ThresholdTypeEnum
UpdateAlertRuleDetails The update alert rule details.
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"` }
func (m UpdateAlertRuleDetails) String() string
UpdateAlertRuleDetailsThresholdTypeEnum is an alias to type: ThresholdTypeEnum Consider using ThresholdTypeEnum instead Deprecated
type UpdateAlertRuleDetailsThresholdTypeEnum = ThresholdTypeEnum
UpdateAlertRuleDetailsTypeEnum is an alias to type: AlertTypeEnum Consider using AlertTypeEnum instead Deprecated
type UpdateAlertRuleDetailsTypeEnum = AlertTypeEnum
UpdateAlertRuleRequest wrapper for the UpdateAlertRule operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/UpdateAlertRule.go.html to see an example of how to use 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 }
func (request UpdateAlertRuleRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAlertRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAlertRuleRequest) String() string
UpdateAlertRuleResponse wrapper for the UpdateAlertRule operation
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"` }
func (response UpdateAlertRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAlertRuleResponse) String() string
UpdateBudgetDetails The update budget details.
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 number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight. BudgetProcessingPeriodStartOffset *int `mandatory:"false" json:"budgetProcessingPeriodStartOffset"` // 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"` }
func (m UpdateBudgetDetails) String() string
UpdateBudgetDetailsResetPeriodEnum is an alias to type: ResetPeriodEnum Consider using ResetPeriodEnum instead Deprecated
type UpdateBudgetDetailsResetPeriodEnum = ResetPeriodEnum
UpdateBudgetRequest wrapper for the UpdateBudget operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/budget/UpdateBudget.go.html to see an example of how to use 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 }
func (request UpdateBudgetRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBudgetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBudgetRequest) String() string
UpdateBudgetResponse wrapper for the UpdateBudget operation
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"` }
func (response UpdateBudgetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBudgetResponse) String() string