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

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

// ListBatchContextShapesRequest wrapper for the ListBatchContextShapes operation
//
// # See also
//
// Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchContextShapes.go.html to see an example of how to use ListBatchContextShapesRequest.
type ListBatchContextShapesRequest 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"`

	// The name of the availability domain.
	AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`

	// 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 type of a shape.
	ShapeType ListBatchContextShapesShapeTypeEnum `mandatory:"false" contributesTo:"query" name:"shapeType" 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 ListBatchContextShapesRequest) String() string {
	return common.PointerString(request)
}

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

	return nil, false

}

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

// ListBatchContextShapesResponse wrapper for the ListBatchContextShapes operation
type ListBatchContextShapesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of BatchContextShapeCollection instances
	BatchContextShapeCollection `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 ListBatchContextShapesResponse) String() string {
	return common.PointerString(response)
}

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

// ListBatchContextShapesShapeTypeEnum Enum with underlying type: string
type ListBatchContextShapesShapeTypeEnum string

// Set of constants representing the allowable values for ListBatchContextShapesShapeTypeEnum
const (
	ListBatchContextShapesShapeTypeCpu ListBatchContextShapesShapeTypeEnum = "CPU"
	ListBatchContextShapesShapeTypeGpu ListBatchContextShapesShapeTypeEnum = "GPU"
)

var mappingListBatchContextShapesShapeTypeEnum = map[string]ListBatchContextShapesShapeTypeEnum{
	"CPU": ListBatchContextShapesShapeTypeCpu,
	"GPU": ListBatchContextShapesShapeTypeGpu,
}

var mappingListBatchContextShapesShapeTypeEnumLowerCase = map[string]ListBatchContextShapesShapeTypeEnum{
	"cpu": ListBatchContextShapesShapeTypeCpu,
	"gpu": ListBatchContextShapesShapeTypeGpu,
}

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

// GetListBatchContextShapesShapeTypeEnumStringValues Enumerates the set of values in String for ListBatchContextShapesShapeTypeEnum
func GetListBatchContextShapesShapeTypeEnumStringValues() []string {
	return []string{
		"CPU",
		"GPU",
	}
}

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