optimizer

package
v65.63.2 Latest Latest
Warning

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

Go to latest
Published: Apr 16, 2024 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetImportanceEnumStringValues

func GetImportanceEnumStringValues() []string

GetImportanceEnumStringValues Enumerates the set of values in String for ImportanceEnum

func GetLifecycleStateEnumStringValues

func GetLifecycleStateEnumStringValues() []string

GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum

func GetListCategoriesLifecycleStateEnumStringValues

func GetListCategoriesLifecycleStateEnumStringValues() []string

GetListCategoriesLifecycleStateEnumStringValues Enumerates the set of values in String for ListCategoriesLifecycleStateEnum

func GetListCategoriesSortByEnumStringValues

func GetListCategoriesSortByEnumStringValues() []string

GetListCategoriesSortByEnumStringValues Enumerates the set of values in String for ListCategoriesSortByEnum

func GetListCategoriesSortOrderEnumStringValues

func GetListCategoriesSortOrderEnumStringValues() []string

GetListCategoriesSortOrderEnumStringValues Enumerates the set of values in String for ListCategoriesSortOrderEnum

func GetListEnrollmentStatusesLifecycleStateEnumStringValues

func GetListEnrollmentStatusesLifecycleStateEnumStringValues() []string

GetListEnrollmentStatusesLifecycleStateEnumStringValues Enumerates the set of values in String for ListEnrollmentStatusesLifecycleStateEnum

func GetListEnrollmentStatusesSortByEnumStringValues

func GetListEnrollmentStatusesSortByEnumStringValues() []string

GetListEnrollmentStatusesSortByEnumStringValues Enumerates the set of values in String for ListEnrollmentStatusesSortByEnum

func GetListEnrollmentStatusesSortOrderEnumStringValues

func GetListEnrollmentStatusesSortOrderEnumStringValues() []string

GetListEnrollmentStatusesSortOrderEnumStringValues Enumerates the set of values in String for ListEnrollmentStatusesSortOrderEnum

func GetListEnrollmentStatusesStatusEnumStringValues

func GetListEnrollmentStatusesStatusEnumStringValues() []string

GetListEnrollmentStatusesStatusEnumStringValues Enumerates the set of values in String for ListEnrollmentStatusesStatusEnum

func GetListHistoriesLifecycleStateEnumStringValues

func GetListHistoriesLifecycleStateEnumStringValues() []string

GetListHistoriesLifecycleStateEnumStringValues Enumerates the set of values in String for ListHistoriesLifecycleStateEnum

func GetListHistoriesSortByEnumStringValues

func GetListHistoriesSortByEnumStringValues() []string

GetListHistoriesSortByEnumStringValues Enumerates the set of values in String for ListHistoriesSortByEnum

func GetListHistoriesSortOrderEnumStringValues

func GetListHistoriesSortOrderEnumStringValues() []string

GetListHistoriesSortOrderEnumStringValues Enumerates the set of values in String for ListHistoriesSortOrderEnum

func GetListHistoriesStatusEnumStringValues

func GetListHistoriesStatusEnumStringValues() []string

GetListHistoriesStatusEnumStringValues Enumerates the set of values in String for ListHistoriesStatusEnum

func GetListProfileLevelsSortByEnumStringValues

func GetListProfileLevelsSortByEnumStringValues() []string

GetListProfileLevelsSortByEnumStringValues Enumerates the set of values in String for ListProfileLevelsSortByEnum

func GetListProfileLevelsSortOrderEnumStringValues

func GetListProfileLevelsSortOrderEnumStringValues() []string

GetListProfileLevelsSortOrderEnumStringValues Enumerates the set of values in String for ListProfileLevelsSortOrderEnum

func GetListProfilesLifecycleStateEnumStringValues

func GetListProfilesLifecycleStateEnumStringValues() []string

GetListProfilesLifecycleStateEnumStringValues Enumerates the set of values in String for ListProfilesLifecycleStateEnum

func GetListProfilesSortByEnumStringValues

func GetListProfilesSortByEnumStringValues() []string

GetListProfilesSortByEnumStringValues Enumerates the set of values in String for ListProfilesSortByEnum

func GetListProfilesSortOrderEnumStringValues

func GetListProfilesSortOrderEnumStringValues() []string

GetListProfilesSortOrderEnumStringValues Enumerates the set of values in String for ListProfilesSortOrderEnum

func GetListRecommendationStrategiesSortByEnumStringValues

func GetListRecommendationStrategiesSortByEnumStringValues() []string

GetListRecommendationStrategiesSortByEnumStringValues Enumerates the set of values in String for ListRecommendationStrategiesSortByEnum

func GetListRecommendationStrategiesSortOrderEnumStringValues

func GetListRecommendationStrategiesSortOrderEnumStringValues() []string

GetListRecommendationStrategiesSortOrderEnumStringValues Enumerates the set of values in String for ListRecommendationStrategiesSortOrderEnum

func GetListRecommendationsLifecycleStateEnumStringValues

func GetListRecommendationsLifecycleStateEnumStringValues() []string

GetListRecommendationsLifecycleStateEnumStringValues Enumerates the set of values in String for ListRecommendationsLifecycleStateEnum

func GetListRecommendationsSortByEnumStringValues

func GetListRecommendationsSortByEnumStringValues() []string

GetListRecommendationsSortByEnumStringValues Enumerates the set of values in String for ListRecommendationsSortByEnum

func GetListRecommendationsSortOrderEnumStringValues

func GetListRecommendationsSortOrderEnumStringValues() []string

GetListRecommendationsSortOrderEnumStringValues Enumerates the set of values in String for ListRecommendationsSortOrderEnum

func GetListRecommendationsStatusEnumStringValues

func GetListRecommendationsStatusEnumStringValues() []string

GetListRecommendationsStatusEnumStringValues Enumerates the set of values in String for ListRecommendationsStatusEnum

func GetListResourceActionsLifecycleStateEnumStringValues

func GetListResourceActionsLifecycleStateEnumStringValues() []string

GetListResourceActionsLifecycleStateEnumStringValues Enumerates the set of values in String for ListResourceActionsLifecycleStateEnum

func GetListResourceActionsSortByEnumStringValues

func GetListResourceActionsSortByEnumStringValues() []string

GetListResourceActionsSortByEnumStringValues Enumerates the set of values in String for ListResourceActionsSortByEnum

func GetListResourceActionsSortOrderEnumStringValues

func GetListResourceActionsSortOrderEnumStringValues() []string

GetListResourceActionsSortOrderEnumStringValues Enumerates the set of values in String for ListResourceActionsSortOrderEnum

func GetListResourceActionsStatusEnumStringValues

func GetListResourceActionsStatusEnumStringValues() []string

GetListResourceActionsStatusEnumStringValues Enumerates the set of values in String for ListResourceActionsStatusEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetOptimizerEnrollmentStatusEnumStringValues

func GetOptimizerEnrollmentStatusEnumStringValues() []string

GetOptimizerEnrollmentStatusEnumStringValues Enumerates the set of values in String for OptimizerEnrollmentStatusEnum

func GetQueryableFieldSummaryFieldTypeEnumStringValues

func GetQueryableFieldSummaryFieldTypeEnumStringValues() []string

GetQueryableFieldSummaryFieldTypeEnumStringValues Enumerates the set of values in String for QueryableFieldSummaryFieldTypeEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetStatusEnumStringValues

func GetStatusEnumStringValues() []string

GetStatusEnumStringValues Enumerates the set of values in String for StatusEnum

func GetStrategyParameterTypeEnumStringValues

func GetStrategyParameterTypeEnumStringValues() []string

GetStrategyParameterTypeEnumStringValues Enumerates the set of values in String for StrategyParameterTypeEnum

func GetTagValueTypeEnumStringValues

func GetTagValueTypeEnumStringValues() []string

GetTagValueTypeEnumStringValues Enumerates the set of values in String for TagValueTypeEnum

func GetWorkRequestActionTypeEnumStringValues

func GetWorkRequestActionTypeEnumStringValues() []string

GetWorkRequestActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestActionTypeEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

Types

type 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"`
}

Action Details about the recommended action.

func (Action) String

func (m Action) String() string

func (Action) ValidateEnumValue

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

type ActionTypeEnum

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string

const (
	ActionTypeKbArticle ActionTypeEnum = "KB_ARTICLE"
)

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

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

type BulkApplyRecommendationsDetails

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"`
}

BulkApplyRecommendationsDetails Details about bulk recommendation actions.

func (BulkApplyRecommendationsDetails) String

func (BulkApplyRecommendationsDetails) ValidateEnumValue

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

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

BulkApplyRecommendationsRequest wrapper for the BulkApplyRecommendations operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/BulkApplyRecommendations.go.html to see an example of how to use BulkApplyRecommendationsRequest.

func (BulkApplyRecommendationsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (BulkApplyRecommendationsRequest) HTTPRequest

func (request BulkApplyRecommendationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BulkApplyRecommendationsRequest) RetryPolicy

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

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

func (BulkApplyRecommendationsRequest) String

func (request BulkApplyRecommendationsRequest) String() string

func (BulkApplyRecommendationsRequest) ValidateEnumValue

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

type BulkApplyRecommendationsResponse

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"`
}

