/
list_finding_analytics_request_response.go
286 lines (234 loc) · 14.1 KB
/
list_finding_analytics_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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
// 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 datasafe
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListFindingAnalyticsRequest wrapper for the ListFindingAnalytics operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datasafe/ListFindingAnalytics.go.html to see an example of how to use ListFindingAnalyticsRequest.
type ListFindingAnalyticsRequest struct {
// A filter to return only resources that match the specified compartment OCID.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Default is false.
// When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.
CompartmentIdInSubtree *bool `mandatory:"false" contributesTo:"query" name:"compartmentIdInSubtree"`
// Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.
// Setting this to ACCESSIBLE returns only those compartments for which the
// user has INSPECT permissions directly or indirectly (permissions can be on a
// resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.
AccessLevel ListFindingAnalyticsAccessLevelEnum `mandatory:"false" contributesTo:"query" name:"accessLevel" omitEmpty:"true"`
// A filter to return only the findings that are marked as top findings.
IsTopFinding *bool `mandatory:"false" contributesTo:"query" name:"isTopFinding"`
// Attribute by which the finding analytics data should be grouped.
GroupBy ListFindingAnalyticsGroupByEnum `mandatory:"false" contributesTo:"query" name:"groupBy" omitEmpty:"true"`
// An optional filter to return only the top finding that match the specified status.
TopFindingStatus FindingAnalyticsDimensionsTopFindingStatusEnum `mandatory:"false" contributesTo:"query" name:"topFindingStatus" omitEmpty:"true"`
// A filter to return only findings of a particular risk level.
Severity ListFindingAnalyticsSeverityEnum `mandatory:"false" contributesTo:"query" name:"severity" omitEmpty:"true"`
// The unique key that identifies the finding. It is a string and unique within a security assessment.
FindingKey *string `mandatory:"false" contributesTo:"query" name:"findingKey"`
// Unique identifier for the request.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 ListFindingAnalyticsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListFindingAnalyticsRequest) 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 ListFindingAnalyticsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListFindingAnalyticsRequest) 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 ListFindingAnalyticsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListFindingAnalyticsAccessLevelEnum(string(request.AccessLevel)); !ok && request.AccessLevel != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for AccessLevel: %s. Supported values are: %s.", request.AccessLevel, strings.Join(GetListFindingAnalyticsAccessLevelEnumStringValues(), ",")))
}
if _, ok := GetMappingListFindingAnalyticsGroupByEnum(string(request.GroupBy)); !ok && request.GroupBy != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for GroupBy: %s. Supported values are: %s.", request.GroupBy, strings.Join(GetListFindingAnalyticsGroupByEnumStringValues(), ",")))
}
if _, ok := GetMappingFindingAnalyticsDimensionsTopFindingStatusEnum(string(request.TopFindingStatus)); !ok && request.TopFindingStatus != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for TopFindingStatus: %s. Supported values are: %s.", request.TopFindingStatus, strings.Join(GetFindingAnalyticsDimensionsTopFindingStatusEnumStringValues(), ",")))
}
if _, ok := GetMappingListFindingAnalyticsSeverityEnum(string(request.Severity)); !ok && request.Severity != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Severity: %s. Supported values are: %s.", request.Severity, strings.Join(GetListFindingAnalyticsSeverityEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListFindingAnalyticsResponse wrapper for the ListFindingAnalytics operation
type ListFindingAnalyticsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of FindingAnalyticsCollection instances
FindingAnalyticsCollection `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. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For 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"`
// 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 previous batch of items.
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListFindingAnalyticsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListFindingAnalyticsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListFindingAnalyticsAccessLevelEnum Enum with underlying type: string
type ListFindingAnalyticsAccessLevelEnum string
// Set of constants representing the allowable values for ListFindingAnalyticsAccessLevelEnum
const (
ListFindingAnalyticsAccessLevelRestricted ListFindingAnalyticsAccessLevelEnum = "RESTRICTED"
ListFindingAnalyticsAccessLevelAccessible ListFindingAnalyticsAccessLevelEnum = "ACCESSIBLE"
)
var mappingListFindingAnalyticsAccessLevelEnum = map[string]ListFindingAnalyticsAccessLevelEnum{
"RESTRICTED": ListFindingAnalyticsAccessLevelRestricted,
"ACCESSIBLE": ListFindingAnalyticsAccessLevelAccessible,
}
var mappingListFindingAnalyticsAccessLevelEnumLowerCase = map[string]ListFindingAnalyticsAccessLevelEnum{
"restricted": ListFindingAnalyticsAccessLevelRestricted,
"accessible": ListFindingAnalyticsAccessLevelAccessible,
}
// GetListFindingAnalyticsAccessLevelEnumValues Enumerates the set of values for ListFindingAnalyticsAccessLevelEnum
func GetListFindingAnalyticsAccessLevelEnumValues() []ListFindingAnalyticsAccessLevelEnum {
values := make([]ListFindingAnalyticsAccessLevelEnum, 0)
for _, v := range mappingListFindingAnalyticsAccessLevelEnum {
values = append(values, v)
}
return values
}
// GetListFindingAnalyticsAccessLevelEnumStringValues Enumerates the set of values in String for ListFindingAnalyticsAccessLevelEnum
func GetListFindingAnalyticsAccessLevelEnumStringValues() []string {
return []string{
"RESTRICTED",
"ACCESSIBLE",
}
}
// GetMappingListFindingAnalyticsAccessLevelEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListFindingAnalyticsAccessLevelEnum(val string) (ListFindingAnalyticsAccessLevelEnum, bool) {
enum, ok := mappingListFindingAnalyticsAccessLevelEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListFindingAnalyticsGroupByEnum Enum with underlying type: string
type ListFindingAnalyticsGroupByEnum string
// Set of constants representing the allowable values for ListFindingAnalyticsGroupByEnum
const (
ListFindingAnalyticsGroupByFindingkeyandtopfindingstatus ListFindingAnalyticsGroupByEnum = "findingKeyAndTopFindingStatus"
ListFindingAnalyticsGroupByFindingkeyandseverity ListFindingAnalyticsGroupByEnum = "findingKeyAndSeverity"
)
var mappingListFindingAnalyticsGroupByEnum = map[string]ListFindingAnalyticsGroupByEnum{
"findingKeyAndTopFindingStatus": ListFindingAnalyticsGroupByFindingkeyandtopfindingstatus,
"findingKeyAndSeverity": ListFindingAnalyticsGroupByFindingkeyandseverity,
}
var mappingListFindingAnalyticsGroupByEnumLowerCase = map[string]ListFindingAnalyticsGroupByEnum{
"findingkeyandtopfindingstatus": ListFindingAnalyticsGroupByFindingkeyandtopfindingstatus,
"findingkeyandseverity": ListFindingAnalyticsGroupByFindingkeyandseverity,
}
// GetListFindingAnalyticsGroupByEnumValues Enumerates the set of values for ListFindingAnalyticsGroupByEnum
func GetListFindingAnalyticsGroupByEnumValues() []ListFindingAnalyticsGroupByEnum {
values := make([]ListFindingAnalyticsGroupByEnum, 0)
for _, v := range mappingListFindingAnalyticsGroupByEnum {
values = append(values, v)
}
return values
}
// GetListFindingAnalyticsGroupByEnumStringValues Enumerates the set of values in String for ListFindingAnalyticsGroupByEnum
func GetListFindingAnalyticsGroupByEnumStringValues() []string {
return []string{
"findingKeyAndTopFindingStatus",
"findingKeyAndSeverity",
}
}
// GetMappingListFindingAnalyticsGroupByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListFindingAnalyticsGroupByEnum(val string) (ListFindingAnalyticsGroupByEnum, bool) {
enum, ok := mappingListFindingAnalyticsGroupByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListFindingAnalyticsSeverityEnum Enum with underlying type: string
type ListFindingAnalyticsSeverityEnum string
// Set of constants representing the allowable values for ListFindingAnalyticsSeverityEnum
const (
ListFindingAnalyticsSeverityHigh ListFindingAnalyticsSeverityEnum = "HIGH"
ListFindingAnalyticsSeverityMedium ListFindingAnalyticsSeverityEnum = "MEDIUM"
ListFindingAnalyticsSeverityLow ListFindingAnalyticsSeverityEnum = "LOW"
ListFindingAnalyticsSeverityEvaluate ListFindingAnalyticsSeverityEnum = "EVALUATE"
ListFindingAnalyticsSeverityAdvisory ListFindingAnalyticsSeverityEnum = "ADVISORY"
ListFindingAnalyticsSeverityPass ListFindingAnalyticsSeverityEnum = "PASS"
ListFindingAnalyticsSeverityDeferred ListFindingAnalyticsSeverityEnum = "DEFERRED"
)
var mappingListFindingAnalyticsSeverityEnum = map[string]ListFindingAnalyticsSeverityEnum{
"HIGH": ListFindingAnalyticsSeverityHigh,
"MEDIUM": ListFindingAnalyticsSeverityMedium,
"LOW": ListFindingAnalyticsSeverityLow,
"EVALUATE": ListFindingAnalyticsSeverityEvaluate,
"ADVISORY": ListFindingAnalyticsSeverityAdvisory,
"PASS": ListFindingAnalyticsSeverityPass,
"DEFERRED": ListFindingAnalyticsSeverityDeferred,
}
var mappingListFindingAnalyticsSeverityEnumLowerCase = map[string]ListFindingAnalyticsSeverityEnum{
"high": ListFindingAnalyticsSeverityHigh,
"medium": ListFindingAnalyticsSeverityMedium,
"low": ListFindingAnalyticsSeverityLow,
"evaluate": ListFindingAnalyticsSeverityEvaluate,
"advisory": ListFindingAnalyticsSeverityAdvisory,
"pass": ListFindingAnalyticsSeverityPass,
"deferred": ListFindingAnalyticsSeverityDeferred,
}
// GetListFindingAnalyticsSeverityEnumValues Enumerates the set of values for ListFindingAnalyticsSeverityEnum
func GetListFindingAnalyticsSeverityEnumValues() []ListFindingAnalyticsSeverityEnum {
values := make([]ListFindingAnalyticsSeverityEnum, 0)
for _, v := range mappingListFindingAnalyticsSeverityEnum {
values = append(values, v)
}
return values
}
// GetListFindingAnalyticsSeverityEnumStringValues Enumerates the set of values in String for ListFindingAnalyticsSeverityEnum
func GetListFindingAnalyticsSeverityEnumStringValues() []string {
return []string{
"HIGH",
"MEDIUM",
"LOW",
"EVALUATE",
"ADVISORY",
"PASS",
"DEFERRED",
}
}
// GetMappingListFindingAnalyticsSeverityEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListFindingAnalyticsSeverityEnum(val string) (ListFindingAnalyticsSeverityEnum, bool) {
enum, ok := mappingListFindingAnalyticsSeverityEnumLowerCase[strings.ToLower(val)]
return enum, ok
}