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

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

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that their lifecycle state matches the given lifecycle state.
	LifecycleState ApiKeyLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

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

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the APIKey.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

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

	// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
	// is descending. Default order for `displayName` is ascending.
	SortBy ListApiKeysSortByEnum `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.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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 ListApiKeysRequest) String() string {
	return common.PointerString(request)
}

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

	return nil, false

}

// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListApiKeysRequest) 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 ListApiKeysRequest) ValidateEnumValue() (bool, error) {
	errMessage := []string{}
	if _, ok := GetMappingApiKeyLifecycleStateEnum(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(GetApiKeyLifecycleStateEnumStringValues(), ",")))
	}
	if _, ok := GetMappingListApiKeysSortOrderEnum(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(GetListApiKeysSortOrderEnumStringValues(), ",")))
	}
	if _, ok := GetMappingListApiKeysSortByEnum(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(GetListApiKeysSortByEnumStringValues(), ",")))
	}
	if len(errMessage) > 0 {
		return true, fmt.Errorf("%s", strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// ListApiKeysResponse wrapper for the ListApiKeys operation
type ListApiKeysResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of ApiKeyCollection instances
	ApiKeyCollection `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 list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

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

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

// ListApiKeysSortOrderEnum Enum with underlying type: string
type ListApiKeysSortOrderEnum string

// Set of constants representing the allowable values for ListApiKeysSortOrderEnum
const (
	ListApiKeysSortOrderAsc  ListApiKeysSortOrderEnum = "ASC"
	ListApiKeysSortOrderDesc ListApiKeysSortOrderEnum = "DESC"
)

var mappingListApiKeysSortOrderEnum = map[string]ListApiKeysSortOrderEnum{
	"ASC":  ListApiKeysSortOrderAsc,
	"DESC": ListApiKeysSortOrderDesc,
}

var mappingListApiKeysSortOrderEnumLowerCase = map[string]ListApiKeysSortOrderEnum{
	"asc":  ListApiKeysSortOrderAsc,
	"desc": ListApiKeysSortOrderDesc,
}

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

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

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

// ListApiKeysSortByEnum Enum with underlying type: string
type ListApiKeysSortByEnum string

// Set of constants representing the allowable values for ListApiKeysSortByEnum
const (
	ListApiKeysSortByDisplayname ListApiKeysSortByEnum = "displayName"
	ListApiKeysSortByTimecreated ListApiKeysSortByEnum = "timeCreated"
)

var mappingListApiKeysSortByEnum = map[string]ListApiKeysSortByEnum{
	"displayName": ListApiKeysSortByDisplayname,
	"timeCreated": ListApiKeysSortByTimecreated,
}

var mappingListApiKeysSortByEnumLowerCase = map[string]ListApiKeysSortByEnum{
	"displayname": ListApiKeysSortByDisplayname,
	"timecreated": ListApiKeysSortByTimecreated,
}

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

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

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