list_database_tools_connections_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 databasetools

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

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

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

	// A filter to return only resources their `lifecycleState` matches the specified `lifecycleState`.
	LifecycleState ListDatabaseToolsConnectionsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

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

	// A filter to return only resources their type matches the specified type.
	Type []ConnectionTypeEnum `contributesTo:"query" name:"type" omitEmpty:"true" collectionFormat:"multi"`

	// A filter to return only resources with one of the specified runtimeSupport values.
	RuntimeSupport []RuntimeSupportEnum `contributesTo:"query" name:"runtimeSupport" omitEmpty:"true" collectionFormat:"multi"`

	// A filter to return only resources associated to the related resource identifier OCID passed in the query string.
	RelatedResourceIdentifier *string `mandatory:"false" contributesTo:"query" name:"relatedResourceIdentifier"`

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

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

	return nil, false

}

// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDatabaseToolsConnectionsRequest) 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 ListDatabaseToolsConnectionsRequest) ValidateEnumValue() (bool, error) {
	errMessage := []string{}
	if _, ok := GetMappingListDatabaseToolsConnectionsLifecycleStateEnum(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(GetListDatabaseToolsConnectionsLifecycleStateEnumStringValues(), ",")))
	}
	for _, val := range request.Type {
		if _, ok := GetMappingConnectionTypeEnum(string(val)); !ok && val != "" {
			errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Type: %s. Supported values are: %s.", val, strings.Join(GetConnectionTypeEnumStringValues(), ",")))
		}
	}

	for _, val := range request.RuntimeSupport {
		if _, ok := GetMappingRuntimeSupportEnum(string(val)); !ok && val != "" {
			errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for RuntimeSupport: %s. Supported values are: %s.", val, strings.Join(GetRuntimeSupportEnumStringValues(), ",")))
		}
	}

	if _, ok := GetMappingListDatabaseToolsConnectionsSortOrderEnum(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(GetListDatabaseToolsConnectionsSortOrderEnumStringValues(), ",")))
	}
	if _, ok := GetMappingListDatabaseToolsConnectionsSortByEnum(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(GetListDatabaseToolsConnectionsSortByEnumStringValues(), ",")))
	}
	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// ListDatabaseToolsConnectionsResponse wrapper for the ListDatabaseToolsConnections operation
type ListDatabaseToolsConnectionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

// ListDatabaseToolsConnectionsLifecycleStateEnum Enum with underlying type: string
type ListDatabaseToolsConnectionsLifecycleStateEnum string

// Set of constants representing the allowable values for ListDatabaseToolsConnectionsLifecycleStateEnum
const (
	ListDatabaseToolsConnectionsLifecycleStateCreating ListDatabaseToolsConnectionsLifecycleStateEnum = "CREATING"
	ListDatabaseToolsConnectionsLifecycleStateUpdating ListDatabaseToolsConnectionsLifecycleStateEnum = "UPDATING"
	ListDatabaseToolsConnectionsLifecycleStateActive   ListDatabaseToolsConnectionsLifecycleStateEnum = "ACTIVE"
	ListDatabaseToolsConnectionsLifecycleStateDeleting ListDatabaseToolsConnectionsLifecycleStateEnum = "DELETING"
	ListDatabaseToolsConnectionsLifecycleStateDeleted  ListDatabaseToolsConnectionsLifecycleStateEnum = "DELETED"
	ListDatabaseToolsConnectionsLifecycleStateFailed   ListDatabaseToolsConnectionsLifecycleStateEnum = "FAILED"
	ListDatabaseToolsConnectionsLifecycleStateInactive ListDatabaseToolsConnectionsLifecycleStateEnum = "INACTIVE"
)

var mappingListDatabaseToolsConnectionsLifecycleStateEnum = map[string]ListDatabaseToolsConnectionsLifecycleStateEnum{
	"CREATING": ListDatabaseToolsConnectionsLifecycleStateCreating,
	"UPDATING": ListDatabaseToolsConnectionsLifecycleStateUpdating,
	"ACTIVE":   ListDatabaseToolsConnectionsLifecycleStateActive,
	"DELETING": ListDatabaseToolsConnectionsLifecycleStateDeleting,
	"DELETED":  ListDatabaseToolsConnectionsLifecycleStateDeleted,
	"FAILED":   ListDatabaseToolsConnectionsLifecycleStateFailed,
	"INACTIVE": ListDatabaseToolsConnectionsLifecycleStateInactive,
}

