/
list_scripts_request_response.go
218 lines (177 loc) · 8.64 KB
/
list_scripts_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
// 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 apmsynthetics
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListScriptsRequest wrapper for the ListScripts operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmsynthetics/ListScripts.go.html to see an example of how to use ListScriptsRequest.
type ListScriptsRequest struct {
// The APM domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// Unique 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"`
// A filter to return only the resources that match the entire display name.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the content type given.
ContentType *string `mandatory:"false" contributesTo:"query" name:"contentType"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The maximum number of results per page, or items to return in a paginated
// "List" call. For information on how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `50`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). Default sort order is ascending.
SortOrder ListScriptsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided.
// Default order of displayName and contentType is ascending.
// Default order of timeCreated and timeUpdated is descending.
// The displayName sort by is case insensitive.
SortBy ListScriptsSortByEnum `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 ListScriptsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListScriptsRequest) 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 ListScriptsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListScriptsRequest) 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 ListScriptsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListScriptsSortOrderEnum(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(GetListScriptsSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListScriptsSortByEnum(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(GetListScriptsSortByEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListScriptsResponse wrapper for the ListScripts operation
type ListScriptsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ScriptCollection instances
ScriptCollection `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 ListScriptsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListScriptsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListScriptsSortOrderEnum Enum with underlying type: string
type ListScriptsSortOrderEnum string
// Set of constants representing the allowable values for ListScriptsSortOrderEnum
const (
ListScriptsSortOrderAsc ListScriptsSortOrderEnum = "ASC"
ListScriptsSortOrderDesc ListScriptsSortOrderEnum = "DESC"
)
var mappingListScriptsSortOrderEnum = map[string]ListScriptsSortOrderEnum{
"ASC": ListScriptsSortOrderAsc,
"DESC": ListScriptsSortOrderDesc,
}
var mappingListScriptsSortOrderEnumLowerCase = map[string]ListScriptsSortOrderEnum{
"asc": ListScriptsSortOrderAsc,
"desc": ListScriptsSortOrderDesc,
}
// GetListScriptsSortOrderEnumValues Enumerates the set of values for ListScriptsSortOrderEnum
func GetListScriptsSortOrderEnumValues() []ListScriptsSortOrderEnum {
values := make([]ListScriptsSortOrderEnum, 0)
for _, v := range mappingListScriptsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListScriptsSortOrderEnumStringValues Enumerates the set of values in String for ListScriptsSortOrderEnum
func GetListScriptsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListScriptsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListScriptsSortOrderEnum(val string) (ListScriptsSortOrderEnum, bool) {
enum, ok := mappingListScriptsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListScriptsSortByEnum Enum with underlying type: string
type ListScriptsSortByEnum string
// Set of constants representing the allowable values for ListScriptsSortByEnum
const (
ListScriptsSortByDisplayname ListScriptsSortByEnum = "displayName"
ListScriptsSortByTimecreated ListScriptsSortByEnum = "timeCreated"
ListScriptsSortByTimeupdated ListScriptsSortByEnum = "timeUpdated"
ListScriptsSortByContenttype ListScriptsSortByEnum = "contentType"
)
var mappingListScriptsSortByEnum = map[string]ListScriptsSortByEnum{
"displayName": ListScriptsSortByDisplayname,
"timeCreated": ListScriptsSortByTimecreated,
"timeUpdated": ListScriptsSortByTimeupdated,
"contentType": ListScriptsSortByContenttype,
}
var mappingListScriptsSortByEnumLowerCase = map[string]ListScriptsSortByEnum{
"displayname": ListScriptsSortByDisplayname,
"timecreated": ListScriptsSortByTimecreated,
"timeupdated": ListScriptsSortByTimeupdated,
"contenttype": ListScriptsSortByContenttype,
}
// GetListScriptsSortByEnumValues Enumerates the set of values for ListScriptsSortByEnum
func GetListScriptsSortByEnumValues() []ListScriptsSortByEnum {
values := make([]ListScriptsSortByEnum, 0)
for _, v := range mappingListScriptsSortByEnum {
values = append(values, v)
}
return values
}
// GetListScriptsSortByEnumStringValues Enumerates the set of values in String for ListScriptsSortByEnum
func GetListScriptsSortByEnumStringValues() []string {
return []string{
"displayName",
"timeCreated",
"timeUpdated",
"contentType",
}
}
// GetMappingListScriptsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListScriptsSortByEnum(val string) (ListScriptsSortByEnum, bool) {
enum, ok := mappingListScriptsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}