BulkApplyRecommendationsResponse wrapper for the BulkApplyRecommendations operation

func (BulkApplyRecommendationsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (BulkApplyRecommendationsResponse) String

func (response BulkApplyRecommendationsResponse) String() string

type BulkApplyResourceAction

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"`
}

BulkApplyResourceAction The resource action that a recommendation will be applied to.

func (BulkApplyResourceAction) String

func (m BulkApplyResourceAction) String() string

func (BulkApplyResourceAction) ValidateEnumValue

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

type 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"`
}

Category The metadata associated with the category.

func (Category) String

func (m Category) String() string

func (Category) ValidateEnumValue

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

type CategoryCollection

type CategoryCollection struct {

	// A collection of category summaries.
	Items []CategorySummary `mandatory:"true" json:"items"`
}

CategoryCollection A list of categories that match filter criteria, if any. Results contain `CategorySummary` objects.

func (CategoryCollection) String

func (m CategoryCollection) String() string

func (CategoryCollection) ValidateEnumValue

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

type CategorySummary

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"`
}

CategorySummary The metadata associated with the category summary.

func (CategorySummary) String

func (m CategorySummary) String() string

func (CategorySummary) ValidateEnumValue

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

type CreateProfileDetails

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.cloud.oracle.com/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.cloud.oracle.com/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"`
}

CreateProfileDetails Details for creating a profile.

func (CreateProfileDetails) String

func (m CreateProfileDetails) String() string

func (CreateProfileDetails) ValidateEnumValue

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

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

CreateProfileRequest wrapper for the CreateProfile operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/CreateProfile.go.html to see an example of how to use CreateProfileRequest.

func (CreateProfileRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (CreateProfileRequest) HTTPRequest

func (request CreateProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateProfileRequest) RetryPolicy

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

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

func (CreateProfileRequest) String

func (request CreateProfileRequest) String() string

func (CreateProfileRequest) ValidateEnumValue

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

type CreateProfileResponse

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"`
}

CreateProfileResponse wrapper for the CreateProfile operation

func (CreateProfileResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateProfileResponse) String

func (response CreateProfileResponse) String() string

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

DeleteProfileRequest wrapper for the DeleteProfile operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/DeleteProfile.go.html to see an example of how to use DeleteProfileRequest.

func (DeleteProfileRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteProfileRequest) HTTPRequest

func (request DeleteProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteProfileRequest) RetryPolicy

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

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

func (DeleteProfileRequest) String

func (request DeleteProfileRequest) String() string

func (DeleteProfileRequest) ValidateEnumValue

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

type DeleteProfileResponse

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"`
}

DeleteProfileResponse wrapper for the DeleteProfile operation

func (DeleteProfileResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteProfileResponse) String

func (response DeleteProfileResponse) String() string

type EnrollmentStatus

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"`
}

EnrollmentStatus The metadata associated with the enrollment status.

func (EnrollmentStatus) String

func (m EnrollmentStatus) String() string

func (EnrollmentStatus) ValidateEnumValue

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

type EnrollmentStatusCollection

type EnrollmentStatusCollection struct {

	// A collection of enrollment status summaries.
	Items []EnrollmentStatusSummary `mandatory:"true" json:"items"`
}

EnrollmentStatusCollection A list of enrollment statuses that match filter criteria, if any. Results contain `EnrollmentStatusSummary` objects.

func (EnrollmentStatusCollection) String

func (EnrollmentStatusCollection) ValidateEnumValue

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

type EnrollmentStatusSummary

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"`
}

EnrollmentStatusSummary The metadata associated with the enrollment status summary.

func (EnrollmentStatusSummary) String

func (m EnrollmentStatusSummary) String() string

func (EnrollmentStatusSummary) ValidateEnumValue

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

type EvaluatedMetric

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"`
}

EvaluatedMetric One of the metrics that will be evaluated by profiles using this profile level.

func (EvaluatedMetric) String

func (m EvaluatedMetric) String() string

func (EvaluatedMetric) ValidateEnumValue

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

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

FilterResourceActionsRequest wrapper for the FilterResourceActions operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/FilterResourceActions.go.html to see an example of how to use FilterResourceActionsRequest.

func (FilterResourceActionsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (FilterResourceActionsRequest) HTTPRequest

func (request FilterResourceActionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (FilterResourceActionsRequest) RetryPolicy

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

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

func (FilterResourceActionsRequest) String

func (request FilterResourceActionsRequest) String() string

func (FilterResourceActionsRequest) ValidateEnumValue

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

type FilterResourceActionsResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

FilterResourceActionsResponse wrapper for the FilterResourceActions operation

func (FilterResourceActionsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (FilterResourceActionsResponse) String

func (response FilterResourceActionsResponse) String() string

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

GetCategoryRequest wrapper for the GetCategory operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetCategory.go.html to see an example of how to use GetCategoryRequest.

func (GetCategoryRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetCategoryRequest) HTTPRequest

func (request GetCategoryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetCategoryRequest) RetryPolicy

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

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

func (GetCategoryRequest) String

func (request GetCategoryRequest) String() string

func (GetCategoryRequest) ValidateEnumValue

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

type GetCategoryResponse

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"`
}

GetCategoryResponse wrapper for the GetCategory operation

func (GetCategoryResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetCategoryResponse) String

func (response GetCategoryResponse) String() string

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

GetEnrollmentStatusRequest wrapper for the GetEnrollmentStatus operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetEnrollmentStatus.go.html to see an example of how to use GetEnrollmentStatusRequest.

func (GetEnrollmentStatusRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetEnrollmentStatusRequest) HTTPRequest

func (request GetEnrollmentStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetEnrollmentStatusRequest) RetryPolicy

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

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

func (GetEnrollmentStatusRequest) String

func (request GetEnrollmentStatusRequest) String() string

func (GetEnrollmentStatusRequest) ValidateEnumValue

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

type GetEnrollmentStatusResponse

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"`
}

GetEnrollmentStatusResponse wrapper for the GetEnrollmentStatus operation

func (GetEnrollmentStatusResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetEnrollmentStatusResponse) String

func (response GetEnrollmentStatusResponse) String() string

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

GetProfileRequest wrapper for the GetProfile operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetProfile.go.html to see an example of how to use GetProfileRequest.

func (GetProfileRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetProfileRequest) HTTPRequest

func (request GetProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetProfileRequest) RetryPolicy

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

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

func (GetProfileRequest) String

func (request GetProfileRequest) String() string

func (GetProfileRequest) ValidateEnumValue

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

type GetProfileResponse

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"`
}

GetProfileResponse wrapper for the GetProfile operation

func (GetProfileResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetProfileResponse) String

func (response GetProfileResponse) String() string

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

GetRecommendationRequest wrapper for the GetRecommendation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetRecommendation.go.html to see an example of how to use GetRecommendationRequest.

func (GetRecommendationRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetRecommendationRequest) HTTPRequest

func (request GetRecommendationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetRecommendationRequest) RetryPolicy

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

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

func (GetRecommendationRequest) String

func (request GetRecommendationRequest) String() string

func (GetRecommendationRequest) ValidateEnumValue

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

type GetRecommendationResponse

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"`
}

GetRecommendationResponse wrapper for the GetRecommendation operation

func (GetRecommendationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetRecommendationResponse) String

func (response GetRecommendationResponse) String() string

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

GetResourceActionRequest wrapper for the GetResourceAction operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetResourceAction.go.html to see an example of how to use GetResourceActionRequest.

func (GetResourceActionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetResourceActionRequest) HTTPRequest

func (request GetResourceActionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetResourceActionRequest) RetryPolicy

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

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

func (GetResourceActionRequest) String

func (request GetResourceActionRequest) String() string

func (GetResourceActionRequest) ValidateEnumValue

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

type GetResourceActionResponse

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"`
}

GetResourceActionResponse wrapper for the GetResourceAction operation

func (GetResourceActionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetResourceActionResponse) String

func (response GetResourceActionResponse) String() string

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

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

func (GetWorkRequestRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

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

type GetWorkRequestResponse

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"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type HistoryCollection

type HistoryCollection struct {

	// A collection of history summaries.
	Items []HistorySummary `mandatory:"true" json:"items"`
}

HistoryCollection A list containing the recommendation history items that match filter criteria, if any. Results contain `HistorySummary` objects.

func (HistoryCollection) String

func (m HistoryCollection) String() string

func (HistoryCollection) ValidateEnumValue

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

type HistorySummary

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"`
}

HistorySummary The metadata associated with the recommendation history and its related resources.

func (HistorySummary) String

func (m HistorySummary) String() string

func (HistorySummary) ValidateEnumValue

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

type ImportanceEnum

type ImportanceEnum string

ImportanceEnum Enum with underlying type: string

const (
	ImportanceCritical ImportanceEnum = "CRITICAL"
	ImportanceHigh     ImportanceEnum = "HIGH"
	ImportanceModerate ImportanceEnum = "MODERATE"
	ImportanceLow      ImportanceEnum = "LOW"
	ImportanceMinor    ImportanceEnum = "MINOR"
)

