list_addm_db_finding_categories_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 opsi

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

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

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

	// Optional list of database OCIDs (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity.
	DatabaseId []string `contributesTo:"query" name:"databaseId" collectionFormat:"multi"`

	// Optional list of database insight resource OCIDs (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
	Id []string `contributesTo:"query" name:"id" collectionFormat:"multi"`

	// 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.cloud.oracle.com/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	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.cloud.oracle.com/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

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

	// Field name for sorting the finding categories
	SortBy ListAddmDbFindingCategoriesSortByEnum `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.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A list of tag filters to apply.  Only resources with a defined tag matching the value will be returned.
	// Each item in the list has the format "{namespace}.{tagName}.{value}".  All inputs are case-insensitive.
	// Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR".
	// Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
	DefinedTagEquals []string `contributesTo:"query" name:"definedTagEquals" collectionFormat:"multi"`

	// A list of tag filters to apply.  Only resources with a freeform tag matching the value will be returned.
	// The key for each tag is "{tagName}.{value}".  All inputs are case-insensitive.
	// Multiple values for the same tag name are interpreted as "OR".  Values for different tag names are interpreted as "AND".
	FreeformTagEquals []string `contributesTo:"query" name:"freeformTagEquals" collectionFormat:"multi"`

	// A list of tag existence filters to apply.  Only resources for which the specified defined tags exist will be returned.
	// Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag)
	// or "{namespace}.true".  All inputs are case-insensitive.
	// Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported.
	// Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR".
	// Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
	DefinedTagExists []string `contributesTo:"query" name:"definedTagExists" collectionFormat:"multi"`

	// A list of tag existence filters to apply.  Only resources for which the specified freeform tags exist the value will be returned.
	// The key for each tag is "{tagName}.true".  All inputs are case-insensitive.
	// Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported.
	// Multiple values for different tag names are interpreted as "AND".
	FreeformTagExists []string `contributesTo:"query" name:"freeformTagExists" collectionFormat:"multi"`

	// A flag to search all resources within a given compartment and all sub-compartments.
	CompartmentIdInSubtree *bool `mandatory:"false" contributesTo:"query" name:"compartmentIdInSubtree"`

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

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

	return nil, false

}

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

// ListAddmDbFindingCategoriesResponse wrapper for the ListAddmDbFindingCategories operation
type ListAddmDbFindingCategoriesResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

// ListAddmDbFindingCategoriesSortOrderEnum Enum with underlying type: string
type ListAddmDbFindingCategoriesSortOrderEnum string

// Set of constants representing the allowable values for ListAddmDbFindingCategoriesSortOrderEnum
const (
	ListAddmDbFindingCategoriesSortOrderAsc  ListAddmDbFindingCategoriesSortOrderEnum = "ASC"
	ListAddmDbFindingCategoriesSortOrderDesc ListAddmDbFindingCategoriesSortOrderEnum = "DESC"
)

var mappingListAddmDbFindingCategoriesSortOrderEnum = map[string]ListAddmDbFindingCategoriesSortOrderEnum{
	"ASC":  ListAddmDbFindingCategoriesSortOrderAsc,
	"DESC": ListAddmDbFindingCategoriesSortOrderDesc,
}

var mappingListAddmDbFindingCategoriesSortOrderEnumLowerCase = map[string]ListAddmDbFindingCategoriesSortOrderEnum{
	"asc":  ListAddmDbFindingCategoriesSortOrderAsc,
	"desc": ListAddmDbFindingCategoriesSortOrderDesc,
}

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

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

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

// ListAddmDbFindingCategoriesSortByEnum Enum with underlying type: string
type ListAddmDbFindingCategoriesSortByEnum string

// Set of constants representing the allowable values for ListAddmDbFindingCategoriesSortByEnum
const (
	ListAddmDbFindingCategoriesSortByName ListAddmDbFindingCategoriesSortByEnum = "name"
)

var mappingListAddmDbFindingCategoriesSortByEnum = map[string]ListAddmDbFindingCategoriesSortByEnum{
	"name": ListAddmDbFindingCategoriesSortByName,
}

var mappingListAddmDbFindingCategoriesSortByEnumLowerCase = map[string]ListAddmDbFindingCategoriesSortByEnum{
	"name": ListAddmDbFindingCategoriesSortByName,
}

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

// GetListAddmDbFindingCategoriesSortByEnumStringValues Enumerates the set of values in String for ListAddmDbFindingCategoriesSortByEnum
func GetListAddmDbFindingCategoriesSortByEnumStringValues() []string {
	return []string{
		"name",
	}
}

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