/
list_waas_policy_custom_protection_rules_request_response.go
155 lines (121 loc) · 7.12 KB
/
list_waas_policy_custom_protection_rules_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
// 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 waas
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"net/http"
"strings"
)
// ListWaasPolicyCustomProtectionRulesRequest wrapper for the ListWaasPolicyCustomProtectionRules operation
//
// # See also
//
// Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWaasPolicyCustomProtectionRules.go.html to see an example of how to use ListWaasPolicyCustomProtectionRulesRequest.
type ListWaasPolicyCustomProtectionRulesRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
// The 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 maximum number of items to return in a paginated call. If unspecified, defaults to `10`.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous paginated call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Filter rules using a list of ModSecurity rule IDs.
ModSecurityRuleId []string `contributesTo:"query" name:"modSecurityRuleId" collectionFormat:"multi"`
// Filter rules using a list of actions.
Action []ListWaasPolicyCustomProtectionRulesActionEnum `contributesTo:"query" name:"action" omitEmpty:"true" collectionFormat:"multi"`
// 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 ListWaasPolicyCustomProtectionRulesRequest) String() string {
return common.PointerString(request)
}
// HTTPRequest implements the OCIRequest interface
func (request ListWaasPolicyCustomProtectionRulesRequest) 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 ListWaasPolicyCustomProtectionRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool) {
return nil, false
}
// RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWaasPolicyCustomProtectionRulesRequest) 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 ListWaasPolicyCustomProtectionRulesRequest) ValidateEnumValue() (bool, error) {
errMessage := []string{}
for _, val := range request.Action {
if _, ok := GetMappingListWaasPolicyCustomProtectionRulesActionEnum(string(val)); !ok && val != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Action: %s. Supported values are: %s.", val, strings.Join(GetListWaasPolicyCustomProtectionRulesActionEnumStringValues(), ",")))
}
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// ListWaasPolicyCustomProtectionRulesResponse wrapper for the ListWaasPolicyCustomProtectionRules operation
type ListWaasPolicyCustomProtectionRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WaasPolicyCustomProtectionRuleSummary instances
Items []WaasPolicyCustomProtectionRuleSummary `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// For list pagination. When this header appears in the response, additional pages of results may remain. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// A 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"`
}
func (response ListWaasPolicyCustomProtectionRulesResponse) String() string {
return common.PointerString(response)
}
// HTTPResponse implements the OCIResponse interface
func (response ListWaasPolicyCustomProtectionRulesResponse) HTTPResponse() *http.Response {
return response.RawResponse
}
// ListWaasPolicyCustomProtectionRulesActionEnum Enum with underlying type: string
type ListWaasPolicyCustomProtectionRulesActionEnum string
// Set of constants representing the allowable values for ListWaasPolicyCustomProtectionRulesActionEnum
const (
ListWaasPolicyCustomProtectionRulesActionDetect ListWaasPolicyCustomProtectionRulesActionEnum = "DETECT"
ListWaasPolicyCustomProtectionRulesActionBlock ListWaasPolicyCustomProtectionRulesActionEnum = "BLOCK"
)
var mappingListWaasPolicyCustomProtectionRulesActionEnum = map[string]ListWaasPolicyCustomProtectionRulesActionEnum{
"DETECT": ListWaasPolicyCustomProtectionRulesActionDetect,
"BLOCK": ListWaasPolicyCustomProtectionRulesActionBlock,
}
var mappingListWaasPolicyCustomProtectionRulesActionEnumLowerCase = map[string]ListWaasPolicyCustomProtectionRulesActionEnum{
"detect": ListWaasPolicyCustomProtectionRulesActionDetect,
"block": ListWaasPolicyCustomProtectionRulesActionBlock,
}
// GetListWaasPolicyCustomProtectionRulesActionEnumValues Enumerates the set of values for ListWaasPolicyCustomProtectionRulesActionEnum
func GetListWaasPolicyCustomProtectionRulesActionEnumValues() []ListWaasPolicyCustomProtectionRulesActionEnum {
values := make([]ListWaasPolicyCustomProtectionRulesActionEnum, 0)
for _, v := range mappingListWaasPolicyCustomProtectionRulesActionEnum {
values = append(values, v)
}
return values
}
// GetListWaasPolicyCustomProtectionRulesActionEnumStringValues Enumerates the set of values in String for ListWaasPolicyCustomProtectionRulesActionEnum
func GetListWaasPolicyCustomProtectionRulesActionEnumStringValues() []string {
return []string{
"DETECT",
"BLOCK",
}
}
// GetMappingListWaasPolicyCustomProtectionRulesActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingListWaasPolicyCustomProtectionRulesActionEnum(val string) (ListWaasPolicyCustomProtectionRulesActionEnum, bool) {
enum, ok := mappingListWaasPolicyCustomProtectionRulesActionEnumLowerCase[strings.ToLower(val)]
return enum, ok
}