-
Notifications
You must be signed in to change notification settings - Fork 80
/
list_announcements_request_response.go
341 lines (276 loc) · 15.3 KB
/
list_announcements_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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
// 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 announcementsservice
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListAnnouncementsRequest wrapper for the ListAnnouncements operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/ListAnnouncements.go.html to see an example of how to use ListAnnouncementsRequest.
type ListAnnouncementsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The type of announcement.
AnnouncementType *string `mandatory:"false" contributesTo:"query" name:"announcementType"`
// The announcement's current lifecycle state.
LifecycleState ListAnnouncementsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Whether the announcement is displayed as a console banner.
IsBanner *bool `mandatory:"false" contributesTo:"query" name:"isBanner"`
// The criteria to sort by. You can specify only one sort order.
SortBy ListAnnouncementsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use. (Sorting by `announcementType` orders the announcements list according to importance.)
SortOrder ListAnnouncementsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The boundary for the earliest `timeOneValue` date on announcements that you want to see.
TimeOneEarliestTime *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeOneEarliestTime"`
// The boundary for the latest `timeOneValue` date on announcements that you want to see.
TimeOneLatestTime *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeOneLatestTime"`
// A filter to return only announcements that match a specific environment name.
EnvironmentName *string `mandatory:"false" contributesTo:"query" name:"environmentName"`
// A filter to return only announcements affecting a specific service.
Service *string `mandatory:"false" contributesTo:"query" name:"service"`
// A filter to return only announcements affecting a specific platform.
PlatformType ListAnnouncementsPlatformTypeEnum `mandatory:"false" contributesTo:"query" name:"platformType" omitEmpty:"true"`
// Exclude The type of announcement.
ExcludeAnnouncementTypes []string `contributesTo:"query" name:"excludeAnnouncementTypes" collectionFormat:"multi"`
// A filter to display only the latest announcement in a chain.
ShouldShowOnlyLatestInChain *bool `mandatory:"false" contributesTo:"query" name:"shouldShowOnlyLatestInChain"`
// A filter to return only announcements belonging to the specified announcement chain ID.
ChainId *string `mandatory:"false" contributesTo:"query" name:"chainId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 ListAnnouncementsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListAnnouncementsRequest) 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 ListAnnouncementsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAnnouncementsRequest) 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 ListAnnouncementsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListAnnouncementsLifecycleStateEnum(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(GetListAnnouncementsLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListAnnouncementsSortByEnum(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(GetListAnnouncementsSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListAnnouncementsSortOrderEnum(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(GetListAnnouncementsSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListAnnouncementsPlatformTypeEnum(string(request.PlatformType)); !ok && request.PlatformType != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for PlatformType: %s. Supported values are: %s.", request.PlatformType, strings.Join(GetListAnnouncementsPlatformTypeEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListAnnouncementsResponse wrapper for the ListAnnouncements operation
type ListAnnouncementsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AnnouncementsCollection instances
AnnouncementsCollection `presentIn:"body"`
// 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"`
// For pagination of a list of items. Include this value as the `page` parameter for the
// subsequent GET request to get the previous batch of items.
OpcPreviousPage *string `presentIn:"header" name:"opc-previous-page"`
// 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"`
}
func (response ListAnnouncementsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListAnnouncementsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListAnnouncementsLifecycleStateEnum Enum with underlying type: string
type ListAnnouncementsLifecycleStateEnum string
// Set of constants representing the allowable values for ListAnnouncementsLifecycleStateEnum
const (
ListAnnouncementsLifecycleStateActive ListAnnouncementsLifecycleStateEnum = "ACTIVE"
ListAnnouncementsLifecycleStateInactive ListAnnouncementsLifecycleStateEnum = "INACTIVE"
)
var mappingListAnnouncementsLifecycleStateEnum = map[string]ListAnnouncementsLifecycleStateEnum{
"ACTIVE": ListAnnouncementsLifecycleStateActive,
"INACTIVE": ListAnnouncementsLifecycleStateInactive,
}
var mappingListAnnouncementsLifecycleStateEnumLowerCase = map[string]ListAnnouncementsLifecycleStateEnum{
"active": ListAnnouncementsLifecycleStateActive,
"inactive": ListAnnouncementsLifecycleStateInactive,
}
// GetListAnnouncementsLifecycleStateEnumValues Enumerates the set of values for ListAnnouncementsLifecycleStateEnum
func GetListAnnouncementsLifecycleStateEnumValues() []ListAnnouncementsLifecycleStateEnum {
values := make([]ListAnnouncementsLifecycleStateEnum, 0)
for _, v := range mappingListAnnouncementsLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetListAnnouncementsLifecycleStateEnumStringValues Enumerates the set of values in String for ListAnnouncementsLifecycleStateEnum
func GetListAnnouncementsLifecycleStateEnumStringValues() []string {
return []string{
"ACTIVE",
"INACTIVE",
}
}
// GetMappingListAnnouncementsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAnnouncementsLifecycleStateEnum(val string) (ListAnnouncementsLifecycleStateEnum, bool) {
enum, ok := mappingListAnnouncementsLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAnnouncementsSortByEnum Enum with underlying type: string
type ListAnnouncementsSortByEnum string
// Set of constants representing the allowable values for ListAnnouncementsSortByEnum
const (
ListAnnouncementsSortByTimeonevalue ListAnnouncementsSortByEnum = "timeOneValue"
ListAnnouncementsSortByTimetwovalue ListAnnouncementsSortByEnum = "timeTwoValue"
ListAnnouncementsSortByTimecreated ListAnnouncementsSortByEnum = "timeCreated"
ListAnnouncementsSortByReferenceticketnumber ListAnnouncementsSortByEnum = "referenceTicketNumber"
ListAnnouncementsSortBySummary ListAnnouncementsSortByEnum = "summary"
ListAnnouncementsSortByAnnouncementtype ListAnnouncementsSortByEnum = "announcementType"
)
var mappingListAnnouncementsSortByEnum = map[string]ListAnnouncementsSortByEnum{
"timeOneValue": ListAnnouncementsSortByTimeonevalue,
"timeTwoValue": ListAnnouncementsSortByTimetwovalue,
"timeCreated": ListAnnouncementsSortByTimecreated,
"referenceTicketNumber": ListAnnouncementsSortByReferenceticketnumber,
"summary": ListAnnouncementsSortBySummary,
"announcementType": ListAnnouncementsSortByAnnouncementtype,
}
var mappingListAnnouncementsSortByEnumLowerCase = map[string]ListAnnouncementsSortByEnum{
"timeonevalue": ListAnnouncementsSortByTimeonevalue,
"timetwovalue": ListAnnouncementsSortByTimetwovalue,
"timecreated": ListAnnouncementsSortByTimecreated,
"referenceticketnumber": ListAnnouncementsSortByReferenceticketnumber,
"summary": ListAnnouncementsSortBySummary,
"announcementtype": ListAnnouncementsSortByAnnouncementtype,
}
// GetListAnnouncementsSortByEnumValues Enumerates the set of values for ListAnnouncementsSortByEnum
func GetListAnnouncementsSortByEnumValues() []ListAnnouncementsSortByEnum {
values := make([]ListAnnouncementsSortByEnum, 0)
for _, v := range mappingListAnnouncementsSortByEnum {
values = append(values, v)
}
return values
}
// GetListAnnouncementsSortByEnumStringValues Enumerates the set of values in String for ListAnnouncementsSortByEnum
func GetListAnnouncementsSortByEnumStringValues() []string {
return []string{
"timeOneValue",
"timeTwoValue",
"timeCreated",
"referenceTicketNumber",
"summary",
"announcementType",
}
}
// GetMappingListAnnouncementsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAnnouncementsSortByEnum(val string) (ListAnnouncementsSortByEnum, bool) {
enum, ok := mappingListAnnouncementsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAnnouncementsSortOrderEnum Enum with underlying type: string
type ListAnnouncementsSortOrderEnum string
// Set of constants representing the allowable values for ListAnnouncementsSortOrderEnum
const (
ListAnnouncementsSortOrderAsc ListAnnouncementsSortOrderEnum = "ASC"
ListAnnouncementsSortOrderDesc ListAnnouncementsSortOrderEnum = "DESC"
)
var mappingListAnnouncementsSortOrderEnum = map[string]ListAnnouncementsSortOrderEnum{
"ASC": ListAnnouncementsSortOrderAsc,
"DESC": ListAnnouncementsSortOrderDesc,
}
var mappingListAnnouncementsSortOrderEnumLowerCase = map[string]ListAnnouncementsSortOrderEnum{
"asc": ListAnnouncementsSortOrderAsc,
"desc": ListAnnouncementsSortOrderDesc,
}
// GetListAnnouncementsSortOrderEnumValues Enumerates the set of values for ListAnnouncementsSortOrderEnum
func GetListAnnouncementsSortOrderEnumValues() []ListAnnouncementsSortOrderEnum {
values := make([]ListAnnouncementsSortOrderEnum, 0)
for _, v := range mappingListAnnouncementsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListAnnouncementsSortOrderEnumStringValues Enumerates the set of values in String for ListAnnouncementsSortOrderEnum
func GetListAnnouncementsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListAnnouncementsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAnnouncementsSortOrderEnum(val string) (ListAnnouncementsSortOrderEnum, bool) {
enum, ok := mappingListAnnouncementsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAnnouncementsPlatformTypeEnum Enum with underlying type: string
type ListAnnouncementsPlatformTypeEnum string
// Set of constants representing the allowable values for ListAnnouncementsPlatformTypeEnum
const (
ListAnnouncementsPlatformTypeIaas ListAnnouncementsPlatformTypeEnum = "IAAS"
ListAnnouncementsPlatformTypeSaas ListAnnouncementsPlatformTypeEnum = "SAAS"
)
var mappingListAnnouncementsPlatformTypeEnum = map[string]ListAnnouncementsPlatformTypeEnum{
"IAAS": ListAnnouncementsPlatformTypeIaas,
"SAAS": ListAnnouncementsPlatformTypeSaas,
}
var mappingListAnnouncementsPlatformTypeEnumLowerCase = map[string]ListAnnouncementsPlatformTypeEnum{
"iaas": ListAnnouncementsPlatformTypeIaas,
"saas": ListAnnouncementsPlatformTypeSaas,
}
// GetListAnnouncementsPlatformTypeEnumValues Enumerates the set of values for ListAnnouncementsPlatformTypeEnum
func GetListAnnouncementsPlatformTypeEnumValues() []ListAnnouncementsPlatformTypeEnum {
values := make([]ListAnnouncementsPlatformTypeEnum, 0)
for _, v := range mappingListAnnouncementsPlatformTypeEnum {
values = append(values, v)
}
return values
}
// GetListAnnouncementsPlatformTypeEnumStringValues Enumerates the set of values in String for ListAnnouncementsPlatformTypeEnum
func GetListAnnouncementsPlatformTypeEnumStringValues() []string {
return []string{
"IAAS",
"SAAS",
}
}
// GetMappingListAnnouncementsPlatformTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAnnouncementsPlatformTypeEnum(val string) (ListAnnouncementsPlatformTypeEnum, bool) {
enum, ok := mappingListAnnouncementsPlatformTypeEnumLowerCase[strings.ToLower(val)]
return enum, ok
}