-
Notifications
You must be signed in to change notification settings - Fork 82
/
list_streams_request_response.go
214 lines (170 loc) · 9.07 KB
/
list_streams_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
// Copyright (c) 2016, 2018, 2023, 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 streaming
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListStreamsRequest wrapper for the ListStreams operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListStreams.go.html to see an example of how to use ListStreamsRequest.
type ListStreamsRequest struct {
// The OCID of the compartment. Is exclusive with the `streamPoolId` parameter. One of them is required.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The OCID of the stream pool. Is exclusive with the `compartmentId` parameter. One of them is required.
StreamPoolId *string `mandatory:"false" contributesTo:"query" name:"streamPoolId"`
// A filter to return only resources that match the given ID exactly.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only resources that match the given name exactly.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The maximum number of items to return. The value must be between 1 and 50. The default is 10.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.
SortBy ListStreamsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListStreamsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
LifecycleState StreamLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The 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 ListStreamsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListStreamsRequest) 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 ListStreamsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListStreamsRequest) 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 ListStreamsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListStreamsSortByEnum(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(GetListStreamsSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListStreamsSortOrderEnum(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(GetListStreamsSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingStreamLifecycleStateEnum(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(GetStreamLifecycleStateEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListStreamsResponse wrapper for the ListStreams operation
type ListStreamsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []StreamSummary instances
Items []StreamSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain. For important 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 list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-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 ListStreamsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListStreamsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListStreamsSortByEnum Enum with underlying type: string
type ListStreamsSortByEnum string
// Set of constants representing the allowable values for ListStreamsSortByEnum
const (
ListStreamsSortByName ListStreamsSortByEnum = "NAME"
ListStreamsSortByTimecreated ListStreamsSortByEnum = "TIMECREATED"
)
var mappingListStreamsSortByEnum = map[string]ListStreamsSortByEnum{
"NAME": ListStreamsSortByName,
"TIMECREATED": ListStreamsSortByTimecreated,
}
var mappingListStreamsSortByEnumLowerCase = map[string]ListStreamsSortByEnum{
"name": ListStreamsSortByName,
"timecreated": ListStreamsSortByTimecreated,
}
// GetListStreamsSortByEnumValues Enumerates the set of values for ListStreamsSortByEnum
func GetListStreamsSortByEnumValues() []ListStreamsSortByEnum {
values := make([]ListStreamsSortByEnum, 0)
for _, v := range mappingListStreamsSortByEnum {
values = append(values, v)
}
return values
}
// GetListStreamsSortByEnumStringValues Enumerates the set of values in String for ListStreamsSortByEnum
func GetListStreamsSortByEnumStringValues() []string {
return []string{
"NAME",
"TIMECREATED",
}
}
// GetMappingListStreamsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListStreamsSortByEnum(val string) (ListStreamsSortByEnum, bool) {
enum, ok := mappingListStreamsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListStreamsSortOrderEnum Enum with underlying type: string
type ListStreamsSortOrderEnum string
// Set of constants representing the allowable values for ListStreamsSortOrderEnum
const (
ListStreamsSortOrderAsc ListStreamsSortOrderEnum = "ASC"
ListStreamsSortOrderDesc ListStreamsSortOrderEnum = "DESC"
)
var mappingListStreamsSortOrderEnum = map[string]ListStreamsSortOrderEnum{
"ASC": ListStreamsSortOrderAsc,
"DESC": ListStreamsSortOrderDesc,
}
var mappingListStreamsSortOrderEnumLowerCase = map[string]ListStreamsSortOrderEnum{
"asc": ListStreamsSortOrderAsc,
"desc": ListStreamsSortOrderDesc,
}
// GetListStreamsSortOrderEnumValues Enumerates the set of values for ListStreamsSortOrderEnum
func GetListStreamsSortOrderEnumValues() []ListStreamsSortOrderEnum {
values := make([]ListStreamsSortOrderEnum, 0)
for _, v := range mappingListStreamsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListStreamsSortOrderEnumStringValues Enumerates the set of values in String for ListStreamsSortOrderEnum
func GetListStreamsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListStreamsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListStreamsSortOrderEnum(val string) (ListStreamsSortOrderEnum, bool) {
enum, ok := mappingListStreamsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}