forked from oracle/oci-go-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
list_data_entities_request_response.go
145 lines (110 loc) · 6.51 KB
/
list_data_entities_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
// Copyright (c) 2016, 2018, 2020, 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 dataintegration
import (
"github.com/oracle/oci-go-sdk/common"
"net/http"
)
// ListDataEntitiesRequest wrapper for the ListDataEntities operation
type ListDataEntitiesRequest struct {
// DIS workspace id
WorkspaceId *string `mandatory:"true" contributesTo:"path" name:"workspaceId"`
// The connection key
ConnectionKey *string `mandatory:"true" contributesTo:"path" name:"connectionKey"`
// Schema resource name used for retrieving schemas
SchemaResourceName *string `mandatory:"true" contributesTo:"path" name:"schemaResourceName"`
// This filter parameter can be used to filter by the name of the object.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// This parameter will control pagination. Values for the parameter should come from the `opc-next-page` or `opc-prev-page` header in previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Type of the object to filter the results with.
Type *string `mandatory:"false" contributesTo:"query" name:"type"`
// This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// This parameter allows users to specify which fields to get for an object.
Fields []string `contributesTo:"query" name:"fields" collectionFormat:"multi"`
// This parameter allows users to specify a sort field. Supported sort fields are `name`, `identifier`, `timeCreated`, and `timeUpdated`. Default sort order is the descending order of `timeCreated` (most recently created objects at the top). Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order).
SortBy ListDataEntitiesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// This parameter is used to control the sort order. Supported values are `ASC` (ascending) and `DESC` (descending).
SortOrder ListDataEntitiesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListDataEntitiesRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListDataEntitiesRequest) HTTPRequest(method, path string) (http.Request, error) {
return common.MakeDefaultHTTPRequestWithTaggedStruct(method, path, request)
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDataEntitiesRequest) RetryPolicy() *common.RetryPolicy {
return request.RequestMetadata.RetryPolicy
}
// ListDataEntitiesResponse wrapper for the ListDataEntities operation
type ListDataEntitiesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DataEntitySummaryCollection instances
DataEntitySummaryCollection `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"`
// Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
// Total items in the entire list.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListDataEntitiesResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListDataEntitiesResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListDataEntitiesSortByEnum Enum with underlying type: string
type ListDataEntitiesSortByEnum string
// Set of constants representing the allowable values for ListDataEntitiesSortByEnum
const (
ListDataEntitiesSortByTimeCreated ListDataEntitiesSortByEnum = "TIME_CREATED"
ListDataEntitiesSortByDisplayName ListDataEntitiesSortByEnum = "DISPLAY_NAME"
)
var mappingListDataEntitiesSortBy = map[string]ListDataEntitiesSortByEnum{
"TIME_CREATED": ListDataEntitiesSortByTimeCreated,
"DISPLAY_NAME": ListDataEntitiesSortByDisplayName,
}
// GetListDataEntitiesSortByEnumValues Enumerates the set of values for ListDataEntitiesSortByEnum
func GetListDataEntitiesSortByEnumValues() []ListDataEntitiesSortByEnum {
values := make([]ListDataEntitiesSortByEnum, 0)
for _, v := range mappingListDataEntitiesSortBy {
values = append(values, v)
}
return values
}
// ListDataEntitiesSortOrderEnum Enum with underlying type: string
type ListDataEntitiesSortOrderEnum string
// Set of constants representing the allowable values for ListDataEntitiesSortOrderEnum
const (
ListDataEntitiesSortOrderAsc ListDataEntitiesSortOrderEnum = "ASC"
ListDataEntitiesSortOrderDesc ListDataEntitiesSortOrderEnum = "DESC"
)
var mappingListDataEntitiesSortOrder = map[string]ListDataEntitiesSortOrderEnum{
"ASC": ListDataEntitiesSortOrderAsc,
"DESC": ListDataEntitiesSortOrderDesc,
}
// GetListDataEntitiesSortOrderEnumValues Enumerates the set of values for ListDataEntitiesSortOrderEnum
func GetListDataEntitiesSortOrderEnumValues() []ListDataEntitiesSortOrderEnum {
values := make([]ListDataEntitiesSortOrderEnum, 0)
for _, v := range mappingListDataEntitiesSortOrder {
values = append(values, v)
}
return values
}