-
Notifications
You must be signed in to change notification settings - Fork 80
/
list_paths_request_response.go
211 lines (168 loc) · 8.59 KB
/
list_paths_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
// 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 devops
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListPathsRequest wrapper for the ListPaths operation
//
// See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/devops/ListPaths.go.html to see an example of how to use ListPathsRequest.
type ListPathsRequest struct {
// Unique repository identifier.
RepositoryId *string `mandatory:"true" contributesTo:"path" name:"repositoryId"`
// The name of branch/tag or commit hash it points to. If names conflict, order of preference is commit > branch > tag.
// You can disambiguate with "heads/foobar" and "tags/foobar". If left blank repository's default branch will be used.
Ref *string `mandatory:"false" contributesTo:"query" name:"ref"`
// Flag to determine if files must be retrived recursively. Flag is False by default.
PathsInSubtree *bool `mandatory:"false" contributesTo:"query" name:"pathsInSubtree"`
// The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.
FolderPath *string `mandatory:"false" contributesTo:"query" name:"folderPath"`
// 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"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The sort order to use. Use either ascending or descending.
SortOrder ListPathsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order is ascending. If no value is specified name is default.
SortBy ListPathsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, 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 ListPathsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListPathsRequest) 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 ListPathsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPathsRequest) 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 ListPathsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListPathsSortOrderEnum(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(GetListPathsSortOrderEnumStringValues(), ",")))
}
if _, ok := GetMappingListPathsSortByEnum(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(GetListPathsSortByEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListPathsResponse wrapper for the ListPaths operation
type ListPathsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of RepositoryPathCollection instances
RepositoryPathCollection `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, 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 ListPathsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListPathsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListPathsSortOrderEnum Enum with underlying type: string
type ListPathsSortOrderEnum string
// Set of constants representing the allowable values for ListPathsSortOrderEnum
const (
ListPathsSortOrderAsc ListPathsSortOrderEnum = "ASC"
ListPathsSortOrderDesc ListPathsSortOrderEnum = "DESC"
)
var mappingListPathsSortOrderEnum = map[string]ListPathsSortOrderEnum{
"ASC": ListPathsSortOrderAsc,
"DESC": ListPathsSortOrderDesc,
}
var mappingListPathsSortOrderEnumLowerCase = map[string]ListPathsSortOrderEnum{
"asc": ListPathsSortOrderAsc,
"desc": ListPathsSortOrderDesc,
}
// GetListPathsSortOrderEnumValues Enumerates the set of values for ListPathsSortOrderEnum
func GetListPathsSortOrderEnumValues() []ListPathsSortOrderEnum {
values := make([]ListPathsSortOrderEnum, 0)
for _, v := range mappingListPathsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListPathsSortOrderEnumStringValues Enumerates the set of values in String for ListPathsSortOrderEnum
func GetListPathsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListPathsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListPathsSortOrderEnum(val string) (ListPathsSortOrderEnum, bool) {
enum, ok := mappingListPathsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListPathsSortByEnum Enum with underlying type: string
type ListPathsSortByEnum string
// Set of constants representing the allowable values for ListPathsSortByEnum
const (
ListPathsSortByType ListPathsSortByEnum = "type"
ListPathsSortBySizeinbytes ListPathsSortByEnum = "sizeInBytes"
ListPathsSortByName ListPathsSortByEnum = "name"
)
var mappingListPathsSortByEnum = map[string]ListPathsSortByEnum{
"type": ListPathsSortByType,
"sizeInBytes": ListPathsSortBySizeinbytes,
"name": ListPathsSortByName,
}
var mappingListPathsSortByEnumLowerCase = map[string]ListPathsSortByEnum{
"type": ListPathsSortByType,
"sizeinbytes": ListPathsSortBySizeinbytes,
"name": ListPathsSortByName,
}
// GetListPathsSortByEnumValues Enumerates the set of values for ListPathsSortByEnum
func GetListPathsSortByEnumValues() []ListPathsSortByEnum {
values := make([]ListPathsSortByEnum, 0)
for _, v := range mappingListPathsSortByEnum {
values = append(values, v)
}
return values
}
// GetListPathsSortByEnumStringValues Enumerates the set of values in String for ListPathsSortByEnum
func GetListPathsSortByEnumStringValues() []string {
return []string{
"type",
"sizeInBytes",
"name",
}
}
// GetMappingListPathsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListPathsSortByEnum(val string) (ListPathsSortByEnum, bool) {
enum, ok := mappingListPathsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}