Set of constants representing the allowable values for ImportanceEnum

func GetImportanceEnumValues

func GetImportanceEnumValues() []ImportanceEnum

GetImportanceEnumValues Enumerates the set of values for ImportanceEnum

func GetMappingImportanceEnum

func GetMappingImportanceEnum(val string) (ImportanceEnum, bool)

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

type LevelConfiguration

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"`
}

LevelConfiguration Details about the configuration level for the recommendation.

func (LevelConfiguration) String

func (m LevelConfiguration) String() string

func (LevelConfiguration) ValidateEnumValue

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

type LevelsConfiguration

type LevelsConfiguration struct {

	// The array of configuration levels.
	Items []LevelConfiguration `mandatory:"false" json:"items"`
}

LevelsConfiguration A list of configuration levels for each recommendation.

func (LevelsConfiguration) String

func (m LevelsConfiguration) String() string

func (LevelsConfiguration) ValidateEnumValue

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

type LifecycleStateEnum

type LifecycleStateEnum string

LifecycleStateEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for LifecycleStateEnum

func GetLifecycleStateEnumValues

func GetLifecycleStateEnumValues() []LifecycleStateEnum

GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum

func GetMappingLifecycleStateEnum

func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)

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

type ListCategoriesLifecycleStateEnum

type ListCategoriesLifecycleStateEnum string

ListCategoriesLifecycleStateEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for ListCategoriesLifecycleStateEnum

func GetListCategoriesLifecycleStateEnumValues

func GetListCategoriesLifecycleStateEnumValues() []ListCategoriesLifecycleStateEnum

GetListCategoriesLifecycleStateEnumValues Enumerates the set of values for ListCategoriesLifecycleStateEnum

func GetMappingListCategoriesLifecycleStateEnum

func GetMappingListCategoriesLifecycleStateEnum(val string) (ListCategoriesLifecycleStateEnum, bool)

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

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

ListCategoriesRequest wrapper for the ListCategories operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListCategories.go.html to see an example of how to use ListCategoriesRequest.

func (ListCategoriesRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListCategoriesRequest) HTTPRequest

func (request ListCategoriesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListCategoriesRequest) RetryPolicy

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

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

func (ListCategoriesRequest) String

func (request ListCategoriesRequest) String() string

func (ListCategoriesRequest) ValidateEnumValue

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

type ListCategoriesResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

ListCategoriesResponse wrapper for the ListCategories operation

func (ListCategoriesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListCategoriesResponse) String

func (response ListCategoriesResponse) String() string

type ListCategoriesSortByEnum

type ListCategoriesSortByEnum string

ListCategoriesSortByEnum Enum with underlying type: string

