▽

Package budget

Variables

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

func GetAlertTypeEnumStringValues ¶

func GetAlertTypeEnumStringValues() []string

GetAlertTypeEnumStringValues Enumerates the set of values in String for AlertTypeEnum

func GetLifecycleStateEnumStringValues ¶

func GetLifecycleStateEnumStringValues() []string

GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum

func GetListAlertRulesLifecycleStateEnumStringValues ¶

func GetListAlertRulesLifecycleStateEnumStringValues() []string

GetListAlertRulesLifecycleStateEnumStringValues Enumerates the set of values in String for ListAlertRulesLifecycleStateEnum

func GetListAlertRulesSortByEnumStringValues ¶

func GetListAlertRulesSortByEnumStringValues() []string

GetListAlertRulesSortByEnumStringValues Enumerates the set of values in String for ListAlertRulesSortByEnum

func GetListAlertRulesSortOrderEnumStringValues ¶

func GetListAlertRulesSortOrderEnumStringValues() []string

GetListAlertRulesSortOrderEnumStringValues Enumerates the set of values in String for ListAlertRulesSortOrderEnum

func GetListBudgetsLifecycleStateEnumStringValues ¶

func GetListBudgetsLifecycleStateEnumStringValues() []string

GetListBudgetsLifecycleStateEnumStringValues Enumerates the set of values in String for ListBudgetsLifecycleStateEnum

func GetListBudgetsSortByEnumStringValues ¶

func GetListBudgetsSortByEnumStringValues() []string

GetListBudgetsSortByEnumStringValues Enumerates the set of values in String for ListBudgetsSortByEnum

func GetListBudgetsSortOrderEnumStringValues ¶

func GetListBudgetsSortOrderEnumStringValues() []string

GetListBudgetsSortOrderEnumStringValues Enumerates the set of values in String for ListBudgetsSortOrderEnum

func GetListBudgetsTargetTypeEnumStringValues ¶

func GetListBudgetsTargetTypeEnumStringValues() []string

GetListBudgetsTargetTypeEnumStringValues Enumerates the set of values in String for ListBudgetsTargetTypeEnum

func GetProcessingPeriodTypeEnumStringValues ¶

func GetProcessingPeriodTypeEnumStringValues() []string

GetProcessingPeriodTypeEnumStringValues Enumerates the set of values in String for ProcessingPeriodTypeEnum

func GetResetPeriodEnumStringValues ¶

func GetResetPeriodEnumStringValues() []string

GetResetPeriodEnumStringValues Enumerates the set of values in String for ResetPeriodEnum

func GetSortByEnumStringValues ¶

func GetSortByEnumStringValues() []string

GetSortByEnumStringValues Enumerates the set of values in String for SortByEnum

func GetSortOrderEnumStringValues ¶

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetTargetTypeEnumStringValues ¶

func GetTargetTypeEnumStringValues() []string

GetTargetTypeEnumStringValues Enumerates the set of values in String for TargetTypeEnum

func GetThresholdTypeEnumStringValues ¶

func GetThresholdTypeEnumStringValues() []string

GetThresholdTypeEnumStringValues Enumerates the set of values in String for ThresholdTypeEnum

type AlertRule ¶

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. Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

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

    // The threshold for triggering the alert. If the 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 delimited list of email addresses to receive the alert when it triggers.
    // Delimiter characters can be a comma, space, TAB, or semicolon.
    Recipients *string `mandatory:"true" json:"recipients"`

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

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

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

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

    // The 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (AlertRule) String ¶

func (m AlertRule) String() string

func (AlertRule) ValidateEnumValue ¶

func (m AlertRule) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type AlertRuleLifecycleStateEnum ¶

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

type AlertRuleLifecycleStateEnum = LifecycleStateEnum

