list_sql_tuning_advisor_tasks_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"
)

// ListSqlTuningAdvisorTasksRequest wrapper for the ListSqlTuningAdvisorTasks operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/databasemanagement/ListSqlTuningAdvisorTasks.go.html to see an example of how to use ListSqlTuningAdvisorTasksRequest.
type ListSqlTuningAdvisorTasksRequest 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 optional query parameter to filter the SQL Tuning Advisor task list by name.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The optional query parameter to filter the SQL Tuning Advisor task list by status.
	Status ListSqlTuningAdvisorTasksStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`

	// The optional greater than or equal to query parameter to filter the timestamp.
	TimeGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeGreaterThanOrEqualTo"`

	// The optional less than or equal to query parameter to filter the timestamp.
	TimeLessThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeLessThanOrEqualTo"`

	// 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 maximum number of records returned in the paginated response.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The option to sort the SQL Tuning Advisor task summary data.
	SortBy ListSqlTuningAdvisorTasksSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

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

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

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

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

	return nil, false

}

// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSqlTuningAdvisorTasksRequest) 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 ListSqlTuningAdvisorTasksRequest) ValidateEnumValue() (bool, error) {
	errMessage := []string{}
	if _, ok := GetMappingListSqlTuningAdvisorTasksStatusEnum(string(request.Status)); !ok && request.Status != "" {
		errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Status: %s. Supported values are: %s.", request.Status, strings.Join(GetListSqlTuningAdvisorTasksStatusEnumStringValues(), ",")))
	}
	if _, ok := GetMappingListSqlTuningAdvisorTasksSortByEnum(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(GetListSqlTuningAdvisorTasksSortByEnumStringValues(), ",")))
	}
	if _, ok := GetMappingListSqlTuningAdvisorTasksSortOrderEnum(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(GetListSqlTuningAdvisorTasksSortOrderEnumStringValues(), ",")))
	}
	if len(errMessage) > 0 {
		return true, fmt.Errorf(strings.Join(errMessage, "\n"))
	}
	return false, nil
}

// ListSqlTuningAdvisorTasksResponse wrapper for the ListSqlTuningAdvisorTasks operation
type ListSqlTuningAdvisorTasksResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

// ListSqlTuningAdvisorTasksStatusEnum Enum with underlying type: string
type ListSqlTuningAdvisorTasksStatusEnum string

// Set of constants representing the allowable values for ListSqlTuningAdvisorTasksStatusEnum
const (
	ListSqlTuningAdvisorTasksStatusInitial     ListSqlTuningAdvisorTasksStatusEnum = "INITIAL"
	ListSqlTuningAdvisorTasksStatusExecuting   ListSqlTuningAdvisorTasksStatusEnum = "EXECUTING"
	ListSqlTuningAdvisorTasksStatusInterrupted ListSqlTuningAdvisorTasksStatusEnum = "INTERRUPTED"
	ListSqlTuningAdvisorTasksStatusCompleted   ListSqlTuningAdvisorTasksStatusEnum = "COMPLETED"
	ListSqlTuningAdvisorTasksStatusError       ListSqlTuningAdvisorTasksStatusEnum = "ERROR"
)

var mappingListSqlTuningAdvisorTasksStatusEnum = map[string]ListSqlTuningAdvisorTasksStatusEnum{
	"INITIAL":     ListSqlTuningAdvisorTasksStatusInitial,
	"EXECUTING":   ListSqlTuningAdvisorTasksStatusExecuting,
	"INTERRUPTED": ListSqlTuningAdvisorTasksStatusInterrupted,
	"COMPLETED":   ListSqlTuningAdvisorTasksStatusCompleted,
	"ERROR":       ListSqlTuningAdvisorTasksStatusError,
}

var mappingListSqlTuningAdvisorTasksStatusEnumLowerCase = map[string]ListSqlTuningAdvisorTasksStatusEnum{
	"initial":     ListSqlTuningAdvisorTasksStatusInitial,
	"executing":   ListSqlTuningAdvisorTasksStatusExecuting,
	"interrupted": ListSqlTuningAdvisorTasksStatusInterrupted,
	"completed":   ListSqlTuningAdvisorTasksStatusCompleted,
	"error":       ListSqlTuningAdvisorTasksStatusError,
}

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

// GetListSqlTuningAdvisorTasksStatusEnumStringValues Enumerates the set of values in String for ListSqlTuningAdvisorTasksStatusEnum
func GetListSqlTuningAdvisorTasksStatusEnumStringValues() []string {
	return []string{
		"INITIAL",
		"EXECUTING",
		"INTERRUPTED",
		"COMPLETED",
		"ERROR",
	}
}

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

// ListSqlTuningAdvisorTasksSortByEnum Enum with underlying type: string
type ListSqlTuningAdvisorTasksSortByEnum string

// Set of constants representing the allowable values for ListSqlTuningAdvisorTasksSortByEnum
const (
	ListSqlTuningAdvisorTasksSortByName      ListSqlTuningAdvisorTasksSortByEnum = "NAME"
	ListSqlTuningAdvisorTasksSortByStartTime ListSqlTuningAdvisorTasksSortByEnum = "START_TIME"
)

var mappingListSqlTuningAdvisorTasksSortByEnum = map[string]ListSqlTuningAdvisorTasksSortByEnum{
	"NAME":       ListSqlTuningAdvisorTasksSortByName,
	"START_TIME": ListSqlTuningAdvisorTasksSortByStartTime,
}

var mappingListSqlTuningAdvisorTasksSortByEnumLowerCase = map[string]ListSqlTuningAdvisorTasksSortByEnum{
	"name":       ListSqlTuningAdvisorTasksSortByName,
	"start_time": ListSqlTuningAdvisorTasksSortByStartTime,
}

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

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

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

// ListSqlTuningAdvisorTasksSortOrderEnum Enum with underlying type: string
type ListSqlTuningAdvisorTasksSortOrderEnum string

// Set of constants representing the allowable values for ListSqlTuningAdvisorTasksSortOrderEnum
const (
	ListSqlTuningAdvisorTasksSortOrderAsc  ListSqlTuningAdvisorTasksSortOrderEnum = "ASC"
	ListSqlTuningAdvisorTasksSortOrderDesc ListSqlTuningAdvisorTasksSortOrderEnum = "DESC"
)

var mappingListSqlTuningAdvisorTasksSortOrderEnum = map[string]ListSqlTuningAdvisorTasksSortOrderEnum{
	"ASC":  ListSqlTuningAdvisorTasksSortOrderAsc,
	"DESC": ListSqlTuningAdvisorTasksSortOrderDesc,
}

var mappingListSqlTuningAdvisorTasksSortOrderEnumLowerCase = map[string]ListSqlTuningAdvisorTasksSortOrderEnum{
	"asc":  ListSqlTuningAdvisorTasksSortOrderAsc,
	"desc": ListSqlTuningAdvisorTasksSortOrderDesc,
}

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

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

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