/
list_columns_request_response.go
228 lines (181 loc) · 9.76 KB
/
list_columns_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
// 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"
)
// ListColumnsRequest wrapper for the ListColumns operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datasafe/ListColumns.go.html to see an example of how to use ListColumnsRequest.
type ListColumnsRequest struct {
// The OCID of the Data Safe target database.
TargetDatabaseId *string `mandatory:"true" contributesTo:"path" name:"targetDatabaseId"`
// 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"`
// A filter to return only items related to specific schema name.
SchemaName []string `contributesTo:"query" name:"schemaName" collectionFormat:"multi"`
// A filter to return only items related to specific table name.
TableName []string `contributesTo:"query" name:"tableName" collectionFormat:"multi"`
// A filter to return only a specific column based on column name.
ColumnName []string `contributesTo:"query" name:"columnName" collectionFormat:"multi"`
// A filter to return only items related to specific datatype.
Datatype []string `contributesTo:"query" name:"datatype" collectionFormat:"multi"`
// The sort order to use, either ascending (ASC) or descending (DESC).
SortOrder ListColumnsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field used for sorting. Only one sorting order (sortOrder) can be specified.
SortBy ListColumnsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A filter to return only items if schema name contains a specific string.
SchemaNameContains *string `mandatory:"false" contributesTo:"query" name:"schemaNameContains"`
// A filter to return only items if table name contains a specific string.
TableNameContains *string `mandatory:"false" contributesTo:"query" name:"tableNameContains"`
// A filter to return only items if column name contains a specific string.
ColumnNameContains *string `mandatory:"false" contributesTo:"query" name:"columnNameContains"`
// 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 ListColumnsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListColumnsRequest) 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 ListColumnsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListColumnsRequest) 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 ListColumnsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListColumnsSortOrderEnum(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(GetListColumnsSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListColumnsSortByEnum(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(GetListColumnsSortByEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListColumnsResponse wrapper for the ListColumns operation
type ListColumnsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ColumnSummary instances
Items []ColumnSummary `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 ListColumnsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListColumnsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListColumnsSortOrderEnum Enum with underlying type: string
type ListColumnsSortOrderEnum string
// Set of constants representing the allowable values for ListColumnsSortOrderEnum
const (
ListColumnsSortOrderAsc ListColumnsSortOrderEnum = "ASC"
ListColumnsSortOrderDesc ListColumnsSortOrderEnum = "DESC"
)
var mappingListColumnsSortOrderEnum = map[string]ListColumnsSortOrderEnum{
"ASC": ListColumnsSortOrderAsc,
"DESC": ListColumnsSortOrderDesc,
}
var mappingListColumnsSortOrderEnumLowerCase = map[string]ListColumnsSortOrderEnum{
"asc": ListColumnsSortOrderAsc,
"desc": ListColumnsSortOrderDesc,
}
// GetListColumnsSortOrderEnumValues Enumerates the set of values for ListColumnsSortOrderEnum
func GetListColumnsSortOrderEnumValues() []ListColumnsSortOrderEnum {
values := make([]ListColumnsSortOrderEnum, 0)
for _, v := range mappingListColumnsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListColumnsSortOrderEnumStringValues Enumerates the set of values in String for ListColumnsSortOrderEnum
func GetListColumnsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListColumnsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListColumnsSortOrderEnum(val string) (ListColumnsSortOrderEnum, bool) {
enum, ok := mappingListColumnsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListColumnsSortByEnum Enum with underlying type: string
type ListColumnsSortByEnum string
// Set of constants representing the allowable values for ListColumnsSortByEnum
const (
ListColumnsSortBySchemaname ListColumnsSortByEnum = "SCHEMANAME"
ListColumnsSortByTablename ListColumnsSortByEnum = "TABLENAME"
ListColumnsSortByColumnname ListColumnsSortByEnum = "COLUMNNAME"
ListColumnsSortByDatatype ListColumnsSortByEnum = "DATATYPE"
)
var mappingListColumnsSortByEnum = map[string]ListColumnsSortByEnum{
"SCHEMANAME": ListColumnsSortBySchemaname,
"TABLENAME": ListColumnsSortByTablename,
"COLUMNNAME": ListColumnsSortByColumnname,
"DATATYPE": ListColumnsSortByDatatype,
}
var mappingListColumnsSortByEnumLowerCase = map[string]ListColumnsSortByEnum{
"schemaname": ListColumnsSortBySchemaname,
"tablename": ListColumnsSortByTablename,
"columnname": ListColumnsSortByColumnname,
"datatype": ListColumnsSortByDatatype,
}
// GetListColumnsSortByEnumValues Enumerates the set of values for ListColumnsSortByEnum
func GetListColumnsSortByEnumValues() []ListColumnsSortByEnum {
values := make([]ListColumnsSortByEnum, 0)
for _, v := range mappingListColumnsSortByEnum {
values = append(values, v)
}
return values
}
// GetListColumnsSortByEnumStringValues Enumerates the set of values in String for ListColumnsSortByEnum
func GetListColumnsSortByEnumStringValues() []string {
return []string{
"SCHEMANAME",
"TABLENAME",
"COLUMNNAME",
"DATATYPE",
}
}
// GetMappingListColumnsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListColumnsSortByEnum(val string) (ListColumnsSortByEnum, bool) {
enum, ok := mappingListColumnsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}