var mappingListDatabaseToolsConnectionsLifecycleStateEnumLowerCase = map[string]ListDatabaseToolsConnectionsLifecycleStateEnum{
	"creating": ListDatabaseToolsConnectionsLifecycleStateCreating,
	"updating": ListDatabaseToolsConnectionsLifecycleStateUpdating,
	"active":   ListDatabaseToolsConnectionsLifecycleStateActive,
	"deleting": ListDatabaseToolsConnectionsLifecycleStateDeleting,
	"deleted":  ListDatabaseToolsConnectionsLifecycleStateDeleted,
	"failed":   ListDatabaseToolsConnectionsLifecycleStateFailed,
	"inactive": ListDatabaseToolsConnectionsLifecycleStateInactive,
}

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

// GetListDatabaseToolsConnectionsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDatabaseToolsConnectionsLifecycleStateEnum
func GetListDatabaseToolsConnectionsLifecycleStateEnumStringValues() []string {
	return []string{
		"CREATING",
		"UPDATING",
		"ACTIVE",
		"DELETING",
		"DELETED",
		"FAILED",
		"INACTIVE",
	}
}

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

// ListDatabaseToolsConnectionsSortOrderEnum Enum with underlying type: string
type ListDatabaseToolsConnectionsSortOrderEnum string

// Set of constants representing the allowable values for ListDatabaseToolsConnectionsSortOrderEnum
const (
	ListDatabaseToolsConnectionsSortOrderAsc  ListDatabaseToolsConnectionsSortOrderEnum = "ASC"
	ListDatabaseToolsConnectionsSortOrderDesc ListDatabaseToolsConnectionsSortOrderEnum = "DESC"
)

var mappingListDatabaseToolsConnectionsSortOrderEnum = map[string]ListDatabaseToolsConnectionsSortOrderEnum{
	"ASC":  ListDatabaseToolsConnectionsSortOrderAsc,
	"DESC": ListDatabaseToolsConnectionsSortOrderDesc,
}

var mappingListDatabaseToolsConnectionsSortOrderEnumLowerCase = map[string]ListDatabaseToolsConnectionsSortOrderEnum{
	"asc":  ListDatabaseToolsConnectionsSortOrderAsc,
	"desc": ListDatabaseToolsConnectionsSortOrderDesc,
}

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

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

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

// ListDatabaseToolsConnectionsSortByEnum Enum with underlying type: string
type ListDatabaseToolsConnectionsSortByEnum string

// Set of constants representing the allowable values for ListDatabaseToolsConnectionsSortByEnum
const (
	ListDatabaseToolsConnectionsSortByTimecreated ListDatabaseToolsConnectionsSortByEnum = "timeCreated"
	ListDatabaseToolsConnectionsSortByDisplayname ListDatabaseToolsConnectionsSortByEnum = "displayName"
)

var mappingListDatabaseToolsConnectionsSortByEnum = map[string]ListDatabaseToolsConnectionsSortByEnum{
	"timeCreated": ListDatabaseToolsConnectionsSortByTimecreated,
	"displayName": ListDatabaseToolsConnectionsSortByDisplayname,
}

var mappingListDatabaseToolsConnectionsSortByEnumLowerCase = map[string]ListDatabaseToolsConnectionsSortByEnum{
	"timecreated": ListDatabaseToolsConnectionsSortByTimecreated,
	"displayname": ListDatabaseToolsConnectionsSortByDisplayname,
}

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

// GetListDatabaseToolsConnectionsSortByEnumStringValues Enumerates the set of values in String for ListDatabaseToolsConnectionsSortByEnum
func GetListDatabaseToolsConnectionsSortByEnumStringValues() []string {
	return []string{
		"timeCreated",
		"displayName",
	}
}

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