summarize_managed_instance_analytics_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 osmanagementhub

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

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

	// A filter to return only metrics whose name matches the given metric names.
	MetricNames []MetricNameEnum `contributesTo:"query" name:"metricNames" omitEmpty:"true" collectionFormat:"multi"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	// This filter returns only resources contained within the specified compartment.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. This filter returns resources associated with this group.
	ManagedInstanceGroupId *string `mandatory:"false" contributesTo:"query" name:"managedInstanceGroupId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment. This filter returns only resource contained with the specified lifecycle environment.
	LifecycleEnvironmentId *string `mandatory:"false" contributesTo:"query" name:"lifecycleEnvironmentId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage. This resource returns resources associated with this lifecycle stage.
	LifecycleStageId *string `mandatory:"false" contributesTo:"query" name:"lifecycleStageId"`

	// A filter to return only managed instances whose status matches the status provided.
	Status []ManagedInstanceStatusEnum `contributesTo:"query" name:"status" omitEmpty:"true" collectionFormat:"multi"`

	// A filter to return only resources whose location matches the given value.
	Location []ManagedInstanceLocationEnum `contributesTo:"query" name:"location" omitEmpty:"true" collectionFormat:"multi"`

	// A filter to return only resources whose location does not match the given value.
	LocationNotEqualTo []ManagedInstanceLocationEnum `contributesTo:"query" name:"locationNotEqualTo" omitEmpty:"true" collectionFormat:"multi"`

	// A filter to return only resources that match the given operating system family.
	OsFamily []OsFamilyEnum `contributesTo:"query" name:"osFamily" omitEmpty:"true" collectionFormat:"multi"`

	// Indicates whether to list only resources managed by the Autonomous Linux service.
	IsManagedByAutonomousLinux *bool `mandatory:"false" contributesTo:"query" name:"isManagedByAutonomousLinux"`

	// A filter to return resources that match the given display names.
	DisplayName []string `contributesTo:"query" name:"displayName" collectionFormat:"multi"`

	// A filter to return resources that may partially match the given display name.
	DisplayNameContains *string `mandatory:"false" contributesTo:"query" name:"displayNameContains"`

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

	// The field to sort by. Only one sort order may be provided. The default is to sort in ascending order by metricName (previously name, which is now depricated).
	// You can also sort by displayName (default is ascending order).
	SortBy SummarizeManagedInstanceAnalyticsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'ASC' or 'DESC'.
	SortOrder SummarizeManagedInstanceAnalyticsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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"`

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

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

	return nil, false

}

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

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

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

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

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

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

// SummarizeManagedInstanceAnalyticsResponse wrapper for the SummarizeManagedInstanceAnalytics operation
type SummarizeManagedInstanceAnalyticsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of ManagedInstanceAnalyticCollection instances
	ManagedInstanceAnalyticCollection `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. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

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

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

// SummarizeManagedInstanceAnalyticsSortByEnum Enum with underlying type: string
type SummarizeManagedInstanceAnalyticsSortByEnum string

// Set of constants representing the allowable values for SummarizeManagedInstanceAnalyticsSortByEnum
const (
	SummarizeManagedInstanceAnalyticsSortByName        SummarizeManagedInstanceAnalyticsSortByEnum = "name"
	SummarizeManagedInstanceAnalyticsSortByMetricname  SummarizeManagedInstanceAnalyticsSortByEnum = "metricName"
	SummarizeManagedInstanceAnalyticsSortByDisplayname SummarizeManagedInstanceAnalyticsSortByEnum = "displayName"
)

var mappingSummarizeManagedInstanceAnalyticsSortByEnum = map[string]SummarizeManagedInstanceAnalyticsSortByEnum{
	"name":        SummarizeManagedInstanceAnalyticsSortByName,
	"metricName":  SummarizeManagedInstanceAnalyticsSortByMetricname,
	"displayName": SummarizeManagedInstanceAnalyticsSortByDisplayname,
}

var mappingSummarizeManagedInstanceAnalyticsSortByEnumLowerCase = map[string]SummarizeManagedInstanceAnalyticsSortByEnum{
	"name":        SummarizeManagedInstanceAnalyticsSortByName,
	"metricname":  SummarizeManagedInstanceAnalyticsSortByMetricname,
	"displayname": SummarizeManagedInstanceAnalyticsSortByDisplayname,
}

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

// GetSummarizeManagedInstanceAnalyticsSortByEnumStringValues Enumerates the set of values in String for SummarizeManagedInstanceAnalyticsSortByEnum
func GetSummarizeManagedInstanceAnalyticsSortByEnumStringValues() []string {
	return []string{
		"name",
		"metricName",
		"displayName",
	}
}

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

// SummarizeManagedInstanceAnalyticsSortOrderEnum Enum with underlying type: string
type SummarizeManagedInstanceAnalyticsSortOrderEnum string

// Set of constants representing the allowable values for SummarizeManagedInstanceAnalyticsSortOrderEnum
const (
	SummarizeManagedInstanceAnalyticsSortOrderAsc  SummarizeManagedInstanceAnalyticsSortOrderEnum = "ASC"
	SummarizeManagedInstanceAnalyticsSortOrderDesc SummarizeManagedInstanceAnalyticsSortOrderEnum = "DESC"
)

var mappingSummarizeManagedInstanceAnalyticsSortOrderEnum = map[string]SummarizeManagedInstanceAnalyticsSortOrderEnum{
	"ASC":  SummarizeManagedInstanceAnalyticsSortOrderAsc,
	"DESC": SummarizeManagedInstanceAnalyticsSortOrderDesc,
}

var mappingSummarizeManagedInstanceAnalyticsSortOrderEnumLowerCase = map[string]SummarizeManagedInstanceAnalyticsSortOrderEnum{
	"asc":  SummarizeManagedInstanceAnalyticsSortOrderAsc,
	"desc": SummarizeManagedInstanceAnalyticsSortOrderDesc,
}

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

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

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