const (
	ListCategoriesSortByName        ListCategoriesSortByEnum = "NAME"
	ListCategoriesSortByTimecreated ListCategoriesSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListCategoriesSortByEnum

func GetListCategoriesSortByEnumValues

func GetListCategoriesSortByEnumValues() []ListCategoriesSortByEnum

GetListCategoriesSortByEnumValues Enumerates the set of values for ListCategoriesSortByEnum

func GetMappingListCategoriesSortByEnum

func GetMappingListCategoriesSortByEnum(val string) (ListCategoriesSortByEnum, bool)

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

type ListCategoriesSortOrderEnum

type ListCategoriesSortOrderEnum string

ListCategoriesSortOrderEnum Enum with underlying type: string

const (
	ListCategoriesSortOrderAsc  ListCategoriesSortOrderEnum = "ASC"
	ListCategoriesSortOrderDesc ListCategoriesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListCategoriesSortOrderEnum

func GetListCategoriesSortOrderEnumValues

func GetListCategoriesSortOrderEnumValues() []ListCategoriesSortOrderEnum

GetListCategoriesSortOrderEnumValues Enumerates the set of values for ListCategoriesSortOrderEnum

func GetMappingListCategoriesSortOrderEnum

func GetMappingListCategoriesSortOrderEnum(val string) (ListCategoriesSortOrderEnum, bool)

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

type ListEnrollmentStatusesLifecycleStateEnum

type ListEnrollmentStatusesLifecycleStateEnum string

ListEnrollmentStatusesLifecycleStateEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for ListEnrollmentStatusesLifecycleStateEnum

func GetListEnrollmentStatusesLifecycleStateEnumValues

func GetListEnrollmentStatusesLifecycleStateEnumValues() []ListEnrollmentStatusesLifecycleStateEnum

GetListEnrollmentStatusesLifecycleStateEnumValues Enumerates the set of values for ListEnrollmentStatusesLifecycleStateEnum

func GetMappingListEnrollmentStatusesLifecycleStateEnum

func GetMappingListEnrollmentStatusesLifecycleStateEnum(val string) (ListEnrollmentStatusesLifecycleStateEnum, bool)

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

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

ListEnrollmentStatusesRequest wrapper for the ListEnrollmentStatuses operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListEnrollmentStatuses.go.html to see an example of how to use ListEnrollmentStatusesRequest.

func (ListEnrollmentStatusesRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListEnrollmentStatusesRequest) HTTPRequest

func (request ListEnrollmentStatusesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListEnrollmentStatusesRequest) RetryPolicy

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

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

func (ListEnrollmentStatusesRequest) String

func (request ListEnrollmentStatusesRequest) String() string

func (ListEnrollmentStatusesRequest) ValidateEnumValue

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

type ListEnrollmentStatusesResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

ListEnrollmentStatusesResponse wrapper for the ListEnrollmentStatuses operation

func (ListEnrollmentStatusesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListEnrollmentStatusesResponse) String

func (response ListEnrollmentStatusesResponse) String() string

type ListEnrollmentStatusesSortByEnum

type ListEnrollmentStatusesSortByEnum string

ListEnrollmentStatusesSortByEnum Enum with underlying type: string

const (
	ListEnrollmentStatusesSortByName        ListEnrollmentStatusesSortByEnum = "NAME"
	ListEnrollmentStatusesSortByTimecreated ListEnrollmentStatusesSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListEnrollmentStatusesSortByEnum

func GetListEnrollmentStatusesSortByEnumValues

func GetListEnrollmentStatusesSortByEnumValues() []ListEnrollmentStatusesSortByEnum

GetListEnrollmentStatusesSortByEnumValues Enumerates the set of values for ListEnrollmentStatusesSortByEnum

func GetMappingListEnrollmentStatusesSortByEnum

func GetMappingListEnrollmentStatusesSortByEnum(val string) (ListEnrollmentStatusesSortByEnum, bool)

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

type ListEnrollmentStatusesSortOrderEnum

type ListEnrollmentStatusesSortOrderEnum string

ListEnrollmentStatusesSortOrderEnum Enum with underlying type: string

const (
	ListEnrollmentStatusesSortOrderAsc  ListEnrollmentStatusesSortOrderEnum = "ASC"
	ListEnrollmentStatusesSortOrderDesc ListEnrollmentStatusesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListEnrollmentStatusesSortOrderEnum

func GetListEnrollmentStatusesSortOrderEnumValues

func GetListEnrollmentStatusesSortOrderEnumValues() []ListEnrollmentStatusesSortOrderEnum

GetListEnrollmentStatusesSortOrderEnumValues Enumerates the set of values for ListEnrollmentStatusesSortOrderEnum

func GetMappingListEnrollmentStatusesSortOrderEnum

func GetMappingListEnrollmentStatusesSortOrderEnum(val string) (ListEnrollmentStatusesSortOrderEnum, bool)

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

type ListEnrollmentStatusesStatusEnum

type ListEnrollmentStatusesStatusEnum string

ListEnrollmentStatusesStatusEnum Enum with underlying type: string

const (
	ListEnrollmentStatusesStatusActive   ListEnrollmentStatusesStatusEnum = "ACTIVE"
	ListEnrollmentStatusesStatusInactive ListEnrollmentStatusesStatusEnum = "INACTIVE"
)

Set of constants representing the allowable values for ListEnrollmentStatusesStatusEnum

func GetListEnrollmentStatusesStatusEnumValues

func GetListEnrollmentStatusesStatusEnumValues() []ListEnrollmentStatusesStatusEnum

GetListEnrollmentStatusesStatusEnumValues Enumerates the set of values for ListEnrollmentStatusesStatusEnum

func GetMappingListEnrollmentStatusesStatusEnum

func GetMappingListEnrollmentStatusesStatusEnum(val string) (ListEnrollmentStatusesStatusEnum, bool)

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

type ListHistoriesLifecycleStateEnum

type ListHistoriesLifecycleStateEnum string

ListHistoriesLifecycleStateEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for ListHistoriesLifecycleStateEnum

func GetListHistoriesLifecycleStateEnumValues

func GetListHistoriesLifecycleStateEnumValues() []ListHistoriesLifecycleStateEnum

GetListHistoriesLifecycleStateEnumValues Enumerates the set of values for ListHistoriesLifecycleStateEnum

func GetMappingListHistoriesLifecycleStateEnum

func GetMappingListHistoriesLifecycleStateEnum(val string) (ListHistoriesLifecycleStateEnum, bool)

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

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

ListHistoriesRequest wrapper for the ListHistories operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListHistories.go.html to see an example of how to use ListHistoriesRequest.

func (ListHistoriesRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListHistoriesRequest) HTTPRequest

func (request ListHistoriesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListHistoriesRequest) RetryPolicy

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

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

func (ListHistoriesRequest) String

func (request ListHistoriesRequest) String() string

func (ListHistoriesRequest) ValidateEnumValue

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

type ListHistoriesResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

ListHistoriesResponse wrapper for the ListHistories operation

func (ListHistoriesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListHistoriesResponse) String

func (response ListHistoriesResponse) String() string

type ListHistoriesSortByEnum

type ListHistoriesSortByEnum string

ListHistoriesSortByEnum Enum with underlying type: string

const (
	ListHistoriesSortByName        ListHistoriesSortByEnum = "NAME"
	ListHistoriesSortByTimecreated ListHistoriesSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListHistoriesSortByEnum

func GetListHistoriesSortByEnumValues

func GetListHistoriesSortByEnumValues() []ListHistoriesSortByEnum

GetListHistoriesSortByEnumValues Enumerates the set of values for ListHistoriesSortByEnum

func GetMappingListHistoriesSortByEnum

func GetMappingListHistoriesSortByEnum(val string) (ListHistoriesSortByEnum, bool)

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

type ListHistoriesSortOrderEnum

type ListHistoriesSortOrderEnum string

ListHistoriesSortOrderEnum Enum with underlying type: string

const (
	ListHistoriesSortOrderAsc  ListHistoriesSortOrderEnum = "ASC"
	ListHistoriesSortOrderDesc ListHistoriesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListHistoriesSortOrderEnum

func GetListHistoriesSortOrderEnumValues

func GetListHistoriesSortOrderEnumValues() []ListHistoriesSortOrderEnum

GetListHistoriesSortOrderEnumValues Enumerates the set of values for ListHistoriesSortOrderEnum

func GetMappingListHistoriesSortOrderEnum

func GetMappingListHistoriesSortOrderEnum(val string) (ListHistoriesSortOrderEnum, bool)

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

type ListHistoriesStatusEnum

type ListHistoriesStatusEnum string

ListHistoriesStatusEnum Enum with underlying type: string

const (
	ListHistoriesStatusPending     ListHistoriesStatusEnum = "PENDING"
	ListHistoriesStatusDismissed   ListHistoriesStatusEnum = "DISMISSED"
	ListHistoriesStatusPostponed   ListHistoriesStatusEnum = "POSTPONED"
	ListHistoriesStatusImplemented ListHistoriesStatusEnum = "IMPLEMENTED"
)

Set of constants representing the allowable values for ListHistoriesStatusEnum

func GetListHistoriesStatusEnumValues

func GetListHistoriesStatusEnumValues() []ListHistoriesStatusEnum

GetListHistoriesStatusEnumValues Enumerates the set of values for ListHistoriesStatusEnum

func GetMappingListHistoriesStatusEnum

func GetMappingListHistoriesStatusEnum(val string) (ListHistoriesStatusEnum, bool)

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

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

ListProfileLevelsRequest wrapper for the ListProfileLevels operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListProfileLevels.go.html to see an example of how to use ListProfileLevelsRequest.

func (ListProfileLevelsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListProfileLevelsRequest) HTTPRequest

func (request ListProfileLevelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListProfileLevelsRequest) RetryPolicy

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

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

func (ListProfileLevelsRequest) String

func (request ListProfileLevelsRequest) String() string

func (ListProfileLevelsRequest) ValidateEnumValue

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

type ListProfileLevelsResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

ListProfileLevelsResponse wrapper for the ListProfileLevels operation

func (ListProfileLevelsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListProfileLevelsResponse) String

func (response ListProfileLevelsResponse) String() string

type ListProfileLevelsSortByEnum

type ListProfileLevelsSortByEnum string

ListProfileLevelsSortByEnum Enum with underlying type: string

const (
	ListProfileLevelsSortByName        ListProfileLevelsSortByEnum = "NAME"
	ListProfileLevelsSortByTimecreated ListProfileLevelsSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListProfileLevelsSortByEnum

func GetListProfileLevelsSortByEnumValues

func GetListProfileLevelsSortByEnumValues() []ListProfileLevelsSortByEnum

GetListProfileLevelsSortByEnumValues Enumerates the set of values for ListProfileLevelsSortByEnum

func GetMappingListProfileLevelsSortByEnum

func GetMappingListProfileLevelsSortByEnum(val string) (ListProfileLevelsSortByEnum, bool)

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

type ListProfileLevelsSortOrderEnum

type ListProfileLevelsSortOrderEnum string

ListProfileLevelsSortOrderEnum Enum with underlying type: string

const (
	ListProfileLevelsSortOrderAsc  ListProfileLevelsSortOrderEnum = "ASC"
	ListProfileLevelsSortOrderDesc ListProfileLevelsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListProfileLevelsSortOrderEnum

func GetListProfileLevelsSortOrderEnumValues

func GetListProfileLevelsSortOrderEnumValues() []ListProfileLevelsSortOrderEnum

GetListProfileLevelsSortOrderEnumValues Enumerates the set of values for ListProfileLevelsSortOrderEnum

func GetMappingListProfileLevelsSortOrderEnum

func GetMappingListProfileLevelsSortOrderEnum(val string) (ListProfileLevelsSortOrderEnum, bool)

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

type ListProfilesLifecycleStateEnum

type ListProfilesLifecycleStateEnum string

ListProfilesLifecycleStateEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for ListProfilesLifecycleStateEnum

func GetListProfilesLifecycleStateEnumValues

func GetListProfilesLifecycleStateEnumValues() []ListProfilesLifecycleStateEnum

GetListProfilesLifecycleStateEnumValues Enumerates the set of values for ListProfilesLifecycleStateEnum

func GetMappingListProfilesLifecycleStateEnum

func GetMappingListProfilesLifecycleStateEnum(val string) (ListProfilesLifecycleStateEnum, bool)

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

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

ListProfilesRequest wrapper for the ListProfiles operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListProfiles.go.html to see an example of how to use ListProfilesRequest.

func (ListProfilesRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListProfilesRequest) HTTPRequest

func (request ListProfilesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListProfilesRequest) RetryPolicy

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

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

func (ListProfilesRequest) String

func (request ListProfilesRequest) String() string

func (ListProfilesRequest) ValidateEnumValue

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

type ListProfilesResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

ListProfilesResponse wrapper for the ListProfiles operation

func (ListProfilesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListProfilesResponse) String

func (response ListProfilesResponse) String() string

type ListProfilesSortByEnum

type ListProfilesSortByEnum string

ListProfilesSortByEnum Enum with underlying type: string

const (
	ListProfilesSortByName        ListProfilesSortByEnum = "NAME"
	ListProfilesSortByTimecreated ListProfilesSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListProfilesSortByEnum

func GetListProfilesSortByEnumValues

func GetListProfilesSortByEnumValues() []ListProfilesSortByEnum

GetListProfilesSortByEnumValues Enumerates the set of values for ListProfilesSortByEnum

func GetMappingListProfilesSortByEnum

func GetMappingListProfilesSortByEnum(val string) (ListProfilesSortByEnum, bool)

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

type ListProfilesSortOrderEnum

type ListProfilesSortOrderEnum string

ListProfilesSortOrderEnum Enum with underlying type: string

const (
	ListProfilesSortOrderAsc  ListProfilesSortOrderEnum = "ASC"
	ListProfilesSortOrderDesc ListProfilesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListProfilesSortOrderEnum

func GetListProfilesSortOrderEnumValues

func GetListProfilesSortOrderEnumValues() []ListProfilesSortOrderEnum

GetListProfilesSortOrderEnumValues Enumerates the set of values for ListProfilesSortOrderEnum

func GetMappingListProfilesSortOrderEnum

func GetMappingListProfilesSortOrderEnum(val string) (ListProfilesSortOrderEnum, bool)

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

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

ListRecommendationStrategiesRequest wrapper for the ListRecommendationStrategies operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListRecommendationStrategies.go.html to see an example of how to use ListRecommendationStrategiesRequest.

func (ListRecommendationStrategiesRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListRecommendationStrategiesRequest) HTTPRequest

func (request ListRecommendationStrategiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListRecommendationStrategiesRequest) RetryPolicy

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

func (ListRecommendationStrategiesRequest) String

func (ListRecommendationStrategiesRequest) ValidateEnumValue

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

type ListRecommendationStrategiesResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

ListRecommendationStrategiesResponse wrapper for the ListRecommendationStrategies operation

func (ListRecommendationStrategiesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListRecommendationStrategiesResponse) String

func (response ListRecommendationStrategiesResponse) String() string

type ListRecommendationStrategiesSortByEnum

type ListRecommendationStrategiesSortByEnum string

ListRecommendationStrategiesSortByEnum Enum with underlying type: string

const (
	ListRecommendationStrategiesSortByName        ListRecommendationStrategiesSortByEnum = "NAME"
	ListRecommendationStrategiesSortByTimecreated ListRecommendationStrategiesSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListRecommendationStrategiesSortByEnum

func GetListRecommendationStrategiesSortByEnumValues

func GetListRecommendationStrategiesSortByEnumValues() []ListRecommendationStrategiesSortByEnum

GetListRecommendationStrategiesSortByEnumValues Enumerates the set of values for ListRecommendationStrategiesSortByEnum

func GetMappingListRecommendationStrategiesSortByEnum

func GetMappingListRecommendationStrategiesSortByEnum(val string) (ListRecommendationStrategiesSortByEnum, bool)

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

type ListRecommendationStrategiesSortOrderEnum

type ListRecommendationStrategiesSortOrderEnum string

ListRecommendationStrategiesSortOrderEnum Enum with underlying type: string

const (
	ListRecommendationStrategiesSortOrderAsc  ListRecommendationStrategiesSortOrderEnum = "ASC"
	ListRecommendationStrategiesSortOrderDesc ListRecommendationStrategiesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListRecommendationStrategiesSortOrderEnum

func GetListRecommendationStrategiesSortOrderEnumValues

func GetListRecommendationStrategiesSortOrderEnumValues() []ListRecommendationStrategiesSortOrderEnum

GetListRecommendationStrategiesSortOrderEnumValues Enumerates the set of values for ListRecommendationStrategiesSortOrderEnum

func GetMappingListRecommendationStrategiesSortOrderEnum

func GetMappingListRecommendationStrategiesSortOrderEnum(val string) (ListRecommendationStrategiesSortOrderEnum, bool)

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

type ListRecommendationsLifecycleStateEnum

type ListRecommendationsLifecycleStateEnum string

ListRecommendationsLifecycleStateEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for ListRecommendationsLifecycleStateEnum

func GetListRecommendationsLifecycleStateEnumValues

func GetListRecommendationsLifecycleStateEnumValues() []ListRecommendationsLifecycleStateEnum

GetListRecommendationsLifecycleStateEnumValues Enumerates the set of values for ListRecommendationsLifecycleStateEnum

func GetMappingListRecommendationsLifecycleStateEnum

func GetMappingListRecommendationsLifecycleStateEnum(val string) (ListRecommendationsLifecycleStateEnum, bool)

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

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

ListRecommendationsRequest wrapper for the ListRecommendations operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListRecommendations.go.html to see an example of how to use ListRecommendationsRequest.

func (ListRecommendationsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListRecommendationsRequest) HTTPRequest

func (request ListRecommendationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListRecommendationsRequest) RetryPolicy

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

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

func (ListRecommendationsRequest) String

func (request ListRecommendationsRequest) String() string

func (ListRecommendationsRequest) ValidateEnumValue

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

type ListRecommendationsResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

ListRecommendationsResponse wrapper for the ListRecommendations operation

func (ListRecommendationsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListRecommendationsResponse) String

func (response ListRecommendationsResponse) String() string

type ListRecommendationsSortByEnum

type ListRecommendationsSortByEnum string

ListRecommendationsSortByEnum Enum with underlying type: string

const (
	ListRecommendationsSortByName        ListRecommendationsSortByEnum = "NAME"
	ListRecommendationsSortByTimecreated ListRecommendationsSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListRecommendationsSortByEnum

func GetListRecommendationsSortByEnumValues

func GetListRecommendationsSortByEnumValues() []ListRecommendationsSortByEnum

GetListRecommendationsSortByEnumValues Enumerates the set of values for ListRecommendationsSortByEnum

func GetMappingListRecommendationsSortByEnum

func GetMappingListRecommendationsSortByEnum(val string) (ListRecommendationsSortByEnum, bool)

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

type ListRecommendationsSortOrderEnum

type ListRecommendationsSortOrderEnum string

ListRecommendationsSortOrderEnum Enum with underlying type: string

const (
	ListRecommendationsSortOrderAsc  ListRecommendationsSortOrderEnum = "ASC"
	ListRecommendationsSortOrderDesc ListRecommendationsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListRecommendationsSortOrderEnum

func GetListRecommendationsSortOrderEnumValues

func GetListRecommendationsSortOrderEnumValues() []ListRecommendationsSortOrderEnum

GetListRecommendationsSortOrderEnumValues Enumerates the set of values for ListRecommendationsSortOrderEnum

func GetMappingListRecommendationsSortOrderEnum

func GetMappingListRecommendationsSortOrderEnum(val string) (ListRecommendationsSortOrderEnum, bool)

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

type ListRecommendationsStatusEnum

type ListRecommendationsStatusEnum string

ListRecommendationsStatusEnum Enum with underlying type: string

const (
	ListRecommendationsStatusPending     ListRecommendationsStatusEnum = "PENDING"
	ListRecommendationsStatusDismissed   ListRecommendationsStatusEnum = "DISMISSED"
	ListRecommendationsStatusPostponed   ListRecommendationsStatusEnum = "POSTPONED"
	ListRecommendationsStatusImplemented ListRecommendationsStatusEnum = "IMPLEMENTED"
)

Set of constants representing the allowable values for ListRecommendationsStatusEnum

func GetListRecommendationsStatusEnumValues

func GetListRecommendationsStatusEnumValues() []ListRecommendationsStatusEnum

GetListRecommendationsStatusEnumValues Enumerates the set of values for ListRecommendationsStatusEnum

func GetMappingListRecommendationsStatusEnum

func GetMappingListRecommendationsStatusEnum(val string) (ListRecommendationsStatusEnum, bool)

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

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

ListResourceActionQueryableFieldsRequest wrapper for the ListResourceActionQueryableFields operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListResourceActionQueryableFields.go.html to see an example of how to use ListResourceActionQueryableFieldsRequest.

func (ListResourceActionQueryableFieldsRequest) BinaryRequestBody

BinaryRequestBody implements the OCIRequest interface

func (ListResourceActionQueryableFieldsRequest) HTTPRequest

func (request ListResourceActionQueryableFieldsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListResourceActionQueryableFieldsRequest) RetryPolicy

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

func (ListResourceActionQueryableFieldsRequest) String

func (ListResourceActionQueryableFieldsRequest) ValidateEnumValue

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

type ListResourceActionQueryableFieldsResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

ListResourceActionQueryableFieldsResponse wrapper for the ListResourceActionQueryableFields operation

func (ListResourceActionQueryableFieldsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListResourceActionQueryableFieldsResponse) String

type ListResourceActionsLifecycleStateEnum

type ListResourceActionsLifecycleStateEnum string

ListResourceActionsLifecycleStateEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for ListResourceActionsLifecycleStateEnum

func GetListResourceActionsLifecycleStateEnumValues

func GetListResourceActionsLifecycleStateEnumValues() []ListResourceActionsLifecycleStateEnum

GetListResourceActionsLifecycleStateEnumValues Enumerates the set of values for ListResourceActionsLifecycleStateEnum

func GetMappingListResourceActionsLifecycleStateEnum

func GetMappingListResourceActionsLifecycleStateEnum(val string) (ListResourceActionsLifecycleStateEnum, bool)

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

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

ListResourceActionsRequest wrapper for the ListResourceActions operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListResourceActions.go.html to see an example of how to use ListResourceActionsRequest.

func (ListResourceActionsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListResourceActionsRequest) HTTPRequest

func (request ListResourceActionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListResourceActionsRequest) RetryPolicy

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

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

func (ListResourceActionsRequest) String

func (request ListResourceActionsRequest) String() string

func (ListResourceActionsRequest) ValidateEnumValue

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

type ListResourceActionsResponse

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

ListResourceActionsResponse wrapper for the ListResourceActions operation

func (ListResourceActionsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListResourceActionsResponse) String

func (response ListResourceActionsResponse) String() string

type ListResourceActionsSortByEnum

type ListResourceActionsSortByEnum string

ListResourceActionsSortByEnum Enum with underlying type: string

const (
	ListResourceActionsSortByName        ListResourceActionsSortByEnum = "NAME"
	ListResourceActionsSortByTimecreated ListResourceActionsSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListResourceActionsSortByEnum

func GetListResourceActionsSortByEnumValues

func GetListResourceActionsSortByEnumValues() []ListResourceActionsSortByEnum

GetListResourceActionsSortByEnumValues Enumerates the set of values for ListResourceActionsSortByEnum

func GetMappingListResourceActionsSortByEnum

func GetMappingListResourceActionsSortByEnum(val string) (ListResourceActionsSortByEnum, bool)

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

type ListResourceActionsSortOrderEnum

type ListResourceActionsSortOrderEnum string

ListResourceActionsSortOrderEnum Enum with underlying type: string

const (
	ListResourceActionsSortOrderAsc  ListResourceActionsSortOrderEnum = "ASC"
	ListResourceActionsSortOrderDesc ListResourceActionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListResourceActionsSortOrderEnum

func GetListResourceActionsSortOrderEnumValues

func GetListResourceActionsSortOrderEnumValues() []ListResourceActionsSortOrderEnum

GetListResourceActionsSortOrderEnumValues Enumerates the set of values for ListResourceActionsSortOrderEnum

func GetMappingListResourceActionsSortOrderEnum

func GetMappingListResourceActionsSortOrderEnum(val string) (ListResourceActionsSortOrderEnum, bool)

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

type ListResourceActionsStatusEnum

type ListResourceActionsStatusEnum string

ListResourceActionsStatusEnum Enum with underlying type: string

const (
	ListResourceActionsStatusPending     ListResourceActionsStatusEnum = "PENDING"
	ListResourceActionsStatusDismissed   ListResourceActionsStatusEnum = "DISMISSED"
	ListResourceActionsStatusPostponed   ListResourceActionsStatusEnum = "POSTPONED"
	ListResourceActionsStatusImplemented ListResourceActionsStatusEnum = "IMPLEMENTED"
)

Set of constants representing the allowable values for ListResourceActionsStatusEnum

func GetListResourceActionsStatusEnumValues

func GetListResourceActionsStatusEnumValues() []ListResourceActionsStatusEnum

GetListResourceActionsStatusEnumValues Enumerates the set of values for ListResourceActionsStatusEnum

func GetMappingListResourceActionsStatusEnum

func GetMappingListResourceActionsStatusEnum(val string) (ListResourceActionsStatusEnum, bool)

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

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

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

func (ListWorkRequestErrorsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

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

type ListWorkRequestErrorsResponse

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"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

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

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

func (ListWorkRequestLogsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

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

type ListWorkRequestLogsResponse

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"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

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

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

func (ListWorkRequestsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

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

type ListWorkRequestsResponse

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"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type OperationStatusEnum

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string

const (
	OperationStatusAccepted   OperationStatusEnum = "ACCEPTED"
	OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
	OperationStatusFailed     OperationStatusEnum = "FAILED"
	OperationStatusSucceeded  OperationStatusEnum = "SUCCEEDED"
	OperationStatusCanceling  OperationStatusEnum = "CANCELING"
	OperationStatusCanceled   OperationStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

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

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string

const (
	OperationTypeBulkApplyRecommendations OperationTypeEnum = "BULK_APPLY_RECOMMENDATIONS"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

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

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type OptimizerClient

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

OptimizerClient a client for Optimizer

func NewOptimizerClientWithConfigurationProvider

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

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 (OptimizerClient) BulkApplyRecommendations

func (client OptimizerClient) BulkApplyRecommendations(ctx context.Context, request BulkApplyRecommendationsRequest) (response BulkApplyRecommendationsResponse, err error)

BulkApplyRecommendations Applies the specified recommendations to the resources.

See also

Click https://docs.cloud.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 (*OptimizerClient) ConfigurationProvider

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

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

func (OptimizerClient) CreateProfile

func (client OptimizerClient) CreateProfile(ctx context.Context, request CreateProfileRequest) (response CreateProfileResponse, err error)

CreateProfile Creates a new profile.

See also

Click https://docs.cloud.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 (OptimizerClient) DeleteProfile

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.

See also

Click https://docs.cloud.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 (OptimizerClient) FilterResourceActions

func (client OptimizerClient) FilterResourceActions(ctx context.Context, request FilterResourceActionsRequest) (response FilterResourceActionsResponse, err error)

FilterResourceActions Queries the Cloud Advisor resource actions that are supported.

See also

Click https://docs.cloud.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 (OptimizerClient) GetCategory

func (client OptimizerClient) GetCategory(ctx context.Context, request GetCategoryRequest) (response GetCategoryResponse, err error)

GetCategory Gets the category that corresponds to the specified OCID.

See also

Click https://docs.cloud.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 (OptimizerClient) GetEnrollmentStatus

func (client OptimizerClient) GetEnrollmentStatus(ctx context.Context, request GetEnrollmentStatusRequest) (response GetEnrollmentStatusResponse, err error)

GetEnrollmentStatus Gets the Cloud Advisor enrollment status.

See also

Click https://docs.cloud.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 (OptimizerClient) GetProfile

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.

See also

Click https://docs.cloud.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 (OptimizerClient) GetRecommendation

func (client OptimizerClient) GetRecommendation(ctx context.Context, request GetRecommendationRequest) (response GetRecommendationResponse, err error)

GetRecommendation Gets the recommendation for the specified OCID.

See also

Click https://docs.cloud.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 (OptimizerClient) GetResourceAction

func (client OptimizerClient) GetResourceAction(ctx context.Context, request GetResourceActionRequest) (response GetResourceActionResponse, err error)

GetResourceAction Gets the resource action that corresponds to the specified OCID.

See also

Click https://docs.cloud.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 (OptimizerClient) GetWorkRequest

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.

See also

Click https://docs.cloud.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 (OptimizerClient) ListCategories

func (client OptimizerClient) ListCategories(ctx context.Context, request ListCategoriesRequest) (response ListCategoriesResponse, err error)

ListCategories Lists the supported Cloud Advisor categories.

See also

Click https://docs.cloud.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 (OptimizerClient) ListEnrollmentStatuses

func (client OptimizerClient) ListEnrollmentStatuses(ctx context.Context, request ListEnrollmentStatusesRequest) (response ListEnrollmentStatusesResponse, err error)

ListEnrollmentStatuses Lists the Cloud Advisor enrollment statuses.

See also

Click https://docs.cloud.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 (OptimizerClient) ListHistories

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.

See also

Click https://docs.cloud.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 (OptimizerClient) ListProfileLevels

func (client OptimizerClient) ListProfileLevels(ctx context.Context, request ListProfileLevelsRequest) (response ListProfileLevelsResponse, err error)

ListProfileLevels Lists the existing profile levels.

See also

Click https://docs.cloud.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 (OptimizerClient) ListProfiles

func (client OptimizerClient) ListProfiles(ctx context.Context, request ListProfilesRequest) (response ListProfilesResponse, err error)

ListProfiles Lists the existing profiles.

See also

Click https://docs.cloud.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 (OptimizerClient) ListRecommendationStrategies

func (client OptimizerClient) ListRecommendationStrategies(ctx context.Context, request ListRecommendationStrategiesRequest) (response ListRecommendationStrategiesResponse, err error)

ListRecommendationStrategies Lists the existing strategies.

See also

Click https://docs.cloud.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 (OptimizerClient) ListRecommendations

func (client OptimizerClient) ListRecommendations(ctx context.Context, request ListRecommendationsRequest) (response ListRecommendationsResponse, err error)

ListRecommendations Lists the Cloud Advisor recommendations that are currently supported.

See also

Click https://docs.cloud.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 (OptimizerClient) ListResourceActionQueryableFields

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.

See also

Click https://docs.cloud.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 (OptimizerClient) ListResourceActions

func (client OptimizerClient) ListResourceActions(ctx context.Context, request ListResourceActionsRequest) (response ListResourceActionsResponse, err error)

ListResourceActions Lists the Cloud Advisor resource actions that are supported.

See also

Click https://docs.cloud.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 (OptimizerClient) ListWorkRequestErrors

func (client OptimizerClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)

ListWorkRequestErrors Lists errors associated with the specified work request.

See also

Click https://docs.cloud.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 (OptimizerClient) ListWorkRequestLogs

func (client OptimizerClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)

ListWorkRequestLogs Lists the logs associated with the specified work request.

See also

Click https://docs.cloud.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 (OptimizerClient) ListWorkRequests

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.

See also

Click https://docs.cloud.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 (*OptimizerClient) SetRegion

func (client *OptimizerClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (OptimizerClient) UpdateEnrollmentStatus

func (client OptimizerClient) UpdateEnrollmentStatus(ctx context.Context, request UpdateEnrollmentStatusRequest) (response UpdateEnrollmentStatusResponse, err error)

UpdateEnrollmentStatus Updates the enrollment status of the tenancy.

See also

Click https://docs.cloud.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 (OptimizerClient) UpdateProfile

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.

See also

Click https://docs.cloud.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 (OptimizerClient) UpdateRecommendation

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:

  • Postpone recommendation
  • Dismiss recommendation
  • Reactivate recommendation

See also

Click https://docs.cloud.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 (OptimizerClient) UpdateResourceAction

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:

  • Postpone resource action
  • Ignore resource action
  • Reactivate resource action

See also

Click https://docs.cloud.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()

type OptimizerEnrollmentStatusEnum

type OptimizerEnrollmentStatusEnum string

OptimizerEnrollmentStatusEnum Enum with underlying type: string

const (
	OptimizerEnrollmentStatusActive   OptimizerEnrollmentStatusEnum = "ACTIVE"
	OptimizerEnrollmentStatusInactive OptimizerEnrollmentStatusEnum = "INACTIVE"
)

Set of constants representing the allowable values for OptimizerEnrollmentStatusEnum

func GetMappingOptimizerEnrollmentStatusEnum

func GetMappingOptimizerEnrollmentStatusEnum(val string) (OptimizerEnrollmentStatusEnum, bool)

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

func GetOptimizerEnrollmentStatusEnumValues

func GetOptimizerEnrollmentStatusEnumValues() []OptimizerEnrollmentStatusEnum

GetOptimizerEnrollmentStatusEnumValues Enumerates the set of values for OptimizerEnrollmentStatusEnum

type 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.cloud.oracle.com/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.cloud.oracle.com/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"`
}

Profile The metadata associated with the profile.

func (Profile) String

func (m Profile) String() string

func (Profile) ValidateEnumValue

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

type ProfileCollection

type ProfileCollection struct {

	// A collection of profile summaries.
	Items []ProfileSummary `mandatory:"true" json:"items"`
}

ProfileCollection A list of profiles that match filter criteria, if any. Results contain `ProfileSummary` objects.

func (ProfileCollection) String

func (m ProfileCollection) String() string

func (ProfileCollection) ValidateEnumValue

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

type ProfileLevelCollection

type ProfileLevelCollection struct {

	// A collection of profile levels.
	Items []ProfileLevelSummary `mandatory:"true" json:"items"`
}

ProfileLevelCollection A list of profile levels that match the filter criteria, if any. The result contains `ProfileLevelSummary` objects.

func (ProfileLevelCollection) String

func (m ProfileLevelCollection) String() string

func (ProfileLevelCollection) ValidateEnumValue

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

type ProfileLevelSummary

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"`
}

ProfileLevelSummary The metadata associated with the profile level summary.

func (ProfileLevelSummary) String

func (m ProfileLevelSummary) String() string

func (ProfileLevelSummary) ValidateEnumValue

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

type ProfileSummary

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.cloud.oracle.com/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.cloud.oracle.com/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"`
}

ProfileSummary The metadata associated with the profile summary.

func (ProfileSummary) String

func (m ProfileSummary) String() string

func (ProfileSummary) ValidateEnumValue

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

type QueryDetails

type QueryDetails struct {

	// The query describing which resources to search for.
	// For more information, see Query Language Syntax (https://docs.cloud.oracle.com/iaas/Content/CloudAdvisor/Reference/query-syntax.htm).
	Query *string `mandatory:"false" json:"query"`
}

QueryDetails The request object for querying the resource action details.

func (QueryDetails) String

func (m QueryDetails) String() string

func (QueryDetails) ValidateEnumValue

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

type QueryableFieldCollection

type QueryableFieldCollection struct {

	// A collection of queryable field summaries.
	Items []QueryableFieldSummary `mandatory:"true" json:"items"`
}

QueryableFieldCollection List of the fields that are indexed for querying and their associated value types. Results contain `QueryableFieldSummary` objects.

func (QueryableFieldCollection) String

func (m QueryableFieldCollection) String() string

func (QueryableFieldCollection) ValidateEnumValue

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

type QueryableFieldSummary

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"`
}

QueryableFieldSummary An individual field that can be used as part of a query filter.

func (QueryableFieldSummary) String

func (m QueryableFieldSummary) String() string

func (QueryableFieldSummary) ValidateEnumValue

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

type QueryableFieldSummaryFieldTypeEnum

type QueryableFieldSummaryFieldTypeEnum string

QueryableFieldSummaryFieldTypeEnum Enum with underlying type: string

const (
	QueryableFieldSummaryFieldTypeString   QueryableFieldSummaryFieldTypeEnum = "STRING"
	QueryableFieldSummaryFieldTypeInteger  QueryableFieldSummaryFieldTypeEnum = "INTEGER"
	QueryableFieldSummaryFieldTypeBoolean  QueryableFieldSummaryFieldTypeEnum = "BOOLEAN"
	QueryableFieldSummaryFieldTypeDateTime QueryableFieldSummaryFieldTypeEnum = "DATE_TIME"
	QueryableFieldSummaryFieldTypeObject   QueryableFieldSummaryFieldTypeEnum = "OBJECT"
)

Set of constants representing the allowable values for QueryableFieldSummaryFieldTypeEnum

func GetMappingQueryableFieldSummaryFieldTypeEnum

func GetMappingQueryableFieldSummaryFieldTypeEnum(val string) (QueryableFieldSummaryFieldTypeEnum, bool)

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

func GetQueryableFieldSummaryFieldTypeEnumValues

func GetQueryableFieldSummaryFieldTypeEnumValues() []QueryableFieldSummaryFieldTypeEnum

GetQueryableFieldSummaryFieldTypeEnumValues Enumerates the set of values for QueryableFieldSummaryFieldTypeEnum

type 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"`
}

Recommendation The metadata associated with the recommendation.

func (Recommendation) String

func (m Recommendation) String() string

func (Recommendation) ValidateEnumValue

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

type RecommendationCollection

type RecommendationCollection struct {

	// A collection of recommendations.
	Items []RecommendationSummary `mandatory:"true" json:"items"`
}

RecommendationCollection A list of recommendations that match filter criteria, if any. Results contain `RecommendationSummary` objects.

func (RecommendationCollection) String

func (m RecommendationCollection) String() string

func (RecommendationCollection) ValidateEnumValue

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

type RecommendationCount

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"`
}

RecommendationCount The count of recommendations in a category, grouped by importance.

func (RecommendationCount) String

func (m RecommendationCount) String() string

func (RecommendationCount) ValidateEnumValue

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

type RecommendationStrategyCollection

type RecommendationStrategyCollection struct {

	// A collection of recommendation strategy summaries.
	Items []RecommendationStrategySummary `mandatory:"true" json:"items"`
}

RecommendationStrategyCollection A list of strategies that match filter criteria, if any. Results contain `RecommendationStrategySummary` objects.

func (RecommendationStrategyCollection) String

func (RecommendationStrategyCollection) ValidateEnumValue

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

type RecommendationStrategySummary

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"`
}

RecommendationStrategySummary The metadata associated with the recommendation strategy.

func (RecommendationStrategySummary) String

func (RecommendationStrategySummary) ValidateEnumValue

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

type RecommendationSummary

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"`
}

RecommendationSummary The metadata associated with the recommendation summary.

func (RecommendationSummary) String

func (m RecommendationSummary) String() string

func (RecommendationSummary) ValidateEnumValue

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

type ResourceAction

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"`
}

ResourceAction The metadata associated with the resource action.

func (ResourceAction) String

func (m ResourceAction) String() string

func (ResourceAction) ValidateEnumValue

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

type ResourceActionCollection

type ResourceActionCollection struct {

	// A collection of resource actions.
	Items []ResourceActionSummary `mandatory:"true" json:"items"`
}

ResourceActionCollection A list of resource actions that match filter criteria, if any. Results contain `ResourceActionSummary` objects.

func (ResourceActionCollection) String

func (m ResourceActionCollection) String() string

func (ResourceActionCollection) ValidateEnumValue

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

type ResourceActionSummary

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"`
}

ResourceActionSummary The metadata associated with the resource action summary.

func (ResourceActionSummary) String

func (m ResourceActionSummary) String() string

func (ResourceActionSummary) ValidateEnumValue

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

type ResourceCount

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"`
}

ResourceCount The count of resources in a category, grouped by status.

func (ResourceCount) String

func (m ResourceCount) String() string

func (ResourceCount) ValidateEnumValue

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

type SortOrderEnum

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string

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

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type StatusEnum

type StatusEnum string

StatusEnum Enum with underlying type: string

const (
	StatusPending     StatusEnum = "PENDING"
	StatusDismissed   StatusEnum = "DISMISSED"
	StatusPostponed   StatusEnum = "POSTPONED"
	StatusImplemented StatusEnum = "IMPLEMENTED"
)

Set of constants representing the allowable values for StatusEnum

func GetMappingStatusEnum

func GetMappingStatusEnum(val string) (StatusEnum, bool)

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

func GetStatusEnumValues

func GetStatusEnumValues() []StatusEnum

GetStatusEnumValues Enumerates the set of values for StatusEnum

type Strategy

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"`
}

Strategy The metadata associated with the strategy. The strategy is the method used to apply the recommendation.

func (Strategy) String

func (m Strategy) String() string

func (Strategy) ValidateEnumValue

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

type StrategyParameter

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"`
}

StrategyParameter The metadata associated with the strategy parameter.

func (StrategyParameter) String

func (m StrategyParameter) String() string

func (StrategyParameter) ValidateEnumValue

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

type StrategyParameterTypeEnum

type StrategyParameterTypeEnum string

StrategyParameterTypeEnum Enum with underlying type: string

const (
	StrategyParameterTypeString   StrategyParameterTypeEnum = "STRING"
	StrategyParameterTypeBoolean  StrategyParameterTypeEnum = "BOOLEAN"
	StrategyParameterTypeNumber   StrategyParameterTypeEnum = "NUMBER"
	StrategyParameterTypeDatetime StrategyParameterTypeEnum = "DATETIME"
)

Set of constants representing the allowable values for StrategyParameterTypeEnum

func GetMappingStrategyParameterTypeEnum

func GetMappingStrategyParameterTypeEnum(val string) (StrategyParameterTypeEnum, bool)

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

func GetStrategyParameterTypeEnumValues

func GetStrategyParameterTypeEnumValues() []StrategyParameterTypeEnum

GetStrategyParameterTypeEnumValues Enumerates the set of values for StrategyParameterTypeEnum

type SupportedLevel

type SupportedLevel struct {

	// The name of the profile level.
	Name *string `mandatory:"false" json:"name"`
}

SupportedLevel A system defined profile level supported by the recommendation.

func (SupportedLevel) String

func (m SupportedLevel) String() string

func (SupportedLevel) ValidateEnumValue

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

type SupportedLevels

type SupportedLevels struct {

	// The list of supported levels.
	Items []SupportedLevel `mandatory:"false" json:"items"`
}

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.

func (SupportedLevels) String

func (m SupportedLevels) String() string

func (SupportedLevels) ValidateEnumValue

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

type TagValueTypeEnum

type TagValueTypeEnum string

TagValueTypeEnum Enum with underlying type: string

const (
	TagValueTypeValue TagValueTypeEnum = "VALUE"
	TagValueTypeAny   TagValueTypeEnum = "ANY"
)

Set of constants representing the allowable values for TagValueTypeEnum

func GetMappingTagValueTypeEnum

func GetMappingTagValueTypeEnum(val string) (TagValueTypeEnum, bool)

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

func GetTagValueTypeEnumValues

func GetTagValueTypeEnumValues() []TagValueTypeEnum

GetTagValueTypeEnumValues Enumerates the set of values for TagValueTypeEnum

type TargetCompartments

type TargetCompartments struct {

	// The list of OCIDs attached to the compartments specified in the current profile override.
	Items []string `mandatory:"true" json:"items"`
}

TargetCompartments Optional. The compartments specified in the profile override for a recommendation.

func (TargetCompartments) String

func (m TargetCompartments) String() string

func (TargetCompartments) ValidateEnumValue

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

type TargetTag

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"`
}

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.cloud.oracle.com/iaas/Content/Tagging/Concepts/taggingoverview.htm)

func (TargetTag) String

func (m TargetTag) String() string

func (TargetTag) ValidateEnumValue

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

type TargetTags

type TargetTags struct {

	// The list of tags specified in the current profile override.
	Items []TargetTag `mandatory:"true" json:"items"`
}

TargetTags Optional. The tags specified in the profile override for a recommendation.

func (TargetTags) String

func (m TargetTags) String() string

func (TargetTags) ValidateEnumValue

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

type UpdateEnrollmentStatusDetails

type UpdateEnrollmentStatusDetails struct {

	// The Cloud Advisor enrollment status.
	Status OptimizerEnrollmentStatusEnum `mandatory:"true" json:"status"`
}

UpdateEnrollmentStatusDetails The request object for updating the enrollment status details.

func (UpdateEnrollmentStatusDetails) String

func (UpdateEnrollmentStatusDetails) ValidateEnumValue

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

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

UpdateEnrollmentStatusRequest wrapper for the UpdateEnrollmentStatus operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/UpdateEnrollmentStatus.go.html to see an example of how to use UpdateEnrollmentStatusRequest.

func (UpdateEnrollmentStatusRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateEnrollmentStatusRequest) HTTPRequest

func (request UpdateEnrollmentStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateEnrollmentStatusRequest) RetryPolicy

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

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

func (UpdateEnrollmentStatusRequest) String

func (request UpdateEnrollmentStatusRequest) String() string

func (UpdateEnrollmentStatusRequest) ValidateEnumValue

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

type UpdateEnrollmentStatusResponse

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"`
}

UpdateEnrollmentStatusResponse wrapper for the UpdateEnrollmentStatus operation

func (UpdateEnrollmentStatusResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateEnrollmentStatusResponse) String

func (response UpdateEnrollmentStatusResponse) String() string

type UpdateProfileDetails

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.cloud.oracle.com/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.cloud.oracle.com/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"`
}

UpdateProfileDetails Details for updating a profile.

func (UpdateProfileDetails) String

func (m UpdateProfileDetails) String() string

func (UpdateProfileDetails) ValidateEnumValue

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

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

UpdateProfileRequest wrapper for the UpdateProfile operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/UpdateProfile.go.html to see an example of how to use UpdateProfileRequest.

func (UpdateProfileRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateProfileRequest) HTTPRequest

func (request UpdateProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateProfileRequest) RetryPolicy

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

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

func (UpdateProfileRequest) String

func (request UpdateProfileRequest) String() string

func (UpdateProfileRequest) ValidateEnumValue

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

type UpdateProfileResponse

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"`
}

UpdateProfileResponse wrapper for the UpdateProfile operation

func (UpdateProfileResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateProfileResponse) String

func (response UpdateProfileResponse) String() string

type UpdateRecommendationDetails

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"`
}

UpdateRecommendationDetails The request object for updating the recommendation details.

func (UpdateRecommendationDetails) String

func (UpdateRecommendationDetails) ValidateEnumValue

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

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

UpdateRecommendationRequest wrapper for the UpdateRecommendation operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/UpdateRecommendation.go.html to see an example of how to use UpdateRecommendationRequest.

func (UpdateRecommendationRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateRecommendationRequest) HTTPRequest

func (request UpdateRecommendationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateRecommendationRequest) RetryPolicy

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

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

func (UpdateRecommendationRequest) String

func (request UpdateRecommendationRequest) String() string

func (UpdateRecommendationRequest) ValidateEnumValue

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

type UpdateRecommendationResponse

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"`
}

UpdateRecommendationResponse wrapper for the UpdateRecommendation operation

func (UpdateRecommendationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateRecommendationResponse) String

func (response UpdateRecommendationResponse) String() string

type UpdateResourceActionDetails

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"`
}

UpdateResourceActionDetails The request object for updating the resource action details.

func (UpdateResourceActionDetails) String

func (UpdateResourceActionDetails) ValidateEnumValue

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

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

UpdateResourceActionRequest wrapper for the UpdateResourceAction operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/UpdateResourceAction.go.html to see an example of how to use UpdateResourceActionRequest.

func (UpdateResourceActionRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateResourceActionRequest) HTTPRequest

func (request UpdateResourceActionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateResourceActionRequest) RetryPolicy

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

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

func (UpdateResourceActionRequest) String

func (request UpdateResourceActionRequest) String() string

func (UpdateResourceActionRequest) ValidateEnumValue

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

type UpdateResourceActionResponse

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"`
}

