-
Notifications
You must be signed in to change notification settings - Fork 80
/
list_accepted_agreements_request_response.go
208 lines (165 loc) · 9.04 KB
/
list_accepted_agreements_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
// 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 marketplace
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListAcceptedAgreementsRequest wrapper for the ListAcceptedAgreements operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/marketplace/ListAcceptedAgreements.go.html to see an example of how to use ListAcceptedAgreementsRequest.
type ListAcceptedAgreementsRequest struct {
// The unique identifier for the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The display name of the resource.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The unique identifier for the listing.
ListingId *string `mandatory:"false" contributesTo:"query" name:"listingId"`
// The version of the package. Package versions are unique within a listing.
PackageVersion *string `mandatory:"false" contributesTo:"query" name:"packageVersion"`
// The unique identifier for the accepted terms of use agreement.
AcceptedAgreementId *string `mandatory:"false" contributesTo:"query" name:"acceptedAgreementId"`
// Unique Oracle-assigned 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"`
// The field to use to sort listed results. You can only specify one field to sort by.
// `TIMEACCEPTED` displays results in descending order by default. You can change your
// preference by specifying a different sort order.
SortBy ListAcceptedAgreementsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either `ASC` or `DESC`.
SortOrder ListAcceptedAgreementsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 ListAcceptedAgreementsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListAcceptedAgreementsRequest) 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 ListAcceptedAgreementsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAcceptedAgreementsRequest) 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 ListAcceptedAgreementsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListAcceptedAgreementsSortByEnum(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(GetListAcceptedAgreementsSortByEnumStringValues(), ",")))
}
if _, ok := GetMappingListAcceptedAgreementsSortOrderEnum(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(GetListAcceptedAgreementsSortOrderEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListAcceptedAgreementsResponse wrapper for the ListAcceptedAgreements operation
type ListAcceptedAgreementsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []AcceptedAgreementSummary instances
Items []AcceptedAgreementSummary `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 ListAcceptedAgreementsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListAcceptedAgreementsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListAcceptedAgreementsSortByEnum Enum with underlying type: string
type ListAcceptedAgreementsSortByEnum string
// Set of constants representing the allowable values for ListAcceptedAgreementsSortByEnum
const (
ListAcceptedAgreementsSortByTimeaccepted ListAcceptedAgreementsSortByEnum = "TIMEACCEPTED"
)
var mappingListAcceptedAgreementsSortByEnum = map[string]ListAcceptedAgreementsSortByEnum{
"TIMEACCEPTED": ListAcceptedAgreementsSortByTimeaccepted,
}
var mappingListAcceptedAgreementsSortByEnumLowerCase = map[string]ListAcceptedAgreementsSortByEnum{
"timeaccepted": ListAcceptedAgreementsSortByTimeaccepted,
}
// GetListAcceptedAgreementsSortByEnumValues Enumerates the set of values for ListAcceptedAgreementsSortByEnum
func GetListAcceptedAgreementsSortByEnumValues() []ListAcceptedAgreementsSortByEnum {
values := make([]ListAcceptedAgreementsSortByEnum, 0)
for _, v := range mappingListAcceptedAgreementsSortByEnum {
values = append(values, v)
}
return values
}
// GetListAcceptedAgreementsSortByEnumStringValues Enumerates the set of values in String for ListAcceptedAgreementsSortByEnum
func GetListAcceptedAgreementsSortByEnumStringValues() []string {
return []string{
"TIMEACCEPTED",
}
}
// GetMappingListAcceptedAgreementsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAcceptedAgreementsSortByEnum(val string) (ListAcceptedAgreementsSortByEnum, bool) {
enum, ok := mappingListAcceptedAgreementsSortByEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// ListAcceptedAgreementsSortOrderEnum Enum with underlying type: string
type ListAcceptedAgreementsSortOrderEnum string
// Set of constants representing the allowable values for ListAcceptedAgreementsSortOrderEnum
const (
ListAcceptedAgreementsSortOrderAsc ListAcceptedAgreementsSortOrderEnum = "ASC"
ListAcceptedAgreementsSortOrderDesc ListAcceptedAgreementsSortOrderEnum = "DESC"
)
var mappingListAcceptedAgreementsSortOrderEnum = map[string]ListAcceptedAgreementsSortOrderEnum{
"ASC": ListAcceptedAgreementsSortOrderAsc,
"DESC": ListAcceptedAgreementsSortOrderDesc,
}
var mappingListAcceptedAgreementsSortOrderEnumLowerCase = map[string]ListAcceptedAgreementsSortOrderEnum{
"asc": ListAcceptedAgreementsSortOrderAsc,
"desc": ListAcceptedAgreementsSortOrderDesc,
}
// GetListAcceptedAgreementsSortOrderEnumValues Enumerates the set of values for ListAcceptedAgreementsSortOrderEnum
func GetListAcceptedAgreementsSortOrderEnumValues() []ListAcceptedAgreementsSortOrderEnum {
values := make([]ListAcceptedAgreementsSortOrderEnum, 0)
for _, v := range mappingListAcceptedAgreementsSortOrderEnum {
values = append(values, v)
}
return values
}
// GetListAcceptedAgreementsSortOrderEnumStringValues Enumerates the set of values in String for ListAcceptedAgreementsSortOrderEnum
func GetListAcceptedAgreementsSortOrderEnumStringValues() []string {
return []string{
"ASC",
"DESC",
}
}
// GetMappingListAcceptedAgreementsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListAcceptedAgreementsSortOrderEnum(val string) (ListAcceptedAgreementsSortOrderEnum, bool) {
enum, ok := mappingListAcceptedAgreementsSortOrderEnumLowerCase[strings.ToLower(val)]
return enum, ok
}