list_proxied_for_users_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 databasemanagement

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

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

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Managed Database.
	ManagedDatabaseId *string `mandatory:"true" contributesTo:"path" name:"managedDatabaseId"`

	// The name of the user whose details are to be viewed.
	UserName *string `mandatory:"true" contributesTo:"path" name:"userName"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

	// The field to sort information by. Only one sortOrder can be used. The default sort order
	// for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive.
	SortBy ListProxiedForUsersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order.
	SortOrder ListProxiedForUsersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The maximum number of records returned in the paginated response.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The page token representing the page from where the next set of paginated results
	// are retrieved. This is usually retrieved from a previous list call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The OCID of the Named Credential.
	OpcNamedCredentialId *string `mandatory:"false" contributesTo:"header" name:"opc-named-credential-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 ListProxiedForUsersRequest) String() string {
	return common.PointerString(request)
}

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

	return nil, false

}

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

// ListProxiedForUsersResponse wrapper for the ListProxiedForUsers operation
type ListProxiedForUsersResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of ProxiedForUserCollection instances
	ProxiedForUserCollection `presentIn:"body"`

	// 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"`

	// 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"`
}

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

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

// ListProxiedForUsersSortByEnum Enum with underlying type: string
type ListProxiedForUsersSortByEnum string

// Set of constants representing the allowable values for ListProxiedForUsersSortByEnum
const (
	ListProxiedForUsersSortByName ListProxiedForUsersSortByEnum = "NAME"
)

var mappingListProxiedForUsersSortByEnum = map[string]ListProxiedForUsersSortByEnum{
	"NAME": ListProxiedForUsersSortByName,
}

var mappingListProxiedForUsersSortByEnumLowerCase = map[string]ListProxiedForUsersSortByEnum{
	"name": ListProxiedForUsersSortByName,
}

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

// GetListProxiedForUsersSortByEnumStringValues Enumerates the set of values in String for ListProxiedForUsersSortByEnum
func GetListProxiedForUsersSortByEnumStringValues() []string {
	return []string{
		"NAME",
	}
}

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

// ListProxiedForUsersSortOrderEnum Enum with underlying type: string
type ListProxiedForUsersSortOrderEnum string

// Set of constants representing the allowable values for ListProxiedForUsersSortOrderEnum
const (
	ListProxiedForUsersSortOrderAsc  ListProxiedForUsersSortOrderEnum = "ASC"
	ListProxiedForUsersSortOrderDesc ListProxiedForUsersSortOrderEnum = "DESC"
)

var mappingListProxiedForUsersSortOrderEnum = map[string]ListProxiedForUsersSortOrderEnum{
	"ASC":  ListProxiedForUsersSortOrderAsc,
	"DESC": ListProxiedForUsersSortOrderDesc,
}

var mappingListProxiedForUsersSortOrderEnumLowerCase = map[string]ListProxiedForUsersSortOrderEnum{
	"asc":  ListProxiedForUsersSortOrderAsc,
	"desc": ListProxiedForUsersSortOrderDesc,
}

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

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

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