-
Notifications
You must be signed in to change notification settings - Fork 80
/
list_indexes_request_response.go
190 lines (151 loc) · 7.31 KB
/
list_indexes_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
// Copyright (c) 2016, 2018, 2021, 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 nosql
import (
"github.com/oracle/oci-go-sdk/v43/common"
"net/http"
)
// ListIndexesRequest wrapper for the ListIndexes operation
//
// See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/nosql/ListIndexes.go.html to see an example of how to use ListIndexesRequest.
type ListIndexesRequest struct {
// A table name within the compartment, or a table OCID.
TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`
// The ID of a table's compartment. When a table is identified
// by name, the compartmentId is often needed to provide
// context for interpreting the name.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A shell-globbing-style (*?[]) filter for names.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// Filter list by the lifecycle state of the item.
LifecycleState ListIndexesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start
// retrieving results. This is usually retrieved from a previous
// list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListIndexesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be
// provided. Default order for timeCreated is descending. Default
// order for name is ascending. If no value is specified
// timeCreated is default.
SortBy ListIndexesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
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 ListIndexesRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListIndexesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser) (http.Request, error) {
return common.MakeDefaultHTTPRequestWithTaggedStruct(method, path, request)
}
// BinaryRequestBody implements the OCIRequest interface
func (request ListIndexesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListIndexesRequest) RetryPolicy() *common.RetryPolicy {
return request.RequestMetadata.RetryPolicy
}
// ListIndexesResponse wrapper for the ListIndexes operation
type ListIndexesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of IndexCollection instances
IndexCollection `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"`
// 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 ListIndexesResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListIndexesResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListIndexesLifecycleStateEnum Enum with underlying type: string
type ListIndexesLifecycleStateEnum string
// Set of constants representing the allowable values for ListIndexesLifecycleStateEnum
const (
ListIndexesLifecycleStateAll ListIndexesLifecycleStateEnum = "ALL"
ListIndexesLifecycleStateCreating ListIndexesLifecycleStateEnum = "CREATING"
ListIndexesLifecycleStateUpdating ListIndexesLifecycleStateEnum = "UPDATING"
ListIndexesLifecycleStateActive ListIndexesLifecycleStateEnum = "ACTIVE"
ListIndexesLifecycleStateDeleting ListIndexesLifecycleStateEnum = "DELETING"
ListIndexesLifecycleStateDeleted ListIndexesLifecycleStateEnum = "DELETED"
ListIndexesLifecycleStateFailed ListIndexesLifecycleStateEnum = "FAILED"
ListIndexesLifecycleStateInactive ListIndexesLifecycleStateEnum = "INACTIVE"
)
var mappingListIndexesLifecycleState = map[string]ListIndexesLifecycleStateEnum{
"ALL": ListIndexesLifecycleStateAll,
"CREATING": ListIndexesLifecycleStateCreating,
"UPDATING": ListIndexesLifecycleStateUpdating,
"ACTIVE": ListIndexesLifecycleStateActive,
"DELETING": ListIndexesLifecycleStateDeleting,
"DELETED": ListIndexesLifecycleStateDeleted,
"FAILED": ListIndexesLifecycleStateFailed,
"INACTIVE": ListIndexesLifecycleStateInactive,
}
// GetListIndexesLifecycleStateEnumValues Enumerates the set of values for ListIndexesLifecycleStateEnum
func GetListIndexesLifecycleStateEnumValues() []ListIndexesLifecycleStateEnum {
values := make([]ListIndexesLifecycleStateEnum, 0)
for _, v := range mappingListIndexesLifecycleState {
values = append(values, v)
}
return values
}
// ListIndexesSortOrderEnum Enum with underlying type: string
type ListIndexesSortOrderEnum string
// Set of constants representing the allowable values for ListIndexesSortOrderEnum
const (
ListIndexesSortOrderAsc ListIndexesSortOrderEnum = "ASC"
ListIndexesSortOrderDesc ListIndexesSortOrderEnum = "DESC"
)
var mappingListIndexesSortOrder = map[string]ListIndexesSortOrderEnum{
"ASC": ListIndexesSortOrderAsc,
"DESC": ListIndexesSortOrderDesc,
}
// GetListIndexesSortOrderEnumValues Enumerates the set of values for ListIndexesSortOrderEnum
func GetListIndexesSortOrderEnumValues() []ListIndexesSortOrderEnum {
values := make([]ListIndexesSortOrderEnum, 0)
for _, v := range mappingListIndexesSortOrder {
values = append(values, v)
}
return values
}
// ListIndexesSortByEnum Enum with underlying type: string
type ListIndexesSortByEnum string
// Set of constants representing the allowable values for ListIndexesSortByEnum
const (
ListIndexesSortByTimecreated ListIndexesSortByEnum = "timeCreated"
ListIndexesSortByName ListIndexesSortByEnum = "name"
)
var mappingListIndexesSortBy = map[string]ListIndexesSortByEnum{
"timeCreated": ListIndexesSortByTimecreated,
"name": ListIndexesSortByName,
}
// GetListIndexesSortByEnumValues Enumerates the set of values for ListIndexesSortByEnum
func GetListIndexesSortByEnumValues() []ListIndexesSortByEnum {
values := make([]ListIndexesSortByEnum, 0)
for _, v := range mappingListIndexesSortBy {
values = append(values, v)
}
return values
}