UpdateResourceActionResponse wrapper for the UpdateResourceAction operation

func (UpdateResourceActionResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateResourceActionResponse) String

func (response UpdateResourceActionResponse) String() string

type WorkRequest

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"`
}

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.

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

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

type WorkRequestActionTypeEnum

type WorkRequestActionTypeEnum string

WorkRequestActionTypeEnum Enum with underlying type: string

const (
	WorkRequestActionTypeCreated    WorkRequestActionTypeEnum = "CREATED"
	WorkRequestActionTypeUpdated    WorkRequestActionTypeEnum = "UPDATED"
	WorkRequestActionTypeDeleted    WorkRequestActionTypeEnum = "DELETED"
	WorkRequestActionTypeInProgress WorkRequestActionTypeEnum = "IN_PROGRESS"
	WorkRequestActionTypeRelated    WorkRequestActionTypeEnum = "RELATED"
)

Set of constants representing the allowable values for WorkRequestActionTypeEnum

func GetMappingWorkRequestActionTypeEnum

func GetMappingWorkRequestActionTypeEnum(val string) (WorkRequestActionTypeEnum, bool)

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

func GetWorkRequestActionTypeEnumValues

func GetWorkRequestActionTypeEnumValues() []WorkRequestActionTypeEnum

GetWorkRequestActionTypeEnumValues Enumerates the set of values for WorkRequestActionTypeEnum

