list_vb_instances_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 visualbuilder

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

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

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

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Example: `My new resource`
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// Life cycle state to query on.
	LifecycleState ListVbInstancesLifecycleStateEnum `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 ListVbInstancesSortOrderEnum `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 ListVbInstancesSortByEnum `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 ListVbInstancesRequest) String() string {
	return common.PointerString(request)
}

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

	return nil, false

}

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

// ListVbInstancesResponse wrapper for the ListVbInstances operation
type ListVbInstancesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of VbInstanceSummaryCollection instances
	VbInstanceSummaryCollection `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 list pagination. When this header appears in the response, additional pages of results remain
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// For list pagination. When this header appears in the response, additional pages of results have been previously returned
	OpcPreviousPage *string `presentIn:"header" name:"opc-previous-page"`
}

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

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

// ListVbInstancesLifecycleStateEnum Enum with underlying type: string
type ListVbInstancesLifecycleStateEnum string

// Set of constants representing the allowable values for ListVbInstancesLifecycleStateEnum
const (
	ListVbInstancesLifecycleStateCreating ListVbInstancesLifecycleStateEnum = "CREATING"
	ListVbInstancesLifecycleStateUpdating ListVbInstancesLifecycleStateEnum = "UPDATING"
	ListVbInstancesLifecycleStateActive   ListVbInstancesLifecycleStateEnum = "ACTIVE"
	ListVbInstancesLifecycleStateInactive ListVbInstancesLifecycleStateEnum = "INACTIVE"
	ListVbInstancesLifecycleStateDeleting ListVbInstancesLifecycleStateEnum = "DELETING"
	ListVbInstancesLifecycleStateDeleted  ListVbInstancesLifecycleStateEnum = "DELETED"
	ListVbInstancesLifecycleStateFailed   ListVbInstancesLifecycleStateEnum = "FAILED"
)

var mappingListVbInstancesLifecycleStateEnum = map[string]ListVbInstancesLifecycleStateEnum{
	"CREATING": ListVbInstancesLifecycleStateCreating,
	"UPDATING": ListVbInstancesLifecycleStateUpdating,
	"ACTIVE":   ListVbInstancesLifecycleStateActive,
	"INACTIVE": ListVbInstancesLifecycleStateInactive,
	"DELETING": ListVbInstancesLifecycleStateDeleting,
	"DELETED":  ListVbInstancesLifecycleStateDeleted,
	"FAILED":   ListVbInstancesLifecycleStateFailed,
}

var mappingListVbInstancesLifecycleStateEnumLowerCase = map[string]ListVbInstancesLifecycleStateEnum{
	"creating": ListVbInstancesLifecycleStateCreating,
	"updating": ListVbInstancesLifecycleStateUpdating,
	"active":   ListVbInstancesLifecycleStateActive,
	"inactive": ListVbInstancesLifecycleStateInactive,
	"deleting": ListVbInstancesLifecycleStateDeleting,
	"deleted":  ListVbInstancesLifecycleStateDeleted,
	"failed":   ListVbInstancesLifecycleStateFailed,
}

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

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

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

// ListVbInstancesSortOrderEnum Enum with underlying type: string
type ListVbInstancesSortOrderEnum string

// Set of constants representing the allowable values for ListVbInstancesSortOrderEnum
const (
	ListVbInstancesSortOrderAsc  ListVbInstancesSortOrderEnum = "ASC"
	ListVbInstancesSortOrderDesc ListVbInstancesSortOrderEnum = "DESC"
)

var mappingListVbInstancesSortOrderEnum = map[string]ListVbInstancesSortOrderEnum{
	"ASC":  ListVbInstancesSortOrderAsc,
	"DESC": ListVbInstancesSortOrderDesc,
}

var mappingListVbInstancesSortOrderEnumLowerCase = map[string]ListVbInstancesSortOrderEnum{
	"asc":  ListVbInstancesSortOrderAsc,
	"desc": ListVbInstancesSortOrderDesc,
}

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

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

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

// ListVbInstancesSortByEnum Enum with underlying type: string
type ListVbInstancesSortByEnum string

// Set of constants representing the allowable values for ListVbInstancesSortByEnum
const (
	ListVbInstancesSortByTimecreated ListVbInstancesSortByEnum = "timeCreated"
	ListVbInstancesSortByDisplayname ListVbInstancesSortByEnum = "displayName"
)

var mappingListVbInstancesSortByEnum = map[string]ListVbInstancesSortByEnum{
	"timeCreated": ListVbInstancesSortByTimecreated,
	"displayName": ListVbInstancesSortByDisplayname,
}

var mappingListVbInstancesSortByEnumLowerCase = map[string]ListVbInstancesSortByEnum{
	"timecreated": ListVbInstancesSortByTimecreated,
	"displayname": ListVbInstancesSortByDisplayname,
}

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

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

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