/
list_approval_templates_request_response.go
213 lines (171 loc) · 9.49 KB
/
list_approval_templates_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
// 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 lockbox
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListApprovalTemplatesRequest wrapper for the ListApprovalTemplates operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/lockbox/ListApprovalTemplates.go.html to see an example of how to use ListApprovalTemplatesRequest.
type ListApprovalTemplatesRequest struct {
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A generic Id query param used to filter lockbox, access request and approval template by Id.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources for which their lifecycleState matches the given lifecycleState.
LifecycleState ApprovalTemplateLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" 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 sort order to use, either 'ASC' or 'DESC'.
SortOrder ListApprovalTemplatesSortOrderEnum `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 displayName is ascending.
SortBy ListApprovalTemplatesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListApprovalTemplatesRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListApprovalTemplatesRequest) 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 ListApprovalTemplatesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListApprovalTemplatesRequest) 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 ListApprovalTemplatesRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingApprovalTemplateLifecycleStateEnum(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(GetApprovalTemplateLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingListApprovalTemplatesSortOrderEnum(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(GetListApprovalTemplatesSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListApprovalTemplatesSortByEnum(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(GetListApprovalTemplatesSortByEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListApprovalTemplatesResponse wrapper for the ListApprovalTemplates operation
type ListApprovalTemplatesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ApprovalTemplateCollection instances
ApprovalTemplateCollection `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 ListApprovalTemplatesResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListApprovalTemplatesResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListApprovalTemplatesSortOrderEnum Enum with underlying type: string
type ListApprovalTemplatesSortOrderEnum string
// Set of constants representing the allowable values for ListApprovalTemplatesSortOrderEnum
const (
ListApprovalTemplatesSortOrderAsc ListApprovalTemplatesSortOrderEnum = "ASC"
ListApprovalTemplatesSortOrderDesc ListApprovalTemplatesSortOrderEnum = "DESC"
)
var mappingListApprovalTemplatesSortOrderEnum = map[string]ListApprovalTemplatesSortOrderEnum{
"ASC": ListApprovalTemplatesSortOrderAsc,
"DESC": ListApprovalTemplatesSortOrderDesc,
}
var mappingListApprovalTemplatesSortOrderEnumLowerCase = map[string]ListApprovalTemplatesSortOrderEnum{
"asc": ListApprovalTemplatesSortOrderAsc,
"desc": ListApprovalTemplatesSortOrderDesc,
}
// GetListApprovalTemplatesSortOrderEnumValues Enumerates the set of values for ListApprovalTemplatesSortOrderEnum
func GetListApprovalTemplatesSortOrderEnumValues() []ListApprovalTemplatesSortOrderEnum {
values := make([]ListApprovalTemplatesSortOrderEnum, 0)
for _, v := range mappingListApprovalTemplatesSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListApprovalTemplatesSortOrderEnumStringValues Enumerates the set of values in String for ListApprovalTemplatesSortOrderEnum
func GetListApprovalTemplatesSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListApprovalTemplatesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListApprovalTemplatesSortOrderEnum(val string) (ListApprovalTemplatesSortOrderEnum, bool) {
enum, ok := mappingListApprovalTemplatesSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListApprovalTemplatesSortByEnum Enum with underlying type: string
type ListApprovalTemplatesSortByEnum string
// Set of constants representing the allowable values for ListApprovalTemplatesSortByEnum
const (
ListApprovalTemplatesSortByTimecreated ListApprovalTemplatesSortByEnum = "timeCreated"
ListApprovalTemplatesSortByDisplayname ListApprovalTemplatesSortByEnum = "displayName"
ListApprovalTemplatesSortById ListApprovalTemplatesSortByEnum = "id"
)
var mappingListApprovalTemplatesSortByEnum = map[string]ListApprovalTemplatesSortByEnum{
"timeCreated": ListApprovalTemplatesSortByTimecreated,
"displayName": ListApprovalTemplatesSortByDisplayname,
"id": ListApprovalTemplatesSortById,
}
var mappingListApprovalTemplatesSortByEnumLowerCase = map[string]ListApprovalTemplatesSortByEnum{
"timecreated": ListApprovalTemplatesSortByTimecreated,
"displayname": ListApprovalTemplatesSortByDisplayname,
"id": ListApprovalTemplatesSortById,
}
// GetListApprovalTemplatesSortByEnumValues Enumerates the set of values for ListApprovalTemplatesSortByEnum
func GetListApprovalTemplatesSortByEnumValues() []ListApprovalTemplatesSortByEnum {
values := make([]ListApprovalTemplatesSortByEnum, 0)
for _, v := range mappingListApprovalTemplatesSortByEnum {
values = append(values, v)
}
return values
}
// GetListApprovalTemplatesSortByEnumStringValues Enumerates the set of values in String for ListApprovalTemplatesSortByEnum
func GetListApprovalTemplatesSortByEnumStringValues() []string {
return []string{
"timeCreated",
"displayName",
"id",
}
}
// GetMappingListApprovalTemplatesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListApprovalTemplatesSortByEnum(val string) (ListApprovalTemplatesSortByEnum, bool) {
enum, ok := mappingListApprovalTemplatesSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}