type AlertRuleSummary ¶

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. Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

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

    // The threshold for triggering the alert. If the 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 receives the alert when it triggers.
    Recipients *string `mandatory:"true" json:"recipients"`

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

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

    // The custom message that will be sent when the alert is triggered.
    Message *string `mandatory:"false" json:"message"`

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

    // The 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (AlertRuleSummary) String ¶

func (m AlertRuleSummary) String() string

func (AlertRuleSummary) ValidateEnumValue ¶

func (m AlertRuleSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type AlertRuleSummaryLifecycleStateEnum ¶

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

type AlertRuleSummaryLifecycleStateEnum = LifecycleStateEnum

type AlertRuleSummaryThresholdTypeEnum ¶

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

type AlertRuleSummaryThresholdTypeEnum = ThresholdTypeEnum

type AlertRuleSummaryTypeEnum ¶

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

type AlertRuleSummaryTypeEnum = AlertTypeEnum

type AlertRuleThresholdTypeEnum ¶

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

type AlertRuleThresholdTypeEnum = ThresholdTypeEnum

type AlertRuleTypeEnum ¶

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

type AlertRuleTypeEnum = AlertTypeEnum

type 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 ¶

func GetAlertTypeEnumValues() []AlertTypeEnum

GetAlertTypeEnumValues Enumerates the set of values for AlertTypeEnum

func GetMappingAlertTypeEnum ¶

func GetMappingAlertTypeEnum(val string) (AlertTypeEnum, bool)

GetMappingAlertTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type Budget ¶

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. Avoid entering confidential information.
    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"`

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

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

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

    // This is DEPRECATED. For backwards compatability, the property is populated when
    // the targetType is "COMPARTMENT", and targets contain the specific 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 budget processing period type. Valid values are INVOICE, MONTH, and SINGLE_USE.
    ProcessingPeriodType ProcessingPeriodTypeEnum `mandatory:"false" json:"processingPeriodType,omitempty"`

    // The date when the one-time budget begins. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
    StartDate *common.SDKTime `mandatory:"false" json:"startDate"`

    // The time when the one-time budget concludes. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
    EndDate *common.SDKTime `mandatory:"false" json:"endDate"`

    // 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 the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs.
    //   If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".
    Targets []string `mandatory:"false" json:"targets"`

    // The 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (Budget) String ¶

func (m Budget) String() string

func (Budget) ValidateEnumValue ¶

func (m Budget) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BudgetClient ¶

BudgetClient a client for Budget

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

func NewBudgetClientWithConfigurationProvider ¶

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

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

func NewBudgetClientWithOboToken ¶

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

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

as well as reading the region

func (*BudgetClient) ConfigurationProvider ¶

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

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

func (BudgetClient) CreateAlertRule ¶

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

CreateAlertRule Creates a new Alert Rule.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/budget/CreateAlertRule.go.html to see an example of how to use CreateAlertRule API. A default retry strategy applies to this operation CreateAlertRule()

func (BudgetClient) CreateBudget ¶

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

CreateBudget Creates a new budget.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/budget/CreateBudget.go.html to see an example of how to use CreateBudget API. A default retry strategy applies to this operation CreateBudget()

func (BudgetClient) DeleteAlertRule ¶

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

DeleteAlertRule Deletes a specified Alert Rule resource.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/budget/DeleteAlertRule.go.html to see an example of how to use DeleteAlertRule API. A default retry strategy applies to this operation DeleteAlertRule()

func (BudgetClient) DeleteBudget ¶

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

DeleteBudget Deletes a specified budget resource.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/budget/DeleteBudget.go.html to see an example of how to use DeleteBudget API. A default retry strategy applies to this operation DeleteBudget()

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.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/budget/GetAlertRule.go.html to see an example of how to use GetAlertRule API. A default retry strategy applies to this operation GetAlertRule()

func (BudgetClient) GetBudget ¶

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

GetBudget Gets a budget by the identifier.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/budget/GetBudget.go.html to see an example of how to use GetBudget API. A default retry strategy applies to this operation GetBudget()

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.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/budget/ListAlertRules.go.html to see an example of how to use ListAlertRules API. A default retry strategy applies to this operation ListAlertRules()

func (BudgetClient) ListBudgets ¶

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

ListBudgets Gets a list of budgets in a compartment. By default, ListBudgets returns budgets of the 'COMPARTMENT' target type, and the budget records with only one target compartment OCID. To list all budgets, set the targetType query parameter to ALL (for example: 'targetType=ALL'). Clients should ignore new targetTypes, or upgrade to the latest version of the client SDK to handle new targetTypes.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/budget/ListBudgets.go.html to see an example of how to use ListBudgets API. A default retry strategy applies to this operation ListBudgets()

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.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/budget/UpdateAlertRule.go.html to see an example of how to use UpdateAlertRule API. A default retry strategy applies to this operation UpdateAlertRule()

func (BudgetClient) UpdateBudget ¶

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

UpdateBudget Update a budget identified by the OCID.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/budget/UpdateBudget.go.html to see an example of how to use UpdateBudget API. A default retry strategy applies to this operation UpdateBudget()

type BudgetLifecycleStateEnum ¶

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

type BudgetLifecycleStateEnum = LifecycleStateEnum

type BudgetResetPeriodEnum ¶

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

type BudgetResetPeriodEnum = ResetPeriodEnum

type BudgetSummary ¶

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. Avoid entering confidential information.
    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"`

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

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

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

    // This is DEPRECATED. For backwards compatability, the property is populated when
    // the targetType is "COMPARTMENT", and the targets contain the specific target compartment OCID.
    // For all other scenarios, this property is 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 the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE.
    ProcessingPeriodType ProcessingPeriodTypeEnum `mandatory:"false" json:"processingPeriodType,omitempty"`

    // The date when the one-time budget begins. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
    StartDate *common.SDKTime `mandatory:"false" json:"startDate"`

    // The time when the one-time budget concludes. For example, - `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
    EndDate *common.SDKTime `mandatory:"false" json:"endDate"`

    // 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 the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs.
    //   If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".
    Targets []string `mandatory:"false" json:"targets"`

    // The 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 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (BudgetSummary) String ¶

func (m BudgetSummary) String() string

func (BudgetSummary) ValidateEnumValue ¶

func (m BudgetSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BudgetSummaryLifecycleStateEnum ¶

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

type BudgetSummaryLifecycleStateEnum = LifecycleStateEnum

type BudgetSummaryResetPeriodEnum ¶

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

type BudgetSummaryResetPeriodEnum = ResetPeriodEnum

type BudgetSummaryTargetTypeEnum ¶

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

type BudgetSummaryTargetTypeEnum = TargetTypeEnum

type BudgetTargetTypeEnum ¶

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

type BudgetTargetTypeEnum = TargetTypeEnum

type CreateAlertRuleDetails ¶

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

type CreateAlertRuleDetails struct {

    // The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or
    // FORECAST (the alert triggers 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 the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point.
    // If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two 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. Avoid entering confidential information.
    DisplayName *string `mandatory:"false" json:"displayName"`

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

    // The audience that receives 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 the 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateAlertRuleDetails) String ¶

func (m CreateAlertRuleDetails) String() string

func (CreateAlertRuleDetails) ValidateEnumValue ¶

func (m CreateAlertRuleDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateAlertRuleDetailsThresholdTypeEnum ¶

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

type CreateAlertRuleDetailsThresholdTypeEnum = ThresholdTypeEnum

type CreateAlertRuleDetailsTypeEnum ¶

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

type CreateAlertRuleDetailsTypeEnum = AlertTypeEnum

type CreateAlertRuleRequest ¶

CreateAlertRuleRequest wrapper for the CreateAlertRule operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 (CreateAlertRuleRequest) BinaryRequestBody ¶

func (request CreateAlertRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateAlertRuleRequest) HTTPRequest ¶

func (request CreateAlertRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (CreateAlertRuleRequest) ValidateEnumValue ¶

func (request CreateAlertRuleRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateAlertRuleResponse ¶

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 (CreateAlertRuleResponse) HTTPResponse ¶

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

HTTPResponse implements the OCIResponse interface

func (CreateAlertRuleResponse) String ¶

func (response CreateAlertRuleResponse) String() string

type CreateBudgetDetails ¶

CreateBudgetDetails The create budget details. Clients should use 'targetType' and 'targets' to specify the target type and list of targets on which the budget is applied. For backwards compatibility, 'targetCompartmentId' is still supported for all existing clients. This is considered deprecated, however, and all clients are upgraded to use 'targetType' and 'targets'. Specifying both 'targetCompartmentId' and 'targets' causes 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 DEPRECATED. Set the target compartment ID in targets instead.
    TargetCompartmentId *string `mandatory:"false" json:"targetCompartmentId"`

    // The displayName of the budget. Avoid entering confidential information.
    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 the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE.
    ProcessingPeriodType ProcessingPeriodTypeEnum `mandatory:"false" json:"processingPeriodType,omitempty"`

    // The date when the one-time budget begins. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
    StartDate *common.SDKTime `mandatory:"false" json:"startDate"`

    // The date when the one-time budget concludes. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
    EndDate *common.SDKTime `mandatory:"false" json:"endDate"`

    // 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", the targets contain the list of compartment OCIDs.
    //   If targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".
    // Curerntly, the array should contain exactly 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateBudgetDetails) String ¶

func (m CreateBudgetDetails) String() string

func (CreateBudgetDetails) ValidateEnumValue ¶

func (m CreateBudgetDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBudgetDetailsResetPeriodEnum ¶

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

type CreateBudgetDetailsResetPeriodEnum = ResetPeriodEnum

type CreateBudgetDetailsTargetTypeEnum ¶

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

type CreateBudgetDetailsTargetTypeEnum = TargetTypeEnum

type CreateBudgetRequest ¶

CreateBudgetRequest wrapper for the CreateBudget operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 (CreateBudgetRequest) BinaryRequestBody ¶

func (request CreateBudgetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateBudgetRequest) HTTPRequest ¶

func (request CreateBudgetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (CreateBudgetRequest) ValidateEnumValue ¶

func (request CreateBudgetRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBudgetResponse ¶

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 (CreateBudgetResponse) HTTPResponse ¶

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

HTTPResponse implements the OCIResponse interface

func (CreateBudgetResponse) String ¶

func (response CreateBudgetResponse) String() string

type DeleteAlertRuleRequest ¶

DeleteAlertRuleRequest wrapper for the DeleteAlertRule operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 (DeleteAlertRuleRequest) BinaryRequestBody ¶

func (request DeleteAlertRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteAlertRuleRequest) HTTPRequest ¶

func (request DeleteAlertRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (DeleteAlertRuleRequest) ValidateEnumValue ¶

func (request DeleteAlertRuleRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteAlertRuleResponse ¶

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 (DeleteAlertRuleResponse) HTTPResponse ¶

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

HTTPResponse implements the OCIResponse interface

func (DeleteAlertRuleResponse) String ¶

func (response DeleteAlertRuleResponse) String() string

type DeleteBudgetRequest ¶

DeleteBudgetRequest wrapper for the DeleteBudget operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 (DeleteBudgetRequest) BinaryRequestBody ¶

func (request DeleteBudgetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteBudgetRequest) HTTPRequest ¶

func (request DeleteBudgetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (DeleteBudgetRequest) ValidateEnumValue ¶

func (request DeleteBudgetRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteBudgetResponse ¶

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 (DeleteBudgetResponse) HTTPResponse ¶

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

HTTPResponse implements the OCIResponse interface

func (DeleteBudgetResponse) String ¶

func (response DeleteBudgetResponse) String() string

type GetAlertRuleRequest ¶

GetAlertRuleRequest wrapper for the GetAlertRule operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 (GetAlertRuleRequest) BinaryRequestBody ¶

func (request GetAlertRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetAlertRuleRequest) HTTPRequest ¶

func (request GetAlertRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (GetAlertRuleRequest) ValidateEnumValue ¶

func (request GetAlertRuleRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetAlertRuleResponse ¶

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 (GetAlertRuleResponse) HTTPResponse ¶

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

HTTPResponse implements the OCIResponse interface

func (GetAlertRuleResponse) String ¶

func (response GetAlertRuleResponse) String() string

type GetBudgetRequest ¶

GetBudgetRequest wrapper for the GetBudget operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 (GetBudgetRequest) BinaryRequestBody ¶

func (request GetBudgetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetBudgetRequest) HTTPRequest ¶

func (request GetBudgetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (GetBudgetRequest) ValidateEnumValue ¶

func (request GetBudgetRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetBudgetResponse ¶

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 (GetBudgetResponse) HTTPResponse ¶

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

HTTPResponse implements the OCIResponse interface

func (GetBudgetResponse) String ¶

func (response GetBudgetResponse) String() string

type LifecycleStateEnum ¶

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 ¶

func GetLifecycleStateEnumValues() []LifecycleStateEnum

GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum

func GetMappingLifecycleStateEnum ¶

func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)

GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAlertRulesLifecycleStateEnum ¶

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 ¶

func GetListAlertRulesLifecycleStateEnumValues() []ListAlertRulesLifecycleStateEnum

GetListAlertRulesLifecycleStateEnumValues Enumerates the set of values for ListAlertRulesLifecycleStateEnum

func GetMappingListAlertRulesLifecycleStateEnum ¶

func GetMappingListAlertRulesLifecycleStateEnum(val string) (ListAlertRulesLifecycleStateEnum, bool)

GetMappingListAlertRulesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAlertRulesRequest ¶

ListAlertRulesRequest wrapper for the ListAlertRules operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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. This 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 (ListAlertRulesRequest) BinaryRequestBody ¶

func (request ListAlertRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAlertRulesRequest) HTTPRequest ¶

func (request ListAlertRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ListAlertRulesRequest) ValidateEnumValue ¶

func (request ListAlertRulesRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListAlertRulesResponse ¶

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`. 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 (ListAlertRulesResponse) HTTPResponse ¶

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

HTTPResponse implements the OCIResponse interface

func (ListAlertRulesResponse) String ¶

func (response ListAlertRulesResponse) String() string

type ListAlertRulesSortByEnum ¶

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 ¶

func GetListAlertRulesSortByEnumValues() []ListAlertRulesSortByEnum

GetListAlertRulesSortByEnumValues Enumerates the set of values for ListAlertRulesSortByEnum

func GetMappingListAlertRulesSortByEnum ¶

func GetMappingListAlertRulesSortByEnum(val string) (ListAlertRulesSortByEnum, bool)

GetMappingListAlertRulesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAlertRulesSortOrderEnum ¶

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 ¶

func GetListAlertRulesSortOrderEnumValues() []ListAlertRulesSortOrderEnum

GetListAlertRulesSortOrderEnumValues Enumerates the set of values for ListAlertRulesSortOrderEnum

func GetMappingListAlertRulesSortOrderEnum ¶

func GetMappingListAlertRulesSortOrderEnum(val string) (ListAlertRulesSortOrderEnum, bool)

GetMappingListAlertRulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBudgetsLifecycleStateEnum ¶

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 ¶

func GetListBudgetsLifecycleStateEnumValues() []ListBudgetsLifecycleStateEnum

GetListBudgetsLifecycleStateEnumValues Enumerates the set of values for ListBudgetsLifecycleStateEnum

func GetMappingListBudgetsLifecycleStateEnum ¶

func GetMappingListBudgetsLifecycleStateEnum(val string) (ListBudgetsLifecycleStateEnum, bool)

GetMappingListBudgetsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBudgetsRequest ¶

ListBudgetsRequest wrapper for the ListBudgets operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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. This 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 (ListBudgetsRequest) BinaryRequestBody ¶

func (request ListBudgetsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBudgetsRequest) HTTPRequest ¶

func (request ListBudgetsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ListBudgetsRequest) ValidateEnumValue ¶

func (request ListBudgetsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListBudgetsResponse ¶

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 (ListBudgetsResponse) HTTPResponse ¶

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

HTTPResponse implements the OCIResponse interface

func (ListBudgetsResponse) String ¶

func (response ListBudgetsResponse) String() string

type ListBudgetsSortByEnum ¶

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 ¶

func GetListBudgetsSortByEnumValues() []ListBudgetsSortByEnum

GetListBudgetsSortByEnumValues Enumerates the set of values for ListBudgetsSortByEnum

func GetMappingListBudgetsSortByEnum ¶

func GetMappingListBudgetsSortByEnum(val string) (ListBudgetsSortByEnum, bool)

GetMappingListBudgetsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBudgetsSortOrderEnum ¶

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 ¶

func GetListBudgetsSortOrderEnumValues() []ListBudgetsSortOrderEnum

GetListBudgetsSortOrderEnumValues Enumerates the set of values for ListBudgetsSortOrderEnum

func GetMappingListBudgetsSortOrderEnum ¶

func GetMappingListBudgetsSortOrderEnum(val string) (ListBudgetsSortOrderEnum, bool)

GetMappingListBudgetsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBudgetsTargetTypeEnum ¶

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 ¶

func GetListBudgetsTargetTypeEnumValues() []ListBudgetsTargetTypeEnum

GetListBudgetsTargetTypeEnumValues Enumerates the set of values for ListBudgetsTargetTypeEnum

func GetMappingListBudgetsTargetTypeEnum ¶

func GetMappingListBudgetsTargetTypeEnum(val string) (ListBudgetsTargetTypeEnum, bool)

GetMappingListBudgetsTargetTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ProcessingPeriodTypeEnum ¶

ProcessingPeriodTypeEnum Enum with underlying type: string

type ProcessingPeriodTypeEnum string

Set of constants representing the allowable values for ProcessingPeriodTypeEnum

const (
    ProcessingPeriodTypeInvoice   ProcessingPeriodTypeEnum = "INVOICE"
    ProcessingPeriodTypeMonth     ProcessingPeriodTypeEnum = "MONTH"
    ProcessingPeriodTypeSingleUse ProcessingPeriodTypeEnum = "SINGLE_USE"
)

func GetMappingProcessingPeriodTypeEnum ¶

func GetMappingProcessingPeriodTypeEnum(val string) (ProcessingPeriodTypeEnum, bool)

GetMappingProcessingPeriodTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetProcessingPeriodTypeEnumValues ¶

func GetProcessingPeriodTypeEnumValues() []ProcessingPeriodTypeEnum

GetProcessingPeriodTypeEnumValues Enumerates the set of values for ProcessingPeriodTypeEnum

type ResetPeriodEnum ¶

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 GetMappingResetPeriodEnum ¶

func GetMappingResetPeriodEnum(val string) (ResetPeriodEnum, bool)

GetMappingResetPeriodEnum performs case Insensitive comparison on enum value and return the desired enum

func GetResetPeriodEnumValues ¶

func GetResetPeriodEnumValues() []ResetPeriodEnum

GetResetPeriodEnumValues Enumerates the set of values for ResetPeriodEnum

type SortByEnum ¶

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 GetMappingSortByEnum ¶

func GetMappingSortByEnum(val string) (SortByEnum, bool)

GetMappingSortByEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortByEnumValues ¶

func GetSortByEnumValues() []SortByEnum

GetSortByEnumValues Enumerates the set of values for SortByEnum

type SortOrderEnum ¶

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 GetMappingSortOrderEnum ¶

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortOrderEnumValues ¶

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type TargetTypeEnum ¶

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 GetMappingTargetTypeEnum ¶

func GetMappingTargetTypeEnum(val string) (TargetTypeEnum, bool)

GetMappingTargetTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTargetTypeEnumValues ¶

func GetTargetTypeEnumValues() []TargetTypeEnum

GetTargetTypeEnumValues Enumerates the set of values for TargetTypeEnum

type ThresholdTypeEnum ¶

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 GetMappingThresholdTypeEnum ¶

func GetMappingThresholdTypeEnum(val string) (ThresholdTypeEnum, bool)

GetMappingThresholdTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetThresholdTypeEnumValues ¶

func GetThresholdTypeEnumValues() []ThresholdTypeEnum

GetThresholdTypeEnumValues Enumerates the set of values for ThresholdTypeEnum

type UpdateAlertRuleDetails ¶

UpdateAlertRuleDetails The update alert rule details.

type UpdateAlertRuleDetails struct {

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

    // The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or
    // FORECAST (the alert triggers 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 the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point.
    // If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two 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 receives the alert when it triggers. If you need to clear out this value, pass in an empty string instead of a null value.
    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 an 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateAlertRuleDetails) String ¶

func (m UpdateAlertRuleDetails) String() string

func (UpdateAlertRuleDetails) ValidateEnumValue ¶

func (m UpdateAlertRuleDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateAlertRuleDetailsThresholdTypeEnum ¶

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

type UpdateAlertRuleDetailsThresholdTypeEnum = ThresholdTypeEnum

type UpdateAlertRuleDetailsTypeEnum ¶

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

type UpdateAlertRuleDetailsTypeEnum = AlertTypeEnum

type UpdateAlertRuleRequest ¶

UpdateAlertRuleRequest wrapper for the UpdateAlertRule operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 (UpdateAlertRuleRequest) BinaryRequestBody ¶

func (request UpdateAlertRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateAlertRuleRequest) HTTPRequest ¶

func (request UpdateAlertRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (UpdateAlertRuleRequest) ValidateEnumValue ¶

func (request UpdateAlertRuleRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateAlertRuleResponse ¶

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 (UpdateAlertRuleResponse) HTTPResponse ¶

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

HTTPResponse implements the OCIResponse interface

func (UpdateAlertRuleResponse) String ¶

func (response UpdateAlertRuleResponse) String() string

type UpdateBudgetDetails ¶

UpdateBudgetDetails The update budget details.

type UpdateBudgetDetails struct {

    // The displayName of the budget. Avoid entering confidential information.
    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 type of the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE.
    ProcessingPeriodType ProcessingPeriodTypeEnum `mandatory:"false" json:"processingPeriodType,omitempty"`

    // The date when the one-time budget begins. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
    StartDate *common.SDKTime `mandatory:"false" json:"startDate"`

    // The time when the one-time budget concludes. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
    EndDate *common.SDKTime `mandatory:"false" json:"endDate"`

    // 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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateBudgetDetails) String ¶

func (m UpdateBudgetDetails) String() string

func (UpdateBudgetDetails) ValidateEnumValue ¶

func (m UpdateBudgetDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateBudgetDetailsResetPeriodEnum ¶

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

type UpdateBudgetDetailsResetPeriodEnum = ResetPeriodEnum

type UpdateBudgetRequest ¶

UpdateBudgetRequest wrapper for the UpdateBudget operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 (UpdateBudgetRequest) BinaryRequestBody ¶

func (request UpdateBudgetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateBudgetRequest) HTTPRequest ¶

func (request UpdateBudgetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (UpdateBudgetRequest) ValidateEnumValue ¶

func (request UpdateBudgetRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateBudgetResponse ¶

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 (UpdateBudgetResponse) HTTPResponse ¶

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

HTTPResponse implements the OCIResponse interface

func (UpdateBudgetResponse) String ¶

func (response UpdateBudgetResponse) String() string