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

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

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

	// The workspace ID.
	WorkspaceId *string `mandatory:"true" contributesTo:"path" name:"workspaceId"`

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

	// Unique key of the folder.
	FolderId *string `mandatory:"false" contributesTo:"query" name:"folderId"`

	// Specifies the fields to get for an object.
	Fields []string `contributesTo:"query" name:"fields" collectionFormat:"multi"`

	// Used to filter by the name of the object.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// Used to filter by the identifier of the object.
	Identifier []string `contributesTo:"query" name:"identifier" collectionFormat:"multi"`

	// Sets the maximum number of results per page, or items to return in a paginated `List` call. 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 for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).
	SortOrder ListDataFlowsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order).
	SortBy ListDataFlowsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

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

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

	return nil, false

}

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

// ListDataFlowsResponse wrapper for the ListDataFlows operation
type ListDataFlowsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of DataFlowSummaryCollection instances
	DataFlowSummaryCollection `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"`

	// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`

	// Total items in the entire list.
	OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}

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

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

// ListDataFlowsSortOrderEnum Enum with underlying type: string
type ListDataFlowsSortOrderEnum string

// Set of constants representing the allowable values for ListDataFlowsSortOrderEnum
const (
	ListDataFlowsSortOrderAsc  ListDataFlowsSortOrderEnum = "ASC"
	ListDataFlowsSortOrderDesc ListDataFlowsSortOrderEnum = "DESC"
)

var mappingListDataFlowsSortOrderEnum = map[string]ListDataFlowsSortOrderEnum{
	"ASC":  ListDataFlowsSortOrderAsc,
	"DESC": ListDataFlowsSortOrderDesc,
}

var mappingListDataFlowsSortOrderEnumLowerCase = map[string]ListDataFlowsSortOrderEnum{
	"asc":  ListDataFlowsSortOrderAsc,
	"desc": ListDataFlowsSortOrderDesc,
}

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

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

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

// ListDataFlowsSortByEnum Enum with underlying type: string
type ListDataFlowsSortByEnum string

// Set of constants representing the allowable values for ListDataFlowsSortByEnum
const (
	ListDataFlowsSortByTimeCreated ListDataFlowsSortByEnum = "TIME_CREATED"
	ListDataFlowsSortByDisplayName ListDataFlowsSortByEnum = "DISPLAY_NAME"
	ListDataFlowsSortByTimeUpdated ListDataFlowsSortByEnum = "TIME_UPDATED"
)

var mappingListDataFlowsSortByEnum = map[string]ListDataFlowsSortByEnum{
	"TIME_CREATED": ListDataFlowsSortByTimeCreated,
	"DISPLAY_NAME": ListDataFlowsSortByDisplayName,
	"TIME_UPDATED": ListDataFlowsSortByTimeUpdated,
}

var mappingListDataFlowsSortByEnumLowerCase = map[string]ListDataFlowsSortByEnum{
	"time_created": ListDataFlowsSortByTimeCreated,
	"display_name": ListDataFlowsSortByDisplayName,
	"time_updated": ListDataFlowsSortByTimeUpdated,
}

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

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

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