/
request_summarized_responder_executions_request_response.go
188 lines (150 loc) · 9.53 KB
/
request_summarized_responder_executions_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
// 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 cloudguard
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// RequestSummarizedResponderExecutionsRequest wrapper for the RequestSummarizedResponderExecutions operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/cloudguard/RequestSummarizedResponderExecutions.go.html to see an example of how to use RequestSummarizedResponderExecutionsRequest.
type RequestSummarizedResponderExecutionsRequest struct {
// The possible attributes based on which the responder executions can be distinguished
ResponderExecutionsDimensions []ResponderDimensionEnum `contributesTo:"query" name:"responderExecutionsDimensions" omitEmpty:"true" collectionFormat:"multi"`
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The possible filters for Responder Type Dimension to distinguish Responder Executions.
// If no values are passed, the metric for responder executions of all reponder types are returned
ResponderTypeFilter []ResponderTypeEnum `contributesTo:"query" name:"responderTypeFilter" omitEmpty:"true" collectionFormat:"multi"`
// The possible filters for Responder Type Dimension to distinguish Responder Executions.
// If no values are passed, the metric for responder executions of all status are returned
ResponderExecutionStatusFilter []ResponderExecutionStatusEnum `contributesTo:"query" name:"responderExecutionStatusFilter" omitEmpty:"true" collectionFormat:"multi"`
// Default is false.
// 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`.
CompartmentIdInSubtree *bool `mandatory:"false" contributesTo:"query" name:"compartmentIdInSubtree"`
// Valid values are `RESTRICTED` and `ACCESSIBLE`. Default is `RESTRICTED`.
// Setting this to `ACCESSIBLE` returns only those compartments for which the
// user has INSPECT permissions directly or indirectly (permissions can be on a
// resource in a subcompartment).
// When set to `RESTRICTED` permissions are checked and no partial results are displayed.
AccessLevel RequestSummarizedResponderExecutionsAccessLevelEnum `mandatory:"false" contributesTo:"query" name:"accessLevel" omitEmpty:"true"`
// 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"`
// The client request ID for tracing.
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 RequestSummarizedResponderExecutionsRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request RequestSummarizedResponderExecutionsRequest) 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 RequestSummarizedResponderExecutionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RequestSummarizedResponderExecutionsRequest) 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 RequestSummarizedResponderExecutionsRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
for _, val := range request.ResponderExecutionsDimensions {
if _, ok := GetMappingResponderDimensionEnum(string(val)); !ok && val != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for ResponderExecutionsDimensions: %s. Supported values are: %s.", val, strings.Join(GetResponderDimensionEnumStringValues(), ",")))
}
}
for _, val := range request.ResponderTypeFilter {
if _, ok := GetMappingResponderTypeEnum(string(val)); !ok && val != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for ResponderTypeFilter: %s. Supported values are: %s.", val, strings.Join(GetResponderTypeEnumStringValues(), ",")))
}
}
for _, val := range request.ResponderExecutionStatusFilter {
if _, ok := GetMappingResponderExecutionStatusEnum(string(val)); !ok && val != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for ResponderExecutionStatusFilter: %s. Supported values are: %s.", val, strings.Join(GetResponderExecutionStatusEnumStringValues(), ",")))
}
}
if _, ok := GetMappingRequestSummarizedResponderExecutionsAccessLevelEnum(string(request.AccessLevel)); !ok && request.AccessLevel != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for AccessLevel: %s. Supported values are: %s.", request.AccessLevel, strings.Join(GetRequestSummarizedResponderExecutionsAccessLevelEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// RequestSummarizedResponderExecutionsResponse wrapper for the RequestSummarizedResponderExecutions operation
type RequestSummarizedResponderExecutionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ResponderExecutionAggregationCollection instances
ResponderExecutionAggregationCollection `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 RequestSummarizedResponderExecutionsResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response RequestSummarizedResponderExecutionsResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// RequestSummarizedResponderExecutionsAccessLevelEnum Enum with underlying type: string
type RequestSummarizedResponderExecutionsAccessLevelEnum string
// Set of constants representing the allowable values for RequestSummarizedResponderExecutionsAccessLevelEnum
const (
RequestSummarizedResponderExecutionsAccessLevelRestricted RequestSummarizedResponderExecutionsAccessLevelEnum = "RESTRICTED"
RequestSummarizedResponderExecutionsAccessLevelAccessible RequestSummarizedResponderExecutionsAccessLevelEnum = "ACCESSIBLE"
)
var mappingRequestSummarizedResponderExecutionsAccessLevelEnum = map[string]RequestSummarizedResponderExecutionsAccessLevelEnum{
"RESTRICTED": RequestSummarizedResponderExecutionsAccessLevelRestricted,
"ACCESSIBLE": RequestSummarizedResponderExecutionsAccessLevelAccessible,
}
var mappingRequestSummarizedResponderExecutionsAccessLevelEnumLowerCase = map[string]RequestSummarizedResponderExecutionsAccessLevelEnum{
"restricted": RequestSummarizedResponderExecutionsAccessLevelRestricted,
"accessible": RequestSummarizedResponderExecutionsAccessLevelAccessible,
}
// GetRequestSummarizedResponderExecutionsAccessLevelEnumValues Enumerates the set of values for RequestSummarizedResponderExecutionsAccessLevelEnum
func GetRequestSummarizedResponderExecutionsAccessLevelEnumValues() []RequestSummarizedResponderExecutionsAccessLevelEnum {
values := make([]RequestSummarizedResponderExecutionsAccessLevelEnum, 0)
for _, v := range mappingRequestSummarizedResponderExecutionsAccessLevelEnum {
values = append(values, v)
}
return values
}
// GetRequestSummarizedResponderExecutionsAccessLevelEnumStringValues Enumerates the set of values in String for RequestSummarizedResponderExecutionsAccessLevelEnum
func GetRequestSummarizedResponderExecutionsAccessLevelEnumStringValues() []string {
return []string{
"RESTRICTED",
"ACCESSIBLE",
}
}
// GetMappingRequestSummarizedResponderExecutionsAccessLevelEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingRequestSummarizedResponderExecutionsAccessLevelEnum(val string) (RequestSummarizedResponderExecutionsAccessLevelEnum, bool) {
enum, ok := mappingRequestSummarizedResponderExecutionsAccessLevelEnumLowerCase[strings.ToLower(val)]
return enum, ok
}