// Copyright (c) 2016, 2018, 2024, 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 adm

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

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

	// A filter to return only resources that match the specified identifier.
	// Required only if the compartmentId query parameter is not specified.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// A filter to return only resources that match the specified Remediation Recipe identifier.
	RemediationRecipeId *string `mandatory:"false" contributesTo:"query" name:"remediationRecipeId"`

	// A filter to return only Remediation Runs that match the specified lifecycleState.
	LifecycleState RemediationRunLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A filter to return only resources that match the entire display name given.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder ListRemediationRunsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field used to sort Remediation Runs. Only one sort order is allowed.
	// Default order for _timeCreated_ is **descending**.
	// Default order for _timeFinished_ is **descending**.
	// Default order for _timeStarted_ is **descending**.
	// Default order for _displayName_ is **ascending alphabetical order**.
	// Default order for _lifecycleState_ is the following sequence: **CREATING, ACTIVE, UPDATING, DELETING, DELETED, and FAILED**.
	// Default order for currentStageType is the following sequence: **DETECT, RECOMMEND, VERIFY, and APPLY**.
	SortBy ListRemediationRunsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// A filter to return only resources that belong to the specified compartment identifier.
	// Required only if the id query param is not specified.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

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

	// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

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

// HTTPRequest implements the OCIRequest interface
func (request ListRemediationRunsRequest) 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 ListRemediationRunsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {

	return nil, false

}

// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRemediationRunsRequest) 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 ListRemediationRunsRequest) ValidateEnumValue() (bool, error) {
	errMessage := []string{}
	if _, ok := GetMappingRemediationRunLifecycleStateEnum(string(request.LifecycleState)); !ok && request.LifecycleState != "" {
		errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleState: %s. Supported values are: %s.", request.LifecycleState, strings.Join(GetRemediationRunLifecycleStateEnumStringValues(), ",")))
	}
	if _, ok := GetMappingListRemediationRunsSortOrderEnum(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(GetListRemediationRunsSortOrderEnumStringValues(), ",")))
	}
	if _, ok := GetMappingListRemediationRunsSortByEnum(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(GetListRemediationRunsSortByEnumStringValues(), ",")))
	}
	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// ListRemediationRunsResponse wrapper for the ListRemediationRuns operation
type ListRemediationRunsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

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

// ListRemediationRunsSortOrderEnum Enum with underlying type: string
type ListRemediationRunsSortOrderEnum string

// Set of constants representing the allowable values for ListRemediationRunsSortOrderEnum
const (
	ListRemediationRunsSortOrderAsc  ListRemediationRunsSortOrderEnum = "ASC"
	ListRemediationRunsSortOrderDesc ListRemediationRunsSortOrderEnum = "DESC"
)

var mappingListRemediationRunsSortOrderEnum = map[string]ListRemediationRunsSortOrderEnum{
	"ASC":  ListRemediationRunsSortOrderAsc,
	"DESC": ListRemediationRunsSortOrderDesc,
}

var mappingListRemediationRunsSortOrderEnumLowerCase = map[string]ListRemediationRunsSortOrderEnum{
	"asc":  ListRemediationRunsSortOrderAsc,
	"desc": ListRemediationRunsSortOrderDesc,
}

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

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

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

// ListRemediationRunsSortByEnum Enum with underlying type: string
type ListRemediationRunsSortByEnum string

// Set of constants representing the allowable values for ListRemediationRunsSortByEnum
const (
	ListRemediationRunsSortByTimecreated      ListRemediationRunsSortByEnum = "timeCreated"
	ListRemediationRunsSortByTimefinished     ListRemediationRunsSortByEnum = "timeFinished"
	ListRemediationRunsSortByTimestarted      ListRemediationRunsSortByEnum = "timeStarted"
	ListRemediationRunsSortByDisplayname      ListRemediationRunsSortByEnum = "displayName"
	ListRemediationRunsSortByLifecyclestate   ListRemediationRunsSortByEnum = "lifecycleState"
	ListRemediationRunsSortByCurrentstagetype ListRemediationRunsSortByEnum = "currentStageType"
)

var mappingListRemediationRunsSortByEnum = map[string]ListRemediationRunsSortByEnum{
	"timeCreated":      ListRemediationRunsSortByTimecreated,
	"timeFinished":     ListRemediationRunsSortByTimefinished,
	"timeStarted":      ListRemediationRunsSortByTimestarted,
	"displayName":      ListRemediationRunsSortByDisplayname,
	"lifecycleState":   ListRemediationRunsSortByLifecyclestate,
	"currentStageType": ListRemediationRunsSortByCurrentstagetype,
}

var mappingListRemediationRunsSortByEnumLowerCase = map[string]ListRemediationRunsSortByEnum{
	"timecreated":      ListRemediationRunsSortByTimecreated,
	"timefinished":     ListRemediationRunsSortByTimefinished,
	"timestarted":      ListRemediationRunsSortByTimestarted,
	"displayname":      ListRemediationRunsSortByDisplayname,
	"lifecyclestate":   ListRemediationRunsSortByLifecyclestate,
	"currentstagetype": ListRemediationRunsSortByCurrentstagetype,
}

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

// GetListRemediationRunsSortByEnumStringValues Enumerates the set of values in String for ListRemediationRunsSortByEnum
func GetListRemediationRunsSortByEnumStringValues() []string {
	return []string{
		"timeCreated",
		"timeFinished",
		"timeStarted",
		"displayName",
		"lifecycleState",
		"currentStageType",
	}
}

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