list_fusion_environments_request_response.go

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

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

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

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The ID of the fusion environment family in which to list resources.
	FusionEnvironmentFamilyId *string `mandatory:"false" contributesTo:"query" name:"fusionEnvironmentFamilyId"`

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

	// A filter that returns all resources that match the specified lifecycle state.
	LifecycleState FusionEnvironmentLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

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

	// 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 sort order to use, either 'asc' or 'desc'.
	SortOrder ListFusionEnvironmentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// 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 ListFusionEnvironmentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" 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 ListFusionEnvironmentsRequest) String() string {
	return common.PointerString(request)
}

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

	return nil, false

}

// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListFusionEnvironmentsRequest) 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 ListFusionEnvironmentsRequest) ValidateEnumValue() (bool, error) {
	errMessage := []string{}
	if _, ok := GetMappingFusionEnvironmentLifecycleStateEnum(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(GetFusionEnvironmentLifecycleStateEnumStringValues(), ",")))
	}
	if _, ok := GetMappingListFusionEnvironmentsSortOrderEnum(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(GetListFusionEnvironmentsSortOrderEnumStringValues(), ",")))
	}
	if _, ok := GetMappingListFusionEnvironmentsSortByEnum(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(GetListFusionEnvironmentsSortByEnumStringValues(), ",")))
	}
	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// ListFusionEnvironmentsResponse wrapper for the ListFusionEnvironments operation
type ListFusionEnvironmentsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

// ListFusionEnvironmentsSortOrderEnum Enum with underlying type: string
type ListFusionEnvironmentsSortOrderEnum string

// Set of constants representing the allowable values for ListFusionEnvironmentsSortOrderEnum
const (
	ListFusionEnvironmentsSortOrderAsc  ListFusionEnvironmentsSortOrderEnum = "ASC"
	ListFusionEnvironmentsSortOrderDesc ListFusionEnvironmentsSortOrderEnum = "DESC"
)

var mappingListFusionEnvironmentsSortOrderEnum = map[string]ListFusionEnvironmentsSortOrderEnum{
	"ASC":  ListFusionEnvironmentsSortOrderAsc,
	"DESC": ListFusionEnvironmentsSortOrderDesc,
}

var mappingListFusionEnvironmentsSortOrderEnumLowerCase = map[string]ListFusionEnvironmentsSortOrderEnum{
	"asc":  ListFusionEnvironmentsSortOrderAsc,
	"desc": ListFusionEnvironmentsSortOrderDesc,
}

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

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

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

// ListFusionEnvironmentsSortByEnum Enum with underlying type: string
type ListFusionEnvironmentsSortByEnum string

// Set of constants representing the allowable values for ListFusionEnvironmentsSortByEnum
const (
	ListFusionEnvironmentsSortByTimeCreated ListFusionEnvironmentsSortByEnum = "TIME_CREATED"
	ListFusionEnvironmentsSortByDisplayName ListFusionEnvironmentsSortByEnum = "DISPLAY_NAME"
)

var mappingListFusionEnvironmentsSortByEnum = map[string]ListFusionEnvironmentsSortByEnum{
	"TIME_CREATED": ListFusionEnvironmentsSortByTimeCreated,
	"DISPLAY_NAME": ListFusionEnvironmentsSortByDisplayName,
}

var mappingListFusionEnvironmentsSortByEnumLowerCase = map[string]ListFusionEnvironmentsSortByEnum{
	"time_created": ListFusionEnvironmentsSortByTimeCreated,
	"display_name": ListFusionEnvironmentsSortByDisplayName,
}

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

// GetListFusionEnvironmentsSortByEnumStringValues Enumerates the set of values in String for ListFusionEnvironmentsSortByEnum
func GetListFusionEnvironmentsSortByEnumStringValues() []string {
	return []string{
		"TIME_CREATED",
		"DISPLAY_NAME",
	}
}

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