/
list_transfer_packages_request_response.go
168 lines (139 loc) · 7.52 KB
/
list_transfer_packages_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
// 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 dts
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListTransferPackagesRequest wrapper for the ListTransferPackages operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dts/ListTransferPackages.go.html to see an example of how to use ListTransferPackagesRequest.
type ListTransferPackagesRequest struct {
// ID of the Transfer Job
Id *string `mandatory:"true" contributesTo:"path" name:"id"`
// filtering by lifecycleState
LifecycleState ListTransferPackagesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// filtering by displayName
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// 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"`
// 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 ListTransferPackagesRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListTransferPackagesRequest) 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 ListTransferPackagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTransferPackagesRequest) 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 ListTransferPackagesRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingListTransferPackagesLifecycleStateEnum(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(GetListTransferPackagesLifecycleStateEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListTransferPackagesResponse wrapper for the ListTransferPackages operation
type ListTransferPackagesResponse struct {
// The underlying http response
RawResponse *http.Response
// The MultipleTransferPackages instance
MultipleTransferPackages `presentIn:"body"`
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListTransferPackagesResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListTransferPackagesResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListTransferPackagesLifecycleStateEnum Enum with underlying type: string
type ListTransferPackagesLifecycleStateEnum string
// Set of constants representing the allowable values for ListTransferPackagesLifecycleStateEnum
const (
ListTransferPackagesLifecycleStatePreparing ListTransferPackagesLifecycleStateEnum = "PREPARING"
ListTransferPackagesLifecycleStateShipping ListTransferPackagesLifecycleStateEnum = "SHIPPING"
ListTransferPackagesLifecycleStateReceived ListTransferPackagesLifecycleStateEnum = "RECEIVED"
ListTransferPackagesLifecycleStateProcessing ListTransferPackagesLifecycleStateEnum = "PROCESSING"
ListTransferPackagesLifecycleStateProcessed ListTransferPackagesLifecycleStateEnum = "PROCESSED"
ListTransferPackagesLifecycleStateReturned ListTransferPackagesLifecycleStateEnum = "RETURNED"
ListTransferPackagesLifecycleStateDeleted ListTransferPackagesLifecycleStateEnum = "DELETED"
ListTransferPackagesLifecycleStateCancelled ListTransferPackagesLifecycleStateEnum = "CANCELLED"
ListTransferPackagesLifecycleStateCancelledReturned ListTransferPackagesLifecycleStateEnum = "CANCELLED_RETURNED"
)
var mappingListTransferPackagesLifecycleStateEnum = map[string]ListTransferPackagesLifecycleStateEnum{
"PREPARING": ListTransferPackagesLifecycleStatePreparing,
"SHIPPING": ListTransferPackagesLifecycleStateShipping,
"RECEIVED": ListTransferPackagesLifecycleStateReceived,
"PROCESSING": ListTransferPackagesLifecycleStateProcessing,
"PROCESSED": ListTransferPackagesLifecycleStateProcessed,
"RETURNED": ListTransferPackagesLifecycleStateReturned,
"DELETED": ListTransferPackagesLifecycleStateDeleted,
"CANCELLED": ListTransferPackagesLifecycleStateCancelled,
"CANCELLED_RETURNED": ListTransferPackagesLifecycleStateCancelledReturned,
}
var mappingListTransferPackagesLifecycleStateEnumLowerCase = map[string]ListTransferPackagesLifecycleStateEnum{
"preparing": ListTransferPackagesLifecycleStatePreparing,
"shipping": ListTransferPackagesLifecycleStateShipping,
"received": ListTransferPackagesLifecycleStateReceived,
"processing": ListTransferPackagesLifecycleStateProcessing,
"processed": ListTransferPackagesLifecycleStateProcessed,
"returned": ListTransferPackagesLifecycleStateReturned,
"deleted": ListTransferPackagesLifecycleStateDeleted,
"cancelled": ListTransferPackagesLifecycleStateCancelled,
"cancelled_returned": ListTransferPackagesLifecycleStateCancelledReturned,
}
// GetListTransferPackagesLifecycleStateEnumValues Enumerates the set of values for ListTransferPackagesLifecycleStateEnum
func GetListTransferPackagesLifecycleStateEnumValues() []ListTransferPackagesLifecycleStateEnum {
values := make([]ListTransferPackagesLifecycleStateEnum, 0)
for _, v := range mappingListTransferPackagesLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetListTransferPackagesLifecycleStateEnumStringValues Enumerates the set of values in String for ListTransferPackagesLifecycleStateEnum
func GetListTransferPackagesLifecycleStateEnumStringValues() []string {
return []string{
"PREPARING",
"SHIPPING",
"RECEIVED",
"PROCESSING",
"PROCESSED",
"RETURNED",
"DELETED",
"CANCELLED",
"CANCELLED_RETURNED",
}
}
// GetMappingListTransferPackagesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListTransferPackagesLifecycleStateEnum(val string) (ListTransferPackagesLifecycleStateEnum, bool) {
enum, ok := mappingListTransferPackagesLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}