func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetImportanceEnumStringValues() []string
GetImportanceEnumStringValues Enumerates the set of values in String for ImportanceEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetListCategoriesLifecycleStateEnumStringValues() []string
GetListCategoriesLifecycleStateEnumStringValues Enumerates the set of values in String for ListCategoriesLifecycleStateEnum
func GetListCategoriesSortByEnumStringValues() []string
GetListCategoriesSortByEnumStringValues Enumerates the set of values in String for ListCategoriesSortByEnum
func GetListCategoriesSortOrderEnumStringValues() []string
GetListCategoriesSortOrderEnumStringValues Enumerates the set of values in String for ListCategoriesSortOrderEnum
func GetListEnrollmentStatusesLifecycleStateEnumStringValues() []string
GetListEnrollmentStatusesLifecycleStateEnumStringValues Enumerates the set of values in String for ListEnrollmentStatusesLifecycleStateEnum
func GetListEnrollmentStatusesSortByEnumStringValues() []string
GetListEnrollmentStatusesSortByEnumStringValues Enumerates the set of values in String for ListEnrollmentStatusesSortByEnum
func GetListEnrollmentStatusesSortOrderEnumStringValues() []string
GetListEnrollmentStatusesSortOrderEnumStringValues Enumerates the set of values in String for ListEnrollmentStatusesSortOrderEnum
func GetListEnrollmentStatusesStatusEnumStringValues() []string
GetListEnrollmentStatusesStatusEnumStringValues Enumerates the set of values in String for ListEnrollmentStatusesStatusEnum
func GetListHistoriesLifecycleStateEnumStringValues() []string
GetListHistoriesLifecycleStateEnumStringValues Enumerates the set of values in String for ListHistoriesLifecycleStateEnum
func GetListHistoriesSortByEnumStringValues() []string
GetListHistoriesSortByEnumStringValues Enumerates the set of values in String for ListHistoriesSortByEnum
func GetListHistoriesSortOrderEnumStringValues() []string
GetListHistoriesSortOrderEnumStringValues Enumerates the set of values in String for ListHistoriesSortOrderEnum
func GetListHistoriesStatusEnumStringValues() []string
GetListHistoriesStatusEnumStringValues Enumerates the set of values in String for ListHistoriesStatusEnum
func GetListProfileLevelsSortByEnumStringValues() []string
GetListProfileLevelsSortByEnumStringValues Enumerates the set of values in String for ListProfileLevelsSortByEnum
func GetListProfileLevelsSortOrderEnumStringValues() []string
GetListProfileLevelsSortOrderEnumStringValues Enumerates the set of values in String for ListProfileLevelsSortOrderEnum
func GetListProfilesLifecycleStateEnumStringValues() []string
GetListProfilesLifecycleStateEnumStringValues Enumerates the set of values in String for ListProfilesLifecycleStateEnum
func GetListProfilesSortByEnumStringValues() []string
GetListProfilesSortByEnumStringValues Enumerates the set of values in String for ListProfilesSortByEnum
func GetListProfilesSortOrderEnumStringValues() []string
GetListProfilesSortOrderEnumStringValues Enumerates the set of values in String for ListProfilesSortOrderEnum
func GetListRecommendationStrategiesSortByEnumStringValues() []string
GetListRecommendationStrategiesSortByEnumStringValues Enumerates the set of values in String for ListRecommendationStrategiesSortByEnum
func GetListRecommendationStrategiesSortOrderEnumStringValues() []string
GetListRecommendationStrategiesSortOrderEnumStringValues Enumerates the set of values in String for ListRecommendationStrategiesSortOrderEnum
func GetListRecommendationsLifecycleStateEnumStringValues() []string
GetListRecommendationsLifecycleStateEnumStringValues Enumerates the set of values in String for ListRecommendationsLifecycleStateEnum
func GetListRecommendationsSortByEnumStringValues() []string
GetListRecommendationsSortByEnumStringValues Enumerates the set of values in String for ListRecommendationsSortByEnum
func GetListRecommendationsSortOrderEnumStringValues() []string
GetListRecommendationsSortOrderEnumStringValues Enumerates the set of values in String for ListRecommendationsSortOrderEnum
func GetListRecommendationsStatusEnumStringValues() []string
GetListRecommendationsStatusEnumStringValues Enumerates the set of values in String for ListRecommendationsStatusEnum
func GetListResourceActionsLifecycleStateEnumStringValues() []string
GetListResourceActionsLifecycleStateEnumStringValues Enumerates the set of values in String for ListResourceActionsLifecycleStateEnum
func GetListResourceActionsSortByEnumStringValues() []string
GetListResourceActionsSortByEnumStringValues Enumerates the set of values in String for ListResourceActionsSortByEnum
func GetListResourceActionsSortOrderEnumStringValues() []string
GetListResourceActionsSortOrderEnumStringValues Enumerates the set of values in String for ListResourceActionsSortOrderEnum
func GetListResourceActionsStatusEnumStringValues() []string
GetListResourceActionsStatusEnumStringValues Enumerates the set of values in String for ListResourceActionsStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetOptimizerEnrollmentStatusEnumStringValues() []string
GetOptimizerEnrollmentStatusEnumStringValues Enumerates the set of values in String for OptimizerEnrollmentStatusEnum
func GetQueryableFieldSummaryFieldTypeEnumStringValues() []string
GetQueryableFieldSummaryFieldTypeEnumStringValues Enumerates the set of values in String for QueryableFieldSummaryFieldTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetStatusEnumStringValues() []string
GetStatusEnumStringValues Enumerates the set of values in String for StatusEnum
func GetStrategyParameterTypeEnumStringValues() []string
GetStrategyParameterTypeEnumStringValues Enumerates the set of values in String for StrategyParameterTypeEnum
func GetTagValueTypeEnumStringValues() []string
GetTagValueTypeEnumStringValues Enumerates the set of values in String for TagValueTypeEnum
func GetWorkRequestActionTypeEnumStringValues() []string
GetWorkRequestActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestActionTypeEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
Action Details about the recommended action.
type Action struct {
// The status of the resource action.
Type ActionTypeEnum `mandatory:"true" json:"type"`
// Text describing the recommended action.
Description *string `mandatory:"true" json:"description"`
// The URL path to documentation that explains how to perform the action.
Url *string `mandatory:"true" json:"url"`
}
func (m Action) String() string
func (m Action) 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
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeKbArticle ActionTypeEnum = "KB_ARTICLE"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BulkApplyRecommendationsDetails Details about bulk recommendation actions.
type BulkApplyRecommendationsDetails struct {
// The current status of the recommendation.
Status StatusEnum `mandatory:"true" json:"status"`
// The unique OCIDs of the resource actions that recommendations are applied to.
// This field is deprecated.
ResourceActionIds []string `mandatory:"false" json:"resourceActionIds"`
// The unique resource actions that recommendations are applied to.
Actions []BulkApplyResourceAction `mandatory:"false" json:"actions"`
// The date and time the current status will change. The format is defined by RFC3339.
// For example, "The current `postponed` status of the resource action will end and change to `pending` on this
// date and time."
TimeStatusEnd *common.SDKTime `mandatory:"false" json:"timeStatusEnd"`
}
func (m BulkApplyRecommendationsDetails) String() string
func (m BulkApplyRecommendationsDetails) 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
BulkApplyRecommendationsRequest wrapper for the BulkApplyRecommendations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/BulkApplyRecommendations.go.html to see an example of how to use BulkApplyRecommendationsRequest.
type BulkApplyRecommendationsRequest struct {
// The unique OCID associated with the recommendation.
RecommendationId *string `mandatory:"true" contributesTo:"path" name:"recommendationId"`
// Details about bulk recommendation actions.
BulkApplyRecommendationsDetails `contributesTo:"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 `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request BulkApplyRecommendationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BulkApplyRecommendationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BulkApplyRecommendationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BulkApplyRecommendationsRequest) String() string
func (request BulkApplyRecommendationsRequest) 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
BulkApplyRecommendationsResponse wrapper for the BulkApplyRecommendations operation
type BulkApplyRecommendationsResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request.
// You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response BulkApplyRecommendationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BulkApplyRecommendationsResponse) String() string
BulkApplyResourceAction The resource action that a recommendation will be applied to.
type BulkApplyResourceAction struct {
// The unique OCIDs of the resource actions that recommendations are applied to.
ResourceActionId *string `mandatory:"true" json:"resourceActionId"`
// The current status of the recommendation.
Status StatusEnum `mandatory:"false" json:"status,omitempty"`
// The date and time the current status will change. The format is defined by RFC3339.
// For example, "The current `postponed` status of the resource action will end and change to `pending` on this
// date and time."
TimeStatusEnd *common.SDKTime `mandatory:"false" json:"timeStatusEnd"`
// Additional parameter key-value pairs defining the resource action.
// For example:
// `{"timeAmount": 15, "timeUnit": "seconds"}`
Parameters map[string]interface{} `mandatory:"false" json:"parameters"`
// The name of the strategy.
StrategyName *string `mandatory:"false" json:"strategyName"`
}
func (m BulkApplyResourceAction) String() string
func (m BulkApplyResourceAction) 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
Category The metadata associated with the category.
type Category struct {
// The unique OCID of the category.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy. The tenancy is the root compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name associated with the compartment.
CompartmentName *string `mandatory:"true" json:"compartmentName"`
// The name assigned to the category.
Name *string `mandatory:"true" json:"name"`
// Text describing the category.
Description *string `mandatory:"true" json:"description"`
// An array of `RecommendationCount` objects grouped by the level of importance assigned to the recommendation.
RecommendationCounts []RecommendationCount `mandatory:"true" json:"recommendationCounts"`
// An array of `ResourceCount` objects grouped by the status of the recommendation.
ResourceCounts []ResourceCount `mandatory:"true" json:"resourceCounts"`
// The category's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The estimated cost savings, in dollars, for the category.
EstimatedCostSaving *float64 `mandatory:"true" json:"estimatedCostSaving"`
// The date and time the category details were created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the category details were last updated, in the format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Additional metadata key/value pairs for the category.
// For example:
// `{"EstimatedSaving": "200"}`
ExtendedMetadata map[string]string `mandatory:"false" json:"extendedMetadata"`
}
func (m Category) String() string
func (m Category) 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
CategoryCollection A list of categories that match filter criteria, if any. Results contain `CategorySummary` objects.
type CategoryCollection struct {
// A collection of category summaries.
Items []CategorySummary `mandatory:"true" json:"items"`
}
func (m CategoryCollection) String() string
func (m CategoryCollection) 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
CategorySummary The metadata associated with the category summary.
type CategorySummary struct {
// The unique OCID of the category.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy. The tenancy is the root compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name associated with the compartment.
CompartmentName *string `mandatory:"true" json:"compartmentName"`
// The name assigned to the category.
Name *string `mandatory:"true" json:"name"`
// Text describing the category.
Description *string `mandatory:"true" json:"description"`
// An array of `RecommendationCount` objects grouped by the level of importance assigned to each recommendation.
RecommendationCounts []RecommendationCount `mandatory:"true" json:"recommendationCounts"`
// An array of `ResourceCount` objects grouped by the status of each recommendation.
ResourceCounts []ResourceCount `mandatory:"true" json:"resourceCounts"`
// The category's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The estimated cost savings, in dollars, for the category.
EstimatedCostSaving *float64 `mandatory:"true" json:"estimatedCostSaving"`
// The date and time the category details were created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the category details were last updated, in the format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Additional metadata key/value pairs for the category summary.
// For example:
// `{"EstimatedSaving": "200"}`
ExtendedMetadata map[string]string `mandatory:"false" json:"extendedMetadata"`
}
func (m CategorySummary) String() string
func (m CategorySummary) 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
CreateProfileDetails Details for creating a profile.
type CreateProfileDetails struct {
// The OCID of the tenancy. The tenancy is the root compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name assigned to the profile. Avoid entering confidential information.
Name *string `mandatory:"true" json:"name"`
// Text describing the profile. Avoid entering confidential information.
Description *string `mandatory:"true" json:"description"`
LevelsConfiguration *LevelsConfiguration `mandatory:"true" json:"levelsConfiguration"`
// The time period over which to collect data for the recommendations, measured in number of days.
AggregationIntervalInDays *int `mandatory:"false" json:"aggregationIntervalInDays"`
// 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: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Simple key-value pair applied without any predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
TargetCompartments *TargetCompartments `mandatory:"false" json:"targetCompartments"`
TargetTags *TargetTags `mandatory:"false" json:"targetTags"`
}
func (m CreateProfileDetails) String() string
func (m CreateProfileDetails) 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
CreateProfileRequest wrapper for the CreateProfile operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/CreateProfile.go.html to see an example of how to use CreateProfileRequest.
type CreateProfileRequest struct {
// Details for creating the profile.
CreateProfileDetails `contributesTo:"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 `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateProfileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateProfileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateProfileRequest) String() string
func (request CreateProfileRequest) 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
CreateProfileResponse wrapper for the CreateProfile operation
type CreateProfileResponse struct {
// The underlying http response
RawResponse *http.Response
// The Profile instance
Profile `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateProfileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateProfileResponse) String() string
DeleteProfileRequest wrapper for the DeleteProfile operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/DeleteProfile.go.html to see an example of how to use DeleteProfileRequest.
type DeleteProfileRequest struct {
// The unique OCID of the profile.
ProfileId *string `mandatory:"true" contributesTo:"path" name:"profileId"`
// 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"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteProfileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteProfileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteProfileRequest) String() string
func (request DeleteProfileRequest) 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
DeleteProfileResponse wrapper for the DeleteProfile operation
type DeleteProfileResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteProfileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteProfileResponse) String() string
EnrollmentStatus The metadata associated with the enrollment status.
type EnrollmentStatus struct {
// The OCID of the enrollment status.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The enrollment status' current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The current Cloud Advisor enrollment status.
Status OptimizerEnrollmentStatusEnum `mandatory:"true" json:"status"`
// The reason for the enrollment status of the tenancy.
StatusReason *string `mandatory:"false" json:"statusReason"`
// The date and time the enrollment status was created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the enrollment status was last updated, in the format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m EnrollmentStatus) String() string
func (m EnrollmentStatus) 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
EnrollmentStatusCollection A list of enrollment statuses that match filter criteria, if any. Results contain `EnrollmentStatusSummary` objects.
type EnrollmentStatusCollection struct {
// A collection of enrollment status summaries.
Items []EnrollmentStatusSummary `mandatory:"true" json:"items"`
}
func (m EnrollmentStatusCollection) String() string
func (m EnrollmentStatusCollection) 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
EnrollmentStatusSummary The metadata associated with the enrollment status summary.
type EnrollmentStatusSummary struct {
// The OCID of the enrollment status.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The enrollment status' current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The current Cloud Advisor enrollment status.
Status OptimizerEnrollmentStatusEnum `mandatory:"true" json:"status"`
// The reason for the enrollment status of the tenancy.
StatusReason *string `mandatory:"false" json:"statusReason"`
// The date and time the enrollment status was created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the enrollment status was last updated, in the format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m EnrollmentStatusSummary) String() string
func (m EnrollmentStatusSummary) 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
EvaluatedMetric One of the metrics that will be evaluated by profiles using this profile level.
type EvaluatedMetric struct {
// The name of the metric (e.g., `CpuUtilization`).
Name *string `mandatory:"true" json:"name"`
// The name of the statistic (e.g., `p95`).
Statistic *string `mandatory:"true" json:"statistic"`
// The threshold that must be crossed for the recommendation to appear.
Threshold *float64 `mandatory:"true" json:"threshold"`
// Optional. The metric value that the recommendation will target.
Target *float64 `mandatory:"false" json:"target"`
}
func (m EvaluatedMetric) String() string
func (m EvaluatedMetric) 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
FilterResourceActionsRequest wrapper for the FilterResourceActions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/FilterResourceActions.go.html to see an example of how to use FilterResourceActionsRequest.
type FilterResourceActionsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.
// Can only be set to true when performing ListCompartments on the tenancy (root compartment).
CompartmentIdInSubtree *bool `mandatory:"true" contributesTo:"query" name:"compartmentIdInSubtree"`
// The request parameters that describe the query criteria.
QueryDetails `contributesTo:"body"`
// The unique OCID associated with the recommendation.
RecommendationId *string `mandatory:"false" contributesTo:"query" name:"recommendationId"`
// Optional. A filter that returns results that match the recommendation name specified.
RecommendationName *string `mandatory:"false" contributesTo:"query" name:"recommendationName"`
// A list of child tenancies for which the respective data will be returned. Please note that
// the parent tenancy id can also be included in this list. For example, if there is a parent P with two
// children A and B, to return results of only parent P and child A, this list should be populated with
// tenancy id of parent P and child A.
// If this list contains a tenancy id that isn't part of the organization of parent P, the request will
// fail. That is, let's say there is an organization with parent P with children A and B, and also one
// other tenant T that isn't part of the organization. If T is included in the list of
// childTenancyIds, the request will fail.
// It is important to note that if you are setting the includeOrganization parameter value as true and
// also populating the childTenancyIds parameter with a list of child tenancies, the request will fail.
// The childTenancyIds and includeOrganization should be used exclusively.
// When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
ChildTenancyIds []string `contributesTo:"query" name:"childTenancyIds" collectionFormat:"multi"`
// When set to true, the data for all child tenancies including the parent is returned. That is, if
// there is an organization with parent P and children A and B, to return the data for the parent P, child
// A and child B, this parameter value should be set to true.
// Please note that this parameter shouldn't be used along with childTenancyIds parameter. If you would like
// to get results specifically for parent P and only child A, use the childTenancyIds parameter and populate
// the list with tenancy id of P and A.
// When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
IncludeOrganization *bool `mandatory:"false" contributesTo:"query" name:"includeOrganization"`
// Supplement additional resource information in extended metadata response.
IncludeResourceMetadata *bool `mandatory:"false" contributesTo:"query" name:"includeResourceMetadata"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request FilterResourceActionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request FilterResourceActionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request FilterResourceActionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request FilterResourceActionsRequest) String() string
func (request FilterResourceActionsRequest) 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
FilterResourceActionsResponse wrapper for the FilterResourceActions operation
type FilterResourceActionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ResourceActionCollection instances
ResourceActionCollection `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 items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results exist.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response FilterResourceActionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response FilterResourceActionsResponse) String() string
GetCategoryRequest wrapper for the GetCategory operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetCategory.go.html to see an example of how to use GetCategoryRequest.
type GetCategoryRequest struct {
// The unique OCID associated with the category.
CategoryId *string `mandatory:"true" contributesTo:"path" name:"categoryId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetCategoryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCategoryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCategoryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCategoryRequest) String() string
func (request GetCategoryRequest) 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
GetCategoryResponse wrapper for the GetCategory operation
type GetCategoryResponse struct {
// The underlying http response
RawResponse *http.Response
// The Category instance
Category `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"`
}
func (response GetCategoryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCategoryResponse) String() string
GetEnrollmentStatusRequest wrapper for the GetEnrollmentStatus operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetEnrollmentStatus.go.html to see an example of how to use GetEnrollmentStatusRequest.
type GetEnrollmentStatusRequest struct {
// The unique OCID associated with the enrollment status.
EnrollmentStatusId *string `mandatory:"true" contributesTo:"path" name:"enrollmentStatusId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetEnrollmentStatusRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetEnrollmentStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetEnrollmentStatusRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetEnrollmentStatusRequest) String() string
func (request GetEnrollmentStatusRequest) 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
GetEnrollmentStatusResponse wrapper for the GetEnrollmentStatus operation
type GetEnrollmentStatusResponse struct {
// The underlying http response
RawResponse *http.Response
// The EnrollmentStatus instance
EnrollmentStatus `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetEnrollmentStatusResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetEnrollmentStatusResponse) String() string
GetProfileRequest wrapper for the GetProfile operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetProfile.go.html to see an example of how to use GetProfileRequest.
type GetProfileRequest struct {
// The unique OCID of the profile.
ProfileId *string `mandatory:"true" contributesTo:"path" name:"profileId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetProfileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetProfileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetProfileRequest) String() string
func (request GetProfileRequest) 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
GetProfileResponse wrapper for the GetProfile operation
type GetProfileResponse struct {
// The underlying http response
RawResponse *http.Response
// The Profile instance
Profile `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetProfileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetProfileResponse) String() string
GetRecommendationRequest wrapper for the GetRecommendation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetRecommendation.go.html to see an example of how to use GetRecommendationRequest.
type GetRecommendationRequest struct {
// The unique OCID associated with the recommendation.
RecommendationId *string `mandatory:"true" contributesTo:"path" name:"recommendationId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetRecommendationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRecommendationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRecommendationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRecommendationRequest) String() string
func (request GetRecommendationRequest) 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
GetRecommendationResponse wrapper for the GetRecommendation operation
type GetRecommendationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Recommendation instance
Recommendation `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetRecommendationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRecommendationResponse) String() string
GetResourceActionRequest wrapper for the GetResourceAction operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetResourceAction.go.html to see an example of how to use GetResourceActionRequest.
type GetResourceActionRequest struct {
// The unique OCID associated with the resource action.
ResourceActionId *string `mandatory:"true" contributesTo:"path" name:"resourceActionId"`
// Supplement additional resource information in extended metadata response.
IncludeResourceMetadata *bool `mandatory:"false" contributesTo:"query" name:"includeResourceMetadata"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetResourceActionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetResourceActionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetResourceActionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetResourceActionRequest) String() string
func (request GetResourceActionRequest) 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
GetResourceActionResponse wrapper for the GetResourceAction operation
type GetResourceActionResponse struct {
// The underlying http response
RawResponse *http.Response
// The ResourceAction instance
ResourceAction `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetResourceActionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetResourceActionResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) 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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HistoryCollection A list containing the recommendation history items that match filter criteria, if any. Results contain `HistorySummary` objects.
type HistoryCollection struct {
// A collection of history summaries.
Items []HistorySummary `mandatory:"true" json:"items"`
}
func (m HistoryCollection) String() string
func (m HistoryCollection) 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
HistorySummary The metadata associated with the recommendation history and its related resources.
type HistorySummary struct {
// The unique OCID associated with the recommendation history.
Id *string `mandatory:"true" json:"id"`
// The name assigned to the resource.
Name *string `mandatory:"true" json:"name"`
// The kind of resource.
ResourceType *string `mandatory:"true" json:"resourceType"`
// The unique OCID associated with the category.
CategoryId *string `mandatory:"true" json:"categoryId"`
// The unique OCID associated with the recommendation.
RecommendationId *string `mandatory:"true" json:"recommendationId"`
// The name assigned to the recommendation.
RecommendationName *string `mandatory:"true" json:"recommendationName"`
// The unique OCID associated with the resource.
ResourceId *string `mandatory:"true" json:"resourceId"`
// The unique OCID associated with the resource action.
ResourceActionId *string `mandatory:"true" json:"resourceActionId"`
Action *Action `mandatory:"true" json:"action"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name assigned to the compartment.
CompartmentName *string `mandatory:"true" json:"compartmentName"`
// The recommendation history's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The estimated cost savings, in dollars, for the resource action.
EstimatedCostSaving *float64 `mandatory:"true" json:"estimatedCostSaving"`
// The current status of the resource action.
Status StatusEnum `mandatory:"true" json:"status"`
// Custom metadata key/value pairs for the resource action.
// **Metadata Example**
// "metadata" : {
// "cpuRecommendedShape": "VM.Standard1.1",
// "computeMemoryUtilization": "26.05734124418388",
// "currentShape": "VM.Standard1.2",
// "instanceRecommendedShape": "VM.Standard1.1",
// "computeCpuUtilization": "7.930035319720132",
// "memoryRecommendedShape": "None"
// }
Metadata map[string]string `mandatory:"false" json:"metadata"`
// Additional metadata key/value pairs that you provide.
// They serve the same purpose and functionality as fields in the `metadata` object.
// They are distinguished from `metadata` fields in that these can be nested JSON objects (whereas `metadata` fields are string/string maps only).
// For example:
// `{"CurrentShape": {"name":"VM.Standard2.16"}, "RecommendedShape": {"name":"VM.Standard2.8"}}`
ExtendedMetadata map[string]interface{} `mandatory:"false" json:"extendedMetadata"`
// The date and time the recommendation history was created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m HistorySummary) String() string
func (m HistorySummary) 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
ImportanceEnum Enum with underlying type: string
type ImportanceEnum string
Set of constants representing the allowable values for ImportanceEnum
const (
ImportanceCritical ImportanceEnum = "CRITICAL"
ImportanceHigh ImportanceEnum = "HIGH"
ImportanceModerate ImportanceEnum = "MODERATE"
ImportanceLow ImportanceEnum = "LOW"
ImportanceMinor ImportanceEnum = "MINOR"
)
func GetImportanceEnumValues() []ImportanceEnum
GetImportanceEnumValues Enumerates the set of values for ImportanceEnum
func GetMappingImportanceEnum(val string) (ImportanceEnum, bool)
GetMappingImportanceEnum performs case Insensitive comparison on enum value and return the desired enum
LevelConfiguration Details about the configuration level for the recommendation.
type LevelConfiguration struct {
// The unique OCID of the recommendation.
RecommendationId *string `mandatory:"false" json:"recommendationId"`
// The pre-defined profile level.
Level *string `mandatory:"false" json:"level"`
}
func (m LevelConfiguration) String() string
func (m LevelConfiguration) 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
LevelsConfiguration A list of configuration levels for each recommendation.
type LevelsConfiguration struct {
// The array of configuration levels.
Items []LevelConfiguration `mandatory:"false" json:"items"`
}
func (m LevelsConfiguration) String() string
func (m LevelsConfiguration) 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
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum
const (
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateFailed LifecycleStateEnum = "FAILED"
LifecycleStateInactive LifecycleStateEnum = "INACTIVE"
LifecycleStateAttaching LifecycleStateEnum = "ATTACHING"
LifecycleStateDetaching LifecycleStateEnum = "DETACHING"
LifecycleStateDeleting LifecycleStateEnum = "DELETING"
LifecycleStateDeleted LifecycleStateEnum = "DELETED"
LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
LifecycleStateCreating LifecycleStateEnum = "CREATING"
)
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListCategoriesLifecycleStateEnum Enum with underlying type: string
type ListCategoriesLifecycleStateEnum string
Set of constants representing the allowable values for ListCategoriesLifecycleStateEnum
const (
ListCategoriesLifecycleStateActive ListCategoriesLifecycleStateEnum = "ACTIVE"
ListCategoriesLifecycleStateFailed ListCategoriesLifecycleStateEnum = "FAILED"
ListCategoriesLifecycleStateInactive ListCategoriesLifecycleStateEnum = "INACTIVE"
ListCategoriesLifecycleStateAttaching ListCategoriesLifecycleStateEnum = "ATTACHING"
ListCategoriesLifecycleStateDetaching ListCategoriesLifecycleStateEnum = "DETACHING"
ListCategoriesLifecycleStateDeleting ListCategoriesLifecycleStateEnum = "DELETING"
ListCategoriesLifecycleStateDeleted ListCategoriesLifecycleStateEnum = "DELETED"
ListCategoriesLifecycleStateUpdating ListCategoriesLifecycleStateEnum = "UPDATING"
ListCategoriesLifecycleStateCreating ListCategoriesLifecycleStateEnum = "CREATING"
)
func GetListCategoriesLifecycleStateEnumValues() []ListCategoriesLifecycleStateEnum
GetListCategoriesLifecycleStateEnumValues Enumerates the set of values for ListCategoriesLifecycleStateEnum
func GetMappingListCategoriesLifecycleStateEnum(val string) (ListCategoriesLifecycleStateEnum, bool)
GetMappingListCategoriesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListCategoriesRequest wrapper for the ListCategories operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListCategories.go.html to see an example of how to use ListCategoriesRequest.
type ListCategoriesRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.
// Can only be set to true when performing ListCompartments on the tenancy (root compartment).
CompartmentIdInSubtree *bool `mandatory:"true" contributesTo:"query" name:"compartmentIdInSubtree"`
// A list of child tenancies for which the respective data will be returned. Please note that
// the parent tenancy id can also be included in this list. For example, if there is a parent P with two
// children A and B, to return results of only parent P and child A, this list should be populated with
// tenancy id of parent P and child A.
// If this list contains a tenancy id that isn't part of the organization of parent P, the request will
// fail. That is, let's say there is an organization with parent P with children A and B, and also one
// other tenant T that isn't part of the organization. If T is included in the list of
// childTenancyIds, the request will fail.
// It is important to note that if you are setting the includeOrganization parameter value as true and
// also populating the childTenancyIds parameter with a list of child tenancies, the request will fail.
// The childTenancyIds and includeOrganization should be used exclusively.
// When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
ChildTenancyIds []string `contributesTo:"query" name:"childTenancyIds" collectionFormat:"multi"`
// When set to true, the data for all child tenancies including the parent is returned. That is, if
// there is an organization with parent P and children A and B, to return the data for the parent P, child
// A and child B, this parameter value should be set to true.
// Please note that this parameter shouldn't be used along with childTenancyIds parameter. If you would like
// to get results specifically for parent P and only child A, use the childTenancyIds parameter and populate
// the list with tenancy id of P and A.
// When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
IncludeOrganization *bool `mandatory:"false" contributesTo:"query" name:"includeOrganization"`
// Optional. A filter that returns results that match the name specified.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListCategoriesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
SortBy ListCategoriesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A filter that returns results that match the lifecycle state specified.
LifecycleState ListCategoriesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListCategoriesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCategoriesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCategoriesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCategoriesRequest) String() string
func (request ListCategoriesRequest) 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
ListCategoriesResponse wrapper for the ListCategories operation
type ListCategoriesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of CategoryCollection instances
CategoryCollection `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 items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results exist.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListCategoriesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCategoriesResponse) String() string
ListCategoriesSortByEnum Enum with underlying type: string
type ListCategoriesSortByEnum string
Set of constants representing the allowable values for ListCategoriesSortByEnum
const (
ListCategoriesSortByName ListCategoriesSortByEnum = "NAME"
ListCategoriesSortByTimecreated ListCategoriesSortByEnum = "TIMECREATED"
)
func GetListCategoriesSortByEnumValues() []ListCategoriesSortByEnum
GetListCategoriesSortByEnumValues Enumerates the set of values for ListCategoriesSortByEnum
func GetMappingListCategoriesSortByEnum(val string) (ListCategoriesSortByEnum, bool)
GetMappingListCategoriesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCategoriesSortOrderEnum Enum with underlying type: string
type ListCategoriesSortOrderEnum string
Set of constants representing the allowable values for ListCategoriesSortOrderEnum
const (
ListCategoriesSortOrderAsc ListCategoriesSortOrderEnum = "ASC"
ListCategoriesSortOrderDesc ListCategoriesSortOrderEnum = "DESC"
)
func GetListCategoriesSortOrderEnumValues() []ListCategoriesSortOrderEnum
GetListCategoriesSortOrderEnumValues Enumerates the set of values for ListCategoriesSortOrderEnum
func GetMappingListCategoriesSortOrderEnum(val string) (ListCategoriesSortOrderEnum, bool)
GetMappingListCategoriesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListEnrollmentStatusesLifecycleStateEnum Enum with underlying type: string
type ListEnrollmentStatusesLifecycleStateEnum string
Set of constants representing the allowable values for ListEnrollmentStatusesLifecycleStateEnum
const (
ListEnrollmentStatusesLifecycleStateActive ListEnrollmentStatusesLifecycleStateEnum = "ACTIVE"
ListEnrollmentStatusesLifecycleStateFailed ListEnrollmentStatusesLifecycleStateEnum = "FAILED"
ListEnrollmentStatusesLifecycleStateInactive ListEnrollmentStatusesLifecycleStateEnum = "INACTIVE"
ListEnrollmentStatusesLifecycleStateAttaching ListEnrollmentStatusesLifecycleStateEnum = "ATTACHING"
ListEnrollmentStatusesLifecycleStateDetaching ListEnrollmentStatusesLifecycleStateEnum = "DETACHING"
ListEnrollmentStatusesLifecycleStateDeleting ListEnrollmentStatusesLifecycleStateEnum = "DELETING"
ListEnrollmentStatusesLifecycleStateDeleted ListEnrollmentStatusesLifecycleStateEnum = "DELETED"
ListEnrollmentStatusesLifecycleStateUpdating ListEnrollmentStatusesLifecycleStateEnum = "UPDATING"
ListEnrollmentStatusesLifecycleStateCreating ListEnrollmentStatusesLifecycleStateEnum = "CREATING"
)
func GetListEnrollmentStatusesLifecycleStateEnumValues() []ListEnrollmentStatusesLifecycleStateEnum
GetListEnrollmentStatusesLifecycleStateEnumValues Enumerates the set of values for ListEnrollmentStatusesLifecycleStateEnum
func GetMappingListEnrollmentStatusesLifecycleStateEnum(val string) (ListEnrollmentStatusesLifecycleStateEnum, bool)
GetMappingListEnrollmentStatusesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListEnrollmentStatusesRequest wrapper for the ListEnrollmentStatuses operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListEnrollmentStatuses.go.html to see an example of how to use ListEnrollmentStatusesRequest.
type ListEnrollmentStatusesRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListEnrollmentStatusesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
SortBy ListEnrollmentStatusesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A filter that returns results that match the lifecycle state specified.
LifecycleState ListEnrollmentStatusesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter that returns results that match the Cloud Advisor enrollment status specified.
Status ListEnrollmentStatusesStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListEnrollmentStatusesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListEnrollmentStatusesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListEnrollmentStatusesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListEnrollmentStatusesRequest) String() string
func (request ListEnrollmentStatusesRequest) 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
ListEnrollmentStatusesResponse wrapper for the ListEnrollmentStatuses operation
type ListEnrollmentStatusesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EnrollmentStatusCollection instances
EnrollmentStatusCollection `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 items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results exist.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListEnrollmentStatusesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListEnrollmentStatusesResponse) String() string
ListEnrollmentStatusesSortByEnum Enum with underlying type: string
type ListEnrollmentStatusesSortByEnum string
Set of constants representing the allowable values for ListEnrollmentStatusesSortByEnum
const (
ListEnrollmentStatusesSortByName ListEnrollmentStatusesSortByEnum = "NAME"
ListEnrollmentStatusesSortByTimecreated ListEnrollmentStatusesSortByEnum = "TIMECREATED"
)
func GetListEnrollmentStatusesSortByEnumValues() []ListEnrollmentStatusesSortByEnum
GetListEnrollmentStatusesSortByEnumValues Enumerates the set of values for ListEnrollmentStatusesSortByEnum
func GetMappingListEnrollmentStatusesSortByEnum(val string) (ListEnrollmentStatusesSortByEnum, bool)
GetMappingListEnrollmentStatusesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListEnrollmentStatusesSortOrderEnum Enum with underlying type: string
type ListEnrollmentStatusesSortOrderEnum string
Set of constants representing the allowable values for ListEnrollmentStatusesSortOrderEnum
const (
ListEnrollmentStatusesSortOrderAsc ListEnrollmentStatusesSortOrderEnum = "ASC"
ListEnrollmentStatusesSortOrderDesc ListEnrollmentStatusesSortOrderEnum = "DESC"
)
func GetListEnrollmentStatusesSortOrderEnumValues() []ListEnrollmentStatusesSortOrderEnum
GetListEnrollmentStatusesSortOrderEnumValues Enumerates the set of values for ListEnrollmentStatusesSortOrderEnum
func GetMappingListEnrollmentStatusesSortOrderEnum(val string) (ListEnrollmentStatusesSortOrderEnum, bool)
GetMappingListEnrollmentStatusesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListEnrollmentStatusesStatusEnum Enum with underlying type: string
type ListEnrollmentStatusesStatusEnum string
Set of constants representing the allowable values for ListEnrollmentStatusesStatusEnum
const (
ListEnrollmentStatusesStatusActive ListEnrollmentStatusesStatusEnum = "ACTIVE"
ListEnrollmentStatusesStatusInactive ListEnrollmentStatusesStatusEnum = "INACTIVE"
)
func GetListEnrollmentStatusesStatusEnumValues() []ListEnrollmentStatusesStatusEnum
GetListEnrollmentStatusesStatusEnumValues Enumerates the set of values for ListEnrollmentStatusesStatusEnum
func GetMappingListEnrollmentStatusesStatusEnum(val string) (ListEnrollmentStatusesStatusEnum, bool)
GetMappingListEnrollmentStatusesStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListHistoriesLifecycleStateEnum Enum with underlying type: string
type ListHistoriesLifecycleStateEnum string
Set of constants representing the allowable values for ListHistoriesLifecycleStateEnum
const (
ListHistoriesLifecycleStateActive ListHistoriesLifecycleStateEnum = "ACTIVE"
ListHistoriesLifecycleStateFailed ListHistoriesLifecycleStateEnum = "FAILED"
ListHistoriesLifecycleStateInactive ListHistoriesLifecycleStateEnum = "INACTIVE"
ListHistoriesLifecycleStateAttaching ListHistoriesLifecycleStateEnum = "ATTACHING"
ListHistoriesLifecycleStateDetaching ListHistoriesLifecycleStateEnum = "DETACHING"
ListHistoriesLifecycleStateDeleting ListHistoriesLifecycleStateEnum = "DELETING"
ListHistoriesLifecycleStateDeleted ListHistoriesLifecycleStateEnum = "DELETED"
ListHistoriesLifecycleStateUpdating ListHistoriesLifecycleStateEnum = "UPDATING"
ListHistoriesLifecycleStateCreating ListHistoriesLifecycleStateEnum = "CREATING"
)
func GetListHistoriesLifecycleStateEnumValues() []ListHistoriesLifecycleStateEnum
GetListHistoriesLifecycleStateEnumValues Enumerates the set of values for ListHistoriesLifecycleStateEnum
func GetMappingListHistoriesLifecycleStateEnum(val string) (ListHistoriesLifecycleStateEnum, bool)
GetMappingListHistoriesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListHistoriesRequest wrapper for the ListHistories operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListHistories.go.html to see an example of how to use ListHistoriesRequest.
type ListHistoriesRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.
// Can only be set to true when performing ListCompartments on the tenancy (root compartment).
CompartmentIdInSubtree *bool `mandatory:"true" contributesTo:"query" name:"compartmentIdInSubtree"`
// Optional. A filter that returns results that match the name specified.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// Optional. A filter that returns results that match the recommendation name specified.
RecommendationName *string `mandatory:"false" contributesTo:"query" name:"recommendationName"`
// The unique OCID associated with the recommendation.
RecommendationId *string `mandatory:"false" contributesTo:"query" name:"recommendationId"`
// Optional. A filter that returns results that match the resource type specified.
ResourceType *string `mandatory:"false" contributesTo:"query" name:"resourceType"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListHistoriesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
SortBy ListHistoriesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A filter that returns results that match the lifecycle state specified.
LifecycleState ListHistoriesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter that returns recommendations that match the status specified.
Status ListHistoriesStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// Supplement additional resource information in extended metadata response.
IncludeResourceMetadata *bool `mandatory:"false" contributesTo:"query" name:"includeResourceMetadata"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListHistoriesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListHistoriesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListHistoriesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListHistoriesRequest) String() string
func (request ListHistoriesRequest) 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
ListHistoriesResponse wrapper for the ListHistories operation
type ListHistoriesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of HistoryCollection instances
HistoryCollection `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 items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results exist.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListHistoriesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListHistoriesResponse) String() string
ListHistoriesSortByEnum Enum with underlying type: string
type ListHistoriesSortByEnum string
Set of constants representing the allowable values for ListHistoriesSortByEnum
const (
ListHistoriesSortByName ListHistoriesSortByEnum = "NAME"
ListHistoriesSortByTimecreated ListHistoriesSortByEnum = "TIMECREATED"
)
func GetListHistoriesSortByEnumValues() []ListHistoriesSortByEnum
GetListHistoriesSortByEnumValues Enumerates the set of values for ListHistoriesSortByEnum
func GetMappingListHistoriesSortByEnum(val string) (ListHistoriesSortByEnum, bool)
GetMappingListHistoriesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListHistoriesSortOrderEnum Enum with underlying type: string
type ListHistoriesSortOrderEnum string
Set of constants representing the allowable values for ListHistoriesSortOrderEnum
const (
ListHistoriesSortOrderAsc ListHistoriesSortOrderEnum = "ASC"
ListHistoriesSortOrderDesc ListHistoriesSortOrderEnum = "DESC"
)
func GetListHistoriesSortOrderEnumValues() []ListHistoriesSortOrderEnum
GetListHistoriesSortOrderEnumValues Enumerates the set of values for ListHistoriesSortOrderEnum
func GetMappingListHistoriesSortOrderEnum(val string) (ListHistoriesSortOrderEnum, bool)
GetMappingListHistoriesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListHistoriesStatusEnum Enum with underlying type: string
type ListHistoriesStatusEnum string
Set of constants representing the allowable values for ListHistoriesStatusEnum
const (
ListHistoriesStatusPending ListHistoriesStatusEnum = "PENDING"
ListHistoriesStatusDismissed ListHistoriesStatusEnum = "DISMISSED"
ListHistoriesStatusPostponed ListHistoriesStatusEnum = "POSTPONED"
ListHistoriesStatusImplemented ListHistoriesStatusEnum = "IMPLEMENTED"
)
func GetListHistoriesStatusEnumValues() []ListHistoriesStatusEnum
GetListHistoriesStatusEnumValues Enumerates the set of values for ListHistoriesStatusEnum
func GetMappingListHistoriesStatusEnum(val string) (ListHistoriesStatusEnum, bool)
GetMappingListHistoriesStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListProfileLevelsRequest wrapper for the ListProfileLevels operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListProfileLevels.go.html to see an example of how to use ListProfileLevelsRequest.
type ListProfileLevelsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.
// Can only be set to true when performing ListCompartments on the tenancy (root compartment).
CompartmentIdInSubtree *bool `mandatory:"true" contributesTo:"query" name:"compartmentIdInSubtree"`
// Optional. A filter that returns results that match the name specified.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// Optional. A filter that returns results that match the recommendation name specified.
RecommendationName *string `mandatory:"false" contributesTo:"query" name:"recommendationName"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListProfileLevelsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
SortBy ListProfileLevelsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListProfileLevelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListProfileLevelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListProfileLevelsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListProfileLevelsRequest) String() string
func (request ListProfileLevelsRequest) 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
ListProfileLevelsResponse wrapper for the ListProfileLevels operation
type ListProfileLevelsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ProfileLevelCollection instances
ProfileLevelCollection `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 items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results exist.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListProfileLevelsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListProfileLevelsResponse) String() string
ListProfileLevelsSortByEnum Enum with underlying type: string
type ListProfileLevelsSortByEnum string
Set of constants representing the allowable values for ListProfileLevelsSortByEnum
const (
ListProfileLevelsSortByName ListProfileLevelsSortByEnum = "NAME"
ListProfileLevelsSortByTimecreated ListProfileLevelsSortByEnum = "TIMECREATED"
)
func GetListProfileLevelsSortByEnumValues() []ListProfileLevelsSortByEnum
GetListProfileLevelsSortByEnumValues Enumerates the set of values for ListProfileLevelsSortByEnum
func GetMappingListProfileLevelsSortByEnum(val string) (ListProfileLevelsSortByEnum, bool)
GetMappingListProfileLevelsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListProfileLevelsSortOrderEnum Enum with underlying type: string
type ListProfileLevelsSortOrderEnum string
Set of constants representing the allowable values for ListProfileLevelsSortOrderEnum
const (
ListProfileLevelsSortOrderAsc ListProfileLevelsSortOrderEnum = "ASC"
ListProfileLevelsSortOrderDesc ListProfileLevelsSortOrderEnum = "DESC"
)
func GetListProfileLevelsSortOrderEnumValues() []ListProfileLevelsSortOrderEnum
GetListProfileLevelsSortOrderEnumValues Enumerates the set of values for ListProfileLevelsSortOrderEnum
func GetMappingListProfileLevelsSortOrderEnum(val string) (ListProfileLevelsSortOrderEnum, bool)
GetMappingListProfileLevelsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListProfilesLifecycleStateEnum Enum with underlying type: string
type ListProfilesLifecycleStateEnum string
Set of constants representing the allowable values for ListProfilesLifecycleStateEnum
const (
ListProfilesLifecycleStateActive ListProfilesLifecycleStateEnum = "ACTIVE"
ListProfilesLifecycleStateFailed ListProfilesLifecycleStateEnum = "FAILED"
ListProfilesLifecycleStateInactive ListProfilesLifecycleStateEnum = "INACTIVE"
ListProfilesLifecycleStateAttaching ListProfilesLifecycleStateEnum = "ATTACHING"
ListProfilesLifecycleStateDetaching ListProfilesLifecycleStateEnum = "DETACHING"
ListProfilesLifecycleStateDeleting ListProfilesLifecycleStateEnum = "DELETING"
ListProfilesLifecycleStateDeleted ListProfilesLifecycleStateEnum = "DELETED"
ListProfilesLifecycleStateUpdating ListProfilesLifecycleStateEnum = "UPDATING"
ListProfilesLifecycleStateCreating ListProfilesLifecycleStateEnum = "CREATING"
)
func GetListProfilesLifecycleStateEnumValues() []ListProfilesLifecycleStateEnum
GetListProfilesLifecycleStateEnumValues Enumerates the set of values for ListProfilesLifecycleStateEnum
func GetMappingListProfilesLifecycleStateEnum(val string) (ListProfilesLifecycleStateEnum, bool)
GetMappingListProfilesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListProfilesRequest wrapper for the ListProfiles operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListProfiles.go.html to see an example of how to use ListProfilesRequest.
type ListProfilesRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Optional. A filter that returns results that match the name specified.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListProfilesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
SortBy ListProfilesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A filter that returns results that match the lifecycle state specified.
LifecycleState ListProfilesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListProfilesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListProfilesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListProfilesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListProfilesRequest) String() string
func (request ListProfilesRequest) 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
ListProfilesResponse wrapper for the ListProfiles operation
type ListProfilesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ProfileCollection instances
ProfileCollection `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 items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results exist.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListProfilesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListProfilesResponse) String() string
ListProfilesSortByEnum Enum with underlying type: string
type ListProfilesSortByEnum string
Set of constants representing the allowable values for ListProfilesSortByEnum
const (
ListProfilesSortByName ListProfilesSortByEnum = "NAME"
ListProfilesSortByTimecreated ListProfilesSortByEnum = "TIMECREATED"
)
func GetListProfilesSortByEnumValues() []ListProfilesSortByEnum
GetListProfilesSortByEnumValues Enumerates the set of values for ListProfilesSortByEnum
func GetMappingListProfilesSortByEnum(val string) (ListProfilesSortByEnum, bool)
GetMappingListProfilesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListProfilesSortOrderEnum Enum with underlying type: string
type ListProfilesSortOrderEnum string
Set of constants representing the allowable values for ListProfilesSortOrderEnum
const (
ListProfilesSortOrderAsc ListProfilesSortOrderEnum = "ASC"
ListProfilesSortOrderDesc ListProfilesSortOrderEnum = "DESC"
)
func GetListProfilesSortOrderEnumValues() []ListProfilesSortOrderEnum
GetListProfilesSortOrderEnumValues Enumerates the set of values for ListProfilesSortOrderEnum
func GetMappingListProfilesSortOrderEnum(val string) (ListProfilesSortOrderEnum, bool)
GetMappingListProfilesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecommendationStrategiesRequest wrapper for the ListRecommendationStrategies operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListRecommendationStrategies.go.html to see an example of how to use ListRecommendationStrategiesRequest.
type ListRecommendationStrategiesRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.
// Can only be set to true when performing ListCompartments on the tenancy (root compartment).
CompartmentIdInSubtree *bool `mandatory:"true" contributesTo:"query" name:"compartmentIdInSubtree"`
// Optional. A filter that returns results that match the name specified.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// Optional. A filter that returns results that match the recommendation name specified.
RecommendationName *string `mandatory:"false" contributesTo:"query" name:"recommendationName"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListRecommendationStrategiesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
SortBy ListRecommendationStrategiesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRecommendationStrategiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRecommendationStrategiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRecommendationStrategiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRecommendationStrategiesRequest) String() string
func (request ListRecommendationStrategiesRequest) 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
ListRecommendationStrategiesResponse wrapper for the ListRecommendationStrategies operation
type ListRecommendationStrategiesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RecommendationStrategyCollection instances
RecommendationStrategyCollection `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 items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results exist.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListRecommendationStrategiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRecommendationStrategiesResponse) String() string
ListRecommendationStrategiesSortByEnum Enum with underlying type: string
type ListRecommendationStrategiesSortByEnum string
Set of constants representing the allowable values for ListRecommendationStrategiesSortByEnum
const (
ListRecommendationStrategiesSortByName ListRecommendationStrategiesSortByEnum = "NAME"
ListRecommendationStrategiesSortByTimecreated ListRecommendationStrategiesSortByEnum = "TIMECREATED"
)
func GetListRecommendationStrategiesSortByEnumValues() []ListRecommendationStrategiesSortByEnum
GetListRecommendationStrategiesSortByEnumValues Enumerates the set of values for ListRecommendationStrategiesSortByEnum
func GetMappingListRecommendationStrategiesSortByEnum(val string) (ListRecommendationStrategiesSortByEnum, bool)
GetMappingListRecommendationStrategiesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecommendationStrategiesSortOrderEnum Enum with underlying type: string
type ListRecommendationStrategiesSortOrderEnum string
Set of constants representing the allowable values for ListRecommendationStrategiesSortOrderEnum
const (
ListRecommendationStrategiesSortOrderAsc ListRecommendationStrategiesSortOrderEnum = "ASC"
ListRecommendationStrategiesSortOrderDesc ListRecommendationStrategiesSortOrderEnum = "DESC"
)
func GetListRecommendationStrategiesSortOrderEnumValues() []ListRecommendationStrategiesSortOrderEnum
GetListRecommendationStrategiesSortOrderEnumValues Enumerates the set of values for ListRecommendationStrategiesSortOrderEnum
func GetMappingListRecommendationStrategiesSortOrderEnum(val string) (ListRecommendationStrategiesSortOrderEnum, bool)
GetMappingListRecommendationStrategiesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecommendationsLifecycleStateEnum Enum with underlying type: string
type ListRecommendationsLifecycleStateEnum string
Set of constants representing the allowable values for ListRecommendationsLifecycleStateEnum
const (
ListRecommendationsLifecycleStateActive ListRecommendationsLifecycleStateEnum = "ACTIVE"
ListRecommendationsLifecycleStateFailed ListRecommendationsLifecycleStateEnum = "FAILED"
ListRecommendationsLifecycleStateInactive ListRecommendationsLifecycleStateEnum = "INACTIVE"
ListRecommendationsLifecycleStateAttaching ListRecommendationsLifecycleStateEnum = "ATTACHING"
ListRecommendationsLifecycleStateDetaching ListRecommendationsLifecycleStateEnum = "DETACHING"
ListRecommendationsLifecycleStateDeleting ListRecommendationsLifecycleStateEnum = "DELETING"
ListRecommendationsLifecycleStateDeleted ListRecommendationsLifecycleStateEnum = "DELETED"
ListRecommendationsLifecycleStateUpdating ListRecommendationsLifecycleStateEnum = "UPDATING"
ListRecommendationsLifecycleStateCreating ListRecommendationsLifecycleStateEnum = "CREATING"
)
func GetListRecommendationsLifecycleStateEnumValues() []ListRecommendationsLifecycleStateEnum
GetListRecommendationsLifecycleStateEnumValues Enumerates the set of values for ListRecommendationsLifecycleStateEnum
func GetMappingListRecommendationsLifecycleStateEnum(val string) (ListRecommendationsLifecycleStateEnum, bool)
GetMappingListRecommendationsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecommendationsRequest wrapper for the ListRecommendations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListRecommendations.go.html to see an example of how to use ListRecommendationsRequest.
type ListRecommendationsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.
// Can only be set to true when performing ListCompartments on the tenancy (root compartment).
CompartmentIdInSubtree *bool `mandatory:"true" contributesTo:"query" name:"compartmentIdInSubtree"`
// The unique OCID associated with the category.
CategoryId *string `mandatory:"false" contributesTo:"query" name:"categoryId"`
// Optional. A filter that returns results that match the category name specified.
CategoryName *string `mandatory:"false" contributesTo:"query" name:"categoryName"`
// A list of child tenancies for which the respective data will be returned. Please note that
// the parent tenancy id can also be included in this list. For example, if there is a parent P with two
// children A and B, to return results of only parent P and child A, this list should be populated with
// tenancy id of parent P and child A.
// If this list contains a tenancy id that isn't part of the organization of parent P, the request will
// fail. That is, let's say there is an organization with parent P with children A and B, and also one
// other tenant T that isn't part of the organization. If T is included in the list of
// childTenancyIds, the request will fail.
// It is important to note that if you are setting the includeOrganization parameter value as true and
// also populating the childTenancyIds parameter with a list of child tenancies, the request will fail.
// The childTenancyIds and includeOrganization should be used exclusively.
// When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
ChildTenancyIds []string `contributesTo:"query" name:"childTenancyIds" collectionFormat:"multi"`
// When set to true, the data for all child tenancies including the parent is returned. That is, if
// there is an organization with parent P and children A and B, to return the data for the parent P, child
// A and child B, this parameter value should be set to true.
// Please note that this parameter shouldn't be used along with childTenancyIds parameter. If you would like
// to get results specifically for parent P and only child A, use the childTenancyIds parameter and populate
// the list with tenancy id of P and A.
// When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
IncludeOrganization *bool `mandatory:"false" contributesTo:"query" name:"includeOrganization"`
// Optional. A filter that returns results that match the name specified.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListRecommendationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
SortBy ListRecommendationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A filter that returns results that match the lifecycle state specified.
LifecycleState ListRecommendationsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter that returns recommendations that match the status specified.
Status ListRecommendationsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRecommendationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRecommendationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRecommendationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRecommendationsRequest) String() string
func (request ListRecommendationsRequest) 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
ListRecommendationsResponse wrapper for the ListRecommendations operation
type ListRecommendationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RecommendationCollection instances
RecommendationCollection `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 items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results exist.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListRecommendationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRecommendationsResponse) String() string
ListRecommendationsSortByEnum Enum with underlying type: string
type ListRecommendationsSortByEnum string
Set of constants representing the allowable values for ListRecommendationsSortByEnum
const (
ListRecommendationsSortByName ListRecommendationsSortByEnum = "NAME"
ListRecommendationsSortByTimecreated ListRecommendationsSortByEnum = "TIMECREATED"
)
func GetListRecommendationsSortByEnumValues() []ListRecommendationsSortByEnum
GetListRecommendationsSortByEnumValues Enumerates the set of values for ListRecommendationsSortByEnum
func GetMappingListRecommendationsSortByEnum(val string) (ListRecommendationsSortByEnum, bool)
GetMappingListRecommendationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecommendationsSortOrderEnum Enum with underlying type: string
type ListRecommendationsSortOrderEnum string
Set of constants representing the allowable values for ListRecommendationsSortOrderEnum
const (
ListRecommendationsSortOrderAsc ListRecommendationsSortOrderEnum = "ASC"
ListRecommendationsSortOrderDesc ListRecommendationsSortOrderEnum = "DESC"
)
func GetListRecommendationsSortOrderEnumValues() []ListRecommendationsSortOrderEnum
GetListRecommendationsSortOrderEnumValues Enumerates the set of values for ListRecommendationsSortOrderEnum
func GetMappingListRecommendationsSortOrderEnum(val string) (ListRecommendationsSortOrderEnum, bool)
GetMappingListRecommendationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecommendationsStatusEnum Enum with underlying type: string
type ListRecommendationsStatusEnum string
Set of constants representing the allowable values for ListRecommendationsStatusEnum
const (
ListRecommendationsStatusPending ListRecommendationsStatusEnum = "PENDING"
ListRecommendationsStatusDismissed ListRecommendationsStatusEnum = "DISMISSED"
ListRecommendationsStatusPostponed ListRecommendationsStatusEnum = "POSTPONED"
ListRecommendationsStatusImplemented ListRecommendationsStatusEnum = "IMPLEMENTED"
)
func GetListRecommendationsStatusEnumValues() []ListRecommendationsStatusEnum
GetListRecommendationsStatusEnumValues Enumerates the set of values for ListRecommendationsStatusEnum
func GetMappingListRecommendationsStatusEnum(val string) (ListRecommendationsStatusEnum, bool)
GetMappingListRecommendationsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListResourceActionQueryableFieldsRequest wrapper for the ListResourceActionQueryableFields operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListResourceActionQueryableFields.go.html to see an example of how to use ListResourceActionQueryableFieldsRequest.
type ListResourceActionQueryableFieldsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.
// Can only be set to true when performing ListCompartments on the tenancy (root compartment).
CompartmentIdInSubtree *bool `mandatory:"true" contributesTo:"query" name:"compartmentIdInSubtree"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListResourceActionQueryableFieldsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListResourceActionQueryableFieldsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListResourceActionQueryableFieldsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListResourceActionQueryableFieldsRequest) String() string
func (request ListResourceActionQueryableFieldsRequest) 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
ListResourceActionQueryableFieldsResponse wrapper for the ListResourceActionQueryableFields operation
type ListResourceActionQueryableFieldsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of QueryableFieldCollection instances
QueryableFieldCollection `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 items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results exist.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListResourceActionQueryableFieldsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListResourceActionQueryableFieldsResponse) String() string
ListResourceActionsLifecycleStateEnum Enum with underlying type: string
type ListResourceActionsLifecycleStateEnum string
Set of constants representing the allowable values for ListResourceActionsLifecycleStateEnum
const (
ListResourceActionsLifecycleStateActive ListResourceActionsLifecycleStateEnum = "ACTIVE"
ListResourceActionsLifecycleStateFailed ListResourceActionsLifecycleStateEnum = "FAILED"
ListResourceActionsLifecycleStateInactive ListResourceActionsLifecycleStateEnum = "INACTIVE"
ListResourceActionsLifecycleStateAttaching ListResourceActionsLifecycleStateEnum = "ATTACHING"
ListResourceActionsLifecycleStateDetaching ListResourceActionsLifecycleStateEnum = "DETACHING"
ListResourceActionsLifecycleStateDeleting ListResourceActionsLifecycleStateEnum = "DELETING"
ListResourceActionsLifecycleStateDeleted ListResourceActionsLifecycleStateEnum = "DELETED"
ListResourceActionsLifecycleStateUpdating ListResourceActionsLifecycleStateEnum = "UPDATING"
ListResourceActionsLifecycleStateCreating ListResourceActionsLifecycleStateEnum = "CREATING"
)
func GetListResourceActionsLifecycleStateEnumValues() []ListResourceActionsLifecycleStateEnum
GetListResourceActionsLifecycleStateEnumValues Enumerates the set of values for ListResourceActionsLifecycleStateEnum
func GetMappingListResourceActionsLifecycleStateEnum(val string) (ListResourceActionsLifecycleStateEnum, bool)
GetMappingListResourceActionsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListResourceActionsRequest wrapper for the ListResourceActions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListResourceActions.go.html to see an example of how to use ListResourceActionsRequest.
type ListResourceActionsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.
// Can only be set to true when performing ListCompartments on the tenancy (root compartment).
CompartmentIdInSubtree *bool `mandatory:"true" contributesTo:"query" name:"compartmentIdInSubtree"`
// The unique OCID associated with the recommendation.
RecommendationId *string `mandatory:"false" contributesTo:"query" name:"recommendationId"`
// Optional. A filter that returns results that match the recommendation name specified.
RecommendationName *string `mandatory:"false" contributesTo:"query" name:"recommendationName"`
// A list of child tenancies for which the respective data will be returned. Please note that
// the parent tenancy id can also be included in this list. For example, if there is a parent P with two
// children A and B, to return results of only parent P and child A, this list should be populated with
// tenancy id of parent P and child A.
// If this list contains a tenancy id that isn't part of the organization of parent P, the request will
// fail. That is, let's say there is an organization with parent P with children A and B, and also one
// other tenant T that isn't part of the organization. If T is included in the list of
// childTenancyIds, the request will fail.
// It is important to note that if you are setting the includeOrganization parameter value as true and
// also populating the childTenancyIds parameter with a list of child tenancies, the request will fail.
// The childTenancyIds and includeOrganization should be used exclusively.
// When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
ChildTenancyIds []string `contributesTo:"query" name:"childTenancyIds" collectionFormat:"multi"`
// When set to true, the data for all child tenancies including the parent is returned. That is, if
// there is an organization with parent P and children A and B, to return the data for the parent P, child
// A and child B, this parameter value should be set to true.
// Please note that this parameter shouldn't be used along with childTenancyIds parameter. If you would like
// to get results specifically for parent P and only child A, use the childTenancyIds parameter and populate
// the list with tenancy id of P and A.
// When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
IncludeOrganization *bool `mandatory:"false" contributesTo:"query" name:"includeOrganization"`
// Optional. A filter that returns results that match the name specified.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// Optional. A filter that returns results that match the resource type specified.
ResourceType *string `mandatory:"false" contributesTo:"query" name:"resourceType"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListResourceActionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
SortBy ListResourceActionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A filter that returns results that match the lifecycle state specified.
LifecycleState ListResourceActionsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter that returns recommendations that match the status specified.
Status ListResourceActionsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// Supplement additional resource information in extended metadata response.
IncludeResourceMetadata *bool `mandatory:"false" contributesTo:"query" name:"includeResourceMetadata"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListResourceActionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListResourceActionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListResourceActionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListResourceActionsRequest) String() string
func (request ListResourceActionsRequest) 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
ListResourceActionsResponse wrapper for the ListResourceActions operation
type ListResourceActionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ResourceActionCollection instances
ResourceActionCollection `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 items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results exist.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListResourceActionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListResourceActionsResponse) String() string
ListResourceActionsSortByEnum Enum with underlying type: string
type ListResourceActionsSortByEnum string
Set of constants representing the allowable values for ListResourceActionsSortByEnum
const (
ListResourceActionsSortByName ListResourceActionsSortByEnum = "NAME"
ListResourceActionsSortByTimecreated ListResourceActionsSortByEnum = "TIMECREATED"
)
func GetListResourceActionsSortByEnumValues() []ListResourceActionsSortByEnum
GetListResourceActionsSortByEnumValues Enumerates the set of values for ListResourceActionsSortByEnum
func GetMappingListResourceActionsSortByEnum(val string) (ListResourceActionsSortByEnum, bool)
GetMappingListResourceActionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListResourceActionsSortOrderEnum Enum with underlying type: string
type ListResourceActionsSortOrderEnum string
Set of constants representing the allowable values for ListResourceActionsSortOrderEnum
const (
ListResourceActionsSortOrderAsc ListResourceActionsSortOrderEnum = "ASC"
ListResourceActionsSortOrderDesc ListResourceActionsSortOrderEnum = "DESC"
)
func GetListResourceActionsSortOrderEnumValues() []ListResourceActionsSortOrderEnum
GetListResourceActionsSortOrderEnumValues Enumerates the set of values for ListResourceActionsSortOrderEnum
func GetMappingListResourceActionsSortOrderEnum(val string) (ListResourceActionsSortOrderEnum, bool)
GetMappingListResourceActionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListResourceActionsStatusEnum Enum with underlying type: string
type ListResourceActionsStatusEnum string
Set of constants representing the allowable values for ListResourceActionsStatusEnum
const (
ListResourceActionsStatusPending ListResourceActionsStatusEnum = "PENDING"
ListResourceActionsStatusDismissed ListResourceActionsStatusEnum = "DISMISSED"
ListResourceActionsStatusPostponed ListResourceActionsStatusEnum = "POSTPONED"
ListResourceActionsStatusImplemented ListResourceActionsStatusEnum = "IMPLEMENTED"
)
func GetListResourceActionsStatusEnumValues() []ListResourceActionsStatusEnum
GetListResourceActionsStatusEnumValues Enumerates the set of values for ListResourceActionsStatusEnum
func GetMappingListResourceActionsStatusEnum(val string) (ListResourceActionsStatusEnum, bool)
GetMappingListResourceActionsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) 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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) 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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) 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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestCollection instances
WorkRequestCollection `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 items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeBulkApplyRecommendations OperationTypeEnum = "BULK_APPLY_RECOMMENDATIONS"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
OptimizerClient a client for Optimizer
type OptimizerClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewOptimizerClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OptimizerClient, err error)
NewOptimizerClientWithConfigurationProvider Creates a new default Optimizer client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewOptimizerClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OptimizerClient, err error)
NewOptimizerClientWithOboToken Creates a new default Optimizer client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client OptimizerClient) BulkApplyRecommendations(ctx context.Context, request BulkApplyRecommendationsRequest) (response BulkApplyRecommendationsResponse, err error)
BulkApplyRecommendations Applies the specified recommendations to the resources.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/BulkApplyRecommendations.go.html to see an example of how to use BulkApplyRecommendations API. A default retry strategy applies to this operation BulkApplyRecommendations()
func (client *OptimizerClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client OptimizerClient) CreateProfile(ctx context.Context, request CreateProfileRequest) (response CreateProfileResponse, err error)
CreateProfile Creates a new profile.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/CreateProfile.go.html to see an example of how to use CreateProfile API. A default retry strategy applies to this operation CreateProfile()
func (client OptimizerClient) DeleteProfile(ctx context.Context, request DeleteProfileRequest) (response DeleteProfileResponse, err error)
DeleteProfile Deletes the specified profile. Uses the profile's OCID to determine which profile to delete.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/DeleteProfile.go.html to see an example of how to use DeleteProfile API. A default retry strategy applies to this operation DeleteProfile()
func (client OptimizerClient) FilterResourceActions(ctx context.Context, request FilterResourceActionsRequest) (response FilterResourceActionsResponse, err error)
FilterResourceActions Queries the Cloud Advisor resource actions that are supported.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/FilterResourceActions.go.html to see an example of how to use FilterResourceActions API. A default retry strategy applies to this operation FilterResourceActions()
func (client OptimizerClient) GetCategory(ctx context.Context, request GetCategoryRequest) (response GetCategoryResponse, err error)
GetCategory Gets the category that corresponds to the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetCategory.go.html to see an example of how to use GetCategory API. A default retry strategy applies to this operation GetCategory()
func (client OptimizerClient) GetEnrollmentStatus(ctx context.Context, request GetEnrollmentStatusRequest) (response GetEnrollmentStatusResponse, err error)
GetEnrollmentStatus Gets the Cloud Advisor enrollment status.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetEnrollmentStatus.go.html to see an example of how to use GetEnrollmentStatus API. A default retry strategy applies to this operation GetEnrollmentStatus()
func (client OptimizerClient) GetProfile(ctx context.Context, request GetProfileRequest) (response GetProfileResponse, err error)
GetProfile Gets the specified profile's information. Uses the profile's OCID to determine which profile to retrieve.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetProfile.go.html to see an example of how to use GetProfile API. A default retry strategy applies to this operation GetProfile()
func (client OptimizerClient) GetRecommendation(ctx context.Context, request GetRecommendationRequest) (response GetRecommendationResponse, err error)
GetRecommendation Gets the recommendation for the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetRecommendation.go.html to see an example of how to use GetRecommendation API. A default retry strategy applies to this operation GetRecommendation()
func (client OptimizerClient) GetResourceAction(ctx context.Context, request GetResourceActionRequest) (response GetResourceActionResponse, err error)
GetResourceAction Gets the resource action that corresponds to the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetResourceAction.go.html to see an example of how to use GetResourceAction API. A default retry strategy applies to this operation GetResourceAction()
func (client OptimizerClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request associated with the specified ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client OptimizerClient) ListCategories(ctx context.Context, request ListCategoriesRequest) (response ListCategoriesResponse, err error)
ListCategories Lists the supported Cloud Advisor categories.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListCategories.go.html to see an example of how to use ListCategories API. A default retry strategy applies to this operation ListCategories()
func (client OptimizerClient) ListEnrollmentStatuses(ctx context.Context, request ListEnrollmentStatusesRequest) (response ListEnrollmentStatusesResponse, err error)
ListEnrollmentStatuses Lists the Cloud Advisor enrollment statuses.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListEnrollmentStatuses.go.html to see an example of how to use ListEnrollmentStatuses API. A default retry strategy applies to this operation ListEnrollmentStatuses()
func (client OptimizerClient) ListHistories(ctx context.Context, request ListHistoriesRequest) (response ListHistoriesResponse, err error)
ListHistories Lists changes to the recommendations based on user activity. For example, lists when recommendations have been implemented, dismissed, postponed, or reactivated.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListHistories.go.html to see an example of how to use ListHistories API. A default retry strategy applies to this operation ListHistories()
func (client OptimizerClient) ListProfileLevels(ctx context.Context, request ListProfileLevelsRequest) (response ListProfileLevelsResponse, err error)
ListProfileLevels Lists the existing profile levels.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListProfileLevels.go.html to see an example of how to use ListProfileLevels API. A default retry strategy applies to this operation ListProfileLevels()
func (client OptimizerClient) ListProfiles(ctx context.Context, request ListProfilesRequest) (response ListProfilesResponse, err error)
ListProfiles Lists the existing profiles.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListProfiles.go.html to see an example of how to use ListProfiles API. A default retry strategy applies to this operation ListProfiles()
func (client OptimizerClient) ListRecommendationStrategies(ctx context.Context, request ListRecommendationStrategiesRequest) (response ListRecommendationStrategiesResponse, err error)
ListRecommendationStrategies Lists the existing strategies.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListRecommendationStrategies.go.html to see an example of how to use ListRecommendationStrategies API. A default retry strategy applies to this operation ListRecommendationStrategies()
func (client OptimizerClient) ListRecommendations(ctx context.Context, request ListRecommendationsRequest) (response ListRecommendationsResponse, err error)
ListRecommendations Lists the Cloud Advisor recommendations that are currently supported.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListRecommendations.go.html to see an example of how to use ListRecommendations API. A default retry strategy applies to this operation ListRecommendations()
func (client OptimizerClient) ListResourceActionQueryableFields(ctx context.Context, request ListResourceActionQueryableFieldsRequest) (response ListResourceActionQueryableFieldsResponse, err error)
ListResourceActionQueryableFields Lists the fields that are indexed for querying and their associated value types.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListResourceActionQueryableFields.go.html to see an example of how to use ListResourceActionQueryableFields API. A default retry strategy applies to this operation ListResourceActionQueryableFields()
func (client OptimizerClient) ListResourceActions(ctx context.Context, request ListResourceActionsRequest) (response ListResourceActionsResponse, err error)
ListResourceActions Lists the Cloud Advisor resource actions that are supported.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListResourceActions.go.html to see an example of how to use ListResourceActions API. A default retry strategy applies to this operation ListResourceActions()
func (client OptimizerClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists errors associated with the specified work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client OptimizerClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs associated with the specified work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client OptimizerClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in the tenancy. The tenancy is the root compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *OptimizerClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client OptimizerClient) UpdateEnrollmentStatus(ctx context.Context, request UpdateEnrollmentStatusRequest) (response UpdateEnrollmentStatusResponse, err error)
UpdateEnrollmentStatus Updates the enrollment status of the tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/UpdateEnrollmentStatus.go.html to see an example of how to use UpdateEnrollmentStatus API. A default retry strategy applies to this operation UpdateEnrollmentStatus()
func (client OptimizerClient) UpdateProfile(ctx context.Context, request UpdateProfileRequest) (response UpdateProfileResponse, err error)
UpdateProfile Updates the specified profile. Uses the profile's OCID to determine which profile to update.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/UpdateProfile.go.html to see an example of how to use UpdateProfile API. A default retry strategy applies to this operation UpdateProfile()
func (client OptimizerClient) UpdateRecommendation(ctx context.Context, request UpdateRecommendationRequest) (response UpdateRecommendationResponse, err error)
UpdateRecommendation Updates the recommendation that corresponds to the specified OCID. Use this operation to implement the following actions:
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/UpdateRecommendation.go.html to see an example of how to use UpdateRecommendation API.
func (client OptimizerClient) UpdateResourceAction(ctx context.Context, request UpdateResourceActionRequest) (response UpdateResourceActionResponse, err error)
UpdateResourceAction Updates the resource action that corresponds to the specified OCID. Use this operation to implement the following actions:
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/UpdateResourceAction.go.html to see an example of how to use UpdateResourceAction API. A default retry strategy applies to this operation UpdateResourceAction()
OptimizerEnrollmentStatusEnum Enum with underlying type: string
type OptimizerEnrollmentStatusEnum string
Set of constants representing the allowable values for OptimizerEnrollmentStatusEnum
const (
OptimizerEnrollmentStatusActive OptimizerEnrollmentStatusEnum = "ACTIVE"
OptimizerEnrollmentStatusInactive OptimizerEnrollmentStatusEnum = "INACTIVE"
)
func GetMappingOptimizerEnrollmentStatusEnum(val string) (OptimizerEnrollmentStatusEnum, bool)
GetMappingOptimizerEnrollmentStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOptimizerEnrollmentStatusEnumValues() []OptimizerEnrollmentStatusEnum
GetOptimizerEnrollmentStatusEnumValues Enumerates the set of values for OptimizerEnrollmentStatusEnum
Profile The metadata associated with the profile.
type Profile struct {
// The unique OCID of the profile.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy. The tenancy is the root compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name assigned to the profile. Avoid entering confidential information.
Name *string `mandatory:"true" json:"name"`
// Text describing the profile. Avoid entering confidential information.
Description *string `mandatory:"true" json:"description"`
// The profile's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the profile was created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the profile was last updated, in the format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The time period over which to collect data for the recommendations, measured in number of days.
AggregationIntervalInDays *int `mandatory:"false" json:"aggregationIntervalInDays"`
// 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: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Simple key-value pair applied without any predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
LevelsConfiguration *LevelsConfiguration `mandatory:"false" json:"levelsConfiguration"`
TargetCompartments *TargetCompartments `mandatory:"false" json:"targetCompartments"`
TargetTags *TargetTags `mandatory:"false" json:"targetTags"`
}
func (m Profile) String() string
func (m Profile) 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
ProfileCollection A list of profiles that match filter criteria, if any. Results contain `ProfileSummary` objects.
type ProfileCollection struct {
// A collection of profile summaries.
Items []ProfileSummary `mandatory:"true" json:"items"`
}
func (m ProfileCollection) String() string
func (m ProfileCollection) 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
ProfileLevelCollection A list of profile levels that match the filter criteria, if any. The result contains `ProfileLevelSummary` objects.
type ProfileLevelCollection struct {
// A collection of profile levels.
Items []ProfileLevelSummary `mandatory:"true" json:"items"`
}
func (m ProfileLevelCollection) String() string
func (m ProfileLevelCollection) 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
ProfileLevelSummary The metadata associated with the profile level summary.
type ProfileLevelSummary struct {
// A unique name for the profile level.
Name *string `mandatory:"true" json:"name"`
// The name of the recommendation this profile level applies to.
RecommendationName *string `mandatory:"true" json:"recommendationName"`
// The metrics that will be evaluated by profiles using this profile level.
Metrics []EvaluatedMetric `mandatory:"true" json:"metrics"`
// The default aggregation interval (in days) for profiles using this profile level.
DefaultInterval *int `mandatory:"true" json:"defaultInterval"`
// An array of aggregation intervals (in days) allowed for profiles using this profile level.
ValidIntervals []int `mandatory:"true" json:"validIntervals"`
// The date and time the category details were created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the category details were last updated, in the format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
}
func (m ProfileLevelSummary) String() string
func (m ProfileLevelSummary) 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
ProfileSummary The metadata associated with the profile summary.
type ProfileSummary struct {
// The unique OCID of the profile.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy. The tenancy is the root compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name assigned to the profile.
Name *string `mandatory:"true" json:"name"`
// Text describing the profile.
Description *string `mandatory:"true" json:"description"`
// The profile's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the profile was created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the profile was last updated, in the format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The time period over which to collect data for the recommendations, measured in number of days.
AggregationIntervalInDays *int `mandatory:"false" json:"aggregationIntervalInDays"`
// 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: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Simple key-value pair applied without any predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
LevelsConfiguration *LevelsConfiguration `mandatory:"false" json:"levelsConfiguration"`
TargetCompartments *TargetCompartments `mandatory:"false" json:"targetCompartments"`
TargetTags *TargetTags `mandatory:"false" json:"targetTags"`
}
func (m ProfileSummary) String() string
func (m ProfileSummary) 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
QueryDetails The request object for querying the resource action details.
type QueryDetails struct {
// The query describing which resources to search for.
// For more information, see Query Language Syntax (https://docs.oracle.com/iaas/Content/CloudAdvisor/Reference/query-syntax.htm).
Query *string `mandatory:"false" json:"query"`
}
func (m QueryDetails) String() string
func (m QueryDetails) 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
QueryableFieldCollection List of the fields that are indexed for querying and their associated value types. Results contain `QueryableFieldSummary` objects.
type QueryableFieldCollection struct {
// A collection of queryable field summaries.
Items []QueryableFieldSummary `mandatory:"true" json:"items"`
}
func (m QueryableFieldCollection) String() string
func (m QueryableFieldCollection) 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
QueryableFieldSummary An individual field that can be used as part of a query filter.
type QueryableFieldSummary struct {
// The type of the field, which dictates the semantics and query constraints that you can use when searching or querying.
FieldType QueryableFieldSummaryFieldTypeEnum `mandatory:"true" json:"fieldType"`
// The name of the field to use when constructing the query. Field names are present for all types except `OBJECT`.
FieldName *string `mandatory:"true" json:"fieldName"`
// If the field type is `OBJECT`, this property lists the individual properties of the object that can be queried.
ObjectProperties []QueryableFieldSummary `mandatory:"false" json:"objectProperties"`
}
func (m QueryableFieldSummary) String() string
func (m QueryableFieldSummary) 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
QueryableFieldSummaryFieldTypeEnum Enum with underlying type: string
type QueryableFieldSummaryFieldTypeEnum string
Set of constants representing the allowable values for QueryableFieldSummaryFieldTypeEnum
const (
QueryableFieldSummaryFieldTypeString QueryableFieldSummaryFieldTypeEnum = "STRING"
QueryableFieldSummaryFieldTypeInteger QueryableFieldSummaryFieldTypeEnum = "INTEGER"
QueryableFieldSummaryFieldTypeBoolean QueryableFieldSummaryFieldTypeEnum = "BOOLEAN"
QueryableFieldSummaryFieldTypeDateTime QueryableFieldSummaryFieldTypeEnum = "DATE_TIME"
QueryableFieldSummaryFieldTypeObject QueryableFieldSummaryFieldTypeEnum = "OBJECT"
)
func GetMappingQueryableFieldSummaryFieldTypeEnum(val string) (QueryableFieldSummaryFieldTypeEnum, bool)
GetMappingQueryableFieldSummaryFieldTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQueryableFieldSummaryFieldTypeEnumValues() []QueryableFieldSummaryFieldTypeEnum
GetQueryableFieldSummaryFieldTypeEnumValues Enumerates the set of values for QueryableFieldSummaryFieldTypeEnum
Recommendation The metadata associated with the recommendation.
type Recommendation struct {
// The unique OCID associated with the recommendation.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy. The tenancy is the root compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The unique OCID associated with the category.
CategoryId *string `mandatory:"true" json:"categoryId"`
// The name assigned to the recommendation.
Name *string `mandatory:"true" json:"name"`
// Text describing the recommendation.
Description *string `mandatory:"true" json:"description"`
// The level of importance assigned to the recommendation.
Importance ImportanceEnum `mandatory:"true" json:"importance"`
// An array of `ResourceCount` objects grouped by the status of the resource actions.
ResourceCounts []ResourceCount `mandatory:"true" json:"resourceCounts"`
// The recommendation's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The estimated cost savings, in dollars, for the recommendation.
EstimatedCostSaving *float64 `mandatory:"true" json:"estimatedCostSaving"`
// The current status of the recommendation.
Status StatusEnum `mandatory:"true" json:"status"`
// The date and time that the recommendation entered its current status. The format is defined by RFC3339.
// For example, "The status of the recommendation changed from `pending` to `current(ignored)` on this date and time."
TimeStatusBegin *common.SDKTime `mandatory:"true" json:"timeStatusBegin"`
// The date and time the current status will change. The format is defined by RFC3339.
// For example, "The current `postponed` status of the recommendation will end and change to `pending` on this
// date and time."
TimeStatusEnd *common.SDKTime `mandatory:"false" json:"timeStatusEnd"`
// The date and time the recommendation details were created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the recommendation details were last updated, in the format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
SupportedLevels *SupportedLevels `mandatory:"false" json:"supportedLevels"`
// Additional metadata key/value pairs for the recommendation.
// For example:
// `{"EstimatedSaving": "200"}`
ExtendedMetadata map[string]string `mandatory:"false" json:"extendedMetadata"`
}
func (m Recommendation) String() string
func (m Recommendation) 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
RecommendationCollection A list of recommendations that match filter criteria, if any. Results contain `RecommendationSummary` objects.
type RecommendationCollection struct {
// A collection of recommendations.
Items []RecommendationSummary `mandatory:"true" json:"items"`
}
func (m RecommendationCollection) String() string
func (m RecommendationCollection) 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
RecommendationCount The count of recommendations in a category, grouped by importance.
type RecommendationCount struct {
// The level of importance assigned to the recommendation.
Importance ImportanceEnum `mandatory:"true" json:"importance"`
// The count of recommendations.
Count *int `mandatory:"true" json:"count"`
}
func (m RecommendationCount) String() string
func (m RecommendationCount) 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
RecommendationStrategyCollection A list of strategies that match filter criteria, if any. Results contain `RecommendationStrategySummary` objects.
type RecommendationStrategyCollection struct {
// A collection of recommendation strategy summaries.
Items []RecommendationStrategySummary `mandatory:"true" json:"items"`
}
func (m RecommendationStrategyCollection) String() string
func (m RecommendationStrategyCollection) 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
RecommendationStrategySummary The metadata associated with the recommendation strategy.
type RecommendationStrategySummary struct {
// The display name of the recommendation.
Name *string `mandatory:"true" json:"name"`
// The list of strategies used.
Strategies []Strategy `mandatory:"true" json:"strategies"`
}
func (m RecommendationStrategySummary) String() string
func (m RecommendationStrategySummary) 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
RecommendationSummary The metadata associated with the recommendation summary.
type RecommendationSummary struct {
// The unique OCID associated with the recommendation.
Id *string `mandatory:"true" json:"id"`
// The OCID of the tenancy. The tenancy is the root compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The unique OCID associated with the category.
CategoryId *string `mandatory:"true" json:"categoryId"`
// The name assigned to the recommendation.
Name *string `mandatory:"true" json:"name"`
// Text describing the recommendation.
Description *string `mandatory:"true" json:"description"`
// The level of importance assigned to the recommendation.
Importance ImportanceEnum `mandatory:"true" json:"importance"`
// An array of `ResourceCount` objects grouped by the status of the resource actions.
ResourceCounts []ResourceCount `mandatory:"true" json:"resourceCounts"`
// The recommendation's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The estimated cost savings, in dollars, for the recommendation.
EstimatedCostSaving *float64 `mandatory:"true" json:"estimatedCostSaving"`
// The current status of the recommendation.
Status StatusEnum `mandatory:"true" json:"status"`
// The date and time that the recommendation entered its current status. The format is defined by RFC3339.
// For example, "The status of the recommendation changed from `pending` to `current(ignored)` on this date and time."
TimeStatusBegin *common.SDKTime `mandatory:"true" json:"timeStatusBegin"`
// The date and time the current status will change. The format is defined by RFC3339.
// For example, "The current `postponed` status of the recommendation will end and change to `pending` on this
// date and time."
TimeStatusEnd *common.SDKTime `mandatory:"false" json:"timeStatusEnd"`
// The date and time the recommendation details were created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the recommendation details were last updated, in the format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
SupportedLevels *SupportedLevels `mandatory:"false" json:"supportedLevels"`
// Additional metadata key/value pairs for the recommendation summary.
// For example:
// `{"EstimatedSaving": "200"}`
ExtendedMetadata map[string]string `mandatory:"false" json:"extendedMetadata"`
}
func (m RecommendationSummary) String() string
func (m RecommendationSummary) 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
ResourceAction The metadata associated with the resource action.
type ResourceAction struct {
// The unique OCID associated with the resource action.
Id *string `mandatory:"true" json:"id"`
// The unique OCID associated with the category.
CategoryId *string `mandatory:"true" json:"categoryId"`
// The unique OCID associated with the recommendation.
RecommendationId *string `mandatory:"true" json:"recommendationId"`
// The unique OCID associated with the resource.
ResourceId *string `mandatory:"true" json:"resourceId"`
// The name assigned to the resource.
Name *string `mandatory:"true" json:"name"`
// The kind of resource.
ResourceType *string `mandatory:"true" json:"resourceType"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name associated with the compartment.
CompartmentName *string `mandatory:"true" json:"compartmentName"`
Action *Action `mandatory:"true" json:"action"`
// The resource action's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The estimated cost savings, in dollars, for the resource action.
EstimatedCostSaving *float64 `mandatory:"true" json:"estimatedCostSaving"`
// The current status of the resource action.
Status StatusEnum `mandatory:"true" json:"status"`
// The date and time that the resource action entered its current status. The format is defined by RFC3339.
// For example, "The status of the resource action changed from `pending` to `current(ignored)` on this date and time."
TimeStatusBegin *common.SDKTime `mandatory:"true" json:"timeStatusBegin"`
// The date and time the current status will change. The format is defined by RFC3339.
// For example, "The current `postponed` status of the resource action will end and change to `pending` on this
// date and time."
TimeStatusEnd *common.SDKTime `mandatory:"false" json:"timeStatusEnd"`
// Custom metadata key/value pairs for the resource action.
// **Metadata Example**
// "metadata" : {
// "cpuRecommendedShape": "VM.Standard1.1",
// "computeMemoryUtilization": "26.05734124418388",
// "currentShape": "VM.Standard1.2",
// "instanceRecommendedShape": "VM.Standard1.1",
// "computeCpuUtilization": "7.930035319720132",
// "memoryRecommendedShape": "None"
// }
Metadata map[string]string `mandatory:"false" json:"metadata"`
// Additional metadata key/value pairs that you provide.
// They serve the same purpose and functionality as fields in the `metadata` object.
// They are distinguished from `metadata` fields in that these can be nested JSON objects (whereas `metadata` fields are string/string maps only).
// For example:
// `{"CurrentShape": {"name":"VM.Standard2.16"}, "RecommendedShape": {"name":"VM.Standard2.8"}}`
ExtendedMetadata map[string]interface{} `mandatory:"false" json:"extendedMetadata"`
// The date and time the resource action details were created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the resource action details were last updated, in the format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m ResourceAction) String() string
func (m ResourceAction) 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
ResourceActionCollection A list of resource actions that match filter criteria, if any. Results contain `ResourceActionSummary` objects.
type ResourceActionCollection struct {
// A collection of resource actions.
Items []ResourceActionSummary `mandatory:"true" json:"items"`
}
func (m ResourceActionCollection) String() string
func (m ResourceActionCollection) 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
ResourceActionSummary The metadata associated with the resource action summary.
type ResourceActionSummary struct {
// The unique OCID associated with the resource action.
Id *string `mandatory:"true" json:"id"`
// The unique OCID associated with the category.
CategoryId *string `mandatory:"true" json:"categoryId"`
// The unique OCID associated with the recommendation.
RecommendationId *string `mandatory:"true" json:"recommendationId"`
// The unique OCID associated with the resource.
ResourceId *string `mandatory:"true" json:"resourceId"`
// The name assigned to the resource.
Name *string `mandatory:"true" json:"name"`
// The kind of resource.
ResourceType *string `mandatory:"true" json:"resourceType"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name associated with the compartment.
CompartmentName *string `mandatory:"true" json:"compartmentName"`
Action *Action `mandatory:"true" json:"action"`
// The resource action's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The estimated cost savings, in dollars, for the resource action.
EstimatedCostSaving *float64 `mandatory:"true" json:"estimatedCostSaving"`
// The current status of the resource action.
Status StatusEnum `mandatory:"true" json:"status"`
// The date and time that the resource action entered its current status. The format is defined by RFC3339.
// For example, "The status of the resource action changed from `pending` to `current(ignored)` on this date and time."
TimeStatusBegin *common.SDKTime `mandatory:"true" json:"timeStatusBegin"`
// The date and time the current status will change. The format is defined by RFC3339.
// For example, "The current `postponed` status of the resource action will end and change to `pending` on this
// date and time."
TimeStatusEnd *common.SDKTime `mandatory:"false" json:"timeStatusEnd"`
// Custom metadata key/value pairs for the resource action.
// **Metadata Example**
// "metadata" : {
// "cpuRecommendedShape": "VM.Standard1.1",
// "computeMemoryUtilization": "26.05734124418388",
// "currentShape": "VM.Standard1.2",
// "instanceRecommendedShape": "VM.Standard1.1",
// "computeCpuUtilization": "7.930035319720132",
// "memoryRecommendedShape": "None"
// }
Metadata map[string]string `mandatory:"false" json:"metadata"`
// Additional metadata key/value pairs that you provide.
// They serve the same purpose and functionality as fields in the `metadata` object.
// They are distinguished from `metadata` fields in that these can be nested JSON objects (whereas `metadata` fields are string/string maps only).
// For example:
// `{"CurrentShape": {"name":"VM.Standard2.16"}, "RecommendedShape": {"name":"VM.Standard2.8"}}`
ExtendedMetadata map[string]interface{} `mandatory:"false" json:"extendedMetadata"`
// The date and time the resource action details were created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the resource action details were last updated, in the format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m ResourceActionSummary) String() string
func (m ResourceActionSummary) 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
ResourceCount The count of resources in a category, grouped by status.
type ResourceCount struct {
// The recommendation status of the resource.
Status StatusEnum `mandatory:"true" json:"status"`
// The count of resources.
Count *int `mandatory:"true" json:"count"`
}
func (m ResourceCount) String() string
func (m ResourceCount) 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
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(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
StatusEnum Enum with underlying type: string
type StatusEnum string
Set of constants representing the allowable values for StatusEnum
const (
StatusPending StatusEnum = "PENDING"
StatusDismissed StatusEnum = "DISMISSED"
StatusPostponed StatusEnum = "POSTPONED"
StatusImplemented StatusEnum = "IMPLEMENTED"
)
func GetMappingStatusEnum(val string) (StatusEnum, bool)
GetMappingStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStatusEnumValues() []StatusEnum
GetStatusEnumValues Enumerates the set of values for StatusEnum
Strategy The metadata associated with the strategy. The strategy is the method used to apply the recommendation.
type Strategy struct {
// The name of the strategy.
StrategyName *string `mandatory:"true" json:"strategyName"`
// Whether this is the default recommendation strategy.
IsDefault *bool `mandatory:"true" json:"isDefault"`
// The list of strategies for the parameters.
ParametersDefinition []StrategyParameter `mandatory:"false" json:"parametersDefinition"`
}
func (m Strategy) String() string
func (m Strategy) 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
StrategyParameter The metadata associated with the strategy parameter.
type StrategyParameter struct {
// The name of the strategy parameter.
Name *string `mandatory:"true" json:"name"`
// The type of strategy parameter.
Type StrategyParameterTypeEnum `mandatory:"true" json:"type"`
// Text describing the strategy parameter.
Description *string `mandatory:"true" json:"description"`
// Whether this parameter is required.
IsRequired *bool `mandatory:"true" json:"isRequired"`
// A default value used for the strategy parameter.
DefaultValue *interface{} `mandatory:"false" json:"defaultValue"`
// The list of possible values used for these strategy parameters.
PossibleValues []interface{} `mandatory:"false" json:"possibleValues"`
}
func (m StrategyParameter) String() string
func (m StrategyParameter) 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
StrategyParameterTypeEnum Enum with underlying type: string
type StrategyParameterTypeEnum string
Set of constants representing the allowable values for StrategyParameterTypeEnum
const (
StrategyParameterTypeString StrategyParameterTypeEnum = "STRING"
StrategyParameterTypeBoolean StrategyParameterTypeEnum = "BOOLEAN"
StrategyParameterTypeNumber StrategyParameterTypeEnum = "NUMBER"
StrategyParameterTypeDatetime StrategyParameterTypeEnum = "DATETIME"
)
func GetMappingStrategyParameterTypeEnum(val string) (StrategyParameterTypeEnum, bool)
GetMappingStrategyParameterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStrategyParameterTypeEnumValues() []StrategyParameterTypeEnum
GetStrategyParameterTypeEnumValues Enumerates the set of values for StrategyParameterTypeEnum
SupportedLevel A system defined profile level supported by the recommendation.
type SupportedLevel struct {
// The name of the profile level.
Name *string `mandatory:"false" json:"name"`
}
func (m SupportedLevel) String() string
func (m SupportedLevel) 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
SupportedLevels Optional. The profile levels supported by a recommendation. For example, profile level values could be `Low`, `Medium`, and `High`. Not all recommendations support this field.
type SupportedLevels struct {
// The list of supported levels.
Items []SupportedLevel `mandatory:"false" json:"items"`
}
func (m SupportedLevels) String() string
func (m SupportedLevels) 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
TagValueTypeEnum Enum with underlying type: string
type TagValueTypeEnum string
Set of constants representing the allowable values for TagValueTypeEnum
const (
TagValueTypeValue TagValueTypeEnum = "VALUE"
TagValueTypeAny TagValueTypeEnum = "ANY"
)
func GetMappingTagValueTypeEnum(val string) (TagValueTypeEnum, bool)
GetMappingTagValueTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTagValueTypeEnumValues() []TagValueTypeEnum
GetTagValueTypeEnumValues Enumerates the set of values for TagValueTypeEnum
TargetCompartments Optional. The compartments specified in the profile override for a recommendation.
type TargetCompartments struct {
// The list of OCIDs attached to the compartments specified in the current profile override.
Items []string `mandatory:"true" json:"items"`
}
func (m TargetCompartments) String() string
func (m TargetCompartments) 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
TargetTag A tag key definition used in the current profile override, including the tag namespace, tag key, tag value type, and tag values. Only defined tags are supported. For more information about tagging, see Tagging Overview (https://docs.oracle.com/iaas/Content/Tagging/Concepts/taggingoverview.htm)
type TargetTag struct {
// The name of the tag namespace.
TagNamespaceName *string `mandatory:"true" json:"tagNamespaceName"`
// The name you use to refer to the tag, also known as the tag key.
TagDefinitionName *string `mandatory:"true" json:"tagDefinitionName"`
// Specifies which tag value types in the `tagValues` field result in overrides of the recommendation criteria.
// When the value for this field is `ANY`, the `tagValues` field should be empty, which enforces overrides to the recommendation
// for resources with any tag values attached to them.
// When the value for this field value is `VALUE`, the `tagValues` field must include a specific value or list of values.
// Overrides to the recommendation criteria only occur for resources that match the values in the `tagValues` fields.
TagValueType TagValueTypeEnum `mandatory:"true" json:"tagValueType"`
// The list of tag values. The tag value is the value that the user applying the tag adds to the tag key.
TagValues []string `mandatory:"false" json:"tagValues"`
}
func (m TargetTag) String() string
func (m TargetTag) 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
TargetTags Optional. The tags specified in the profile override for a recommendation.
type TargetTags struct {
// The list of tags specified in the current profile override.
Items []TargetTag `mandatory:"true" json:"items"`
}
func (m TargetTags) String() string
func (m TargetTags) 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
UpdateEnrollmentStatusDetails The request object for updating the enrollment status details.
type UpdateEnrollmentStatusDetails struct {
// The Cloud Advisor enrollment status.
Status OptimizerEnrollmentStatusEnum `mandatory:"true" json:"status"`
}
func (m UpdateEnrollmentStatusDetails) String() string
func (m UpdateEnrollmentStatusDetails) 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
UpdateEnrollmentStatusRequest wrapper for the UpdateEnrollmentStatus operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/UpdateEnrollmentStatus.go.html to see an example of how to use UpdateEnrollmentStatusRequest.
type UpdateEnrollmentStatusRequest struct {
// The unique OCID associated with the enrollment status.
EnrollmentStatusId *string `mandatory:"true" contributesTo:"path" name:"enrollmentStatusId"`
// The request object for updating the enrollment status.
UpdateEnrollmentStatusDetails `contributesTo:"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 `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateEnrollmentStatusRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateEnrollmentStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateEnrollmentStatusRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateEnrollmentStatusRequest) String() string
func (request UpdateEnrollmentStatusRequest) 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
UpdateEnrollmentStatusResponse wrapper for the UpdateEnrollmentStatus operation
type UpdateEnrollmentStatusResponse struct {
// The underlying http response
RawResponse *http.Response
// The EnrollmentStatus instance
EnrollmentStatus `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateEnrollmentStatusResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateEnrollmentStatusResponse) String() string
UpdateProfileDetails Details for updating a profile.
type UpdateProfileDetails struct {
// Text describing the profile. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// The time period over which to collect data for the recommendations, measured in number of days.
AggregationIntervalInDays *int `mandatory:"false" json:"aggregationIntervalInDays"`
// 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: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Simple key-value pair applied without any predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
LevelsConfiguration *LevelsConfiguration `mandatory:"false" json:"levelsConfiguration"`
TargetCompartments *TargetCompartments `mandatory:"false" json:"targetCompartments"`
TargetTags *TargetTags `mandatory:"false" json:"targetTags"`
// The name assigned to the profile. Avoid entering confidential information.
Name *string `mandatory:"false" json:"name"`
}
func (m UpdateProfileDetails) String() string
func (m UpdateProfileDetails) 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
UpdateProfileRequest wrapper for the UpdateProfile operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/UpdateProfile.go.html to see an example of how to use UpdateProfileRequest.
type UpdateProfileRequest struct {
// The unique OCID of the profile.
ProfileId *string `mandatory:"true" contributesTo:"path" name:"profileId"`
// The profile information to use for the update.
UpdateProfileDetails `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"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateProfileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateProfileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateProfileRequest) String() string
func (request UpdateProfileRequest) 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
UpdateProfileResponse wrapper for the UpdateProfile operation
type UpdateProfileResponse struct {
// The underlying http response
RawResponse *http.Response
// The Profile instance
Profile `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateProfileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateProfileResponse) String() string
UpdateRecommendationDetails The request object for updating the recommendation details.
type UpdateRecommendationDetails struct {
// The status of the recommendation.
Status StatusEnum `mandatory:"true" json:"status"`
// The date and time the current status will change. The format is defined by RFC3339.
// For example, "The current `postponed` status of the recommendation will end and change to `pending` on this
// date and time."
TimeStatusEnd *common.SDKTime `mandatory:"false" json:"timeStatusEnd"`
}
func (m UpdateRecommendationDetails) String() string
func (m UpdateRecommendationDetails) 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
UpdateRecommendationRequest wrapper for the UpdateRecommendation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/UpdateRecommendation.go.html to see an example of how to use UpdateRecommendationRequest.
type UpdateRecommendationRequest struct {
// The unique OCID associated with the recommendation.
RecommendationId *string `mandatory:"true" contributesTo:"path" name:"recommendationId"`
// The request object for updating the recommendation details.
UpdateRecommendationDetails `contributesTo:"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 `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateRecommendationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRecommendationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRecommendationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRecommendationRequest) String() string
func (request UpdateRecommendationRequest) 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
UpdateRecommendationResponse wrapper for the UpdateRecommendation operation
type UpdateRecommendationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Recommendation instance
Recommendation `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateRecommendationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRecommendationResponse) String() string
UpdateResourceActionDetails The request object for updating the resource action details.
type UpdateResourceActionDetails struct {
// The status of the resource action.
Status StatusEnum `mandatory:"true" json:"status"`
// The date and time the current status will change. The format is defined by RFC3339.
// For example, "The current `postponed` status of the resource action will end and change to `pending` on this
// date and time."
TimeStatusEnd *common.SDKTime `mandatory:"false" json:"timeStatusEnd"`
}
func (m UpdateResourceActionDetails) String() string
func (m UpdateResourceActionDetails) 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
UpdateResourceActionRequest wrapper for the UpdateResourceAction operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/UpdateResourceAction.go.html to see an example of how to use UpdateResourceActionRequest.
type UpdateResourceActionRequest struct {
// The unique OCID associated with the resource action.
ResourceActionId *string `mandatory:"true" contributesTo:"path" name:"resourceActionId"`
// The resource action information to be updated.
UpdateResourceActionDetails `contributesTo:"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 `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateResourceActionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateResourceActionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateResourceActionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateResourceActionRequest) String() string
func (request UpdateResourceActionRequest) 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
UpdateResourceActionResponse wrapper for the UpdateResourceAction operation
type UpdateResourceActionResponse struct {
// The underlying http response
RawResponse *http.Response
// The ResourceAction instance
ResourceAction `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateResourceActionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateResourceActionResponse) String() string
WorkRequest The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows.
type WorkRequest struct {
// An enum-like description of the type of work the work request is doing.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The current status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources this work request affects.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// How much progress the operation has made.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// Date and time the work was accepted, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// Date and time the work started, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// Date and time the work completed, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) 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
WorkRequestActionTypeEnum Enum with underlying type: string
type WorkRequestActionTypeEnum string
Set of constants representing the allowable values for WorkRequestActionTypeEnum
const (
WorkRequestActionTypeCreated WorkRequestActionTypeEnum = "CREATED"
WorkRequestActionTypeUpdated WorkRequestActionTypeEnum = "UPDATED"
WorkRequestActionTypeDeleted WorkRequestActionTypeEnum = "DELETED"
WorkRequestActionTypeInProgress WorkRequestActionTypeEnum = "IN_PROGRESS"
WorkRequestActionTypeRelated WorkRequestActionTypeEnum = "RELATED"
)
func GetMappingWorkRequestActionTypeEnum(val string) (WorkRequestActionTypeEnum, bool)
GetMappingWorkRequestActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestActionTypeEnumValues() []WorkRequestActionTypeEnum
GetWorkRequestActionTypeEnumValues Enumerates the set of values for WorkRequestActionTypeEnum
WorkRequestCollection A list of work requests that match filter criteria, if any. Results contain `WorkRequest` objects.
type WorkRequestCollection struct {
// A collection of work requests.
Items []WorkRequest `mandatory:"true" json:"items"`
}
func (m WorkRequestCollection) String() string
func (m WorkRequestCollection) 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
WorkRequestError Details about errors encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred.
Code *string `mandatory:"true" json:"code"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
// Date and time the error happened, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) 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
WorkRequestErrorCollection A list of work request errors that match filter criteria, if any. Results contain `WorkRequestError` objects.
type WorkRequestErrorCollection struct {
// A collection of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) 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
WorkRequestLogEntry Details about the log entity.
type WorkRequestLogEntry struct {
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
// Date and time the log was written, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) 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
WorkRequestLogEntryCollection A list of work request logs that match filter criteria, if any. Results contain `WorkRequestLogEntry` objects.
type WorkRequestLogEntryCollection struct {
// A collection of work request log entries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) 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
WorkRequestResource Details about the resource entity.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource was affected by the work tracked by the work request.
// A resource being created, updated, or deleted remains in the `IN_PROGRESS` state until
// work is complete for that resource. At that point, the resource transitions to the `CREATED`, `UPDATED`,
// or `DELETED` state.
ActionType WorkRequestActionTypeEnum `mandatory:"true" json:"actionType"`
// The resource identifier the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata
EntityUri *string `mandatory:"false" json:"entityUri"`
// Additional information about the resource.
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) 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
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyOperationName WorkRequestResourceMetadataKeyEnum = "OPERATION_NAME"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum