-
Notifications
You must be signed in to change notification settings - Fork 80
/
filter_resource_actions_request_response.go
145 lines (114 loc) · 7.16 KB
/
filter_resource_actions_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, 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 optimizer
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// FilterResourceActionsRequest wrapper for the FilterResourceActions operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/optimizer/FilterResourceActions.go.html to see an example of how to use FilterResourceActionsRequest.
type FilterResourceActionsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.
// Can only be set to true when performing ListCompartments on the tenancy (root compartment).
CompartmentIdInSubtree *bool `mandatory:"true" contributesTo:"query" name:"compartmentIdInSubtree"`
// The request parameters that describe the query criteria.
QueryDetails `contributesTo:"body"`
// The unique OCID associated with the recommendation.
RecommendationId *string `mandatory:"false" contributesTo:"query" name:"recommendationId"`
// Optional. A filter that returns results that match the recommendation name specified.
RecommendationName *string `mandatory:"false" contributesTo:"query" name:"recommendationName"`
// A list of child tenancies for which the respective data will be returned. Please note that
// the parent tenancy id can also be included in this list. For example, if there is a parent P with two
// children A and B, to return results of only parent P and child A, this list should be populated with
// tenancy id of parent P and child A.
// If this list contains a tenancy id that isn't part of the organization of parent P, the request will
// fail. That is, let's say there is an organization with parent P with children A and B, and also one
// other tenant T that isn't part of the organization. If T is included in the list of
// childTenancyIds, the request will fail.
// It is important to note that if you are setting the includeOrganization parameter value as true and
// also populating the childTenancyIds parameter with a list of child tenancies, the request will fail.
// The childTenancyIds and includeOrganization should be used exclusively.
// When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
ChildTenancyIds []string `contributesTo:"query" name:"childTenancyIds" collectionFormat:"multi"`
// When set to true, the data for all child tenancies including the parent is returned. That is, if
// there is an organization with parent P and children A and B, to return the data for the parent P, child
// A and child B, this parameter value should be set to true.
// Please note that this parameter shouldn't be used along with childTenancyIds parameter. If you would like
// to get results specifically for parent P and only child A, use the childTenancyIds parameter and populate
// the list with tenancy id of P and A.
// When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
IncludeOrganization *bool `mandatory:"false" contributesTo:"query" name:"includeOrganization"`
// Supplement additional resource information in extended metadata response.
IncludeResourceMetadata *bool `mandatory:"false" contributesTo:"query" name:"includeResourceMetadata"`
// The maximum number of items to return in a paginated "List" call.
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"`
// 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 FilterResourceActionsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request FilterResourceActionsRequest) 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 FilterResourceActionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request FilterResourceActionsRequest) 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 FilterResourceActionsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// FilterResourceActionsResponse wrapper for the FilterResourceActions operation
type FilterResourceActionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ResourceActionCollection instances
ResourceActionCollection `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"`
// For list pagination. When this header appears in the response, previous pages of results exist.
// For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response FilterResourceActionsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response FilterResourceActionsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}