optimizer

package
v27.3.0 Latest Latest
Warning

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

 Go to latest Published: Nov 3, 2020 License: Apache-2.0, UPL-1.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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. **Caution:** Avoid using any confidential information when you use the API to supply string values.

func (Action) String 

func (m Action) String() string

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

type BulkApplyRecommendationsDetails 

type BulkApplyRecommendationsDetails struct {

	// The unique OCIDs of the resource actions that recommendations are applied to.
	ResourceActionIds []string `mandatory:"true" json:"resourceActionIds"`

	// The current 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 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 (m BulkApplyRecommendationsDetails) String() string

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

func (BulkApplyRecommendationsRequest) HTTPRequest 

func (request BulkApplyRecommendationsRequest) HTTPRequest(method, path 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

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

Category The metadata associated with the category. **Caution:** Avoid using any confidential information when you supply string values using the API.

func (Category) String 

func (m Category) String() string

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

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

CategorySummary The metadata associated with the category summary. **Caution:** Avoid using any confidential information when you supply string values using the API.

func (CategorySummary) String 

func (m CategorySummary) String() string

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.
	Name *string `mandatory:"true" json:"name"`

	// Text describing the profile.
	Description *string `mandatory:"true" json:"description"`

	LevelsConfiguration *LevelsConfiguration `mandatory:"true" json:"levelsConfiguration"`

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

CreateProfileDetails Details for creating a profile. **Caution:** Avoid using any confidential information when you use the API to supply string values.

func (CreateProfileDetails) String 

func (m CreateProfileDetails) String() string

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

func (CreateProfileRequest) HTTPRequest 

func (request CreateProfileRequest) HTTPRequest(method, path 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

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

func (DeleteProfileRequest) HTTPRequest 

func (request DeleteProfileRequest) HTTPRequest(method, path 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

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. **Caution:** Avoid using any confidential information when you use the API to supply string values.

func (EnrollmentStatus) String 

func (m EnrollmentStatus) String() string

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 (m EnrollmentStatusCollection) String() string

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. **Caution:** Avoid using any confidential information when you use the API to supply string values.

func (EnrollmentStatusSummary) String 

func (m EnrollmentStatusSummary) 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

func (GetCategoryRequest) HTTPRequest 

func (request GetCategoryRequest) HTTPRequest(method, path 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

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

func (GetEnrollmentStatusRequest) HTTPRequest 

func (request GetEnrollmentStatusRequest) HTTPRequest(method, path 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

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

func (GetProfileRequest) HTTPRequest 

func (request GetProfileRequest) HTTPRequest(method, path 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

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

func (GetRecommendationRequest) HTTPRequest 

func (request GetRecommendationRequest) HTTPRequest(method, path 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

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

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

func (GetResourceActionRequest) HTTPRequest 

func (request GetResourceActionRequest) HTTPRequest(method, path 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

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

func (GetWorkRequestRequest) HTTPRequest 

func (request GetWorkRequestRequest) HTTPRequest(method, path 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

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

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. **Caution:** Avoid using any confidential information when you use the API to supply string values.

func (HistorySummary) String 

func (m HistorySummary) String() string

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

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

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

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

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

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

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

func (ListCategoriesRequest) HTTPRequest 

func (request ListCategoriesRequest) HTTPRequest(method, path 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

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

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

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

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

func (ListEnrollmentStatusesRequest) HTTPRequest 

func (request ListEnrollmentStatusesRequest) HTTPRequest(method, path 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

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

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

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

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

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

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

func (ListHistoriesRequest) HTTPRequest 

func (request ListHistoriesRequest) HTTPRequest(method, path 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

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

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

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

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

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

func (ListProfilesRequest) HTTPRequest 

func (request ListProfilesRequest) HTTPRequest(method, path 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

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

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

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

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:"true" contributesTo:"query" name:"categoryId"`

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

func (ListRecommendationsRequest) HTTPRequest 

func (request ListRecommendationsRequest) HTTPRequest(method, path 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

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

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

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

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

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:"true" contributesTo:"query" name:"recommendationId"`

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

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

func (ListResourceActionsRequest) HTTPRequest 

func (request ListResourceActionsRequest) HTTPRequest(method, path 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

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

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

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

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

func (ListWorkRequestErrorsRequest) HTTPRequest 

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path 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

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

func (ListWorkRequestLogsRequest) HTTPRequest 

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path 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

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

func (ListWorkRequestsRequest) HTTPRequest 

func (request ListWorkRequestsRequest) HTTPRequest(method, path 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

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

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.

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.

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.

func (OptimizerClient) GetEnrollmentStatus 

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

GetEnrollmentStatus Gets the Cloud Advisor enrollment status.

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.

func (OptimizerClient) GetRecommendation 

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

GetRecommendation Gets the recommendation for the specified OCID.

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.

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.

func (OptimizerClient) ListCategories 

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

ListCategories Lists the supported Cloud Advisor categories.

func (OptimizerClient) ListEnrollmentStatuses 

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

ListEnrollmentStatuses Lists the Cloud Advisor enrollment statuses.

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.

func (OptimizerClient) ListProfiles 

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

ListProfiles Lists the existing profiles.

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 in the specified category.

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 by the specified recommendation.

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.

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.

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.

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.

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.

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

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

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

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

	LevelsConfiguration *LevelsConfiguration `mandatory:"false" json:"levelsConfiguration"`
}

Profile The metadata associated with the profile. **Caution:** Avoid using any confidential information when you use the API to supply string values.

func (Profile) String 

func (m Profile) String() string

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

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

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

	LevelsConfiguration *LevelsConfiguration `mandatory:"false" json:"levelsConfiguration"`
}

ProfileSummary The metadata associated with the profile summary.

func (ProfileSummary) String 

func (m ProfileSummary) String() string

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

Recommendation The metadata associated with the recommendation. **Caution:** Avoid using any confidential information when you supply string values using the API.

func (Recommendation) String 

func (m Recommendation) String() string

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

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

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

RecommendationSummary The metadata associated with the recommendation summary. **Caution:** Avoid using any confidential information when you supply string values using the API.

func (RecommendationSummary) String 

func (m RecommendationSummary) String() string

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. **Caution:** Avoid using any confidential information when you use the API to supply string values.

func (ResourceAction) String 

func (m ResourceAction) String() string

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

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. **Caution:** Avoid using any confidential information when you use the API to supply string values.

func (ResourceActionSummary) String 

func (m ResourceActionSummary) String() string

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

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

func GetStatusEnumValues() []StatusEnum

GetStatusEnumValues Enumerates the set of values for StatusEnum

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

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

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. **Caution:** Avoid using any confidential information when you use the API to supply string values.

func (UpdateEnrollmentStatusDetails) String 

func (m UpdateEnrollmentStatusDetails) String() string

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

func (UpdateEnrollmentStatusRequest) HTTPRequest 

func (request UpdateEnrollmentStatusRequest) HTTPRequest(method, path 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

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.
	Description *string `mandatory:"false" json:"description"`

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

	LevelsConfiguration *LevelsConfiguration `mandatory:"false" json:"levelsConfiguration"`
}

UpdateProfileDetails Details for updating a profile. **Caution:** Avoid using any confidential information when you use the API to supply string values.

func (UpdateProfileDetails) String 

func (m UpdateProfileDetails) String() string

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

func (UpdateProfileRequest) HTTPRequest 

func (request UpdateProfileRequest) HTTPRequest(method, path 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

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 (m UpdateRecommendationDetails) String() string

type UpdateRecommendationRequest 

type UpdateRecommendationRequest struct {

	// The unique OCID associated with the recommendation.
	RecommendationId *string `mandatory:"true" contributesTo:"path" name:"recommendationId"`

	// The request object for udpating 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

func (UpdateRecommendationRequest) HTTPRequest 

func (request UpdateRecommendationRequest) HTTPRequest(method, path 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

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 (m UpdateResourceActionDetails) String() string

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

func (UpdateResourceActionRequest) HTTPRequest 

func (request UpdateResourceActionRequest) HTTPRequest(method, path 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

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

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

type WorkRequestError 

type WorkRequestError struct {

	// A machine-usable code for the error that occured.
	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

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 (m WorkRequestErrorCollection) String() string

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

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 (m WorkRequestLogEntryCollection) String() string

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

WorkRequestResource Details about the resource entity.

func (WorkRequestResource) String 

func (m WorkRequestResource) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.