-
Notifications
You must be signed in to change notification settings - Fork 80
/
summarize_host_insight_network_usage_trend_request_response.go
190 lines (152 loc) · 9.47 KB
/
summarize_host_insight_network_usage_trend_request_response.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
// 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 opsi
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// SummarizeHostInsightNetworkUsageTrendRequest wrapper for the SummarizeHostInsightNetworkUsageTrend operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/opsi/SummarizeHostInsightNetworkUsageTrend.go.html to see an example of how to use SummarizeHostInsightNetworkUsageTrendRequest.
type SummarizeHostInsightNetworkUsageTrendRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Required OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource.
Id *string `mandatory:"true" contributesTo:"query" name:"id"`
// Specify time period in ISO 8601 format with respect to current time.
// Default is last 30 days represented by P30D.
// If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored.
// Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).
AnalysisTimeInterval *string `mandatory:"false" contributesTo:"query" name:"analysisTimeInterval"`
// Analysis start time in UTC in ISO 8601 format(inclusive).
// Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).
// The minimum allowed value is 2 years prior to the current day.
// timeIntervalStart and timeIntervalEnd parameters are used together.
// If analysisTimeInterval is specified, this parameter is ignored.
TimeIntervalStart *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeIntervalStart"`
// Analysis end time in UTC in ISO 8601 format(exclusive).
// Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ).
// timeIntervalStart and timeIntervalEnd are used together.
// If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
TimeIntervalEnd *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeIntervalEnd"`
// Optional OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id)
HostId *string `mandatory:"false" contributesTo:"query" name:"hostId"`
// 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"`
// 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"`
// Choose the type of statistic metric data to be used for forecasting.
Statistic SummarizeHostInsightNetworkUsageTrendStatisticEnum `mandatory:"false" contributesTo:"query" name:"statistic" 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"`
// Resource Status
Status []ResourceStatusEnum `contributesTo:"query" name:"status" omitEmpty:"true" collectionFormat:"multi"`
// 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 SummarizeHostInsightNetworkUsageTrendRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request SummarizeHostInsightNetworkUsageTrendRequest) 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 SummarizeHostInsightNetworkUsageTrendRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SummarizeHostInsightNetworkUsageTrendRequest) 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 SummarizeHostInsightNetworkUsageTrendRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingSummarizeHostInsightNetworkUsageTrendStatisticEnum(string(request.Statistic)); !ok && request.Statistic != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Statistic: %s. Supported values are: %s.", request.Statistic, strings.Join(GetSummarizeHostInsightNetworkUsageTrendStatisticEnumStringValues(), ",")))
}
for _, val := range request.Status {
if _, ok := GetMappingResourceStatusEnum(string(val)); !ok && val != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Status: %s. Supported values are: %s.", val, strings.Join(GetResourceStatusEnumStringValues(), ",")))
}
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// SummarizeHostInsightNetworkUsageTrendResponse wrapper for the SummarizeHostInsightNetworkUsageTrend operation
type SummarizeHostInsightNetworkUsageTrendResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SummarizeHostInsightNetworkUsageTrendAggregationCollection instances
SummarizeHostInsightNetworkUsageTrendAggregationCollection `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 SummarizeHostInsightNetworkUsageTrendResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response SummarizeHostInsightNetworkUsageTrendResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// SummarizeHostInsightNetworkUsageTrendStatisticEnum Enum with underlying type: string
type SummarizeHostInsightNetworkUsageTrendStatisticEnum string
// Set of constants representing the allowable values for SummarizeHostInsightNetworkUsageTrendStatisticEnum
const (
SummarizeHostInsightNetworkUsageTrendStatisticAvg SummarizeHostInsightNetworkUsageTrendStatisticEnum = "AVG"
SummarizeHostInsightNetworkUsageTrendStatisticMax SummarizeHostInsightNetworkUsageTrendStatisticEnum = "MAX"
)
var mappingSummarizeHostInsightNetworkUsageTrendStatisticEnum = map[string]SummarizeHostInsightNetworkUsageTrendStatisticEnum{
"AVG": SummarizeHostInsightNetworkUsageTrendStatisticAvg,
"MAX": SummarizeHostInsightNetworkUsageTrendStatisticMax,
}
var mappingSummarizeHostInsightNetworkUsageTrendStatisticEnumLowerCase = map[string]SummarizeHostInsightNetworkUsageTrendStatisticEnum{
"avg": SummarizeHostInsightNetworkUsageTrendStatisticAvg,
"max": SummarizeHostInsightNetworkUsageTrendStatisticMax,
}
// GetSummarizeHostInsightNetworkUsageTrendStatisticEnumValues Enumerates the set of values for SummarizeHostInsightNetworkUsageTrendStatisticEnum
func GetSummarizeHostInsightNetworkUsageTrendStatisticEnumValues() []SummarizeHostInsightNetworkUsageTrendStatisticEnum {
values := make([]SummarizeHostInsightNetworkUsageTrendStatisticEnum, 0)
for _, v := range mappingSummarizeHostInsightNetworkUsageTrendStatisticEnum {
values = append(values, v)
}
return values
}
// GetSummarizeHostInsightNetworkUsageTrendStatisticEnumStringValues Enumerates the set of values in String for SummarizeHostInsightNetworkUsageTrendStatisticEnum
func GetSummarizeHostInsightNetworkUsageTrendStatisticEnumStringValues() []string {
return []string{
"AVG",
"MAX",
}
}
// GetMappingSummarizeHostInsightNetworkUsageTrendStatisticEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingSummarizeHostInsightNetworkUsageTrendStatisticEnum(val string) (SummarizeHostInsightNetworkUsageTrendStatisticEnum, bool) {
enum, ok := mappingSummarizeHostInsightNetworkUsageTrendStatisticEnumLowerCase[strings.ToLower(val)]
return enum, ok
}