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

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

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

	// The OCID of the cluster.
	BdsInstanceId *string `mandatory:"true" contributesTo:"path" name:"bdsInstanceId"`

	// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

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

	// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
	SortBy ListResourcePrincipalConfigurationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'asc' or 'desc'.
	SortOrder ListResourcePrincipalConfigurationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

	// The state of the ResourcePrincipalConfiguration.
	LifecycleState ResourcePrincipalConfigurationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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 ListResourcePrincipalConfigurationsRequest) String() string {
	return common.PointerString(request)
}

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

	return nil, false

}

// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListResourcePrincipalConfigurationsRequest) 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 ListResourcePrincipalConfigurationsRequest) ValidateEnumValue() (bool, error) {
	errMessage := []string{}
	if _, ok := GetMappingListResourcePrincipalConfigurationsSortByEnum(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(GetListResourcePrincipalConfigurationsSortByEnumStringValues(), ",")))
	}
	if _, ok := GetMappingListResourcePrincipalConfigurationsSortOrderEnum(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(GetListResourcePrincipalConfigurationsSortOrderEnumStringValues(), ",")))
	}
	if _, ok := GetMappingResourcePrincipalConfigurationLifecycleStateEnum(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(GetResourcePrincipalConfigurationLifecycleStateEnumStringValues(), ",")))
	}
	if len(errMessage) > 0 {
		return true, fmt.Errorf("%s", strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// ListResourcePrincipalConfigurationsResponse wrapper for the ListResourcePrincipalConfigurations operation
type ListResourcePrincipalConfigurationsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []ResourcePrincipalConfigurationSummary instances
	Items []ResourcePrincipalConfigurationSummary `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a request, provide this 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 ListResourcePrincipalConfigurationsResponse) String() string {
	return common.PointerString(response)
}

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

// ListResourcePrincipalConfigurationsSortByEnum Enum with underlying type: string
type ListResourcePrincipalConfigurationsSortByEnum string

// Set of constants representing the allowable values for ListResourcePrincipalConfigurationsSortByEnum
const (
	ListResourcePrincipalConfigurationsSortByTimecreated ListResourcePrincipalConfigurationsSortByEnum = "timeCreated"
	ListResourcePrincipalConfigurationsSortByDisplayname ListResourcePrincipalConfigurationsSortByEnum = "displayName"
)

var mappingListResourcePrincipalConfigurationsSortByEnum = map[string]ListResourcePrincipalConfigurationsSortByEnum{
	"timeCreated": ListResourcePrincipalConfigurationsSortByTimecreated,
	"displayName": ListResourcePrincipalConfigurationsSortByDisplayname,
}

var mappingListResourcePrincipalConfigurationsSortByEnumLowerCase = map[string]ListResourcePrincipalConfigurationsSortByEnum{
	"timecreated": ListResourcePrincipalConfigurationsSortByTimecreated,
	"displayname": ListResourcePrincipalConfigurationsSortByDisplayname,
}

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

// GetListResourcePrincipalConfigurationsSortByEnumStringValues Enumerates the set of values in String for ListResourcePrincipalConfigurationsSortByEnum
func GetListResourcePrincipalConfigurationsSortByEnumStringValues() []string {
	return []string{
		"timeCreated",
		"displayName",
	}
}

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

// ListResourcePrincipalConfigurationsSortOrderEnum Enum with underlying type: string
type ListResourcePrincipalConfigurationsSortOrderEnum string

// Set of constants representing the allowable values for ListResourcePrincipalConfigurationsSortOrderEnum
const (
	ListResourcePrincipalConfigurationsSortOrderAsc  ListResourcePrincipalConfigurationsSortOrderEnum = "ASC"
	ListResourcePrincipalConfigurationsSortOrderDesc ListResourcePrincipalConfigurationsSortOrderEnum = "DESC"
)

var mappingListResourcePrincipalConfigurationsSortOrderEnum = map[string]ListResourcePrincipalConfigurationsSortOrderEnum{
	"ASC":  ListResourcePrincipalConfigurationsSortOrderAsc,
	"DESC": ListResourcePrincipalConfigurationsSortOrderDesc,
}

var mappingListResourcePrincipalConfigurationsSortOrderEnumLowerCase = map[string]ListResourcePrincipalConfigurationsSortOrderEnum{
	"asc":  ListResourcePrincipalConfigurationsSortOrderAsc,
	"desc": ListResourcePrincipalConfigurationsSortOrderDesc,
}

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

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

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