type WorkRequestCollection

type WorkRequestCollection struct {

	// A collection of work requests.
	Items []WorkRequest `mandatory:"true" json:"items"`
}

WorkRequestCollection A list of work requests that match filter criteria, if any. Results contain `WorkRequest` objects.

func (WorkRequestCollection) String

func (m WorkRequestCollection) String() string

func (WorkRequestCollection) ValidateEnumValue

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

type WorkRequestError

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"`
}

WorkRequestError Details about errors encountered while executing a work request.

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

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

type WorkRequestErrorCollection

type WorkRequestErrorCollection struct {

	// A collection of work request errors.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection A list of work request errors that match filter criteria, if any. Results contain `WorkRequestError` objects.

func (WorkRequestErrorCollection) String

func (WorkRequestErrorCollection) ValidateEnumValue

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

type WorkRequestLogEntry

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"`
}

WorkRequestLogEntry Details about the log entity.

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

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

type WorkRequestLogEntryCollection

type WorkRequestLogEntryCollection struct {

	// A collection of work request log entries.
	Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

WorkRequestLogEntryCollection A list of work request logs that match filter criteria, if any. Results contain `WorkRequestLogEntry` objects.

func (WorkRequestLogEntryCollection) String

func (WorkRequestLogEntryCollection) ValidateEnumValue

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

type WorkRequestResource

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"`
}

WorkRequestResource Details about the resource entity.

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

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

type WorkRequestResourceMetadataKeyEnum

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string

const (
	WorkRequestResourceMetadataKeyOperationName WorkRequestResourceMetadataKeyEnum = "OPERATION_NAME"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

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

func GetWorkRequestResourceMetadataKeyEnumValues

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

Source Files

Jump to

Keyboard shortcuts

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