list_host_insights_request_response.go

// Copyright (c) 2016, 2018, 2021, 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 opsi

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

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

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

	// Optional list of host insight resource OCIDs (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource.
	Id []string `contributesTo:"query" name:"id" collectionFormat:"multi"`

	// Resource Status
	Status []ResourceStatusEnum `contributesTo:"query" name:"status" omitEmpty:"true" collectionFormat:"multi"`

	// Lifecycle states
	LifecycleState []LifecycleStateEnum `contributesTo:"query" name:"lifecycleState" omitEmpty:"true" collectionFormat:"multi"`

	// Filter by one or more host types.
	// Possible value is EXTERNAL-HOST.
	HostType []string `contributesTo:"query" name:"hostType" collectionFormat:"multi"`

	// Filter by one or more platform types.
	// Possible value is LINUX.
	PlatformType []ListHostInsightsPlatformTypeEnum `contributesTo:"query" name:"platformType" omitEmpty:"true" collectionFormat:"multi"`

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

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListHostInsightsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// Host insight list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified.
	SortBy ListHostInsightsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" 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 ListHostInsightsRequest) String() string {
	return common.PointerString(request)
}

// HTTPRequest implements the OCIRequest interface
func (request ListHostInsightsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser) (http.Request, error) {

	return common.MakeDefaultHTTPRequestWithTaggedStruct(method, path, request)
}

// BinaryRequestBody implements the OCIRequest interface
func (request ListHostInsightsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {

	return nil, false

}

// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListHostInsightsRequest) RetryPolicy() *common.RetryPolicy {
	return request.RequestMetadata.RetryPolicy
}

// ListHostInsightsResponse wrapper for the ListHostInsights operation
type ListHostInsightsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of HostInsightSummaryCollection instances
	HostInsightSummaryCollection `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. The total number of items in the result.
	OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`

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

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

// ListHostInsightsPlatformTypeEnum Enum with underlying type: string
type ListHostInsightsPlatformTypeEnum string

// Set of constants representing the allowable values for ListHostInsightsPlatformTypeEnum
const (
	ListHostInsightsPlatformTypeLinux ListHostInsightsPlatformTypeEnum = "LINUX"
)

var mappingListHostInsightsPlatformType = map[string]ListHostInsightsPlatformTypeEnum{
	"LINUX": ListHostInsightsPlatformTypeLinux,
}

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

// ListHostInsightsSortOrderEnum Enum with underlying type: string
type ListHostInsightsSortOrderEnum string

// Set of constants representing the allowable values for ListHostInsightsSortOrderEnum
const (
	ListHostInsightsSortOrderAsc  ListHostInsightsSortOrderEnum = "ASC"
	ListHostInsightsSortOrderDesc ListHostInsightsSortOrderEnum = "DESC"
)

var mappingListHostInsightsSortOrder = map[string]ListHostInsightsSortOrderEnum{
	"ASC":  ListHostInsightsSortOrderAsc,
	"DESC": ListHostInsightsSortOrderDesc,
}

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

// ListHostInsightsSortByEnum Enum with underlying type: string
type ListHostInsightsSortByEnum string

// Set of constants representing the allowable values for ListHostInsightsSortByEnum
const (
	ListHostInsightsSortByHostname ListHostInsightsSortByEnum = "hostName"
	ListHostInsightsSortByHosttype ListHostInsightsSortByEnum = "hostType"
)

var mappingListHostInsightsSortBy = map[string]ListHostInsightsSortByEnum{
	"hostName": ListHostInsightsSortByHostname,
	"hostType": ListHostInsightsSortByHosttype,
}

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