-
Notifications
You must be signed in to change notification settings - Fork 82
/
list_vulnerability_audits_request_response.go
227 lines (183 loc) · 10.7 KB
/
list_vulnerability_audits_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
// Copyright (c) 2016, 2018, 2022, 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 adm
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListVulnerabilityAuditsRequest wrapper for the ListVulnerabilityAudits operation
//
// See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/adm/ListVulnerabilityAudits.go.html to see an example of how to use ListVulnerabilityAuditsRequest.
type ListVulnerabilityAuditsRequest struct {
// A filter to return only resources that match the specified identifier.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only resources that belong to the specified compartment identifier.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return only Vulnerability Audits that were created against the specified knowledge base.
KnowledgeBaseId *string `mandatory:"false" contributesTo:"query" name:"knowledgeBaseId"`
// A filter to return only successful or failed Vulnerability Audits.
IsSuccess *bool `mandatory:"false" contributesTo:"query" name:"isSuccess"`
// A filter to return only Vulnerability Audits that match the specified lifecycleState.
LifecycleState VulnerabilityAuditLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListVulnerabilityAuditsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The field used to sort Vulnerability Audits. Only one sort order is allowed.
// Default order for _maxObservedCvssV2Score_ is **ascending**.
// Default order for _maxObservedCvssV3Score_ is **ascending**.
// Default order for _timeCreated_ is **descending**.
// Default order for _vulnerableArtifactsCount_ is **ascending**.
SortBy ListVulnerabilityAuditsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// 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 ListVulnerabilityAuditsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListVulnerabilityAuditsRequest) 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 ListVulnerabilityAuditsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVulnerabilityAuditsRequest) 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 ListVulnerabilityAuditsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingVulnerabilityAuditLifecycleStateEnum(string(request.LifecycleState)); !ok && request.LifecycleState != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleState: %s. Supported values are: %s.", request.LifecycleState, strings.Join(GetVulnerabilityAuditLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListVulnerabilityAuditsSortOrderEnum(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(GetListVulnerabilityAuditsSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListVulnerabilityAuditsSortByEnum(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(GetListVulnerabilityAuditsSortByEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListVulnerabilityAuditsResponse wrapper for the ListVulnerabilityAudits operation
type ListVulnerabilityAuditsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of VulnerabilityAuditCollection instances
VulnerabilityAuditCollection `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 ListVulnerabilityAuditsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListVulnerabilityAuditsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListVulnerabilityAuditsSortOrderEnum Enum with underlying type: string
type ListVulnerabilityAuditsSortOrderEnum string
// Set of constants representing the allowable values for ListVulnerabilityAuditsSortOrderEnum
const (
ListVulnerabilityAuditsSortOrderAsc ListVulnerabilityAuditsSortOrderEnum = "ASC"
ListVulnerabilityAuditsSortOrderDesc ListVulnerabilityAuditsSortOrderEnum = "DESC"
)
var mappingListVulnerabilityAuditsSortOrderEnum = map[string]ListVulnerabilityAuditsSortOrderEnum{
"ASC": ListVulnerabilityAuditsSortOrderAsc,
"DESC": ListVulnerabilityAuditsSortOrderDesc,
}
var mappingListVulnerabilityAuditsSortOrderEnumLowerCase = map[string]ListVulnerabilityAuditsSortOrderEnum{
"asc": ListVulnerabilityAuditsSortOrderAsc,
"desc": ListVulnerabilityAuditsSortOrderDesc,
}
// GetListVulnerabilityAuditsSortOrderEnumValues Enumerates the set of values for ListVulnerabilityAuditsSortOrderEnum
func GetListVulnerabilityAuditsSortOrderEnumValues() []ListVulnerabilityAuditsSortOrderEnum {
values := make([]ListVulnerabilityAuditsSortOrderEnum, 0)
for _, v := range mappingListVulnerabilityAuditsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListVulnerabilityAuditsSortOrderEnumStringValues Enumerates the set of values in String for ListVulnerabilityAuditsSortOrderEnum
func GetListVulnerabilityAuditsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListVulnerabilityAuditsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListVulnerabilityAuditsSortOrderEnum(val string) (ListVulnerabilityAuditsSortOrderEnum, bool) {
enum, ok := mappingListVulnerabilityAuditsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListVulnerabilityAuditsSortByEnum Enum with underlying type: string
type ListVulnerabilityAuditsSortByEnum string
// Set of constants representing the allowable values for ListVulnerabilityAuditsSortByEnum
const (
ListVulnerabilityAuditsSortByMaxobservedcvssv2score ListVulnerabilityAuditsSortByEnum = "maxObservedCvssV2Score"
ListVulnerabilityAuditsSortByMaxobservedcvssv3score ListVulnerabilityAuditsSortByEnum = "maxObservedCvssV3Score"
ListVulnerabilityAuditsSortByTimecreated ListVulnerabilityAuditsSortByEnum = "timeCreated"
ListVulnerabilityAuditsSortByVulnerableartifactscount ListVulnerabilityAuditsSortByEnum = "vulnerableArtifactsCount"
)
var mappingListVulnerabilityAuditsSortByEnum = map[string]ListVulnerabilityAuditsSortByEnum{
"maxObservedCvssV2Score": ListVulnerabilityAuditsSortByMaxobservedcvssv2score,
"maxObservedCvssV3Score": ListVulnerabilityAuditsSortByMaxobservedcvssv3score,
"timeCreated": ListVulnerabilityAuditsSortByTimecreated,
"vulnerableArtifactsCount": ListVulnerabilityAuditsSortByVulnerableartifactscount,
}
var mappingListVulnerabilityAuditsSortByEnumLowerCase = map[string]ListVulnerabilityAuditsSortByEnum{
"maxobservedcvssv2score": ListVulnerabilityAuditsSortByMaxobservedcvssv2score,
"maxobservedcvssv3score": ListVulnerabilityAuditsSortByMaxobservedcvssv3score,
"timecreated": ListVulnerabilityAuditsSortByTimecreated,
"vulnerableartifactscount": ListVulnerabilityAuditsSortByVulnerableartifactscount,
}
// GetListVulnerabilityAuditsSortByEnumValues Enumerates the set of values for ListVulnerabilityAuditsSortByEnum
func GetListVulnerabilityAuditsSortByEnumValues() []ListVulnerabilityAuditsSortByEnum {
values := make([]ListVulnerabilityAuditsSortByEnum, 0)
for _, v := range mappingListVulnerabilityAuditsSortByEnum {
values = append(values, v)
}
return values
}
// GetListVulnerabilityAuditsSortByEnumStringValues Enumerates the set of values in String for ListVulnerabilityAuditsSortByEnum
func GetListVulnerabilityAuditsSortByEnumStringValues() []string {
return []string{
"maxObservedCvssV2Score",
"maxObservedCvssV3Score",
"timeCreated",
"vulnerableArtifactsCount",
}
}
// GetMappingListVulnerabilityAuditsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListVulnerabilityAuditsSortByEnum(val string) (ListVulnerabilityAuditsSortByEnum, bool) {
enum, ok := mappingListVulnerabilityAuditsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}