// Copyright (c) 2016, 2018, 2023, Oracle and/or its affiliates.  All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.

package optimizer

import (
	"fmt"
	"github.com/oracle/oci-go-sdk/v65/common"
	"net/http"
	"strings"
)

// ListProfileLevelsRequest wrapper for the ListProfileLevels operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/ListProfileLevels.go.html to see an example of how to use ListProfileLevelsRequest.
type ListProfileLevelsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.
	// Can only be set to true when performing ListCompartments on the tenancy (root compartment).
	CompartmentIdInSubtree *bool `mandatory:"true" contributesTo:"query" name:"compartmentIdInSubtree"`

	// Optional. A filter that returns results that match the name specified.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// Optional. A filter that returns results that match the recommendation name specified.
	RecommendationName *string `mandatory:"false" contributesTo:"query" name:"recommendationName"`

	// The maximum number of items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListProfileLevelsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
	SortBy ListProfileLevelsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Unique Oracle-assigned identifier for the request.
	// If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

func (request ListProfileLevelsRequest) String() string {
	return common.PointerString(request)
}

// HTTPRequest implements the OCIRequest interface
func (request ListProfileLevelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error) {

	_, err := request.ValidateEnumValue()
	if err != nil {
		return http.Request{}, err
	}
	return common.MakeDefaultHTTPRequestWithTaggedStructAndExtraHeaders(method, path, request, extraHeaders)
}

// BinaryRequestBody implements the OCIRequest interface
func (request ListProfileLevelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {

	return nil, false

}

// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListProfileLevelsRequest) RetryPolicy() *common.RetryPolicy {
	return request.RequestMetadata.RetryPolicy
}

// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (request ListProfileLevelsRequest) ValidateEnumValue() (bool, error) {
	errMessage := []string{}
	if _, ok := GetMappingListProfileLevelsSortOrderEnum(string(request.SortOrder)); !ok && request.SortOrder != "" {
		errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for SortOrder: %s. Supported values are: %s.", request.SortOrder, strings.Join(GetListProfileLevelsSortOrderEnumStringValues(), ",")))
	}
	if _, ok := GetMappingListProfileLevelsSortByEnum(string(request.SortBy)); !ok && request.SortBy != "" {
		errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for SortBy: %s. Supported values are: %s.", request.SortBy, strings.Join(GetListProfileLevelsSortByEnumStringValues(), ",")))
	}
	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// ListProfileLevelsResponse wrapper for the ListProfileLevels operation
type ListProfileLevelsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of ProfileLevelCollection instances
	ProfileLevelCollection `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// For list pagination. When this header appears in the response, previous pages of results exist.
	// For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

func (response ListProfileLevelsResponse) String() string {
	return common.PointerString(response)
}

// HTTPResponse implements the OCIResponse interface
func (response ListProfileLevelsResponse) HTTPResponse() *http.Response {
	return response.RawResponse
}

// ListProfileLevelsSortOrderEnum Enum with underlying type: string
type ListProfileLevelsSortOrderEnum string

// Set of constants representing the allowable values for ListProfileLevelsSortOrderEnum
const (
	ListProfileLevelsSortOrderAsc  ListProfileLevelsSortOrderEnum = "ASC"
	ListProfileLevelsSortOrderDesc ListProfileLevelsSortOrderEnum = "DESC"
)

var mappingListProfileLevelsSortOrderEnum = map[string]ListProfileLevelsSortOrderEnum{
	"ASC":  ListProfileLevelsSortOrderAsc,
	"DESC": ListProfileLevelsSortOrderDesc,
}

var mappingListProfileLevelsSortOrderEnumLowerCase = map[string]ListProfileLevelsSortOrderEnum{
	"asc":  ListProfileLevelsSortOrderAsc,
	"desc": ListProfileLevelsSortOrderDesc,
}

// GetListProfileLevelsSortOrderEnumValues Enumerates the set of values for ListProfileLevelsSortOrderEnum
func GetListProfileLevelsSortOrderEnumValues() []ListProfileLevelsSortOrderEnum {
	values := make([]ListProfileLevelsSortOrderEnum, 0)
	for _, v := range mappingListProfileLevelsSortOrderEnum {
		values = append(values, v)
	}
	return values
}

// GetListProfileLevelsSortOrderEnumStringValues Enumerates the set of values in String for ListProfileLevelsSortOrderEnum
func GetListProfileLevelsSortOrderEnumStringValues() []string {
	return []string{
		"ASC",
		"DESC",
	}
}

// GetMappingListProfileLevelsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListProfileLevelsSortOrderEnum(val string) (ListProfileLevelsSortOrderEnum, bool) {
	enum, ok := mappingListProfileLevelsSortOrderEnumLowerCase[strings.ToLower(val)]
	return enum, ok
}

// ListProfileLevelsSortByEnum Enum with underlying type: string
type ListProfileLevelsSortByEnum string

// Set of constants representing the allowable values for ListProfileLevelsSortByEnum
const (
	ListProfileLevelsSortByName        ListProfileLevelsSortByEnum = "NAME"
	ListProfileLevelsSortByTimecreated ListProfileLevelsSortByEnum = "TIMECREATED"
)

var mappingListProfileLevelsSortByEnum = map[string]ListProfileLevelsSortByEnum{
	"NAME":        ListProfileLevelsSortByName,
	"TIMECREATED": ListProfileLevelsSortByTimecreated,
}

var mappingListProfileLevelsSortByEnumLowerCase = map[string]ListProfileLevelsSortByEnum{
	"name":        ListProfileLevelsSortByName,
	"timecreated": ListProfileLevelsSortByTimecreated,
}

// GetListProfileLevelsSortByEnumValues Enumerates the set of values for ListProfileLevelsSortByEnum
func GetListProfileLevelsSortByEnumValues() []ListProfileLevelsSortByEnum {
	values := make([]ListProfileLevelsSortByEnum, 0)
	for _, v := range mappingListProfileLevelsSortByEnum {
		values = append(values, v)
	}
	return values
}

// GetListProfileLevelsSortByEnumStringValues Enumerates the set of values in String for ListProfileLevelsSortByEnum
func GetListProfileLevelsSortByEnumStringValues() []string {
	return []string{
		"NAME",
		"TIMECREATED",
	}
}

// GetMappingListProfileLevelsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListProfileLevelsSortByEnum(val string) (ListProfileLevelsSortByEnum, bool) {
	enum, ok := mappingListProfileLevelsSortByEnumLowerCase[strings.ToLower(val)]
	return enum, ok
}
