GetCertificateLifecycleStateEnumValues Enumerates the set of values for LifecycleStatesEnum Consider using GetLifecycleStatesEnumValue Deprecated
var GetCertificateLifecycleStateEnumValues = GetLifecycleStatesEnumValues
GetCertificateSummaryLifecycleStateEnumValues Enumerates the set of values for LifecycleStatesEnum Consider using GetLifecycleStatesEnumValue Deprecated
var GetCertificateSummaryLifecycleStateEnumValues = GetLifecycleStatesEnumValues
GetWaasPolicyLifecycleStateEnumValues Enumerates the set of values for LifecycleStatesEnum Consider using GetLifecycleStatesEnumValue Deprecated
var GetWaasPolicyLifecycleStateEnumValues = GetLifecycleStatesEnumValues
GetWaasPolicySummaryLifecycleStateEnumValues Enumerates the set of values for LifecycleStatesEnum Consider using GetLifecycleStatesEnumValue Deprecated
var GetWaasPolicySummaryLifecycleStateEnumValues = GetLifecycleStatesEnumValues
GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypesEnum Consider using GetWorkRequestOperationTypesEnumValue Deprecated
var GetWorkRequestOperationTypeEnumValues = GetWorkRequestOperationTypesEnumValues
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusValuesEnum Consider using GetWorkRequestStatusValuesEnumValue Deprecated
var GetWorkRequestStatusEnumValues = GetWorkRequestStatusValuesEnumValues
GetWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypesEnum Consider using GetWorkRequestOperationTypesEnumValue Deprecated
var GetWorkRequestSummaryOperationTypeEnumValues = GetWorkRequestOperationTypesEnumValues
GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestStatusValuesEnum Consider using GetWorkRequestStatusValuesEnumValue Deprecated
var GetWorkRequestSummaryStatusEnumValues = GetWorkRequestStatusValuesEnumValues
func GetAccessRuleActionEnumStringValues() []string
GetAccessRuleActionEnumStringValues Enumerates the set of values in String for AccessRuleActionEnum
func GetAccessRuleBlockActionEnumStringValues() []string
GetAccessRuleBlockActionEnumStringValues Enumerates the set of values in String for AccessRuleBlockActionEnum
func GetAccessRuleBypassChallengesEnumStringValues() []string
GetAccessRuleBypassChallengesEnumStringValues Enumerates the set of values in String for AccessRuleBypassChallengesEnum
func GetAccessRuleCriteriaConditionEnumStringValues() []string
GetAccessRuleCriteriaConditionEnumStringValues Enumerates the set of values in String for AccessRuleCriteriaConditionEnum
func GetAccessRuleRedirectResponseCodeEnumStringValues() []string
GetAccessRuleRedirectResponseCodeEnumStringValues Enumerates the set of values in String for AccessRuleRedirectResponseCodeEnum
func GetBlockChallengeSettingsBlockActionEnumStringValues() []string
GetBlockChallengeSettingsBlockActionEnumStringValues Enumerates the set of values in String for BlockChallengeSettingsBlockActionEnum
func GetCachingRuleActionEnumStringValues() []string
GetCachingRuleActionEnumStringValues Enumerates the set of values in String for CachingRuleActionEnum
func GetCachingRuleCriteriaConditionEnumStringValues() []string
GetCachingRuleCriteriaConditionEnumStringValues Enumerates the set of values in String for CachingRuleCriteriaConditionEnum
func GetCachingRuleSummaryActionEnumStringValues() []string
GetCachingRuleSummaryActionEnumStringValues Enumerates the set of values in String for CachingRuleSummaryActionEnum
func GetCustomProtectionRuleSettingActionEnumStringValues() []string
GetCustomProtectionRuleSettingActionEnumStringValues Enumerates the set of values in String for CustomProtectionRuleSettingActionEnum
func GetDeviceFingerprintChallengeActionEnumStringValues() []string
GetDeviceFingerprintChallengeActionEnumStringValues Enumerates the set of values in String for DeviceFingerprintChallengeActionEnum
func GetHeaderManipulationActionActionEnumStringValues() []string
GetHeaderManipulationActionActionEnumStringValues Enumerates the set of values in String for HeaderManipulationActionActionEnum
func GetHealthCheckExpectedResponseCodeGroupEnumStringValues() []string
GetHealthCheckExpectedResponseCodeGroupEnumStringValues Enumerates the set of values in String for HealthCheckExpectedResponseCodeGroupEnum
func GetHealthCheckMethodEnumStringValues() []string
GetHealthCheckMethodEnumStringValues Enumerates the set of values in String for HealthCheckMethodEnum
func GetHttpRedirectTargetProtocolEnumStringValues() []string
GetHttpRedirectTargetProtocolEnumStringValues Enumerates the set of values in String for HttpRedirectTargetProtocolEnum
func GetHumanInteractionChallengeActionEnumStringValues() []string
GetHumanInteractionChallengeActionEnumStringValues Enumerates the set of values in String for HumanInteractionChallengeActionEnum
func GetJsChallengeActionEnumStringValues() []string
GetJsChallengeActionEnumStringValues Enumerates the set of values in String for JsChallengeActionEnum
func GetLifecycleStatesEnumStringValues() []string
GetLifecycleStatesEnumStringValues Enumerates the set of values in String for LifecycleStatesEnum
func GetListAddressListsSortByEnumStringValues() []string
GetListAddressListsSortByEnumStringValues Enumerates the set of values in String for ListAddressListsSortByEnum
func GetListAddressListsSortOrderEnumStringValues() []string
GetListAddressListsSortOrderEnumStringValues Enumerates the set of values in String for ListAddressListsSortOrderEnum
func GetListCertificatesSortByEnumStringValues() []string
GetListCertificatesSortByEnumStringValues Enumerates the set of values in String for ListCertificatesSortByEnum
func GetListCertificatesSortOrderEnumStringValues() []string
GetListCertificatesSortOrderEnumStringValues Enumerates the set of values in String for ListCertificatesSortOrderEnum
func GetListCustomProtectionRulesSortByEnumStringValues() []string
GetListCustomProtectionRulesSortByEnumStringValues Enumerates the set of values in String for ListCustomProtectionRulesSortByEnum
func GetListCustomProtectionRulesSortOrderEnumStringValues() []string
GetListCustomProtectionRulesSortOrderEnumStringValues Enumerates the set of values in String for ListCustomProtectionRulesSortOrderEnum
func GetListEdgeSubnetsSortByEnumStringValues() []string
GetListEdgeSubnetsSortByEnumStringValues Enumerates the set of values in String for ListEdgeSubnetsSortByEnum
func GetListEdgeSubnetsSortOrderEnumStringValues() []string
GetListEdgeSubnetsSortOrderEnumStringValues Enumerates the set of values in String for ListEdgeSubnetsSortOrderEnum
func GetListHttpRedirectsSortByEnumStringValues() []string
GetListHttpRedirectsSortByEnumStringValues Enumerates the set of values in String for ListHttpRedirectsSortByEnum
func GetListHttpRedirectsSortOrderEnumStringValues() []string
GetListHttpRedirectsSortOrderEnumStringValues Enumerates the set of values in String for ListHttpRedirectsSortOrderEnum
func GetListProtectionRulesActionEnumStringValues() []string
GetListProtectionRulesActionEnumStringValues Enumerates the set of values in String for ListProtectionRulesActionEnum
func GetListRecommendationsRecommendedActionEnumStringValues() []string
GetListRecommendationsRecommendedActionEnumStringValues Enumerates the set of values in String for ListRecommendationsRecommendedActionEnum
func GetListWaasPoliciesSortByEnumStringValues() []string
GetListWaasPoliciesSortByEnumStringValues Enumerates the set of values in String for ListWaasPoliciesSortByEnum
func GetListWaasPoliciesSortOrderEnumStringValues() []string
GetListWaasPoliciesSortOrderEnumStringValues Enumerates the set of values in String for ListWaasPoliciesSortOrderEnum
func GetListWaasPolicyCustomProtectionRulesActionEnumStringValues() []string
GetListWaasPolicyCustomProtectionRulesActionEnumStringValues Enumerates the set of values in String for ListWaasPolicyCustomProtectionRulesActionEnum
func GetListWafBlockedRequestsWafFeatureEnumStringValues() []string
GetListWafBlockedRequestsWafFeatureEnumStringValues Enumerates the set of values in String for ListWafBlockedRequestsWafFeatureEnum
func GetListWafLogsActionEnumStringValues() []string
GetListWafLogsActionEnumStringValues Enumerates the set of values in String for ListWafLogsActionEnum
func GetListWafLogsHttpMethodEnumStringValues() []string
GetListWafLogsHttpMethodEnumStringValues Enumerates the set of values in String for ListWafLogsHttpMethodEnum
func GetListWafLogsLogTypeEnumStringValues() []string
GetListWafLogsLogTypeEnumStringValues Enumerates the set of values in String for ListWafLogsLogTypeEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetLoadBalancingMethodMethodEnumStringValues() []string
GetLoadBalancingMethodMethodEnumStringValues Enumerates the set of values in String for LoadBalancingMethodMethodEnum
func GetPolicyConfigCipherGroupEnumStringValues() []string
GetPolicyConfigCipherGroupEnumStringValues Enumerates the set of values in String for PolicyConfigCipherGroupEnum
func GetPolicyConfigClientAddressHeaderEnumStringValues() []string
GetPolicyConfigClientAddressHeaderEnumStringValues Enumerates the set of values in String for PolicyConfigClientAddressHeaderEnum
func GetPolicyConfigTlsProtocolsEnumStringValues() []string
GetPolicyConfigTlsProtocolsEnumStringValues Enumerates the set of values in String for PolicyConfigTlsProtocolsEnum
func GetProtectionRuleActionActionEnumStringValues() []string
GetProtectionRuleActionActionEnumStringValues Enumerates the set of values in String for ProtectionRuleActionActionEnum
func GetProtectionRuleActionEnumStringValues() []string
GetProtectionRuleActionEnumStringValues Enumerates the set of values in String for ProtectionRuleActionEnum
func GetProtectionRuleExclusionTargetEnumStringValues() []string
GetProtectionRuleExclusionTargetEnumStringValues Enumerates the set of values in String for ProtectionRuleExclusionTargetEnum
func GetProtectionSettingsAllowedHttpMethodsEnumStringValues() []string
GetProtectionSettingsAllowedHttpMethodsEnumStringValues Enumerates the set of values in String for ProtectionSettingsAllowedHttpMethodsEnum
func GetProtectionSettingsBlockActionEnumStringValues() []string
GetProtectionSettingsBlockActionEnumStringValues Enumerates the set of values in String for ProtectionSettingsBlockActionEnum
func GetThreatFeedActionActionEnumStringValues() []string
GetThreatFeedActionActionEnumStringValues Enumerates the set of values in String for ThreatFeedActionActionEnum
func GetThreatFeedActionEnumStringValues() []string
GetThreatFeedActionEnumStringValues Enumerates the set of values in String for ThreatFeedActionEnum
func GetWaasPolicyCustomProtectionRuleSummaryActionEnumStringValues() []string
GetWaasPolicyCustomProtectionRuleSummaryActionEnumStringValues Enumerates the set of values in String for WaasPolicyCustomProtectionRuleSummaryActionEnum
func GetWafBlockedRequestWafFeatureEnumStringValues() []string
GetWafBlockedRequestWafFeatureEnumStringValues Enumerates the set of values in String for WafBlockedRequestWafFeatureEnum
func GetWorkRequestOperationTypesEnumStringValues() []string
GetWorkRequestOperationTypesEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypesEnum
func GetWorkRequestResourceActionTypeEnumStringValues() []string
GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum
func GetWorkRequestStatusValuesEnumStringValues() []string
GetWorkRequestStatusValuesEnumStringValues Enumerates the set of values in String for WorkRequestStatusValuesEnum
AcceptRecommendationsRequest wrapper for the AcceptRecommendations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/AcceptRecommendations.go.html to see an example of how to use AcceptRecommendationsRequest.
type AcceptRecommendationsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
ProtectionRuleKeys *[]string `mandatory:"true" contributesTo:"body"`
// 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"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 AcceptRecommendationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AcceptRecommendationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AcceptRecommendationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AcceptRecommendationsRequest) String() string
func (request AcceptRecommendationsRequest) ValidateEnumValue() (bool, error)
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
AcceptRecommendationsResponse wrapper for the AcceptRecommendations operation
type AcceptRecommendationsResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response AcceptRecommendationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AcceptRecommendationsResponse) String() string
AccessRule A content access rule. An access rule specifies an action to take if a set of criteria is matched by a request.
type AccessRule struct {
// The unique name of the access rule.
Name *string `mandatory:"true" json:"name"`
// The list of access rule criteria. The rule would be applied only for the requests that matched all the listed conditions.
Criteria []AccessRuleCriteria `mandatory:"true" json:"criteria"`
// The action to take when the access criteria are met for a rule. If unspecified, defaults to `ALLOW`.
// - **ALLOW:** Takes no action, just logs the request.
// - **DETECT:** Takes no action, but creates an alert for the request.
// - **BLOCK:** Blocks the request by returning specified response code or showing error page.
// - **BYPASS:** Bypasses some or all challenges.
// - **REDIRECT:** Redirects the request to the specified URL. These fields are required when `REDIRECT` is selected: `redirectUrl`, `redirectResponseCode`.
// - **SHOW_CAPTCHA:** Show a CAPTCHA Challenge page instead of the requested page.
// Regardless of action, no further rules are processed once a rule is matched.
Action AccessRuleActionEnum `mandatory:"true" json:"action"`
// The method used to block requests if `action` is set to `BLOCK` and the access criteria are met. If unspecified, defaults to `SET_RESPONSE_CODE`.
BlockAction AccessRuleBlockActionEnum `mandatory:"false" json:"blockAction,omitempty"`
// The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the access criteria are met. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`.
BlockResponseCode *int `mandatory:"false" json:"blockResponseCode"`
// The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access to the website is blocked.'
BlockErrorPageMessage *string `mandatory:"false" json:"blockErrorPageMessage"`
// The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access rules'.
BlockErrorPageCode *string `mandatory:"false" json:"blockErrorPageCode"`
// The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the access criteria are met. If unspecified, defaults to 'Access blocked by website owner. Please contact support.'
BlockErrorPageDescription *string `mandatory:"false" json:"blockErrorPageDescription"`
// The list of challenges to bypass when `action` is set to `BYPASS`. If unspecified or empty, all challenges are bypassed.
// - **JS_CHALLENGE:** Bypasses JavaScript Challenge.
// - **DEVICE_FINGERPRINT_CHALLENGE:** Bypasses Device Fingerprint Challenge.
// - **HUMAN_INTERACTION_CHALLENGE:** Bypasses Human Interaction Challenge.
// - **CAPTCHA:** Bypasses CAPTCHA Challenge.
BypassChallenges []AccessRuleBypassChallengesEnum `mandatory:"false" json:"bypassChallenges,omitempty"`
// The target to which the request should be redirected, represented as a URI reference. Required when `action` is `REDIRECT`.
RedirectUrl *string `mandatory:"false" json:"redirectUrl"`
// The response status code to return when `action` is set to `REDIRECT`.
// - **MOVED_PERMANENTLY:** Used for designating the permanent movement of a page (numerical code - 301).
// - **FOUND:** Used for designating the temporary movement of a page (numerical code - 302).
RedirectResponseCode AccessRuleRedirectResponseCodeEnum `mandatory:"false" json:"redirectResponseCode,omitempty"`
// The title used when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged.
CaptchaTitle *string `mandatory:"false" json:"captchaTitle"`
// The text to show in the header when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged.
CaptchaHeader *string `mandatory:"false" json:"captchaHeader"`
// The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged.
CaptchaFooter *string `mandatory:"false" json:"captchaFooter"`
// The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `SHOW_CAPTCHA` and the request is challenged.
CaptchaSubmitLabel *string `mandatory:"false" json:"captchaSubmitLabel"`
// An object that represents an action to apply to an HTTP response headers if all rule criteria will be matched regardless of `action` value.
ResponseHeaderManipulation []HeaderManipulationAction `mandatory:"false" json:"responseHeaderManipulation"`
}
func (m AccessRule) String() string
func (m *AccessRule) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AccessRule) ValidateEnumValue() (bool, error)
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
AccessRuleActionEnum Enum with underlying type: string
type AccessRuleActionEnum string
Set of constants representing the allowable values for AccessRuleActionEnum
const (
AccessRuleActionAllow AccessRuleActionEnum = "ALLOW"
AccessRuleActionDetect AccessRuleActionEnum = "DETECT"
AccessRuleActionBlock AccessRuleActionEnum = "BLOCK"
AccessRuleActionBypass AccessRuleActionEnum = "BYPASS"
AccessRuleActionRedirect AccessRuleActionEnum = "REDIRECT"
AccessRuleActionShowCaptcha AccessRuleActionEnum = "SHOW_CAPTCHA"
)
func GetAccessRuleActionEnumValues() []AccessRuleActionEnum
GetAccessRuleActionEnumValues Enumerates the set of values for AccessRuleActionEnum
func GetMappingAccessRuleActionEnum(val string) (AccessRuleActionEnum, bool)
GetMappingAccessRuleActionEnum performs case Insensitive comparison on enum value and return the desired enum
AccessRuleBlockActionEnum Enum with underlying type: string
type AccessRuleBlockActionEnum string
Set of constants representing the allowable values for AccessRuleBlockActionEnum
const (
AccessRuleBlockActionSetResponseCode AccessRuleBlockActionEnum = "SET_RESPONSE_CODE"
AccessRuleBlockActionShowErrorPage AccessRuleBlockActionEnum = "SHOW_ERROR_PAGE"
)
func GetAccessRuleBlockActionEnumValues() []AccessRuleBlockActionEnum
GetAccessRuleBlockActionEnumValues Enumerates the set of values for AccessRuleBlockActionEnum
func GetMappingAccessRuleBlockActionEnum(val string) (AccessRuleBlockActionEnum, bool)
GetMappingAccessRuleBlockActionEnum performs case Insensitive comparison on enum value and return the desired enum
AccessRuleBypassChallengesEnum Enum with underlying type: string
type AccessRuleBypassChallengesEnum string
Set of constants representing the allowable values for AccessRuleBypassChallengesEnum
const (
AccessRuleBypassChallengesJsChallenge AccessRuleBypassChallengesEnum = "JS_CHALLENGE"
AccessRuleBypassChallengesDeviceFingerprintChallenge AccessRuleBypassChallengesEnum = "DEVICE_FINGERPRINT_CHALLENGE"
AccessRuleBypassChallengesHumanInteractionChallenge AccessRuleBypassChallengesEnum = "HUMAN_INTERACTION_CHALLENGE"
AccessRuleBypassChallengesCaptcha AccessRuleBypassChallengesEnum = "CAPTCHA"
)
func GetAccessRuleBypassChallengesEnumValues() []AccessRuleBypassChallengesEnum
GetAccessRuleBypassChallengesEnumValues Enumerates the set of values for AccessRuleBypassChallengesEnum
func GetMappingAccessRuleBypassChallengesEnum(val string) (AccessRuleBypassChallengesEnum, bool)
GetMappingAccessRuleBypassChallengesEnum performs case Insensitive comparison on enum value and return the desired enum
AccessRuleCriteria When defined, the parent challenge would be applied only for the requests that matched all the listed conditions.
type AccessRuleCriteria struct {
// The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request.
// - **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. URL must start with a `/`.
// - **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical to the contents of the `value` field. URL must start with a `/`.
// - **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field. URL must start with a `/`.
// - **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field.
// - **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field.
// - **URL_REGEX:** Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org).
// - **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is not described by the regular expression in the `value` field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org).
// - **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does not start with the contents of the `value` field.
// - **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query does not contain the contents of the `value` field.
// - **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and query does not end with the contents of the `value` field.
// - **IP_IS:** Matches if the request originates from one of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n
// *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30"
// - **IP_IS_NOT:** Matches if the request does not originate from any of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n
// *Example:* "1.1.1.1\n1.1.1.2\n1.2.2.1/30"
// - **IP_IN_LIST:** Matches if the request originates from one of the IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list.
// - **IP_NOT_IN_LIST:** Matches if the request does not originate from any IP address contained in the referenced address list. The `value` field in this case is OCID of the address list.
// - **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. `host:test.example.com` is an example of a criteria value where `host` is the header field name and `test.example.com` is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match.
// *Example:* With a criteria value of `host:test.example.com`, where `host` is the name of the field and `test.example.com` is the value of the host field, a request with the header values, `Host: www.test.example.com` will match, where as a request with header values of `host: www.example.com` or `host: test.sub.example.com` will not match.
// - **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`
// *Example:* "GET\nPOST"
// - **HTTP_METHOD_IS_NOT:** Matches if the request is not identical to any of the contents of the `value` field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`
// *Example:* "GET\nPOST"
// - **COUNTRY_IS:** Matches if the request originates from one of countries in the `value` field. The `value` in this case is string with one or multiple countries separated by new line symbol \n Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see ISO's website (https://www.iso.org/obp/ui/#search/code/).
// *Example:* "AL\nDZ\nAM"
// - **COUNTRY_IS_NOT:** Matches if the request does not originate from any of countries in the `value` field. The `value` in this case is string with one or multiple countries separated by new line symbol \n Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see ISO's website (https://www.iso.org/obp/ui/#search/code/).
// *Example:* "AL\nDZ\nAM"
// - **USER_AGENT_IS:** Matches if the requesting user agent is identical to the contents of the `value` field.
// *Example:* `Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0`
// - **USER_AGENT_IS_NOT:** Matches if the requesting user agent is not identical to the contents of the `value` field.
// *Example:* `Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0`
Condition AccessRuleCriteriaConditionEnum `mandatory:"true" json:"condition"`
// The criteria value.
Value *string `mandatory:"true" json:"value"`
// When enabled, the condition will be matched with case-sensitive rules.
IsCaseSensitive *bool `mandatory:"false" json:"isCaseSensitive"`
}
func (m AccessRuleCriteria) String() string
func (m AccessRuleCriteria) ValidateEnumValue() (bool, error)
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
AccessRuleCriteriaConditionEnum Enum with underlying type: string
type AccessRuleCriteriaConditionEnum string
Set of constants representing the allowable values for AccessRuleCriteriaConditionEnum
const (
AccessRuleCriteriaConditionUrlIs AccessRuleCriteriaConditionEnum = "URL_IS"
AccessRuleCriteriaConditionUrlIsNot AccessRuleCriteriaConditionEnum = "URL_IS_NOT"
AccessRuleCriteriaConditionUrlStartsWith AccessRuleCriteriaConditionEnum = "URL_STARTS_WITH"
AccessRuleCriteriaConditionUrlPartEndsWith AccessRuleCriteriaConditionEnum = "URL_PART_ENDS_WITH"
AccessRuleCriteriaConditionUrlPartContains AccessRuleCriteriaConditionEnum = "URL_PART_CONTAINS"
AccessRuleCriteriaConditionUrlRegex AccessRuleCriteriaConditionEnum = "URL_REGEX"
AccessRuleCriteriaConditionUrlDoesNotMatchRegex AccessRuleCriteriaConditionEnum = "URL_DOES_NOT_MATCH_REGEX"
AccessRuleCriteriaConditionUrlDoesNotStartWith AccessRuleCriteriaConditionEnum = "URL_DOES_NOT_START_WITH"
AccessRuleCriteriaConditionUrlPartDoesNotContain AccessRuleCriteriaConditionEnum = "URL_PART_DOES_NOT_CONTAIN"
AccessRuleCriteriaConditionUrlPartDoesNotEndWith AccessRuleCriteriaConditionEnum = "URL_PART_DOES_NOT_END_WITH"
AccessRuleCriteriaConditionIpIs AccessRuleCriteriaConditionEnum = "IP_IS"
AccessRuleCriteriaConditionIpIsNot AccessRuleCriteriaConditionEnum = "IP_IS_NOT"
AccessRuleCriteriaConditionIpInList AccessRuleCriteriaConditionEnum = "IP_IN_LIST"
AccessRuleCriteriaConditionIpNotInList AccessRuleCriteriaConditionEnum = "IP_NOT_IN_LIST"
AccessRuleCriteriaConditionHttpHeaderContains AccessRuleCriteriaConditionEnum = "HTTP_HEADER_CONTAINS"
AccessRuleCriteriaConditionHttpMethodIs AccessRuleCriteriaConditionEnum = "HTTP_METHOD_IS"
AccessRuleCriteriaConditionHttpMethodIsNot AccessRuleCriteriaConditionEnum = "HTTP_METHOD_IS_NOT"
AccessRuleCriteriaConditionCountryIs AccessRuleCriteriaConditionEnum = "COUNTRY_IS"
AccessRuleCriteriaConditionCountryIsNot AccessRuleCriteriaConditionEnum = "COUNTRY_IS_NOT"
AccessRuleCriteriaConditionUserAgentIs AccessRuleCriteriaConditionEnum = "USER_AGENT_IS"
AccessRuleCriteriaConditionUserAgentIsNot AccessRuleCriteriaConditionEnum = "USER_AGENT_IS_NOT"
)
func GetAccessRuleCriteriaConditionEnumValues() []AccessRuleCriteriaConditionEnum
GetAccessRuleCriteriaConditionEnumValues Enumerates the set of values for AccessRuleCriteriaConditionEnum
func GetMappingAccessRuleCriteriaConditionEnum(val string) (AccessRuleCriteriaConditionEnum, bool)
GetMappingAccessRuleCriteriaConditionEnum performs case Insensitive comparison on enum value and return the desired enum
AccessRuleRedirectResponseCodeEnum Enum with underlying type: string
type AccessRuleRedirectResponseCodeEnum string
Set of constants representing the allowable values for AccessRuleRedirectResponseCodeEnum
const (
AccessRuleRedirectResponseCodeMovedPermanently AccessRuleRedirectResponseCodeEnum = "MOVED_PERMANENTLY"
AccessRuleRedirectResponseCodeFound AccessRuleRedirectResponseCodeEnum = "FOUND"
)
func GetAccessRuleRedirectResponseCodeEnumValues() []AccessRuleRedirectResponseCodeEnum
GetAccessRuleRedirectResponseCodeEnumValues Enumerates the set of values for AccessRuleRedirectResponseCodeEnum
func GetMappingAccessRuleRedirectResponseCodeEnum(val string) (AccessRuleRedirectResponseCodeEnum, bool)
GetMappingAccessRuleRedirectResponseCodeEnum performs case Insensitive comparison on enum value and return the desired enum
AddHttpResponseHeaderAction An object that represents the action of replacing or adding a header field. All prior occurrences of the header with the given name are removed and then the header field with specified value is added.
type AddHttpResponseHeaderAction struct {
// A header field name that conforms to RFC 7230.
// Example: `example_header_name`
Header *string `mandatory:"true" json:"header"`
// A header field value that conforms to RFC 7230.
// Example: `example_value`
Value *string `mandatory:"true" json:"value"`
}
func (m AddHttpResponseHeaderAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AddHttpResponseHeaderAction) String() string
func (m AddHttpResponseHeaderAction) ValidateEnumValue() (bool, error)
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
AddressList The details of the address list.
type AddressList struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the address list.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the address list's compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The user-friendly name of the address list.
DisplayName *string `mandatory:"false" json:"displayName"`
// The total number of unique IP addresses in the address list.
AddressCount *float32 `mandatory:"false" json:"addressCount"`
// The list of IP addresses or CIDR notations.
Addresses []string `mandatory:"false" json:"addresses"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The current lifecycle state of the address list.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the address list was created, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m AddressList) String() string
func (m AddressList) ValidateEnumValue() (bool, error)
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
AddressListSummary A summary of the address list's information.
type AddressListSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the address list.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the address list's compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The user-friendly name of the address list.
DisplayName *string `mandatory:"false" json:"displayName"`
// The total number of unique IP addresses in the address list.
AddressCount *float32 `mandatory:"false" json:"addressCount"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The current lifecycle state of the address list.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the address list was created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m AddressListSummary) String() string
func (m AddressListSummary) ValidateEnumValue() (bool, error)
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
AddressRateLimiting The IP rate limiting configuration. Defines the amount of allowed requests from a unique IP address and the resulting block response code when that threshold is exceeded.
type AddressRateLimiting struct {
// Enables or disables the address rate limiting Web Application Firewall feature.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The number of allowed requests per second from one IP address. If unspecified, defaults to `1`.
AllowedRatePerAddress *int `mandatory:"false" json:"allowedRatePerAddress"`
// The maximum number of requests allowed to be queued before subsequent requests are dropped. If unspecified, defaults to `10`.
MaxDelayedCountPerAddress *int `mandatory:"false" json:"maxDelayedCountPerAddress"`
// The response status code returned when a request is blocked. If unspecified, defaults to `503`. The list of available response codes: `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`.
BlockResponseCode *int `mandatory:"false" json:"blockResponseCode"`
}
func (m AddressRateLimiting) String() string
func (m AddressRateLimiting) ValidateEnumValue() (bool, error)
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
BlockChallengeSettings The challenge settings if `action` is set to `BLOCK`.
type BlockChallengeSettings struct {
// The method used to block requests that fail the challenge, if `action` is set to `BLOCK`. If unspecified, defaults to `SHOW_ERROR_PAGE`.
BlockAction BlockChallengeSettingsBlockActionEnum `mandatory:"false" json:"blockAction,omitempty"`
// The response status code to return when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE` or `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `403`. The list of available response codes: `200`, `201`, `202`, `204`, `206`, `300`, `301`, `302`, `303`, `304`, `307`, `400`, `401`, `403`, `404`, `405`, `408`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `422`, `444`, `494`, `495`, `496`, `497`, `499`, `500`, `501`, `502`, `503`, `504`, `507`.
BlockResponseCode *int `mandatory:"false" json:"blockResponseCode"`
// The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `Access to the website is blocked`.
BlockErrorPageMessage *string `mandatory:"false" json:"blockErrorPageMessage"`
// The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the request is blocked. If unspecified, defaults to `Access blocked by website owner. Please contact support.`
BlockErrorPageDescription *string `mandatory:"false" json:"blockErrorPageDescription"`
// The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE` and the request is blocked. If unspecified, defaults to `403`.
BlockErrorPageCode *string `mandatory:"false" json:"blockErrorPageCode"`
// The title used when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Are you human?`
CaptchaTitle *string `mandatory:"false" json:"captchaTitle"`
// The text to show in the header when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.`
CaptchaHeader *string `mandatory:"false" json:"captchaHeader"`
// The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, default to `Enter the letters and numbers as they are shown in image above`.
CaptchaFooter *string `mandatory:"false" json:"captchaFooter"`
// The text to show on the label of the CAPTCHA challenge submit button when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_CAPTCHA`, and the request is blocked. If unspecified, defaults to `Yes, I am human`.
CaptchaSubmitLabel *string `mandatory:"false" json:"captchaSubmitLabel"`
}
func (m BlockChallengeSettings) String() string
func (m BlockChallengeSettings) ValidateEnumValue() (bool, error)
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
BlockChallengeSettingsBlockActionEnum Enum with underlying type: string
type BlockChallengeSettingsBlockActionEnum string
Set of constants representing the allowable values for BlockChallengeSettingsBlockActionEnum
const (
BlockChallengeSettingsBlockActionSetResponseCode BlockChallengeSettingsBlockActionEnum = "SET_RESPONSE_CODE"
BlockChallengeSettingsBlockActionShowErrorPage BlockChallengeSettingsBlockActionEnum = "SHOW_ERROR_PAGE"
BlockChallengeSettingsBlockActionShowCaptcha BlockChallengeSettingsBlockActionEnum = "SHOW_CAPTCHA"
)
func GetBlockChallengeSettingsBlockActionEnumValues() []BlockChallengeSettingsBlockActionEnum
GetBlockChallengeSettingsBlockActionEnumValues Enumerates the set of values for BlockChallengeSettingsBlockActionEnum
func GetMappingBlockChallengeSettingsBlockActionEnum(val string) (BlockChallengeSettingsBlockActionEnum, bool)
GetMappingBlockChallengeSettingsBlockActionEnum performs case Insensitive comparison on enum value and return the desired enum
CachingRule The representation of CachingRule
type CachingRule struct {
// The name of the caching rule.
Name *string `mandatory:"true" json:"name"`
// The action to take when the criteria of a caching rule are met.
// - **CACHE:** Caches requested content when the criteria of the rule are met.
// - **BYPASS_CACHE:** Allows requests to bypass the cache and be directed to the origin when the criteria of the rule is met.
Action CachingRuleActionEnum `mandatory:"true" json:"action"`
// The array of the rule criteria with condition and value. The caching rule would be applied for the requests that matched any of the listed conditions.
Criteria []CachingRuleCriteria `mandatory:"true" json:"criteria"`
// The unique key for the caching rule.
Key *string `mandatory:"false" json:"key"`
// The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`.
// Example: `PT1H`
CachingDuration *string `mandatory:"false" json:"cachingDuration"`
// Enables or disables client caching.
// Browsers use the `Cache-Control` header value for caching content locally in the browser. This setting overrides the addition of a `Cache-Control` header in responses.
IsClientCachingEnabled *bool `mandatory:"false" json:"isClientCachingEnabled"`
// The duration to cache content in the user's browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`.
// Example: `PT1H`
ClientCachingDuration *string `mandatory:"false" json:"clientCachingDuration"`
}
func (m CachingRule) String() string
func (m CachingRule) ValidateEnumValue() (bool, error)
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
CachingRuleActionEnum Enum with underlying type: string
type CachingRuleActionEnum string
Set of constants representing the allowable values for CachingRuleActionEnum
const (
CachingRuleActionCache CachingRuleActionEnum = "CACHE"
CachingRuleActionBypassCache CachingRuleActionEnum = "BYPASS_CACHE"
)
func GetCachingRuleActionEnumValues() []CachingRuleActionEnum
GetCachingRuleActionEnumValues Enumerates the set of values for CachingRuleActionEnum
func GetMappingCachingRuleActionEnum(val string) (CachingRuleActionEnum, bool)
GetMappingCachingRuleActionEnum performs case Insensitive comparison on enum value and return the desired enum
CachingRuleCriteria A caching rule criteria condition and value.
type CachingRuleCriteria struct {
// The condition of the caching rule criteria.
// - **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field.
// - **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field.
// - **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field.
// - **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field.
// URLs must start with a `/`. URLs can't contain restricted double slashes `//`. URLs can't contain the restricted `'` `&` `?` symbols. Resources to cache can only be specified by a URL, any query parameters are ignored.
Condition CachingRuleCriteriaConditionEnum `mandatory:"true" json:"condition"`
// The value of the caching rule criteria.
Value *string `mandatory:"true" json:"value"`
}
func (m CachingRuleCriteria) String() string
func (m CachingRuleCriteria) ValidateEnumValue() (bool, error)
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
CachingRuleCriteriaConditionEnum Enum with underlying type: string
type CachingRuleCriteriaConditionEnum string
Set of constants representing the allowable values for CachingRuleCriteriaConditionEnum
const (
CachingRuleCriteriaConditionIs CachingRuleCriteriaConditionEnum = "URL_IS"
CachingRuleCriteriaConditionStartsWith CachingRuleCriteriaConditionEnum = "URL_STARTS_WITH"
CachingRuleCriteriaConditionPartEndsWith CachingRuleCriteriaConditionEnum = "URL_PART_ENDS_WITH"
CachingRuleCriteriaConditionPartContains CachingRuleCriteriaConditionEnum = "URL_PART_CONTAINS"
)
func GetCachingRuleCriteriaConditionEnumValues() []CachingRuleCriteriaConditionEnum
GetCachingRuleCriteriaConditionEnumValues Enumerates the set of values for CachingRuleCriteriaConditionEnum
func GetMappingCachingRuleCriteriaConditionEnum(val string) (CachingRuleCriteriaConditionEnum, bool)
GetMappingCachingRuleCriteriaConditionEnum performs case Insensitive comparison on enum value and return the desired enum
CachingRuleSummary The caching rule settings.
type CachingRuleSummary struct {
// The name of the caching rule.
Name *string `mandatory:"true" json:"name"`
// The action to take when the criteria of a caching rule are met.
// - **CACHE:** Caches requested content when the criteria of the rule are met.
// - **BYPASS_CACHE:** Allows requests to bypass the cache and be directed to the origin when the criteria of the rule is met.
Action CachingRuleSummaryActionEnum `mandatory:"true" json:"action"`
// The array of the rule criteria with condition and value. The caching rule would be applied for the requests that matched any of the listed conditions.
Criteria []CachingRuleCriteria `mandatory:"true" json:"criteria"`
// The unique key for the caching rule.
Key *string `mandatory:"false" json:"key"`
// The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`.
// Example: `PT1H`
CachingDuration *string `mandatory:"false" json:"cachingDuration"`
// Enables or disables client caching.
// Browsers use the `Cache-Control` header value for caching content locally in the browser. This setting overrides the addition of a `Cache-Control` header in responses.
IsClientCachingEnabled *bool `mandatory:"false" json:"isClientCachingEnabled"`
// The duration to cache content in the user's browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is `99`. Mixing of multiple units is not supported. Only applies when the `action` is set to `CACHE`.
// Example: `PT1H`
ClientCachingDuration *string `mandatory:"false" json:"clientCachingDuration"`
}
func (m CachingRuleSummary) String() string
func (m CachingRuleSummary) ValidateEnumValue() (bool, error)
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
CachingRuleSummaryActionEnum Enum with underlying type: string
type CachingRuleSummaryActionEnum string
Set of constants representing the allowable values for CachingRuleSummaryActionEnum
const (
CachingRuleSummaryActionCache CachingRuleSummaryActionEnum = "CACHE"
CachingRuleSummaryActionBypassCache CachingRuleSummaryActionEnum = "BYPASS_CACHE"
)
func GetCachingRuleSummaryActionEnumValues() []CachingRuleSummaryActionEnum
GetCachingRuleSummaryActionEnumValues Enumerates the set of values for CachingRuleSummaryActionEnum
func GetMappingCachingRuleSummaryActionEnum(val string) (CachingRuleSummaryActionEnum, bool)
GetMappingCachingRuleSummaryActionEnum performs case Insensitive comparison on enum value and return the desired enum
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request. This number is generated when work request is created.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)
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
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
Captcha The settings of the CAPTCHA challenge. If a specific URL should be accessed only by a human, a CAPTCHA challenge can be placed at the URL to protect the web application from bots. *Warning:* Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type Captcha struct {
// The unique URL path at which to show the CAPTCHA challenge.
Url *string `mandatory:"true" json:"url"`
// The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to `300`.
SessionExpirationInSeconds *int `mandatory:"true" json:"sessionExpirationInSeconds"`
// The title used when displaying a CAPTCHA challenge. If unspecified, defaults to `Are you human?`
Title *string `mandatory:"true" json:"title"`
// The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to `The CAPTCHA was incorrect. Try again.`
FailureMessage *string `mandatory:"true" json:"failureMessage"`
// The text to show on the label of the CAPTCHA challenge submit button. If unspecified, defaults to `Yes, I am human`.
SubmitLabel *string `mandatory:"true" json:"submitLabel"`
// The text to show in the header when showing a CAPTCHA challenge. If unspecified, defaults to 'We have detected an increased number of attempts to access this website. To help us keep this site secure, please let us know that you are not a robot by entering the text from the image below.'
HeaderText *string `mandatory:"false" json:"headerText"`
// The text to show in the footer when showing a CAPTCHA challenge. If unspecified, defaults to 'Enter the letters and numbers as they are shown in the image above.'
FooterText *string `mandatory:"false" json:"footerText"`
}
func (m Captcha) String() string
func (m Captcha) ValidateEnumValue() (bool, error)
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
Certificate The details of the SSL certificate. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type Certificate struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the certificate.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the certificate's compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The user-friendly name of the certificate.
DisplayName *string `mandatory:"true" json:"displayName"`
// A unique, positive integer assigned by the Certificate Authority (CA). The issuer name and serial number identify a unique certificate.
SerialNumber *string `mandatory:"true" json:"serialNumber"`
// The version of the encoded certificate.
Version *int `mandatory:"true" json:"version"`
// The identifier for the cryptographic algorithm used by the Certificate Authority (CA) to sign this certificate.
SignatureAlgorithm *string `mandatory:"true" json:"signatureAlgorithm"`
// The date and time the certificate will become valid, expressed in RFC 3339 timestamp format.
TimeNotValidBefore *common.SDKTime `mandatory:"true" json:"timeNotValidBefore"`
// The date and time the certificate will expire, expressed in RFC 3339 timestamp format.
TimeNotValidAfter *common.SDKTime `mandatory:"true" json:"timeNotValidAfter"`
IssuedBy *string `mandatory:"false" json:"issuedBy"`
SubjectName *CertificateSubjectName `mandatory:"false" json:"subjectName"`
IssuerName *CertificateIssuerName `mandatory:"false" json:"issuerName"`
PublicKeyInfo *CertificatePublicKeyInfo `mandatory:"false" json:"publicKeyInfo"`
// Additional attributes associated with users or public keys for managing relationships between Certificate Authorities.
Extensions []CertificateExtensions `mandatory:"false" json:"extensions"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The current lifecycle state of the SSL certificate.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the certificate was created, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// This indicates whether trust verification was disabled during the creation of SSL certificate.
// If `true` SSL certificate trust verification was disabled and this SSL certificate is most likely self-signed.
IsTrustVerificationDisabled *bool `mandatory:"false" json:"isTrustVerificationDisabled"`
// The data of the SSL certificate.
CertificateData *string `mandatory:"false" json:"certificateData"`
}
func (m Certificate) String() string
func (m Certificate) ValidateEnumValue() (bool, error)
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
CertificateExtensions The representation of CertificateExtensions
type CertificateExtensions struct {
// The certificate extension name.
Name *string `mandatory:"false" json:"name"`
// The critical flag of the extension. Critical extensions must be processed, non-critical extensions can be ignored.
IsCritical *bool `mandatory:"false" json:"isCritical"`
// The certificate extension value.
Value *string `mandatory:"false" json:"value"`
}
func (m CertificateExtensions) String() string
func (m CertificateExtensions) ValidateEnumValue() (bool, error)
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
CertificateIssuerName The issuer of the certificate.
type CertificateIssuerName struct {
// ISO 3166-1 alpha-2 code of the country where the organization is located. For a list of codes, see ISO's website (https://www.iso.org/obp/ui/#search/code/).
Country *string `mandatory:"false" json:"country"`
// The province where the organization is located.
StateProvince *string `mandatory:"false" json:"stateProvince"`
// The city in which the organization is located.
Locality *string `mandatory:"false" json:"locality"`
// The organization name.
Organization *string `mandatory:"false" json:"organization"`
// The field to differentiate between divisions within an organization.
OrganizationalUnit *string `mandatory:"false" json:"organizationalUnit"`
// The Certificate Authority (CA) name.
CommonName *string `mandatory:"false" json:"commonName"`
// The email address of the server's administrator.
EmailAddress *string `mandatory:"false" json:"emailAddress"`
}
func (m CertificateIssuerName) String() string
func (m CertificateIssuerName) ValidateEnumValue() (bool, error)
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
CertificateLifecycleStateEnum is an alias to type: LifecycleStatesEnum Consider using LifecycleStatesEnum instead Deprecated
type CertificateLifecycleStateEnum = LifecycleStatesEnum
CertificatePublicKeyInfo Information about the public key and the algorithm used by the public key.
type CertificatePublicKeyInfo struct {
// The algorithm identifier and parameters for the public key.
Algorithm *string `mandatory:"false" json:"algorithm"`
// The private key exponent.
Exponent *int `mandatory:"false" json:"exponent"`
// The number of bits in a key used by a cryptographic algorithm.
KeySize *int `mandatory:"false" json:"keySize"`
}
func (m CertificatePublicKeyInfo) String() string
func (m CertificatePublicKeyInfo) ValidateEnumValue() (bool, error)
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
CertificateSubjectName The entity to be secured by the certificate.
type CertificateSubjectName struct {
// ISO 3166-1 alpha-2 code of the country where the organization is located. For a list of codes, see ISO's website (https://www.iso.org/obp/ui/#search/code/).
Country *string `mandatory:"false" json:"country"`
// The province where the organization is located.
StateProvince *string `mandatory:"false" json:"stateProvince"`
// The city in which the organization is located.
Locality *string `mandatory:"false" json:"locality"`
// The organization name.
Organization *string `mandatory:"false" json:"organization"`
// The field to differentiate between divisions within an organization.
OrganizationalUnit *string `mandatory:"false" json:"organizationalUnit"`
// The fully qualified domain name used for DNS lookups of the server.
CommonName *string `mandatory:"false" json:"commonName"`
// The email address of the server's administrator.
EmailAddress *string `mandatory:"false" json:"emailAddress"`
}
func (m CertificateSubjectName) String() string
func (m CertificateSubjectName) ValidateEnumValue() (bool, error)
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
CertificateSummary A summary of the SSL certificate's information. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CertificateSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SSL certificate.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SSL certificate's compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The user-friendly name of the SSL certificate.
DisplayName *string `mandatory:"false" json:"displayName"`
// The date and time the certificate will expire, expressed in RFC 3339 timestamp format.
TimeNotValidAfter *common.SDKTime `mandatory:"false" json:"timeNotValidAfter"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The current lifecycle state of the certificate.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the certificate was created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m CertificateSummary) String() string
func (m CertificateSummary) ValidateEnumValue() (bool, error)
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
CertificateSummaryLifecycleStateEnum is an alias to type: LifecycleStatesEnum Consider using LifecycleStatesEnum instead Deprecated
type CertificateSummaryLifecycleStateEnum = LifecycleStatesEnum
ChangeAddressListCompartmentDetails The representation of ChangeAddressListCompartmentDetails
type ChangeAddressListCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeAddressListCompartmentDetails) String() string
func (m ChangeAddressListCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeAddressListCompartmentRequest wrapper for the ChangeAddressListCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ChangeAddressListCompartment.go.html to see an example of how to use ChangeAddressListCompartmentRequest.
type ChangeAddressListCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the address list. This number is generated when the address list is added to the compartment.
AddressListId *string `mandatory:"true" contributesTo:"path" name:"addressListId"`
ChangeAddressListCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 ChangeAddressListCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeAddressListCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeAddressListCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeAddressListCompartmentRequest) String() string
func (request ChangeAddressListCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeAddressListCompartmentResponse wrapper for the ChangeAddressListCompartment operation
type ChangeAddressListCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 ChangeAddressListCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeAddressListCompartmentResponse) String() string
ChangeCertificateCompartmentDetails The representation of ChangeCertificateCompartmentDetails
type ChangeCertificateCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
// For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeCertificateCompartmentDetails) String() string
func (m ChangeCertificateCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeCertificateCompartmentRequest wrapper for the ChangeCertificateCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ChangeCertificateCompartment.go.html to see an example of how to use ChangeCertificateCompartmentRequest.
type ChangeCertificateCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SSL certificate used in the WAAS policy. This number is generated when the certificate is added to the policy.
CertificateId *string `mandatory:"true" contributesTo:"path" name:"certificateId"`
ChangeCertificateCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 ChangeCertificateCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeCertificateCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeCertificateCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeCertificateCompartmentRequest) String() string
func (request ChangeCertificateCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeCertificateCompartmentResponse wrapper for the ChangeCertificateCompartment operation
type ChangeCertificateCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 ChangeCertificateCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeCertificateCompartmentResponse) String() string
ChangeCustomProtectionRuleCompartmentDetails The representation of ChangeCustomProtectionRuleCompartmentDetails
type ChangeCustomProtectionRuleCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeCustomProtectionRuleCompartmentDetails) String() string
func (m ChangeCustomProtectionRuleCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeCustomProtectionRuleCompartmentRequest wrapper for the ChangeCustomProtectionRuleCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ChangeCustomProtectionRuleCompartment.go.html to see an example of how to use ChangeCustomProtectionRuleCompartmentRequest.
type ChangeCustomProtectionRuleCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule. This number is generated when the custom protection rule is added to the compartment.
CustomProtectionRuleId *string `mandatory:"true" contributesTo:"path" name:"customProtectionRuleId"`
ChangeCustomProtectionRuleCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 ChangeCustomProtectionRuleCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeCustomProtectionRuleCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeCustomProtectionRuleCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeCustomProtectionRuleCompartmentRequest) String() string
func (request ChangeCustomProtectionRuleCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeCustomProtectionRuleCompartmentResponse wrapper for the ChangeCustomProtectionRuleCompartment operation
type ChangeCustomProtectionRuleCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 ChangeCustomProtectionRuleCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeCustomProtectionRuleCompartmentResponse) String() string
ChangeHttpRedirectCompartmentDetails The representation of ChangeHttpRedirectCompartmentDetails
type ChangeHttpRedirectCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeHttpRedirectCompartmentDetails) String() string
func (m ChangeHttpRedirectCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeHttpRedirectCompartmentRequest wrapper for the ChangeHttpRedirectCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ChangeHttpRedirectCompartment.go.html to see an example of how to use ChangeHttpRedirectCompartmentRequest.
type ChangeHttpRedirectCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HTTP Redirect.
HttpRedirectId *string `mandatory:"true" contributesTo:"path" name:"httpRedirectId"`
ChangeHttpRedirectCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 ChangeHttpRedirectCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeHttpRedirectCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeHttpRedirectCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeHttpRedirectCompartmentRequest) String() string
func (request ChangeHttpRedirectCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeHttpRedirectCompartmentResponse wrapper for the ChangeHttpRedirectCompartment operation
type ChangeHttpRedirectCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 ChangeHttpRedirectCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeHttpRedirectCompartmentResponse) String() string
ChangeWaasPolicyCompartmentDetails The representation of ChangeWaasPolicyCompartmentDetails
type ChangeWaasPolicyCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved.
// For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeWaasPolicyCompartmentDetails) String() string
func (m ChangeWaasPolicyCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeWaasPolicyCompartmentRequest wrapper for the ChangeWaasPolicyCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ChangeWaasPolicyCompartment.go.html to see an example of how to use ChangeWaasPolicyCompartmentRequest.
type ChangeWaasPolicyCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
ChangeWaasPolicyCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 ChangeWaasPolicyCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeWaasPolicyCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeWaasPolicyCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeWaasPolicyCompartmentRequest) String() string
func (request ChangeWaasPolicyCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeWaasPolicyCompartmentResponse wrapper for the ChangeWaasPolicyCompartment operation
type ChangeWaasPolicyCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 ChangeWaasPolicyCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeWaasPolicyCompartmentResponse) String() string
CreateAddressListDetails The data used to create a new address list of IP addresses and CIDR notations.
type CreateAddressListDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to create the address list.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name for the address list.
DisplayName *string `mandatory:"true" json:"displayName"`
// A list of IP addresses or CIDR notations.
Addresses []string `mandatory:"true" json:"addresses"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateAddressListDetails) String() string
func (m CreateAddressListDetails) ValidateEnumValue() (bool, error)
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
CreateAddressListRequest wrapper for the CreateAddressList operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/CreateAddressList.go.html to see an example of how to use CreateAddressListRequest.
type CreateAddressListRequest struct {
// The details of the address list resource to create.
CreateAddressListDetails `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateAddressListRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAddressListRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAddressListRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAddressListRequest) String() string
func (request CreateAddressListRequest) ValidateEnumValue() (bool, error)
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
CreateAddressListResponse wrapper for the CreateAddressList operation
type CreateAddressListResponse struct {
// The underlying http response
RawResponse *http.Response
// The AddressList instance
AddressList `presentIn:"body"`
// 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateAddressListResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAddressListResponse) String() string
CreateCertificateDetails The data used to create a new SSL certificate. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CreateCertificateDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to create the SSL certificate.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The data of the SSL certificate.
//
// **Note:** Many SSL certificate providers require an intermediate certificate chain to ensure a trusted status.
// If your SSL certificate requires an intermediate certificate chain, please append the intermediate certificate
// key in the `certificateData` field after the leaf certificate issued by the SSL certificate provider. If you
// are unsure if your certificate requires an intermediate certificate chain, see your certificate
// provider's documentation.
//
// The example below shows an intermediate certificate appended to a leaf certificate.
CertificateData *string `mandatory:"true" json:"certificateData"`
// The private key of the SSL certificate.
PrivateKeyData *string `mandatory:"true" json:"privateKeyData"`
// A user-friendly name for the SSL certificate. The name can be changed and does not need to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// Set to `true` if the SSL certificate is self-signed.
IsTrustVerificationDisabled *bool `mandatory:"false" json:"isTrustVerificationDisabled"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateCertificateDetails) String() string
func (m CreateCertificateDetails) ValidateEnumValue() (bool, error)
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
CreateCertificateRequest wrapper for the CreateCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/CreateCertificate.go.html to see an example of how to use CreateCertificateRequest.
type CreateCertificateRequest struct {
// The details of the SSL certificate resource to create.
CreateCertificateDetails `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCertificateRequest) String() string
func (request CreateCertificateRequest) ValidateEnumValue() (bool, error)
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
CreateCertificateResponse wrapper for the CreateCertificate operation
type CreateCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The Certificate instance
Certificate `presentIn:"body"`
// 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCertificateResponse) String() string
CreateCustomProtectionRuleDetails The required data to create a custom protection rule. For more information about custom protection rules, see Custom Protection Rules (https://docs.oracle.com/iaas/Content/WAF/Tasks/customprotectionrules.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CreateCustomProtectionRuleDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to create the custom protection rule.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name for the custom protection rule.
DisplayName *string `mandatory:"true" json:"displayName"`
// The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language.
// Additionally, each rule must include two placeholder variables that are updated by the WAF service upon publication of the rule.
// `id: {{id_1}}` - This field is populated with a unique rule ID generated by the WAF service which identifies a `SecRule`. More than one `SecRule` can be defined in the `template` field of a CreateCustomSecurityRule call. The value of the first `SecRule` must be `id: {{id_1}}` and the `id` field of each subsequent `SecRule` should increase by one, as shown in the example.
// `ctl:ruleEngine={{mode}}` - The action to be taken when the criteria of the `SecRule` are met, either `OFF`, `DETECT` or `BLOCK`. This field is automatically populated with the corresponding value of the `action` field of the `CustomProtectionRuleSetting` schema when the `WafConfig` is updated.
// *Example:*
// ```
// SecRule REQUEST_COOKIES "regex matching SQL injection - part 1/2" \
// "phase:2, \
// msg:'Detects chained SQL injection attempts 1/2.', \
// id: {{id_1}}, \
// ctl:ruleEngine={{mode}}, \
// deny"
// SecRule REQUEST_COOKIES "regex matching SQL injection - part 2/2" \
// "phase:2, \
// msg:'Detects chained SQL injection attempts 2/2.', \
// id: {{id_2}}, \
// ctl:ruleEngine={{mode}}, \
// deny"
// ```
//
// The example contains two `SecRules` each having distinct regex expression to match the `Cookie` header value during the second input analysis phase.
// For more information about custom protection rules, see Custom Protection Rules (https://docs.oracle.com/iaas/Content/WAF/Tasks/customprotectionrules.htm).
// For more information about ModSecurity syntax, see Making Rules: The Basic Syntax (https://www.modsecurity.org/CRS/Documentation/making.html).
// For more information about ModSecurity's open source WAF rules, see Mod Security's OWASP Core Rule Set documentation (https://www.modsecurity.org/CRS/Documentation/index.html).
Template *string `mandatory:"true" json:"template"`
// A description for the Custom Protection rule.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateCustomProtectionRuleDetails) String() string
func (m CreateCustomProtectionRuleDetails) ValidateEnumValue() (bool, error)
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
CreateCustomProtectionRuleRequest wrapper for the CreateCustomProtectionRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/CreateCustomProtectionRule.go.html to see an example of how to use CreateCustomProtectionRuleRequest.
type CreateCustomProtectionRuleRequest struct {
// The details of the custom protection rule.
CreateCustomProtectionRuleDetails `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateCustomProtectionRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCustomProtectionRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCustomProtectionRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCustomProtectionRuleRequest) String() string
func (request CreateCustomProtectionRuleRequest) ValidateEnumValue() (bool, error)
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
CreateCustomProtectionRuleResponse wrapper for the CreateCustomProtectionRule operation
type CreateCustomProtectionRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The CustomProtectionRule instance
CustomProtectionRule `presentIn:"body"`
// 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateCustomProtectionRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCustomProtectionRuleResponse) String() string
CreateHttpRedirectDetails The details of a HTTP Redirect configured to redirect traffic from one hostname to another. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CreateHttpRedirectDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HTTP Redirects compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The domain from which traffic will be redirected.
Domain *string `mandatory:"true" json:"domain"`
// The redirect target object including all the redirect data.
Target *HttpRedirectTarget `mandatory:"true" json:"target"`
// The user-friendly name of the HTTP Redirect. The name can be changed and does not need to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// The response code returned for the redirect to the client. For more information, see RFC 7231 (https://tools.ietf.org/html/rfc7231#section-6.4).
ResponseCode *int `mandatory:"false" json:"responseCode"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateHttpRedirectDetails) String() string
func (m CreateHttpRedirectDetails) ValidateEnumValue() (bool, error)
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
CreateHttpRedirectRequest wrapper for the CreateHttpRedirect operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/CreateHttpRedirect.go.html to see an example of how to use CreateHttpRedirectRequest.
type CreateHttpRedirectRequest struct {
// The details of the HTTP Redirect.
CreateHttpRedirectDetails `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateHttpRedirectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateHttpRedirectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateHttpRedirectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateHttpRedirectRequest) String() string
func (request CreateHttpRedirectRequest) ValidateEnumValue() (bool, error)
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
CreateHttpRedirectResponse wrapper for the CreateHttpRedirect operation
type CreateHttpRedirectResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateHttpRedirectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateHttpRedirectResponse) String() string
CreateWaasPolicyDetails The required data to create a WAAS policy. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type CreateWaasPolicyDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to create the WAAS policy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The web application domain that the WAAS policy protects.
Domain *string `mandatory:"true" json:"domain"`
// A user-friendly name for the WAAS policy. The name can be changed and does not need to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// An array of additional domains for the specified web application.
AdditionalDomains []string `mandatory:"false" json:"additionalDomains"`
// A map of host to origin for the web application. The key should be a customer friendly name for the host, ex. primary, secondary, etc.
Origins map[string]Origin `mandatory:"false" json:"origins"`
// The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests.
// To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request.
OriginGroups map[string]OriginGroup `mandatory:"false" json:"originGroups"`
PolicyConfig *PolicyConfig `mandatory:"false" json:"policyConfig"`
WafConfig *WafConfigDetails `mandatory:"false" json:"wafConfig"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateWaasPolicyDetails) String() string
func (m CreateWaasPolicyDetails) ValidateEnumValue() (bool, error)
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
CreateWaasPolicyRequest wrapper for the CreateWaasPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/CreateWaasPolicy.go.html to see an example of how to use CreateWaasPolicyRequest.
type CreateWaasPolicyRequest struct {
// The details of the WAAS policy.
CreateWaasPolicyDetails `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateWaasPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateWaasPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateWaasPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateWaasPolicyRequest) String() string
func (request CreateWaasPolicyRequest) ValidateEnumValue() (bool, error)
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
CreateWaasPolicyResponse wrapper for the CreateWaasPolicy operation
type CreateWaasPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateWaasPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateWaasPolicyResponse) String() string
CustomProtectionRule The details of a custom protection rule.
type CustomProtectionRule struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule's compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The user-friendly name of the custom protection rule.
DisplayName *string `mandatory:"false" json:"displayName"`
// The description of the custom protection rule.
Description *string `mandatory:"false" json:"description"`
// The auto-generated ID for the custom protection rule. These IDs are referenced in logs.
ModSecurityRuleIds []string `mandatory:"false" json:"modSecurityRuleIds"`
// The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language.
// Additionally, each rule must include two placeholder variables that are updated by the WAF service upon publication of the rule.
// `id: {{id_1}}` - This field is populated with a unique rule ID generated by the WAF service which identifies a `SecRule`. More than one `SecRule` can be defined in the `template` field of a CreateCustomSecurityRule call. The value of the first `SecRule` must be `id: {{id_1}}` and the `id` field of each subsequent `SecRule` should increase by one, as shown in the example.
// `ctl:ruleEngine={{mode}}` - The action to be taken when the criteria of the `SecRule` are met, either `OFF`, `DETECT` or `BLOCK`. This field is automatically populated with the corresponding value of the `action` field of the `CustomProtectionRuleSetting` schema when the `WafConfig` is updated.
// *Example:*
// ```
// SecRule REQUEST_COOKIES "regex matching SQL injection - part 1/2" \
// "phase:2, \
// msg:'Detects chained SQL injection attempts 1/2.', \
// id: {{id_1}}, \
// ctl:ruleEngine={{mode}}, \
// deny"
// SecRule REQUEST_COOKIES "regex matching SQL injection - part 2/2" \
// "phase:2, \
// msg:'Detects chained SQL injection attempts 2/2.', \
// id: {{id_2}}, \
// ctl:ruleEngine={{mode}}, \
// deny"
// ```
//
// The example contains two `SecRules` each having distinct regex expression to match the `Cookie` header value during the second input analysis phase.
// For more information about custom protection rules, see Custom Protection Rules (https://docs.oracle.com/iaas/Content/WAF/Tasks/customprotectionrules.htm).
// For more information about ModSecurity syntax, see Making Rules: The Basic Syntax (https://www.modsecurity.org/CRS/Documentation/making.html).
// For more information about ModSecurity's open source WAF rules, see Mod Security's OWASP Core Rule Set documentation (https://www.modsecurity.org/CRS/Documentation/index.html).
Template *string `mandatory:"false" json:"template"`
// The current lifecycle state of the custom protection rule.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the protection rule was created, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CustomProtectionRule) String() string
func (m CustomProtectionRule) ValidateEnumValue() (bool, error)
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
CustomProtectionRuleSetting The OCID and action of a custom protection rule.
type CustomProtectionRuleSetting struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule.
Id *string `mandatory:"false" json:"id"`
// The action to take when the custom protection rule is triggered.
// `DETECT` - Logs the request when the criteria of the custom protection rule are met. `BLOCK` - Blocks the request when the criteria of the custom protection rule are met.
Action CustomProtectionRuleSettingActionEnum `mandatory:"false" json:"action,omitempty"`
Exclusions []ProtectionRuleExclusion `mandatory:"false" json:"exclusions"`
}
func (m CustomProtectionRuleSetting) String() string
func (m CustomProtectionRuleSetting) ValidateEnumValue() (bool, error)
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
CustomProtectionRuleSettingActionEnum Enum with underlying type: string
type CustomProtectionRuleSettingActionEnum string
Set of constants representing the allowable values for CustomProtectionRuleSettingActionEnum
const (
CustomProtectionRuleSettingActionDetect CustomProtectionRuleSettingActionEnum = "DETECT"
CustomProtectionRuleSettingActionBlock CustomProtectionRuleSettingActionEnum = "BLOCK"
)
func GetCustomProtectionRuleSettingActionEnumValues() []CustomProtectionRuleSettingActionEnum
GetCustomProtectionRuleSettingActionEnumValues Enumerates the set of values for CustomProtectionRuleSettingActionEnum
func GetMappingCustomProtectionRuleSettingActionEnum(val string) (CustomProtectionRuleSettingActionEnum, bool)
GetMappingCustomProtectionRuleSettingActionEnum performs case Insensitive comparison on enum value and return the desired enum
CustomProtectionRuleSummary An overview of a custom protection rule.
type CustomProtectionRuleSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule's compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The user-friendly name of the custom protection rule.
DisplayName *string `mandatory:"false" json:"displayName"`
// The auto-generated ID for the custom protection rule. These IDs are referenced in logs.
ModSecurityRuleIds []string `mandatory:"false" json:"modSecurityRuleIds"`
// The current lifecycle state of the custom protection rule.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the protection rule was created, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CustomProtectionRuleSummary) String() string
func (m CustomProtectionRuleSummary) ValidateEnumValue() (bool, error)
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
DeleteAddressListRequest wrapper for the DeleteAddressList operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/DeleteAddressList.go.html to see an example of how to use DeleteAddressListRequest.
type DeleteAddressListRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the address list. This number is generated when the address list is added to the compartment.
AddressListId *string `mandatory:"true" contributesTo:"path" name:"addressListId"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 DeleteAddressListRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAddressListRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAddressListRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAddressListRequest) String() string
func (request DeleteAddressListRequest) ValidateEnumValue() (bool, error)
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
DeleteAddressListResponse wrapper for the DeleteAddressList operation
type DeleteAddressListResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 DeleteAddressListResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAddressListResponse) String() string
DeleteCertificateRequest wrapper for the DeleteCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/DeleteCertificate.go.html to see an example of how to use DeleteCertificateRequest.
type DeleteCertificateRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SSL certificate used in the WAAS policy. This number is generated when the certificate is added to the policy.
CertificateId *string `mandatory:"true" contributesTo:"path" name:"certificateId"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 DeleteCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteCertificateRequest) String() string
func (request DeleteCertificateRequest) ValidateEnumValue() (bool, error)
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
DeleteCertificateResponse wrapper for the DeleteCertificate operation
type DeleteCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 DeleteCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteCertificateResponse) String() string
DeleteCustomProtectionRuleRequest wrapper for the DeleteCustomProtectionRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/DeleteCustomProtectionRule.go.html to see an example of how to use DeleteCustomProtectionRuleRequest.
type DeleteCustomProtectionRuleRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule. This number is generated when the custom protection rule is added to the compartment.
CustomProtectionRuleId *string `mandatory:"true" contributesTo:"path" name:"customProtectionRuleId"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 DeleteCustomProtectionRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteCustomProtectionRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteCustomProtectionRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteCustomProtectionRuleRequest) String() string
func (request DeleteCustomProtectionRuleRequest) ValidateEnumValue() (bool, error)
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
DeleteCustomProtectionRuleResponse wrapper for the DeleteCustomProtectionRule operation
type DeleteCustomProtectionRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// 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 DeleteCustomProtectionRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteCustomProtectionRuleResponse) String() string
DeleteHttpRedirectRequest wrapper for the DeleteHttpRedirect operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/DeleteHttpRedirect.go.html to see an example of how to use DeleteHttpRedirectRequest.
type DeleteHttpRedirectRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HTTP Redirect.
HttpRedirectId *string `mandatory:"true" contributesTo:"path" name:"httpRedirectId"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 DeleteHttpRedirectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteHttpRedirectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteHttpRedirectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteHttpRedirectRequest) String() string
func (request DeleteHttpRedirectRequest) ValidateEnumValue() (bool, error)
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
DeleteHttpRedirectResponse wrapper for the DeleteHttpRedirect operation
type DeleteHttpRedirectResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteHttpRedirectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteHttpRedirectResponse) String() string
DeleteWaasPolicyRequest wrapper for the DeleteWaasPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/DeleteWaasPolicy.go.html to see an example of how to use DeleteWaasPolicyRequest.
type DeleteWaasPolicyRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 DeleteWaasPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteWaasPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteWaasPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteWaasPolicyRequest) String() string
func (request DeleteWaasPolicyRequest) ValidateEnumValue() (bool, error)
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
DeleteWaasPolicyResponse wrapper for the DeleteWaasPolicy operation
type DeleteWaasPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteWaasPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteWaasPolicyResponse) String() string
DeviceFingerprintChallenge The device fingerprint challenge settings. The device fingerprint challenge generates hashed signatures of both virtual and real browsers to identify and block malicious bots.
type DeviceFingerprintChallenge struct {
// Enables or disables the device fingerprint challenge Web Application Firewall feature.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The action to take on requests from detected bots. If unspecified, defaults to `DETECT`.
Action DeviceFingerprintChallengeActionEnum `mandatory:"false" json:"action,omitempty"`
// The number of failed requests allowed before taking action. If unspecified, defaults to `10`.
FailureThreshold *int `mandatory:"false" json:"failureThreshold"`
// The number of seconds between challenges for the same IP address. If unspecified, defaults to `60`.
ActionExpirationInSeconds *int `mandatory:"false" json:"actionExpirationInSeconds"`
// The number of seconds before the failure threshold resets. If unspecified, defaults to `60`.
FailureThresholdExpirationInSeconds *int `mandatory:"false" json:"failureThresholdExpirationInSeconds"`
// The maximum number of IP addresses permitted with the same device fingerprint. If unspecified, defaults to `20`.
MaxAddressCount *int `mandatory:"false" json:"maxAddressCount"`
// The number of seconds before the maximum addresses count resets. If unspecified, defaults to `60`.
MaxAddressCountExpirationInSeconds *int `mandatory:"false" json:"maxAddressCountExpirationInSeconds"`
ChallengeSettings *BlockChallengeSettings `mandatory:"false" json:"challengeSettings"`
}
func (m DeviceFingerprintChallenge) String() string
func (m DeviceFingerprintChallenge) ValidateEnumValue() (bool, error)
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
DeviceFingerprintChallengeActionEnum Enum with underlying type: string
type DeviceFingerprintChallengeActionEnum string
Set of constants representing the allowable values for DeviceFingerprintChallengeActionEnum
const (
DeviceFingerprintChallengeActionDetect DeviceFingerprintChallengeActionEnum = "DETECT"
DeviceFingerprintChallengeActionBlock DeviceFingerprintChallengeActionEnum = "BLOCK"
)
func GetDeviceFingerprintChallengeActionEnumValues() []DeviceFingerprintChallengeActionEnum
GetDeviceFingerprintChallengeActionEnumValues Enumerates the set of values for DeviceFingerprintChallengeActionEnum
func GetMappingDeviceFingerprintChallengeActionEnum(val string) (DeviceFingerprintChallengeActionEnum, bool)
GetMappingDeviceFingerprintChallengeActionEnum performs case Insensitive comparison on enum value and return the desired enum
EdgeSubnet The details about an edge node subnet.
type EdgeSubnet struct {
// An edge node subnet. This can include /24 or /8 addresses.
Cidr *string `mandatory:"false" json:"cidr"`
// The date and time the last change was made to the indicated edge node subnet, expressed in RFC 3339 timestamp format.
TimeModified *common.SDKTime `mandatory:"false" json:"timeModified"`
// The name of the region containing the indicated subnet.
Region *string `mandatory:"false" json:"region"`
}
func (m EdgeSubnet) String() string
func (m EdgeSubnet) ValidateEnumValue() (bool, error)
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
ExtendHttpResponseHeaderAction An object that represents the action of adding a header field to a response. If the header with specified value already exists, nothing will be added. If the header exists with different value, additional header name:value pair will be added. Comma separated header values are not considered individually (instead as a single value) when adding a new header field.
type ExtendHttpResponseHeaderAction struct {
// A header field name that conforms to RFC 7230.
// Example: `example_header_name`
Header *string `mandatory:"true" json:"header"`
// A header field value that conforms to RFC 7230.
// Example: `example_value`
Value *string `mandatory:"true" json:"value"`
}
func (m ExtendHttpResponseHeaderAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ExtendHttpResponseHeaderAction) String() string
func (m ExtendHttpResponseHeaderAction) ValidateEnumValue() (bool, error)
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
GetAddressListRequest wrapper for the GetAddressList operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetAddressList.go.html to see an example of how to use GetAddressListRequest.
type GetAddressListRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the address list. This number is generated when the address list is added to the compartment.
AddressListId *string `mandatory:"true" contributesTo:"path" name:"addressListId"`
// 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"`
// 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 GetAddressListRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAddressListRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAddressListRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAddressListRequest) String() string
func (request GetAddressListRequest) ValidateEnumValue() (bool, error)
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
GetAddressListResponse wrapper for the GetAddressList operation
type GetAddressListResponse struct {
// The underlying http response
RawResponse *http.Response
// The AddressList instance
AddressList `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetAddressListResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAddressListResponse) String() string
GetCertificateRequest wrapper for the GetCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetCertificate.go.html to see an example of how to use GetCertificateRequest.
type GetCertificateRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SSL certificate used in the WAAS policy. This number is generated when the certificate is added to the policy.
CertificateId *string `mandatory:"true" contributesTo:"path" name:"certificateId"`
// 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"`
// 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 GetCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCertificateRequest) String() string
func (request GetCertificateRequest) ValidateEnumValue() (bool, error)
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
GetCertificateResponse wrapper for the GetCertificate operation
type GetCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The Certificate instance
Certificate `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCertificateResponse) String() string
GetCustomProtectionRuleRequest wrapper for the GetCustomProtectionRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetCustomProtectionRule.go.html to see an example of how to use GetCustomProtectionRuleRequest.
type GetCustomProtectionRuleRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule. This number is generated when the custom protection rule is added to the compartment.
CustomProtectionRuleId *string `mandatory:"true" contributesTo:"path" name:"customProtectionRuleId"`
// 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"`
// 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 GetCustomProtectionRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCustomProtectionRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCustomProtectionRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCustomProtectionRuleRequest) String() string
func (request GetCustomProtectionRuleRequest) ValidateEnumValue() (bool, error)
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
GetCustomProtectionRuleResponse wrapper for the GetCustomProtectionRule operation
type GetCustomProtectionRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The CustomProtectionRule instance
CustomProtectionRule `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetCustomProtectionRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCustomProtectionRuleResponse) String() string
GetDeviceFingerprintChallengeRequest wrapper for the GetDeviceFingerprintChallenge operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetDeviceFingerprintChallenge.go.html to see an example of how to use GetDeviceFingerprintChallengeRequest.
type GetDeviceFingerprintChallengeRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 GetDeviceFingerprintChallengeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDeviceFingerprintChallengeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDeviceFingerprintChallengeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDeviceFingerprintChallengeRequest) String() string
func (request GetDeviceFingerprintChallengeRequest) ValidateEnumValue() (bool, error)
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
GetDeviceFingerprintChallengeResponse wrapper for the GetDeviceFingerprintChallenge operation
type GetDeviceFingerprintChallengeResponse struct {
// The underlying http response
RawResponse *http.Response
// The DeviceFingerprintChallenge instance
DeviceFingerprintChallenge `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetDeviceFingerprintChallengeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDeviceFingerprintChallengeResponse) String() string
GetHttpRedirectRequest wrapper for the GetHttpRedirect operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetHttpRedirect.go.html to see an example of how to use GetHttpRedirectRequest.
type GetHttpRedirectRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HTTP Redirect.
HttpRedirectId *string `mandatory:"true" contributesTo:"path" name:"httpRedirectId"`
// 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"`
// 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 GetHttpRedirectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetHttpRedirectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetHttpRedirectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetHttpRedirectRequest) String() string
func (request GetHttpRedirectRequest) ValidateEnumValue() (bool, error)
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
GetHttpRedirectResponse wrapper for the GetHttpRedirect operation
type GetHttpRedirectResponse struct {
// The underlying http response
RawResponse *http.Response
// The HttpRedirect instance
HttpRedirect `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetHttpRedirectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetHttpRedirectResponse) String() string
GetHumanInteractionChallengeRequest wrapper for the GetHumanInteractionChallenge operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetHumanInteractionChallenge.go.html to see an example of how to use GetHumanInteractionChallengeRequest.
type GetHumanInteractionChallengeRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 GetHumanInteractionChallengeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetHumanInteractionChallengeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetHumanInteractionChallengeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetHumanInteractionChallengeRequest) String() string
func (request GetHumanInteractionChallengeRequest) ValidateEnumValue() (bool, error)
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
GetHumanInteractionChallengeResponse wrapper for the GetHumanInteractionChallenge operation
type GetHumanInteractionChallengeResponse struct {
// The underlying http response
RawResponse *http.Response
// The HumanInteractionChallenge instance
HumanInteractionChallenge `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetHumanInteractionChallengeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetHumanInteractionChallengeResponse) String() string
GetJsChallengeRequest wrapper for the GetJsChallenge operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetJsChallenge.go.html to see an example of how to use GetJsChallengeRequest.
type GetJsChallengeRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 GetJsChallengeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetJsChallengeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetJsChallengeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetJsChallengeRequest) String() string
func (request GetJsChallengeRequest) ValidateEnumValue() (bool, error)
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
GetJsChallengeResponse wrapper for the GetJsChallenge operation
type GetJsChallengeResponse struct {
// The underlying http response
RawResponse *http.Response
// The JsChallenge instance
JsChallenge `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetJsChallengeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetJsChallengeResponse) String() string
GetPolicyConfigRequest wrapper for the GetPolicyConfig operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetPolicyConfig.go.html to see an example of how to use GetPolicyConfigRequest.
type GetPolicyConfigRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 GetPolicyConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPolicyConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPolicyConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPolicyConfigRequest) String() string
func (request GetPolicyConfigRequest) ValidateEnumValue() (bool, error)
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
GetPolicyConfigResponse wrapper for the GetPolicyConfig operation
type GetPolicyConfigResponse struct {
// The underlying http response
RawResponse *http.Response
// The PolicyConfig instance
PolicyConfig `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetPolicyConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPolicyConfigResponse) String() string
GetProtectionRuleRequest wrapper for the GetProtectionRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetProtectionRule.go.html to see an example of how to use GetProtectionRuleRequest.
type GetProtectionRuleRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
// The protection rule key.
ProtectionRuleKey *string `mandatory:"true" contributesTo:"path" name:"protectionRuleKey"`
// 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"`
// 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 GetProtectionRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetProtectionRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetProtectionRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetProtectionRuleRequest) String() string
func (request GetProtectionRuleRequest) ValidateEnumValue() (bool, error)
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
GetProtectionRuleResponse wrapper for the GetProtectionRule operation
type GetProtectionRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The ProtectionRule instance
ProtectionRule `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetProtectionRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetProtectionRuleResponse) String() string
GetProtectionSettingsRequest wrapper for the GetProtectionSettings operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetProtectionSettings.go.html to see an example of how to use GetProtectionSettingsRequest.
type GetProtectionSettingsRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 GetProtectionSettingsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetProtectionSettingsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetProtectionSettingsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetProtectionSettingsRequest) String() string
func (request GetProtectionSettingsRequest) ValidateEnumValue() (bool, error)
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
GetProtectionSettingsResponse wrapper for the GetProtectionSettings operation
type GetProtectionSettingsResponse struct {
// The underlying http response
RawResponse *http.Response
// The ProtectionSettings instance
ProtectionSettings `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetProtectionSettingsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetProtectionSettingsResponse) String() string
GetWaasPolicyRequest wrapper for the GetWaasPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetWaasPolicy.go.html to see an example of how to use GetWaasPolicyRequest.
type GetWaasPolicyRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 GetWaasPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWaasPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWaasPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWaasPolicyRequest) String() string
func (request GetWaasPolicyRequest) ValidateEnumValue() (bool, error)
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
GetWaasPolicyResponse wrapper for the GetWaasPolicy operation
type GetWaasPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// The WaasPolicy instance
WaasPolicy `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetWaasPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWaasPolicyResponse) String() string
GetWafAddressRateLimitingRequest wrapper for the GetWafAddressRateLimiting operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetWafAddressRateLimiting.go.html to see an example of how to use GetWafAddressRateLimitingRequest.
type GetWafAddressRateLimitingRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 GetWafAddressRateLimitingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWafAddressRateLimitingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWafAddressRateLimitingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWafAddressRateLimitingRequest) String() string
func (request GetWafAddressRateLimitingRequest) ValidateEnumValue() (bool, error)
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
GetWafAddressRateLimitingResponse wrapper for the GetWafAddressRateLimiting operation
type GetWafAddressRateLimitingResponse struct {
// The underlying http response
RawResponse *http.Response
// The AddressRateLimiting instance
AddressRateLimiting `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetWafAddressRateLimitingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWafAddressRateLimitingResponse) String() string
GetWafConfigRequest wrapper for the GetWafConfig operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetWafConfig.go.html to see an example of how to use GetWafConfigRequest.
type GetWafConfigRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 GetWafConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWafConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWafConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWafConfigRequest) String() string
func (request GetWafConfigRequest) ValidateEnumValue() (bool, error)
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
GetWafConfigResponse wrapper for the GetWafConfig operation
type GetWafConfigResponse struct {
// The underlying http response
RawResponse *http.Response
// The WafConfig instance
WafConfig `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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 GetWafConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWafConfigResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request. This number is generated when work request is created.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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"`
// 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 GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
// 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 GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
GoodBot The good bot settings. Good bots provides a list of bots which are managed by known providers.
type GoodBot struct {
// The unique key for the bot.
Key *string `mandatory:"true" json:"key"`
// Enables or disables the bot.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The bot name.
Name *string `mandatory:"false" json:"name"`
// The description of the bot.
Description *string `mandatory:"false" json:"description"`
}
func (m GoodBot) String() string
func (m GoodBot) ValidateEnumValue() (bool, error)
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
Header An HTTP header with name and value.
type Header struct {
// The name of the header.
Name *string `mandatory:"true" json:"name"`
// The value of the header.
Value *string `mandatory:"true" json:"value"`
}
func (m Header) String() string
func (m Header) ValidateEnumValue() (bool, error)
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
HeaderManipulationAction An object that represents an action to apply to an HTTP headers.
type HeaderManipulationAction interface {
}
HeaderManipulationActionActionEnum Enum with underlying type: string
type HeaderManipulationActionActionEnum string
Set of constants representing the allowable values for HeaderManipulationActionActionEnum
const (
HeaderManipulationActionActionExtendHttpResponseHeader HeaderManipulationActionActionEnum = "EXTEND_HTTP_RESPONSE_HEADER"
HeaderManipulationActionActionAddHttpResponseHeader HeaderManipulationActionActionEnum = "ADD_HTTP_RESPONSE_HEADER"
HeaderManipulationActionActionRemoveHttpResponseHeader HeaderManipulationActionActionEnum = "REMOVE_HTTP_RESPONSE_HEADER"
)
func GetHeaderManipulationActionActionEnumValues() []HeaderManipulationActionActionEnum
GetHeaderManipulationActionActionEnumValues Enumerates the set of values for HeaderManipulationActionActionEnum
func GetMappingHeaderManipulationActionActionEnum(val string) (HeaderManipulationActionActionEnum, bool)
GetMappingHeaderManipulationActionActionEnum performs case Insensitive comparison on enum value and return the desired enum
HealthCheck Health checks monitor the status of your origin servers and only route traffic to the origins that pass the health check. If the health check fails, origin is automatically removed from the load balancing. There is roughly one health check per EDGE POP per period. Any checks that pass will be reported as "healthy".
type HealthCheck struct {
// Enables or disables the health checks.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// An HTTP verb (i.e. HEAD, GET, or POST) to use when performing the health check.
Method HealthCheckMethodEnum `mandatory:"false" json:"method,omitempty"`
// Path to visit on your origins when performing the health check.
Path *string `mandatory:"false" json:"path"`
// HTTP header fields to include in health check requests, expressed as `"name": "value"` properties. Because HTTP header field names are case-insensitive, any use of names that are case-insensitive equal to other names will be rejected. If Host is not specified, requests will include a Host header field with value matching the policy's protected domain. If User-Agent is not specified, requests will include a User-Agent header field with value "waf health checks".
// **Note:** The only currently-supported header fields are Host and User-Agent.
Headers map[string]string `mandatory:"false" json:"headers"`
// The HTTP response codes that signify a healthy state.
// - **2XX:** Success response code group.
// - **3XX:** Redirection response code group.
// - **4XX:** Client errors response code group.
// - **5XX:** Server errors response code group.
ExpectedResponseCodeGroup []HealthCheckExpectedResponseCodeGroupEnum `mandatory:"false" json:"expectedResponseCodeGroup,omitempty"`
// Enables or disables additional check for predefined text in addition to response code.
IsResponseTextCheckEnabled *bool `mandatory:"false" json:"isResponseTextCheckEnabled"`
// Health check will search for the given text in a case-sensitive manner within the response body and will fail if the text is not found.
ExpectedResponseText *string `mandatory:"false" json:"expectedResponseText"`
// Time between health checks of an individual origin server, in seconds.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Response timeout represents wait time until request is considered failed, in seconds.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
// Number of successful health checks after which the server is marked up.
HealthyThreshold *int `mandatory:"false" json:"healthyThreshold"`
// Number of failed health checks after which the server is marked down.
UnhealthyThreshold *int `mandatory:"false" json:"unhealthyThreshold"`
}
func (m HealthCheck) String() string
func (m HealthCheck) ValidateEnumValue() (bool, error)
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
HealthCheckExpectedResponseCodeGroupEnum Enum with underlying type: string
type HealthCheckExpectedResponseCodeGroupEnum string
Set of constants representing the allowable values for HealthCheckExpectedResponseCodeGroupEnum
const (
HealthCheckExpectedResponseCodeGroup2xx HealthCheckExpectedResponseCodeGroupEnum = "2XX"
HealthCheckExpectedResponseCodeGroup3xx HealthCheckExpectedResponseCodeGroupEnum = "3XX"
HealthCheckExpectedResponseCodeGroup4xx HealthCheckExpectedResponseCodeGroupEnum = "4XX"
HealthCheckExpectedResponseCodeGroup5xx HealthCheckExpectedResponseCodeGroupEnum = "5XX"
)
func GetHealthCheckExpectedResponseCodeGroupEnumValues() []HealthCheckExpectedResponseCodeGroupEnum
GetHealthCheckExpectedResponseCodeGroupEnumValues Enumerates the set of values for HealthCheckExpectedResponseCodeGroupEnum
func GetMappingHealthCheckExpectedResponseCodeGroupEnum(val string) (HealthCheckExpectedResponseCodeGroupEnum, bool)
GetMappingHealthCheckExpectedResponseCodeGroupEnum performs case Insensitive comparison on enum value and return the desired enum
HealthCheckMethodEnum Enum with underlying type: string
type HealthCheckMethodEnum string
Set of constants representing the allowable values for HealthCheckMethodEnum
const (
HealthCheckMethodGet HealthCheckMethodEnum = "GET"
HealthCheckMethodHead HealthCheckMethodEnum = "HEAD"
HealthCheckMethodPost HealthCheckMethodEnum = "POST"
)
func GetHealthCheckMethodEnumValues() []HealthCheckMethodEnum
GetHealthCheckMethodEnumValues Enumerates the set of values for HealthCheckMethodEnum
func GetMappingHealthCheckMethodEnum(val string) (HealthCheckMethodEnum, bool)
GetMappingHealthCheckMethodEnum performs case Insensitive comparison on enum value and return the desired enum
HttpRedirect The details of a HTTP Redirect configuration to allow redirecting HTTP traffic from a request domain to a new target. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type HttpRedirect struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HTTP Redirect.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HTTP Redirect's compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The user-friendly name of the HTTP Redirect. The name can be changed and does not need to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// The domain from which traffic will be redirected.
Domain *string `mandatory:"false" json:"domain"`
// The redirect target object including all the redirect data.
Target *HttpRedirectTarget `mandatory:"false" json:"target"`
// The response code returned for the redirect to the client. For more information, see RFC 7231 (https://tools.ietf.org/html/rfc7231#section-6.4).
ResponseCode *int `mandatory:"false" json:"responseCode"`
// The date and time the policy was created, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The current lifecycle state of the HTTP Redirect.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m HttpRedirect) String() string
func (m HttpRedirect) ValidateEnumValue() (bool, error)
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
HttpRedirectSummary The details of a HTTP Redirect configuration to allow redirecting HTTP traffic from a request domain to a new target. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type HttpRedirectSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HTTP Redirect.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HTTP Redirect's compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The user-friendly name of the HTTP Redirect. The name can be changed and does not need to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// The domain from which traffic will be redirected.
Domain *string `mandatory:"false" json:"domain"`
// The redirect target object including all the redirect data.
Target *HttpRedirectTarget `mandatory:"false" json:"target"`
// The response code returned for the redirect to the client. For more information, see RFC 7231 (https://tools.ietf.org/html/rfc7231#section-6.4).
ResponseCode *int `mandatory:"false" json:"responseCode"`
// The current lifecycle state of the HTTP Redirect.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the policy was created, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m HttpRedirectSummary) String() string
func (m HttpRedirectSummary) ValidateEnumValue() (bool, error)
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
HttpRedirectTarget The representation of HttpRedirectTarget
type HttpRedirectTarget struct {
// The protocol used for the target, http or https.
Protocol HttpRedirectTargetProtocolEnum `mandatory:"true" json:"protocol"`
// The host portion of the redirect.
Host *string `mandatory:"true" json:"host"`
// The path component of the target URL (e.g., "/path/to/resource" in "https://target.example.com/path/to/resource?redirected"), which can be empty, static, or request-copying, or request-prefixing. Use of \ is not permitted except to escape a following \, {, or }. An empty value is treated the same as static "/". A static value must begin with a leading "/", optionally followed by other path characters. A request-copying value must exactly match "{path}", and will be replaced with the path component of the request URL (including its initial "/"). A request-prefixing value must start with "/" and end with a non-escaped "{path}", which will be replaced with the path component of the request URL (including its initial "/"). Only one such replacement token is allowed.
Path *string `mandatory:"true" json:"path"`
// The query component of the target URL (e.g., "?redirected" in "https://target.example.com/path/to/resource?redirected"), which can be empty, static, or request-copying. Use of \ is not permitted except to escape a following \, {, or }. An empty value results in a redirection target URL with no query component. A static value must begin with a leading "?", optionally followed by other query characters. A request-copying value must exactly match "{query}", and will be replaced with the query component of the request URL (including a leading "?" if and only if the request URL includes a query component).
Query *string `mandatory:"true" json:"query"`
// Port number of the target destination of the redirect, default to match protocol
Port *int `mandatory:"false" json:"port"`
}
func (m HttpRedirectTarget) String() string
func (m HttpRedirectTarget) ValidateEnumValue() (bool, error)
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
HttpRedirectTargetProtocolEnum Enum with underlying type: string
type HttpRedirectTargetProtocolEnum string
Set of constants representing the allowable values for HttpRedirectTargetProtocolEnum
const (
HttpRedirectTargetProtocolHttp HttpRedirectTargetProtocolEnum = "HTTP"
HttpRedirectTargetProtocolHttps HttpRedirectTargetProtocolEnum = "HTTPS"
)
func GetHttpRedirectTargetProtocolEnumValues() []HttpRedirectTargetProtocolEnum
GetHttpRedirectTargetProtocolEnumValues Enumerates the set of values for HttpRedirectTargetProtocolEnum
func GetMappingHttpRedirectTargetProtocolEnum(val string) (HttpRedirectTargetProtocolEnum, bool)
GetMappingHttpRedirectTargetProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
HumanInteractionChallenge The human interaction challenge settings. The human interaction challenge checks various event listeners in the user's browser to determine if there is a human user making a request.
type HumanInteractionChallenge struct {
// Enables or disables the human interaction challenge Web Application Firewall feature.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The action to take against requests from detected bots. If unspecified, defaults to `DETECT`.
Action HumanInteractionChallengeActionEnum `mandatory:"false" json:"action,omitempty"`
// The number of failed requests before taking action. If unspecified, defaults to `10`.
FailureThreshold *int `mandatory:"false" json:"failureThreshold"`
// The number of seconds between challenges for the same IP address. If unspecified, defaults to `60`.
ActionExpirationInSeconds *int `mandatory:"false" json:"actionExpirationInSeconds"`
// The number of seconds before the failure threshold resets. If unspecified, defaults to `60`.
FailureThresholdExpirationInSeconds *int `mandatory:"false" json:"failureThresholdExpirationInSeconds"`
// The number of interactions required to pass the challenge. If unspecified, defaults to `3`.
InteractionThreshold *int `mandatory:"false" json:"interactionThreshold"`
// The number of seconds to record the interactions from the user. If unspecified, defaults to `15`.
RecordingPeriodInSeconds *int `mandatory:"false" json:"recordingPeriodInSeconds"`
// Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the `action` is set to `DETECT`.
SetHttpHeader *Header `mandatory:"false" json:"setHttpHeader"`
ChallengeSettings *BlockChallengeSettings `mandatory:"false" json:"challengeSettings"`
// When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses.
IsNatEnabled *bool `mandatory:"false" json:"isNatEnabled"`
}
func (m HumanInteractionChallenge) String() string
func (m HumanInteractionChallenge) ValidateEnumValue() (bool, error)
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
HumanInteractionChallengeActionEnum Enum with underlying type: string
type HumanInteractionChallengeActionEnum string
Set of constants representing the allowable values for HumanInteractionChallengeActionEnum
const (
HumanInteractionChallengeActionDetect HumanInteractionChallengeActionEnum = "DETECT"
HumanInteractionChallengeActionBlock HumanInteractionChallengeActionEnum = "BLOCK"
)
func GetHumanInteractionChallengeActionEnumValues() []HumanInteractionChallengeActionEnum
GetHumanInteractionChallengeActionEnumValues Enumerates the set of values for HumanInteractionChallengeActionEnum
func GetMappingHumanInteractionChallengeActionEnum(val string) (HumanInteractionChallengeActionEnum, bool)
GetMappingHumanInteractionChallengeActionEnum performs case Insensitive comparison on enum value and return the desired enum
IpHashLoadBalancingMethod An object that represents the `ip-hash` load balancing method.
type IpHashLoadBalancingMethod struct {
}
func (m IpHashLoadBalancingMethod) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m IpHashLoadBalancingMethod) String() string
func (m IpHashLoadBalancingMethod) ValidateEnumValue() (bool, error)
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
JsChallenge The JavaScript challenge settings. JavaScript Challenge is the function to filter abnormal or malicious bots and allow access to real clients.
type JsChallenge struct {
// Enables or disables the JavaScript challenge Web Application Firewall feature.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The action to take against requests from detected bots. If unspecified, defaults to `DETECT`.
Action JsChallengeActionEnum `mandatory:"false" json:"action,omitempty"`
// The number of failed requests before taking action. If unspecified, defaults to `10`.
FailureThreshold *int `mandatory:"false" json:"failureThreshold"`
// The number of seconds between challenges from the same IP address. If unspecified, defaults to `60`.
ActionExpirationInSeconds *int `mandatory:"false" json:"actionExpirationInSeconds"`
// Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the `action` is set to `DETECT`.
SetHttpHeader *Header `mandatory:"false" json:"setHttpHeader"`
ChallengeSettings *BlockChallengeSettings `mandatory:"false" json:"challengeSettings"`
// When enabled, redirect responses from the origin will also be challenged. This will change HTTP 301/302 responses from origin to HTTP 200 with an HTML body containing JavaScript page redirection.
AreRedirectsChallenged *bool `mandatory:"false" json:"areRedirectsChallenged"`
// When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions.
Criteria []AccessRuleCriteria `mandatory:"false" json:"criteria"`
// When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses.
IsNatEnabled *bool `mandatory:"false" json:"isNatEnabled"`
}
func (m JsChallenge) String() string
func (m JsChallenge) ValidateEnumValue() (bool, error)
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
JsChallengeActionEnum Enum with underlying type: string
type JsChallengeActionEnum string
Set of constants representing the allowable values for JsChallengeActionEnum
const (
JsChallengeActionDetect JsChallengeActionEnum = "DETECT"
JsChallengeActionBlock JsChallengeActionEnum = "BLOCK"
)
func GetJsChallengeActionEnumValues() []JsChallengeActionEnum
GetJsChallengeActionEnumValues Enumerates the set of values for JsChallengeActionEnum
func GetMappingJsChallengeActionEnum(val string) (JsChallengeActionEnum, bool)
GetMappingJsChallengeActionEnum performs case Insensitive comparison on enum value and return the desired enum
LifecycleStatesEnum Enum with underlying type: string
type LifecycleStatesEnum string
Set of constants representing the allowable values for LifecycleStatesEnum Deprecated
const (
CertificateLifecycleStateCreating LifecycleStatesEnum = "CREATING"
CertificateLifecycleStateActive LifecycleStatesEnum = "ACTIVE"
CertificateLifecycleStateFailed LifecycleStatesEnum = "FAILED"
CertificateLifecycleStateUpdating LifecycleStatesEnum = "UPDATING"
CertificateLifecycleStateDeleting LifecycleStatesEnum = "DELETING"
CertificateLifecycleStateDeleted LifecycleStatesEnum = "DELETED"
)
Set of constants representing the allowable values for LifecycleStatesEnum Deprecated
const (
CertificateSummaryLifecycleStateCreating LifecycleStatesEnum = "CREATING"
CertificateSummaryLifecycleStateActive LifecycleStatesEnum = "ACTIVE"
CertificateSummaryLifecycleStateFailed LifecycleStatesEnum = "FAILED"
CertificateSummaryLifecycleStateUpdating LifecycleStatesEnum = "UPDATING"
CertificateSummaryLifecycleStateDeleting LifecycleStatesEnum = "DELETING"
CertificateSummaryLifecycleStateDeleted LifecycleStatesEnum = "DELETED"
)
Set of constants representing the allowable values for LifecycleStatesEnum
const (
LifecycleStatesCreating LifecycleStatesEnum = "CREATING"
LifecycleStatesActive LifecycleStatesEnum = "ACTIVE"
LifecycleStatesFailed LifecycleStatesEnum = "FAILED"
LifecycleStatesUpdating LifecycleStatesEnum = "UPDATING"
LifecycleStatesDeleting LifecycleStatesEnum = "DELETING"
LifecycleStatesDeleted LifecycleStatesEnum = "DELETED"
)
Set of constants representing the allowable values for LifecycleStatesEnum Deprecated
const (
WaasPolicyLifecycleStateCreating LifecycleStatesEnum = "CREATING"
WaasPolicyLifecycleStateActive LifecycleStatesEnum = "ACTIVE"
WaasPolicyLifecycleStateFailed LifecycleStatesEnum = "FAILED"
WaasPolicyLifecycleStateUpdating LifecycleStatesEnum = "UPDATING"
WaasPolicyLifecycleStateDeleting LifecycleStatesEnum = "DELETING"
WaasPolicyLifecycleStateDeleted LifecycleStatesEnum = "DELETED"
)
Set of constants representing the allowable values for LifecycleStatesEnum Deprecated
const (
WaasPolicySummaryLifecycleStateCreating LifecycleStatesEnum = "CREATING"
WaasPolicySummaryLifecycleStateActive LifecycleStatesEnum = "ACTIVE"
WaasPolicySummaryLifecycleStateFailed LifecycleStatesEnum = "FAILED"
WaasPolicySummaryLifecycleStateUpdating LifecycleStatesEnum = "UPDATING"
WaasPolicySummaryLifecycleStateDeleting LifecycleStatesEnum = "DELETING"
WaasPolicySummaryLifecycleStateDeleted LifecycleStatesEnum = "DELETED"
)
func GetLifecycleStatesEnumValues() []LifecycleStatesEnum
GetLifecycleStatesEnumValues Enumerates the set of values for LifecycleStatesEnum
func GetMappingLifecycleStatesEnum(val string) (LifecycleStatesEnum, bool)
GetMappingLifecycleStatesEnum performs case Insensitive comparison on enum value and return the desired enum
ListAccessRulesRequest wrapper for the ListAccessRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListAccessRules.go.html to see an example of how to use ListAccessRulesRequest.
type ListAccessRulesRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 ListAccessRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAccessRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAccessRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAccessRulesRequest) String() string
func (request ListAccessRulesRequest) ValidateEnumValue() (bool, error)
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
ListAccessRulesResponse wrapper for the ListAccessRules operation
type ListAccessRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []AccessRule instances
Items []AccessRule `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.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 ListAccessRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAccessRulesResponse) String() string
ListAddressListsRequest wrapper for the ListAddressLists operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListAddressLists.go.html to see an example of how to use ListAddressListsRequest.
type ListAddressListsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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"`
// The value by which address lists are sorted in a paginated 'List' call. If unspecified, defaults to `timeCreated`.
SortBy ListAddressListsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`.
SortOrder ListAddressListsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Filter address lists using a list of address lists OCIDs.
Id []string `contributesTo:"query" name:"id" collectionFormat:"multi"`
// Filter address lists using a list of names.
Name []string `contributesTo:"query" name:"name" collectionFormat:"multi"`
// Filter address lists using a list of lifecycle states.
LifecycleState []LifecycleStatesEnum `contributesTo:"query" name:"lifecycleState" omitEmpty:"true" collectionFormat:"multi"`
// A filter that matches address lists created on or after the specified date-time.
TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"`
// A filter that matches address lists created before the specified date-time.
TimeCreatedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedLessThan"`
// 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 ListAddressListsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAddressListsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAddressListsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAddressListsRequest) String() string
func (request ListAddressListsRequest) ValidateEnumValue() (bool, error)
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
ListAddressListsResponse wrapper for the ListAddressLists operation
type ListAddressListsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []AddressListSummary instances
Items []AddressListSummary `presentIn:"body"`
// 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.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 ListAddressListsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAddressListsResponse) String() string
ListAddressListsSortByEnum Enum with underlying type: string
type ListAddressListsSortByEnum string
Set of constants representing the allowable values for ListAddressListsSortByEnum
const (
ListAddressListsSortById ListAddressListsSortByEnum = "id"
ListAddressListsSortByName ListAddressListsSortByEnum = "name"
ListAddressListsSortByTimecreated ListAddressListsSortByEnum = "timeCreated"
)
func GetListAddressListsSortByEnumValues() []ListAddressListsSortByEnum
GetListAddressListsSortByEnumValues Enumerates the set of values for ListAddressListsSortByEnum
func GetMappingListAddressListsSortByEnum(val string) (ListAddressListsSortByEnum, bool)
GetMappingListAddressListsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAddressListsSortOrderEnum Enum with underlying type: string
type ListAddressListsSortOrderEnum string
Set of constants representing the allowable values for ListAddressListsSortOrderEnum
const (
ListAddressListsSortOrderAsc ListAddressListsSortOrderEnum = "ASC"
ListAddressListsSortOrderDesc ListAddressListsSortOrderEnum = "DESC"
)
func GetListAddressListsSortOrderEnumValues() []ListAddressListsSortOrderEnum
GetListAddressListsSortOrderEnumValues Enumerates the set of values for ListAddressListsSortOrderEnum
func GetMappingListAddressListsSortOrderEnum(val string) (ListAddressListsSortOrderEnum, bool)
GetMappingListAddressListsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListCachingRulesRequest wrapper for the ListCachingRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListCachingRules.go.html to see an example of how to use ListCachingRulesRequest.
type ListCachingRulesRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 ListCachingRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCachingRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCachingRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCachingRulesRequest) String() string
func (request ListCachingRulesRequest) ValidateEnumValue() (bool, error)
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
ListCachingRulesResponse wrapper for the ListCachingRules operation
type ListCachingRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []CachingRuleSummary instances
Items []CachingRuleSummary `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.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 ListCachingRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCachingRulesResponse) String() string
ListCaptchasRequest wrapper for the ListCaptchas operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListCaptchas.go.html to see an example of how to use ListCaptchasRequest.
type ListCaptchasRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 ListCaptchasRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCaptchasRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCaptchasRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCaptchasRequest) String() string
func (request ListCaptchasRequest) ValidateEnumValue() (bool, error)
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
ListCaptchasResponse wrapper for the ListCaptchas operation
type ListCaptchasResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []Captcha instances
Items []Captcha `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.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 ListCaptchasResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCaptchasResponse) String() string
ListCertificatesRequest wrapper for the ListCertificates operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListCertificates.go.html to see an example of how to use ListCertificatesRequest.
type ListCertificatesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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"`
// The value by which certificate summaries are sorted in a paginated 'List' call. If unspecified, defaults to `timeCreated`.
SortBy ListCertificatesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`.
SortOrder ListCertificatesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Filter certificates using a list of certificates OCIDs.
Id []string `contributesTo:"query" name:"id" collectionFormat:"multi"`
// Filter certificates using a list of display names.
DisplayName []string `contributesTo:"query" name:"displayName" collectionFormat:"multi"`
// Filter certificates using a list of lifecycle states.
LifecycleState []LifecycleStatesEnum `contributesTo:"query" name:"lifecycleState" omitEmpty:"true" collectionFormat:"multi"`
// A filter that matches certificates created on or after the specified date-time.
TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"`
// A filter that matches certificates created before the specified date-time.
TimeCreatedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedLessThan"`
// 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 ListCertificatesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCertificatesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCertificatesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCertificatesRequest) String() string
func (request ListCertificatesRequest) ValidateEnumValue() (bool, error)
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
ListCertificatesResponse wrapper for the ListCertificates operation
type ListCertificatesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []CertificateSummary instances
Items []CertificateSummary `presentIn:"body"`
// 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.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 ListCertificatesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCertificatesResponse) String() string
ListCertificatesSortByEnum Enum with underlying type: string
type ListCertificatesSortByEnum string
Set of constants representing the allowable values for ListCertificatesSortByEnum
const (
ListCertificatesSortById ListCertificatesSortByEnum = "id"
ListCertificatesSortByCompartmentid ListCertificatesSortByEnum = "compartmentId"
ListCertificatesSortByDisplayname ListCertificatesSortByEnum = "displayName"
ListCertificatesSortByNotvalidafter ListCertificatesSortByEnum = "notValidAfter"
ListCertificatesSortByTimecreated ListCertificatesSortByEnum = "timeCreated"
)
func GetListCertificatesSortByEnumValues() []ListCertificatesSortByEnum
GetListCertificatesSortByEnumValues Enumerates the set of values for ListCertificatesSortByEnum
func GetMappingListCertificatesSortByEnum(val string) (ListCertificatesSortByEnum, bool)
GetMappingListCertificatesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCertificatesSortOrderEnum Enum with underlying type: string
type ListCertificatesSortOrderEnum string
Set of constants representing the allowable values for ListCertificatesSortOrderEnum
const (
ListCertificatesSortOrderAsc ListCertificatesSortOrderEnum = "ASC"
ListCertificatesSortOrderDesc ListCertificatesSortOrderEnum = "DESC"
)
func GetListCertificatesSortOrderEnumValues() []ListCertificatesSortOrderEnum
GetListCertificatesSortOrderEnumValues Enumerates the set of values for ListCertificatesSortOrderEnum
func GetMappingListCertificatesSortOrderEnum(val string) (ListCertificatesSortOrderEnum, bool)
GetMappingListCertificatesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListCustomProtectionRulesRequest wrapper for the ListCustomProtectionRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListCustomProtectionRules.go.html to see an example of how to use ListCustomProtectionRulesRequest.
type ListCustomProtectionRulesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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"`
// The value by which custom protection rules are sorted in a paginated 'List' call. If unspecified, defaults to `timeCreated`.
SortBy ListCustomProtectionRulesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`.
SortOrder ListCustomProtectionRulesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Filter custom protection rules using a list of custom protection rule OCIDs.
Id []string `contributesTo:"query" name:"id" collectionFormat:"multi"`
// Filter custom protection rules using a list of display names.
DisplayName []string `contributesTo:"query" name:"displayName" collectionFormat:"multi"`
// Filter Custom Protection rules using a list of lifecycle states.
LifecycleState []LifecycleStatesEnum `contributesTo:"query" name:"lifecycleState" omitEmpty:"true" collectionFormat:"multi"`
// A filter that matches Custom Protection rules created on or after the specified date-time.
TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"`
// A filter that matches custom protection rules created before the specified date-time.
TimeCreatedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedLessThan"`
// 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 ListCustomProtectionRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCustomProtectionRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCustomProtectionRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCustomProtectionRulesRequest) String() string
func (request ListCustomProtectionRulesRequest) ValidateEnumValue() (bool, error)
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
ListCustomProtectionRulesResponse wrapper for the ListCustomProtectionRules operation
type ListCustomProtectionRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []CustomProtectionRuleSummary instances
Items []CustomProtectionRuleSummary `presentIn:"body"`
// 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.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 ListCustomProtectionRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCustomProtectionRulesResponse) String() string
ListCustomProtectionRulesSortByEnum Enum with underlying type: string
type ListCustomProtectionRulesSortByEnum string
Set of constants representing the allowable values for ListCustomProtectionRulesSortByEnum
const (
ListCustomProtectionRulesSortById ListCustomProtectionRulesSortByEnum = "id"
ListCustomProtectionRulesSortByCompartmentid ListCustomProtectionRulesSortByEnum = "compartmentId"
ListCustomProtectionRulesSortByDisplayname ListCustomProtectionRulesSortByEnum = "displayName"
ListCustomProtectionRulesSortByModsecurityruleid ListCustomProtectionRulesSortByEnum = "modSecurityRuleId"
ListCustomProtectionRulesSortByTimecreated ListCustomProtectionRulesSortByEnum = "timeCreated"
)
func GetListCustomProtectionRulesSortByEnumValues() []ListCustomProtectionRulesSortByEnum
GetListCustomProtectionRulesSortByEnumValues Enumerates the set of values for ListCustomProtectionRulesSortByEnum
func GetMappingListCustomProtectionRulesSortByEnum(val string) (ListCustomProtectionRulesSortByEnum, bool)
GetMappingListCustomProtectionRulesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCustomProtectionRulesSortOrderEnum Enum with underlying type: string
type ListCustomProtectionRulesSortOrderEnum string
Set of constants representing the allowable values for ListCustomProtectionRulesSortOrderEnum
const (
ListCustomProtectionRulesSortOrderAsc ListCustomProtectionRulesSortOrderEnum = "ASC"
ListCustomProtectionRulesSortOrderDesc ListCustomProtectionRulesSortOrderEnum = "DESC"
)
func GetListCustomProtectionRulesSortOrderEnumValues() []ListCustomProtectionRulesSortOrderEnum
GetListCustomProtectionRulesSortOrderEnumValues Enumerates the set of values for ListCustomProtectionRulesSortOrderEnum
func GetMappingListCustomProtectionRulesSortOrderEnum(val string) (ListCustomProtectionRulesSortOrderEnum, bool)
GetMappingListCustomProtectionRulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListEdgeSubnetsRequest wrapper for the ListEdgeSubnets operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListEdgeSubnets.go.html to see an example of how to use ListEdgeSubnetsRequest.
type ListEdgeSubnetsRequest struct {
// 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"`
// The value by which edge node subnets are sorted in a paginated 'List' call. If unspecified, defaults to `timeModified`.
SortBy ListEdgeSubnetsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`.
SortOrder ListEdgeSubnetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListEdgeSubnetsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListEdgeSubnetsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListEdgeSubnetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListEdgeSubnetsRequest) String() string
func (request ListEdgeSubnetsRequest) ValidateEnumValue() (bool, error)
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
ListEdgeSubnetsResponse wrapper for the ListEdgeSubnets operation
type ListEdgeSubnetsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []EdgeSubnet instances
Items []EdgeSubnet `presentIn:"body"`
// 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"`
// 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 ListEdgeSubnetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListEdgeSubnetsResponse) String() string
ListEdgeSubnetsSortByEnum Enum with underlying type: string
type ListEdgeSubnetsSortByEnum string
Set of constants representing the allowable values for ListEdgeSubnetsSortByEnum
const (
ListEdgeSubnetsSortByCidr ListEdgeSubnetsSortByEnum = "cidr"
ListEdgeSubnetsSortByRegion ListEdgeSubnetsSortByEnum = "region"
ListEdgeSubnetsSortByTimemodified ListEdgeSubnetsSortByEnum = "timeModified"
)
func GetListEdgeSubnetsSortByEnumValues() []ListEdgeSubnetsSortByEnum
GetListEdgeSubnetsSortByEnumValues Enumerates the set of values for ListEdgeSubnetsSortByEnum
func GetMappingListEdgeSubnetsSortByEnum(val string) (ListEdgeSubnetsSortByEnum, bool)
GetMappingListEdgeSubnetsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListEdgeSubnetsSortOrderEnum Enum with underlying type: string
type ListEdgeSubnetsSortOrderEnum string
Set of constants representing the allowable values for ListEdgeSubnetsSortOrderEnum
const (
ListEdgeSubnetsSortOrderAsc ListEdgeSubnetsSortOrderEnum = "ASC"
ListEdgeSubnetsSortOrderDesc ListEdgeSubnetsSortOrderEnum = "DESC"
)
func GetListEdgeSubnetsSortOrderEnumValues() []ListEdgeSubnetsSortOrderEnum
GetListEdgeSubnetsSortOrderEnumValues Enumerates the set of values for ListEdgeSubnetsSortOrderEnum
func GetMappingListEdgeSubnetsSortOrderEnum(val string) (ListEdgeSubnetsSortOrderEnum, bool)
GetMappingListEdgeSubnetsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListGoodBotsRequest wrapper for the ListGoodBots operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListGoodBots.go.html to see an example of how to use ListGoodBotsRequest.
type ListGoodBotsRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 ListGoodBotsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListGoodBotsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListGoodBotsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListGoodBotsRequest) String() string
func (request ListGoodBotsRequest) ValidateEnumValue() (bool, error)
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
ListGoodBotsResponse wrapper for the ListGoodBots operation
type ListGoodBotsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []GoodBot instances
Items []GoodBot `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
// 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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListGoodBotsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListGoodBotsResponse) String() string
ListHttpRedirectsRequest wrapper for the ListHttpRedirects operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListHttpRedirects.go.html to see an example of how to use ListHttpRedirectsRequest.
type ListHttpRedirectsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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"`
// The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`.
SortOrder ListHttpRedirectsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort the results of the List query.
SortBy ListHttpRedirectsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Filter redirects using a list of redirect OCIDs.
Id []string `contributesTo:"query" name:"id" collectionFormat:"multi"`
// Filter redirects using a display name.
DisplayName []string `contributesTo:"query" name:"displayName" collectionFormat:"multi"`
// Filter redirects using a list of lifecycle states.
LifecycleState []LifecycleStatesEnum `contributesTo:"query" name:"lifecycleState" omitEmpty:"true" collectionFormat:"multi"`
// A filter that matches redirects created on or after the specified date and time.
TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"`
// A filter that matches redirects created before the specified date-time. Default to 1 day before now.
TimeCreatedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedLessThan"`
// 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 ListHttpRedirectsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListHttpRedirectsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListHttpRedirectsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListHttpRedirectsRequest) String() string
func (request ListHttpRedirectsRequest) ValidateEnumValue() (bool, error)
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
ListHttpRedirectsResponse wrapper for the ListHttpRedirects operation
type ListHttpRedirectsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []HttpRedirectSummary instances
Items []HttpRedirectSummary `presentIn:"body"`
// 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.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 ListHttpRedirectsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListHttpRedirectsResponse) String() string
ListHttpRedirectsSortByEnum Enum with underlying type: string
type ListHttpRedirectsSortByEnum string
Set of constants representing the allowable values for ListHttpRedirectsSortByEnum
const (
ListHttpRedirectsSortById ListHttpRedirectsSortByEnum = "id"
ListHttpRedirectsSortByDomain ListHttpRedirectsSortByEnum = "domain"
ListHttpRedirectsSortByTarget ListHttpRedirectsSortByEnum = "target"
ListHttpRedirectsSortByDisplayname ListHttpRedirectsSortByEnum = "displayName"
)
func GetListHttpRedirectsSortByEnumValues() []ListHttpRedirectsSortByEnum
GetListHttpRedirectsSortByEnumValues Enumerates the set of values for ListHttpRedirectsSortByEnum
func GetMappingListHttpRedirectsSortByEnum(val string) (ListHttpRedirectsSortByEnum, bool)
GetMappingListHttpRedirectsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListHttpRedirectsSortOrderEnum Enum with underlying type: string
type ListHttpRedirectsSortOrderEnum string
Set of constants representing the allowable values for ListHttpRedirectsSortOrderEnum
const (
ListHttpRedirectsSortOrderAsc ListHttpRedirectsSortOrderEnum = "ASC"
ListHttpRedirectsSortOrderDesc ListHttpRedirectsSortOrderEnum = "DESC"
)
func GetListHttpRedirectsSortOrderEnumValues() []ListHttpRedirectsSortOrderEnum
GetListHttpRedirectsSortOrderEnumValues Enumerates the set of values for ListHttpRedirectsSortOrderEnum
func GetMappingListHttpRedirectsSortOrderEnum(val string) (ListHttpRedirectsSortOrderEnum, bool)
GetMappingListHttpRedirectsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListProtectionRulesActionEnum Enum with underlying type: string
type ListProtectionRulesActionEnum string
Set of constants representing the allowable values for ListProtectionRulesActionEnum
const (
ListProtectionRulesActionOff ListProtectionRulesActionEnum = "OFF"
ListProtectionRulesActionDetect ListProtectionRulesActionEnum = "DETECT"
ListProtectionRulesActionBlock ListProtectionRulesActionEnum = "BLOCK"
)
func GetListProtectionRulesActionEnumValues() []ListProtectionRulesActionEnum
GetListProtectionRulesActionEnumValues Enumerates the set of values for ListProtectionRulesActionEnum
func GetMappingListProtectionRulesActionEnum(val string) (ListProtectionRulesActionEnum, bool)
GetMappingListProtectionRulesActionEnum performs case Insensitive comparison on enum value and return the desired enum
ListProtectionRulesRequest wrapper for the ListProtectionRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListProtectionRules.go.html to see an example of how to use ListProtectionRulesRequest.
type ListProtectionRulesRequest struct {
// The OCID (https://docs.oracle.com/iaas/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 []ListProtectionRulesActionEnum `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 ListProtectionRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListProtectionRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListProtectionRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListProtectionRulesRequest) String() string
func (request ListProtectionRulesRequest) ValidateEnumValue() (bool, error)
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
ListProtectionRulesResponse wrapper for the ListProtectionRules operation
type ListProtectionRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ProtectionRule instances
Items []ProtectionRule `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.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 ListProtectionRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListProtectionRulesResponse) String() string
ListRecommendationsRecommendedActionEnum Enum with underlying type: string
type ListRecommendationsRecommendedActionEnum string
Set of constants representing the allowable values for ListRecommendationsRecommendedActionEnum
const (
ListRecommendationsRecommendedActionDetect ListRecommendationsRecommendedActionEnum = "DETECT"
ListRecommendationsRecommendedActionBlock ListRecommendationsRecommendedActionEnum = "BLOCK"
)
func GetListRecommendationsRecommendedActionEnumValues() []ListRecommendationsRecommendedActionEnum
GetListRecommendationsRecommendedActionEnumValues Enumerates the set of values for ListRecommendationsRecommendedActionEnum
func GetMappingListRecommendationsRecommendedActionEnum(val string) (ListRecommendationsRecommendedActionEnum, bool)
GetMappingListRecommendationsRecommendedActionEnum performs case Insensitive comparison on enum value and return the desired enum
ListRecommendationsRequest wrapper for the ListRecommendations operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListRecommendations.go.html to see an example of how to use ListRecommendationsRequest.
type ListRecommendationsRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// A filter that matches recommended protection rules based on the selected action. If unspecified, rules with any action type are returned.
RecommendedAction ListRecommendationsRecommendedActionEnum `mandatory:"false" contributesTo:"query" name:"recommendedAction" omitEmpty:"true"`
// 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"`
// 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 ListRecommendationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRecommendationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRecommendationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRecommendationsRequest) String() string
func (request ListRecommendationsRequest) ValidateEnumValue() (bool, error)
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
ListRecommendationsResponse wrapper for the ListRecommendations operation
type ListRecommendationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []Recommendation instances
Items []Recommendation `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.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 ListRecommendationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRecommendationsResponse) String() string
ListThreatFeedsRequest wrapper for the ListThreatFeeds operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListThreatFeeds.go.html to see an example of how to use ListThreatFeedsRequest.
type ListThreatFeedsRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 ListThreatFeedsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListThreatFeedsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListThreatFeedsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListThreatFeedsRequest) String() string
func (request ListThreatFeedsRequest) ValidateEnumValue() (bool, error)
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
ListThreatFeedsResponse wrapper for the ListThreatFeeds operation
type ListThreatFeedsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ThreatFeed instances
Items []ThreatFeed `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
// 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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListThreatFeedsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListThreatFeedsResponse) String() string
ListWaasPoliciesRequest wrapper for the ListWaasPolicies operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWaasPolicies.go.html to see an example of how to use ListWaasPoliciesRequest.
type ListWaasPoliciesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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"`
// The value by which policies are sorted in a paginated 'List' call. If unspecified, defaults to `timeCreated`.
SortBy ListWaasPoliciesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`.
SortOrder ListWaasPoliciesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Filter policies using a list of policy OCIDs.
Id []string `contributesTo:"query" name:"id" collectionFormat:"multi"`
// Filter policies using a list of display names.
DisplayName []string `contributesTo:"query" name:"displayName" collectionFormat:"multi"`
// Filter policies using a list of lifecycle states.
LifecycleState []LifecycleStatesEnum `contributesTo:"query" name:"lifecycleState" omitEmpty:"true" collectionFormat:"multi"`
// A filter that matches policies created on or after the specified date and time.
TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"`
// A filter that matches policies created before the specified date-time.
TimeCreatedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedLessThan"`
// 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 ListWaasPoliciesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWaasPoliciesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWaasPoliciesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWaasPoliciesRequest) String() string
func (request ListWaasPoliciesRequest) ValidateEnumValue() (bool, error)
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
ListWaasPoliciesResponse wrapper for the ListWaasPolicies operation
type ListWaasPoliciesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WaasPolicySummary instances
Items []WaasPolicySummary `presentIn:"body"`
// 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.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 ListWaasPoliciesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWaasPoliciesResponse) String() string
ListWaasPoliciesSortByEnum Enum with underlying type: string
type ListWaasPoliciesSortByEnum string
Set of constants representing the allowable values for ListWaasPoliciesSortByEnum
const (
ListWaasPoliciesSortById ListWaasPoliciesSortByEnum = "id"
ListWaasPoliciesSortByDisplayname ListWaasPoliciesSortByEnum = "displayName"
ListWaasPoliciesSortByTimecreated ListWaasPoliciesSortByEnum = "timeCreated"
)
func GetListWaasPoliciesSortByEnumValues() []ListWaasPoliciesSortByEnum
GetListWaasPoliciesSortByEnumValues Enumerates the set of values for ListWaasPoliciesSortByEnum
func GetMappingListWaasPoliciesSortByEnum(val string) (ListWaasPoliciesSortByEnum, bool)
GetMappingListWaasPoliciesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWaasPoliciesSortOrderEnum Enum with underlying type: string
type ListWaasPoliciesSortOrderEnum string
Set of constants representing the allowable values for ListWaasPoliciesSortOrderEnum
const (
ListWaasPoliciesSortOrderAsc ListWaasPoliciesSortOrderEnum = "ASC"
ListWaasPoliciesSortOrderDesc ListWaasPoliciesSortOrderEnum = "DESC"
)
func GetListWaasPoliciesSortOrderEnumValues() []ListWaasPoliciesSortOrderEnum
GetListWaasPoliciesSortOrderEnumValues Enumerates the set of values for ListWaasPoliciesSortOrderEnum
func GetMappingListWaasPoliciesSortOrderEnum(val string) (ListWaasPoliciesSortOrderEnum, bool)
GetMappingListWaasPoliciesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
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"
)
func GetListWaasPolicyCustomProtectionRulesActionEnumValues() []ListWaasPolicyCustomProtectionRulesActionEnum
GetListWaasPolicyCustomProtectionRulesActionEnumValues Enumerates the set of values for ListWaasPolicyCustomProtectionRulesActionEnum
func GetMappingListWaasPolicyCustomProtectionRulesActionEnum(val string) (ListWaasPolicyCustomProtectionRulesActionEnum, bool)
GetMappingListWaasPolicyCustomProtectionRulesActionEnum performs case Insensitive comparison on enum value and return the desired enum
ListWaasPolicyCustomProtectionRulesRequest wrapper for the ListWaasPolicyCustomProtectionRules operation
Click https://docs.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.oracle.com/iaas/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) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWaasPolicyCustomProtectionRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWaasPolicyCustomProtectionRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWaasPolicyCustomProtectionRulesRequest) String() string
func (request ListWaasPolicyCustomProtectionRulesRequest) ValidateEnumValue() (bool, error)
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
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.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) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWaasPolicyCustomProtectionRulesResponse) String() string
ListWafBlockedRequestsRequest wrapper for the ListWafBlockedRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWafBlockedRequests.go.html to see an example of how to use ListWafBlockedRequestsRequest.
type ListWafBlockedRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// A filter that limits returned events to those occurring on or after a date and time, specified in RFC 3339 format. If unspecified, defaults to 30 minutes before receipt of the request.
TimeObservedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeObservedGreaterThanOrEqualTo"`
// A filter that limits returned events to those occurring before a date and time, specified in RFC 3339 format.
TimeObservedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeObservedLessThan"`
// 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 stats by the Web Application Firewall feature that triggered the block action. If unspecified, data for all WAF features will be returned.
WafFeature []ListWafBlockedRequestsWafFeatureEnum `contributesTo:"query" name:"wafFeature" 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 ListWafBlockedRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWafBlockedRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWafBlockedRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWafBlockedRequestsRequest) String() string
func (request ListWafBlockedRequestsRequest) ValidateEnumValue() (bool, error)
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
ListWafBlockedRequestsResponse wrapper for the ListWafBlockedRequests operation
type ListWafBlockedRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WafBlockedRequest instances
Items []WafBlockedRequest `presentIn:"body"`
// 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"`
// 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 ListWafBlockedRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWafBlockedRequestsResponse) String() string
ListWafBlockedRequestsWafFeatureEnum Enum with underlying type: string
type ListWafBlockedRequestsWafFeatureEnum string
Set of constants representing the allowable values for ListWafBlockedRequestsWafFeatureEnum
const (
ListWafBlockedRequestsWafFeatureProtectionRules ListWafBlockedRequestsWafFeatureEnum = "PROTECTION_RULES"
ListWafBlockedRequestsWafFeatureJsChallenge ListWafBlockedRequestsWafFeatureEnum = "JS_CHALLENGE"
ListWafBlockedRequestsWafFeatureAccessRules ListWafBlockedRequestsWafFeatureEnum = "ACCESS_RULES"
ListWafBlockedRequestsWafFeatureThreatFeeds ListWafBlockedRequestsWafFeatureEnum = "THREAT_FEEDS"
ListWafBlockedRequestsWafFeatureHumanInteractionChallenge ListWafBlockedRequestsWafFeatureEnum = "HUMAN_INTERACTION_CHALLENGE"
ListWafBlockedRequestsWafFeatureDeviceFingerprintChallenge ListWafBlockedRequestsWafFeatureEnum = "DEVICE_FINGERPRINT_CHALLENGE"
ListWafBlockedRequestsWafFeatureCaptcha ListWafBlockedRequestsWafFeatureEnum = "CAPTCHA"
ListWafBlockedRequestsWafFeatureAddressRateLimiting ListWafBlockedRequestsWafFeatureEnum = "ADDRESS_RATE_LIMITING"
)
func GetListWafBlockedRequestsWafFeatureEnumValues() []ListWafBlockedRequestsWafFeatureEnum
GetListWafBlockedRequestsWafFeatureEnumValues Enumerates the set of values for ListWafBlockedRequestsWafFeatureEnum
func GetMappingListWafBlockedRequestsWafFeatureEnum(val string) (ListWafBlockedRequestsWafFeatureEnum, bool)
GetMappingListWafBlockedRequestsWafFeatureEnum performs case Insensitive comparison on enum value and return the desired enum
ListWafLogsActionEnum Enum with underlying type: string
type ListWafLogsActionEnum string
Set of constants representing the allowable values for ListWafLogsActionEnum
const (
ListWafLogsActionBlock ListWafLogsActionEnum = "BLOCK"
ListWafLogsActionDetect ListWafLogsActionEnum = "DETECT"
ListWafLogsActionBypass ListWafLogsActionEnum = "BYPASS"
ListWafLogsActionLog ListWafLogsActionEnum = "LOG"
ListWafLogsActionRedirected ListWafLogsActionEnum = "REDIRECTED"
)
func GetListWafLogsActionEnumValues() []ListWafLogsActionEnum
GetListWafLogsActionEnumValues Enumerates the set of values for ListWafLogsActionEnum
func GetMappingListWafLogsActionEnum(val string) (ListWafLogsActionEnum, bool)
GetMappingListWafLogsActionEnum performs case Insensitive comparison on enum value and return the desired enum
ListWafLogsHttpMethodEnum Enum with underlying type: string
type ListWafLogsHttpMethodEnum string
Set of constants representing the allowable values for ListWafLogsHttpMethodEnum
const (
ListWafLogsHttpMethodOptions ListWafLogsHttpMethodEnum = "OPTIONS"
ListWafLogsHttpMethodGet ListWafLogsHttpMethodEnum = "GET"
ListWafLogsHttpMethodHead ListWafLogsHttpMethodEnum = "HEAD"
ListWafLogsHttpMethodPost ListWafLogsHttpMethodEnum = "POST"
ListWafLogsHttpMethodPut ListWafLogsHttpMethodEnum = "PUT"
ListWafLogsHttpMethodDelete ListWafLogsHttpMethodEnum = "DELETE"
ListWafLogsHttpMethodTrace ListWafLogsHttpMethodEnum = "TRACE"
ListWafLogsHttpMethodConnect ListWafLogsHttpMethodEnum = "CONNECT"
)
func GetListWafLogsHttpMethodEnumValues() []ListWafLogsHttpMethodEnum
GetListWafLogsHttpMethodEnumValues Enumerates the set of values for ListWafLogsHttpMethodEnum
func GetMappingListWafLogsHttpMethodEnum(val string) (ListWafLogsHttpMethodEnum, bool)
GetMappingListWafLogsHttpMethodEnum performs case Insensitive comparison on enum value and return the desired enum
ListWafLogsLogTypeEnum Enum with underlying type: string
type ListWafLogsLogTypeEnum string
Set of constants representing the allowable values for ListWafLogsLogTypeEnum
const (
ListWafLogsLogTypeAccess ListWafLogsLogTypeEnum = "ACCESS"
ListWafLogsLogTypeProtectionRules ListWafLogsLogTypeEnum = "PROTECTION_RULES"
ListWafLogsLogTypeJsChallenge ListWafLogsLogTypeEnum = "JS_CHALLENGE"
ListWafLogsLogTypeCaptcha ListWafLogsLogTypeEnum = "CAPTCHA"
ListWafLogsLogTypeAccessRules ListWafLogsLogTypeEnum = "ACCESS_RULES"
ListWafLogsLogTypeThreatFeeds ListWafLogsLogTypeEnum = "THREAT_FEEDS"
ListWafLogsLogTypeHumanInteractionChallenge ListWafLogsLogTypeEnum = "HUMAN_INTERACTION_CHALLENGE"
ListWafLogsLogTypeDeviceFingerprintChallenge ListWafLogsLogTypeEnum = "DEVICE_FINGERPRINT_CHALLENGE"
ListWafLogsLogTypeAddressRateLimiting ListWafLogsLogTypeEnum = "ADDRESS_RATE_LIMITING"
)
func GetListWafLogsLogTypeEnumValues() []ListWafLogsLogTypeEnum
GetListWafLogsLogTypeEnumValues Enumerates the set of values for ListWafLogsLogTypeEnum
func GetMappingListWafLogsLogTypeEnum(val string) (ListWafLogsLogTypeEnum, bool)
GetMappingListWafLogsLogTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListWafLogsRequest wrapper for the ListWafLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWafLogs.go.html to see an example of how to use ListWafLogsRequest.
type ListWafLogsRequest struct {
// The OCID (https://docs.oracle.com/iaas/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 `20`.
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"`
// A filter that matches log entries where the observed event occurred on or after a date and time specified in RFC 3339 format. If unspecified, defaults to two hours before receipt of the request.
TimeObservedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeObservedGreaterThanOrEqualTo"`
// A filter that matches log entries where the observed event occurred before a date and time, specified in RFC 3339 format.
TimeObservedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeObservedLessThan"`
// A full text search for logs.
TextContains *string `mandatory:"false" contributesTo:"query" name:"textContains"`
// Filters logs by access rule key.
AccessRuleKey []string `contributesTo:"query" name:"accessRuleKey" collectionFormat:"multi"`
// Filters logs by Web Application Firewall action.
Action []ListWafLogsActionEnum `contributesTo:"query" name:"action" omitEmpty:"true" collectionFormat:"multi"`
// Filters logs by client IP address.
ClientAddress []string `contributesTo:"query" name:"clientAddress" collectionFormat:"multi"`
// Filters logs by country code. Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see ISO's website (https://www.iso.org/obp/ui/#search/code/).
CountryCode []string `contributesTo:"query" name:"countryCode" collectionFormat:"multi"`
// Filter logs by country name.
CountryName []string `contributesTo:"query" name:"countryName" collectionFormat:"multi"`
// Filter logs by device fingerprint.
Fingerprint []string `contributesTo:"query" name:"fingerprint" collectionFormat:"multi"`
// Filter logs by HTTP method.
HttpMethod []ListWafLogsHttpMethodEnum `contributesTo:"query" name:"httpMethod" omitEmpty:"true" collectionFormat:"multi"`
// Filter logs by incident key.
IncidentKey []string `contributesTo:"query" name:"incidentKey" collectionFormat:"multi"`
// Filter by log type. For more information about WAF logs, see Logs (https://docs.oracle.com/iaas/Content/WAF/Tasks/logs.htm).
LogType []ListWafLogsLogTypeEnum `contributesTo:"query" name:"logType" omitEmpty:"true" collectionFormat:"multi"`
// Filter by origin IP address.
OriginAddress []string `contributesTo:"query" name:"originAddress" collectionFormat:"multi"`
// Filter by referrer.
Referrer []string `contributesTo:"query" name:"referrer" collectionFormat:"multi"`
// Filter by request URL.
RequestUrl []string `contributesTo:"query" name:"requestUrl" collectionFormat:"multi"`
// Filter by response code.
ResponseCode []int `contributesTo:"query" name:"responseCode" collectionFormat:"multi"`
// Filter by threat feed key.
ThreatFeedKey []string `contributesTo:"query" name:"threatFeedKey" collectionFormat:"multi"`
// Filter by user agent.
UserAgent []string `contributesTo:"query" name:"userAgent" collectionFormat:"multi"`
// Filter by protection rule key.
ProtectionRuleKey []string `contributesTo:"query" name:"protectionRuleKey" 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 ListWafLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWafLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWafLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWafLogsRequest) String() string
func (request ListWafLogsRequest) ValidateEnumValue() (bool, error)
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
ListWafLogsResponse wrapper for the ListWafLogs operation
type ListWafLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WafLog instances
Items []WafLog `presentIn:"body"`
// 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"`
// 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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWafLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWafLogsResponse) String() string
ListWafRequestsRequest wrapper for the ListWafRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWafRequests.go.html to see an example of how to use ListWafRequestsRequest.
type ListWafRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// A filter that limits returned events to those occurring on or after a date and time, specified in RFC 3339 format. If unspecified, defaults to 30 minutes before receipt of the request.
TimeObservedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeObservedGreaterThanOrEqualTo"`
// A filter that limits returned events to those occurring before a date and time, specified in RFC 3339 format.
TimeObservedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeObservedLessThan"`
// 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"`
// 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 ListWafRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWafRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWafRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWafRequestsRequest) String() string
func (request ListWafRequestsRequest) ValidateEnumValue() (bool, error)
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
ListWafRequestsResponse wrapper for the ListWafRequests operation
type ListWafRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WafRequest instances
Items []WafRequest `presentIn:"body"`
// 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"`
// 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 ListWafRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWafRequestsResponse) String() string
ListWafTrafficRequest wrapper for the ListWafTraffic operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWafTraffic.go.html to see an example of how to use ListWafTrafficRequest.
type ListWafTrafficRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// A filter that limits returned events to those occurring on or after a date and time, specified in RFC 3339 format. If unspecified, defaults to 30 minutes before receipt of the request.
TimeObservedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeObservedGreaterThanOrEqualTo"`
// A filter that limits returned events to those occurring before a date and time, specified in RFC 3339 format.
TimeObservedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeObservedLessThan"`
// 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"`
// 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 ListWafTrafficRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWafTrafficRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWafTrafficRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWafTrafficRequest) String() string
func (request ListWafTrafficRequest) ValidateEnumValue() (bool, error)
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
ListWafTrafficResponse wrapper for the ListWafTraffic operation
type ListWafTrafficResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WafTrafficDatum instances
Items []WafTrafficDatum `presentIn:"body"`
// 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"`
// 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 ListWafTrafficResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWafTrafficResponse) String() string
ListWhitelistsRequest wrapper for the ListWhitelists operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWhitelists.go.html to see an example of how to use ListWhitelistsRequest.
type ListWhitelistsRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// 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 ListWhitelistsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWhitelistsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWhitelistsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWhitelistsRequest) String() string
func (request ListWhitelistsRequest) ValidateEnumValue() (bool, error)
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
ListWhitelistsResponse wrapper for the ListWhitelists operation
type ListWhitelistsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []Whitelist instances
Items []Whitelist `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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"`
// 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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWhitelistsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWhitelistsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"query" name:"waasPolicyId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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"`
// The value by which work requests are sorted in a paginated 'List' call. If unspecified, defaults to `timeAccepted`.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`.
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestSummary instances
Items []WorkRequestSummary `presentIn:"body"`
// 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.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 ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortById ListWorkRequestsSortByEnum = "id"
ListWorkRequestsSortByStatus ListWorkRequestsSortByEnum = "status"
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
ListWorkRequestsSortByTimestarted ListWorkRequestsSortByEnum = "timeStarted"
ListWorkRequestsSortByTimefinished ListWorkRequestsSortByEnum = "timeFinished"
ListWorkRequestsSortByOperationtype ListWorkRequestsSortByEnum = "operationType"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
LoadBalancingMethod The representation of LoadBalancingMethod
type LoadBalancingMethod interface {
}
LoadBalancingMethodMethodEnum Enum with underlying type: string
type LoadBalancingMethodMethodEnum string
Set of constants representing the allowable values for LoadBalancingMethodMethodEnum
const (
LoadBalancingMethodMethodIpHash LoadBalancingMethodMethodEnum = "IP_HASH"
LoadBalancingMethodMethodRoundRobin LoadBalancingMethodMethodEnum = "ROUND_ROBIN"
LoadBalancingMethodMethodStickyCookie LoadBalancingMethodMethodEnum = "STICKY_COOKIE"
)
func GetLoadBalancingMethodMethodEnumValues() []LoadBalancingMethodMethodEnum
GetLoadBalancingMethodMethodEnumValues Enumerates the set of values for LoadBalancingMethodMethodEnum
func GetMappingLoadBalancingMethodMethodEnum(val string) (LoadBalancingMethodMethodEnum, bool)
GetMappingLoadBalancingMethodMethodEnum performs case Insensitive comparison on enum value and return the desired enum
Origin A detailed description of your web application's origin host server. An origin must be defined to set up WAF rules.
type Origin struct {
// The URI of the origin. Does not support paths. Port numbers should be specified in the `httpPort` and `httpsPort` fields.
Uri *string `mandatory:"true" json:"uri"`
// The HTTP port on the origin that the web application listens on. If unspecified, defaults to `80`. If `0` is specified - the origin is not used for HTTP traffic.
HttpPort *int `mandatory:"false" json:"httpPort"`
// The HTTPS port on the origin that the web application listens on. If unspecified, defaults to `443`. If `0` is specified - the origin is not used for HTTPS traffic.
HttpsPort *int `mandatory:"false" json:"httpsPort"`
// A list of HTTP headers to forward to your origin.
CustomHeaders []Header `mandatory:"false" json:"customHeaders"`
}
func (m Origin) String() string
func (m Origin) ValidateEnumValue() (bool, error)
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
OriginGroup The representation of OriginGroup
type OriginGroup struct {
// The list of objects containing origin references and additional properties.
Origins []OriginGroupOrigins `mandatory:"false" json:"origins"`
}
func (m OriginGroup) String() string
func (m OriginGroup) ValidateEnumValue() (bool, error)
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
OriginGroupOrigins The representation of OriginGroupOrigins
type OriginGroupOrigins struct {
// The IP address or CIDR notation of the origin server.
Origin *string `mandatory:"false" json:"origin"`
// The weight of the origin used in load balancing. Origins with higher weights will receive larger proportions of client requests.
Weight *int `mandatory:"false" json:"weight"`
}
func (m OriginGroupOrigins) String() string
func (m OriginGroupOrigins) ValidateEnumValue() (bool, error)
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
PolicyConfig The configuration details for the WAAS policy.
type PolicyConfig struct {
// The OCID of the SSL certificate to use if HTTPS is supported.
CertificateId *string `mandatory:"false" json:"certificateId"`
// Enable or disable HTTPS support. If true, a `certificateId` is required. If unspecified, defaults to `false`.
IsHttpsEnabled *bool `mandatory:"false" json:"isHttpsEnabled"`
// Force HTTP to HTTPS redirection. If unspecified, defaults to `false`.
IsHttpsForced *bool `mandatory:"false" json:"isHttpsForced"`
// A list of allowed TLS protocols. Only applicable when HTTPS support is enabled.
// The TLS protocol is negotiated while the request is connecting and the most recent protocol supported by both the edge node and client browser will be selected. If no such version exists, the connection will be aborted.
// - **TLS_V1:** corresponds to TLS 1.0 specification.
// - **TLS_V1_1:** corresponds to TLS 1.1 specification.
// - **TLS_V1_2:** corresponds to TLS 1.2 specification.
// - **TLS_V1_3:** corresponds to TLS 1.3 specification.
// Enabled TLS protocols must go in a row. For example if `TLS_v1_1` and `TLS_V1_3` are enabled, `TLS_V1_2` must be enabled too.
TlsProtocols []PolicyConfigTlsProtocolsEnum `mandatory:"false" json:"tlsProtocols,omitempty"`
// Enable or disable GZIP compression of origin responses. If enabled, the header `Accept-Encoding: gzip` is sent to origin, otherwise, the empty `Accept-Encoding:` header is used.
IsOriginCompressionEnabled *bool `mandatory:"false" json:"isOriginCompressionEnabled"`
// Enabling `isBehindCdn` allows for the collection of IP addresses from client requests if the WAF is connected to a CDN.
IsBehindCdn *bool `mandatory:"false" json:"isBehindCdn"`
// Specifies an HTTP header name which is treated as the connecting client's IP address. Applicable only if `isBehindCdn` is enabled.
// The edge node reads this header and its value and sets the client IP address as specified. It does not create the header if the header is not present in the request. If the header is not present, the connecting IP address will be used as the client's true IP address. It uses the last IP address in the header's value as the true IP address.
// Example: `X-Client-Ip: 11.1.1.1, 13.3.3.3`
// In the case of multiple headers with the same name, only the first header will be used. It is assumed that CDN sets the correct client IP address to prevent spoofing.
// - **X_FORWARDED_FOR:** Corresponds to `X-Forwarded-For` header name.
// - **X_CLIENT_IP:** Corresponds to `X-Client-Ip` header name.
// - **X_REAL_IP:** Corresponds to `X-Real-Ip` header name.
// - **CLIENT_IP:** Corresponds to `Client-Ip` header name.
// - **TRUE_CLIENT_IP:** Corresponds to `True-Client-Ip` header name.
ClientAddressHeader PolicyConfigClientAddressHeaderEnum `mandatory:"false" json:"clientAddressHeader,omitempty"`
// Enable or disable automatic content caching based on the response `cache-control` header. This feature enables the origin to act as a proxy cache. Caching is usually defined using `cache-control` header. For example `cache-control: max-age=120` means that the returned resource is valid for 120 seconds. Caching rules will overwrite this setting.
IsCacheControlRespected *bool `mandatory:"false" json:"isCacheControlRespected"`
// Enable or disable buffering of responses from the origin. Buffering improves overall stability in case of network issues, but slightly increases Time To First Byte.
IsResponseBufferingEnabled *bool `mandatory:"false" json:"isResponseBufferingEnabled"`
// The set cipher group for the configured TLS protocol. This sets the configuration for the TLS connections between clients and edge nodes only.
// - **DEFAULT:** Cipher group supports TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3 protocols. It has the following ciphers enabled: `ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:!DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA`
CipherGroup PolicyConfigCipherGroupEnum `mandatory:"false" json:"cipherGroup,omitempty"`
// An object that represents a load balancing method and its properties.
LoadBalancingMethod LoadBalancingMethod `mandatory:"false" json:"loadBalancingMethod"`
// ModSecurity is not capable to inspect WebSockets. Therefore paths specified here have WAF disabled if Connection request header from the client has the value Upgrade (case insensitive matching) and Upgrade request header has the value websocket (case insensitive matching). Paths matches if the concatenation of request URL path and query starts with the contents of the one of `websocketPathPrefixes` array value. In All other cases challenges, like JSC, HIC and etc., remain active.
WebsocketPathPrefixes []string `mandatory:"false" json:"websocketPathPrefixes"`
// SNI stands for Server Name Indication and is an extension of the TLS protocol. It indicates which hostname is being contacted by the browser at the beginning of the 'handshake'-process. This allows a server to connect multiple SSL Certificates to one IP address and port.
IsSniEnabled *bool `mandatory:"false" json:"isSniEnabled"`
HealthChecks *HealthCheck `mandatory:"false" json:"healthChecks"`
}
func (m PolicyConfig) String() string
func (m *PolicyConfig) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m PolicyConfig) ValidateEnumValue() (bool, error)
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
PolicyConfigCipherGroupEnum Enum with underlying type: string
type PolicyConfigCipherGroupEnum string
Set of constants representing the allowable values for PolicyConfigCipherGroupEnum
const (
PolicyConfigCipherGroupDefault PolicyConfigCipherGroupEnum = "DEFAULT"
)
func GetMappingPolicyConfigCipherGroupEnum(val string) (PolicyConfigCipherGroupEnum, bool)
GetMappingPolicyConfigCipherGroupEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPolicyConfigCipherGroupEnumValues() []PolicyConfigCipherGroupEnum
GetPolicyConfigCipherGroupEnumValues Enumerates the set of values for PolicyConfigCipherGroupEnum
PolicyConfigClientAddressHeaderEnum Enum with underlying type: string
type PolicyConfigClientAddressHeaderEnum string
Set of constants representing the allowable values for PolicyConfigClientAddressHeaderEnum
const (
PolicyConfigClientAddressHeaderXForwardedFor PolicyConfigClientAddressHeaderEnum = "X_FORWARDED_FOR"
PolicyConfigClientAddressHeaderXClientIp PolicyConfigClientAddressHeaderEnum = "X_CLIENT_IP"
PolicyConfigClientAddressHeaderXRealIp PolicyConfigClientAddressHeaderEnum = "X_REAL_IP"
PolicyConfigClientAddressHeaderClientIp PolicyConfigClientAddressHeaderEnum = "CLIENT_IP"
PolicyConfigClientAddressHeaderTrueClientIp PolicyConfigClientAddressHeaderEnum = "TRUE_CLIENT_IP"
)
func GetMappingPolicyConfigClientAddressHeaderEnum(val string) (PolicyConfigClientAddressHeaderEnum, bool)
GetMappingPolicyConfigClientAddressHeaderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPolicyConfigClientAddressHeaderEnumValues() []PolicyConfigClientAddressHeaderEnum
GetPolicyConfigClientAddressHeaderEnumValues Enumerates the set of values for PolicyConfigClientAddressHeaderEnum
PolicyConfigTlsProtocolsEnum Enum with underlying type: string
type PolicyConfigTlsProtocolsEnum string
Set of constants representing the allowable values for PolicyConfigTlsProtocolsEnum
const (
PolicyConfigTlsProtocolsV1 PolicyConfigTlsProtocolsEnum = "TLS_V1"
PolicyConfigTlsProtocolsV11 PolicyConfigTlsProtocolsEnum = "TLS_V1_1"
PolicyConfigTlsProtocolsV12 PolicyConfigTlsProtocolsEnum = "TLS_V1_2"
PolicyConfigTlsProtocolsV13 PolicyConfigTlsProtocolsEnum = "TLS_V1_3"
)
func GetMappingPolicyConfigTlsProtocolsEnum(val string) (PolicyConfigTlsProtocolsEnum, bool)
GetMappingPolicyConfigTlsProtocolsEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPolicyConfigTlsProtocolsEnumValues() []PolicyConfigTlsProtocolsEnum
GetPolicyConfigTlsProtocolsEnumValues Enumerates the set of values for PolicyConfigTlsProtocolsEnum
ProtectionRule The protection rule settings. Protection rules can allow, block, or trigger an alert if a request meets the parameters of an applied rule.
type ProtectionRule struct {
// The unique key of the protection rule.
Key *string `mandatory:"false" json:"key"`
// The list of the ModSecurity rule IDs that apply to this protection rule. For more information about ModSecurity's open source WAF rules, see Mod Security's documentation (https://www.modsecurity.org/CRS/Documentation/index.html).
ModSecurityRuleIds []string `mandatory:"false" json:"modSecurityRuleIds"`
// The name of the protection rule.
Name *string `mandatory:"false" json:"name"`
// The description of the protection rule.
Description *string `mandatory:"false" json:"description"`
// The action to take when the traffic is detected as malicious. If unspecified, defaults to `OFF`.
Action ProtectionRuleActionEnum `mandatory:"false" json:"action,omitempty"`
// The list of labels for the protection rule.
// **Note:** Protection rules with a `ResponseBody` label will have no effect unless `isResponseInspected` is true.
Labels []string `mandatory:"false" json:"labels"`
Exclusions []ProtectionRuleExclusion `mandatory:"false" json:"exclusions"`
}
func (m ProtectionRule) String() string
func (m ProtectionRule) ValidateEnumValue() (bool, error)
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
ProtectionRuleAction A protection rule key and the associated action to apply to that rule.
type ProtectionRuleAction struct {
// The unique key of the protection rule.
Key *string `mandatory:"true" json:"key"`
// The action to apply to the protection rule. If unspecified, defaults to `OFF`.
Action ProtectionRuleActionActionEnum `mandatory:"true" json:"action"`
// The types of requests excluded from the protection rule action. If the requests matches the criteria in the `exclusions`, the protection rule action will not be executed.
Exclusions []ProtectionRuleExclusion `mandatory:"false" json:"exclusions"`
}
func (m ProtectionRuleAction) String() string
func (m ProtectionRuleAction) ValidateEnumValue() (bool, error)
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
ProtectionRuleActionActionEnum Enum with underlying type: string
type ProtectionRuleActionActionEnum string
Set of constants representing the allowable values for ProtectionRuleActionActionEnum
const (
ProtectionRuleActionActionOff ProtectionRuleActionActionEnum = "OFF"
ProtectionRuleActionActionDetect ProtectionRuleActionActionEnum = "DETECT"
ProtectionRuleActionActionBlock ProtectionRuleActionActionEnum = "BLOCK"
)
func GetMappingProtectionRuleActionActionEnum(val string) (ProtectionRuleActionActionEnum, bool)
GetMappingProtectionRuleActionActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProtectionRuleActionActionEnumValues() []ProtectionRuleActionActionEnum
GetProtectionRuleActionActionEnumValues Enumerates the set of values for ProtectionRuleActionActionEnum
ProtectionRuleActionEnum Enum with underlying type: string
type ProtectionRuleActionEnum string
Set of constants representing the allowable values for ProtectionRuleActionEnum
const (
ProtectionRuleActionOff ProtectionRuleActionEnum = "OFF"
ProtectionRuleActionDetect ProtectionRuleActionEnum = "DETECT"
ProtectionRuleActionBlock ProtectionRuleActionEnum = "BLOCK"
)
func GetMappingProtectionRuleActionEnum(val string) (ProtectionRuleActionEnum, bool)
GetMappingProtectionRuleActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProtectionRuleActionEnumValues() []ProtectionRuleActionEnum
GetProtectionRuleActionEnumValues Enumerates the set of values for ProtectionRuleActionEnum
ProtectionRuleExclusion Allows specified types of requests to bypass the protection rule. If a request matches any of the criteria in the `exclusions` field, the protection rule will not be executed. Rules can have more than one exclusion and exclusions are applied to requests disjunctively, meaning the specified exclusion strings are independently matched against the specified targets of a request. The first target to match a specified string will trigger an exclusion. **Example:** If the following exclusions are defined for a protection rule:
"action": "BLOCK",
"exclusions": [
{
"target":"REQUEST_COOKIES",
"exclusions":["example.com", "12345", "219ffwef9w0f"]
},
{
"target":"REQUEST_COOKIE_NAMES",
"exclusions":["OAMAuthnCookie", "JSESSIONID", "HCM-PSJSESSIONID"]
}
],
"key": "1000000",
A request with the cookie name `sessionid` would trigger an exclusion. A request with the cookie name `yourcompany.com` would *not* trigger and exclusion.
type ProtectionRuleExclusion struct {
// The target of the exclusion.
Target ProtectionRuleExclusionTargetEnum `mandatory:"false" json:"target,omitempty"`
Exclusions []string `mandatory:"false" json:"exclusions"`
}
func (m ProtectionRuleExclusion) String() string
func (m ProtectionRuleExclusion) ValidateEnumValue() (bool, error)
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
ProtectionRuleExclusionTargetEnum Enum with underlying type: string
type ProtectionRuleExclusionTargetEnum string
Set of constants representing the allowable values for ProtectionRuleExclusionTargetEnum
const (
ProtectionRuleExclusionTargetRequestCookies ProtectionRuleExclusionTargetEnum = "REQUEST_COOKIES"
ProtectionRuleExclusionTargetRequestCookieNames ProtectionRuleExclusionTargetEnum = "REQUEST_COOKIE_NAMES"
ProtectionRuleExclusionTargetArgs ProtectionRuleExclusionTargetEnum = "ARGS"
ProtectionRuleExclusionTargetArgsNames ProtectionRuleExclusionTargetEnum = "ARGS_NAMES"
)
func GetMappingProtectionRuleExclusionTargetEnum(val string) (ProtectionRuleExclusionTargetEnum, bool)
GetMappingProtectionRuleExclusionTargetEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProtectionRuleExclusionTargetEnumValues() []ProtectionRuleExclusionTargetEnum
GetProtectionRuleExclusionTargetEnumValues Enumerates the set of values for ProtectionRuleExclusionTargetEnum
ProtectionSettings The settings used for protection rules.
type ProtectionSettings struct {
// If `action` is set to `BLOCK`, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to `SET_RESPONSE_CODE`.
BlockAction ProtectionSettingsBlockActionEnum `mandatory:"false" json:"blockAction,omitempty"`
// The response code returned when `action` is set to `BLOCK`, `blockAction` is set to `SET_RESPONSE_CODE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`. The list of available response codes: `400`, `401`, `403`, `405`, `409`, `411`, `412`, `413`, `414`, `415`, `416`, `500`, `501`, `502`, `503`, `504`, `507`.
BlockResponseCode *int `mandatory:"false" json:"blockResponseCode"`
// The message to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 'Access to the website is blocked.'
BlockErrorPageMessage *string `mandatory:"false" json:"blockErrorPageMessage"`
// The error code to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `403`.
BlockErrorPageCode *string `mandatory:"false" json:"blockErrorPageCode"`
// The description text to show on the error page when `action` is set to `BLOCK`, `blockAction` is set to `SHOW_ERROR_PAGE`, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to `Access blocked by website owner. Please contact support.`
BlockErrorPageDescription *string `mandatory:"false" json:"blockErrorPageDescription"`
// The maximum number of arguments allowed to be passed to your application before an action is taken. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `255`. This setting only applies if a corresponding protection rule is enabled, such as the "Number of Arguments Limits" rule (key: 960335).
// Example: If `maxArgumentCount` to `2` for the Max Number of Arguments protection rule (key: 960335), the following requests would be blocked:
// `GET /myapp/path?query=one&query=two&query=three`
// `POST /myapp/path` with Body `{"argument1":"one","argument2":"two","argument3":"three"}`
MaxArgumentCount *int `mandatory:"false" json:"maxArgumentCount"`
// The maximum length allowed for each argument name, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `400`. This setting only applies if a corresponding protection rule is enabled, such as the "Values Limits" rule (key: 960208).
MaxNameLengthPerArgument *int `mandatory:"false" json:"maxNameLengthPerArgument"`
// The maximum length allowed for the sum of the argument name and value, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to `64000`. This setting only applies if a corresponding protection rule is enabled, such as the "Total Arguments Limits" rule (key: 960341).
MaxTotalNameLengthOfArguments *int `mandatory:"false" json:"maxTotalNameLengthOfArguments"`
// The length of time to analyze traffic traffic, in days. After the analysis period, `WafRecommendations` will be populated. If unspecified, defaults to `10`.
// Use `GET /waasPolicies/{waasPolicyId}/wafRecommendations` to view WAF recommendations.
RecommendationsPeriodInDays *int `mandatory:"false" json:"recommendationsPeriodInDays"`
// Inspects the response body of origin responses. Can be used to detect leakage of sensitive data. If unspecified, defaults to `false`.
// **Note:** Only origin responses with a Content-Type matching a value in `mediaTypes` will be inspected.
IsResponseInspected *bool `mandatory:"false" json:"isResponseInspected"`
// The maximum response size to be fully inspected, in binary kilobytes (KiB). Anything over this limit will be partially inspected. If unspecified, defaults to `1024`.
MaxResponseSizeInKiB *int `mandatory:"false" json:"maxResponseSizeInKiB"`
// The list of allowed HTTP methods. If unspecified, default to `[OPTIONS, GET, HEAD, POST]`. This setting only applies if a corresponding protection rule is enabled, such as the "Restrict HTTP Request Methods" rule (key: 911100).
AllowedHttpMethods []ProtectionSettingsAllowedHttpMethodsEnum `mandatory:"false" json:"allowedHttpMethods,omitempty"`
// The list of media types to allow for inspection, if `isResponseInspected` is enabled. Only responses with MIME types in this list will be inspected. If unspecified, defaults to `["text/html", "text/plain", "text/xml"]`.
// Supported MIME types include:
// - text/html
// - text/plain
// - text/asp
// - text/css
// - text/x-script
// - application/json
// - text/webviewhtml
// - text/x-java-source
// - application/x-javascript
// - application/javascript
// - application/ecmascript
// - text/javascript
// - text/ecmascript
// - text/x-script.perl
// - text/x-script.phyton
// - application/plain
// - application/xml
// - text/xml
MediaTypes []string `mandatory:"false" json:"mediaTypes"`
}
func (m ProtectionSettings) String() string
func (m ProtectionSettings) ValidateEnumValue() (bool, error)
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
ProtectionSettingsAllowedHttpMethodsEnum Enum with underlying type: string
type ProtectionSettingsAllowedHttpMethodsEnum string
Set of constants representing the allowable values for ProtectionSettingsAllowedHttpMethodsEnum
const (
ProtectionSettingsAllowedHttpMethodsOptions ProtectionSettingsAllowedHttpMethodsEnum = "OPTIONS"
ProtectionSettingsAllowedHttpMethodsGet ProtectionSettingsAllowedHttpMethodsEnum = "GET"
ProtectionSettingsAllowedHttpMethodsHead ProtectionSettingsAllowedHttpMethodsEnum = "HEAD"
ProtectionSettingsAllowedHttpMethodsPost ProtectionSettingsAllowedHttpMethodsEnum = "POST"
ProtectionSettingsAllowedHttpMethodsPut ProtectionSettingsAllowedHttpMethodsEnum = "PUT"
ProtectionSettingsAllowedHttpMethodsDelete ProtectionSettingsAllowedHttpMethodsEnum = "DELETE"
ProtectionSettingsAllowedHttpMethodsTrace ProtectionSettingsAllowedHttpMethodsEnum = "TRACE"
ProtectionSettingsAllowedHttpMethodsConnect ProtectionSettingsAllowedHttpMethodsEnum = "CONNECT"
ProtectionSettingsAllowedHttpMethodsPatch ProtectionSettingsAllowedHttpMethodsEnum = "PATCH"
ProtectionSettingsAllowedHttpMethodsPropfind ProtectionSettingsAllowedHttpMethodsEnum = "PROPFIND"
)
func GetMappingProtectionSettingsAllowedHttpMethodsEnum(val string) (ProtectionSettingsAllowedHttpMethodsEnum, bool)
GetMappingProtectionSettingsAllowedHttpMethodsEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProtectionSettingsAllowedHttpMethodsEnumValues() []ProtectionSettingsAllowedHttpMethodsEnum
GetProtectionSettingsAllowedHttpMethodsEnumValues Enumerates the set of values for ProtectionSettingsAllowedHttpMethodsEnum
ProtectionSettingsBlockActionEnum Enum with underlying type: string
type ProtectionSettingsBlockActionEnum string
Set of constants representing the allowable values for ProtectionSettingsBlockActionEnum
const (
ProtectionSettingsBlockActionShowErrorPage ProtectionSettingsBlockActionEnum = "SHOW_ERROR_PAGE"
ProtectionSettingsBlockActionSetResponseCode ProtectionSettingsBlockActionEnum = "SET_RESPONSE_CODE"
)
func GetMappingProtectionSettingsBlockActionEnum(val string) (ProtectionSettingsBlockActionEnum, bool)
GetMappingProtectionSettingsBlockActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProtectionSettingsBlockActionEnumValues() []ProtectionSettingsBlockActionEnum
GetProtectionSettingsBlockActionEnumValues Enumerates the set of values for ProtectionSettingsBlockActionEnum
PurgeCache The list of cached resources to purge. If a resource is not specified, the purge targets all rules in a policy.
type PurgeCache struct {
// A resource to purge, specified by either a hostless absolute path starting with a single slash (Example: `/path/to/resource`) or by a relative path in which the first component will be interpreted as a domain protected by the WAAS policy (Example: `example.com/path/to/resource`).
Resources []string `mandatory:"false" json:"resources"`
}
func (m PurgeCache) String() string
func (m PurgeCache) ValidateEnumValue() (bool, error)
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
PurgeCacheRequest wrapper for the PurgeCache operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/PurgeCache.go.html to see an example of how to use PurgeCacheRequest.
type PurgeCacheRequest struct {
// The OCID (https://docs.oracle.com/iaas/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"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
PurgeCache `contributesTo:"body"`
// 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 PurgeCacheRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PurgeCacheRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PurgeCacheRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PurgeCacheRequest) String() string
func (request PurgeCacheRequest) ValidateEnumValue() (bool, error)
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
PurgeCacheResponse wrapper for the PurgeCache operation
type PurgeCacheResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response PurgeCacheResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PurgeCacheResponse) String() string
Recommendation A recommended protection rule for a web application. This recommendation can be accepted to apply it to the Web Application Firewall configuration for this policy. Use the `POST /waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations` method to accept recommended protection rules.
type Recommendation struct {
// The unique key for the recommended protection rule.
Key *string `mandatory:"false" json:"key"`
// The list of the ModSecurity rule IDs associated with the protection rule.
// For more information about ModSecurity's open source WAF rules, see Mod Security's documentation (https://www.modsecurity.org/CRS/Documentation/index.html).
ModSecurityRuleIds []string `mandatory:"false" json:"modSecurityRuleIds"`
// The name of the recommended protection rule.
Name *string `mandatory:"false" json:"name"`
// The description of the recommended protection rule.
Description *string `mandatory:"false" json:"description"`
// The list of labels for the recommended protection rule.
Labels []string `mandatory:"false" json:"labels"`
// The recommended action to apply to the protection rule.
RecommendedAction *string `mandatory:"false" json:"recommendedAction"`
}
func (m Recommendation) String() string
func (m Recommendation) ValidateEnumValue() (bool, error)
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
RedirectClient a client for Redirect
type RedirectClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewRedirectClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RedirectClient, err error)
NewRedirectClientWithConfigurationProvider Creates a new default Redirect client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewRedirectClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RedirectClient, err error)
NewRedirectClientWithOboToken Creates a new default Redirect client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client RedirectClient) ChangeHttpRedirectCompartment(ctx context.Context, request ChangeHttpRedirectCompartmentRequest) (response ChangeHttpRedirectCompartmentResponse, err error)
ChangeHttpRedirectCompartment Moves HTTP Redirect into a different compartment. When provided, If-Match is checked against ETag values of the WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ChangeHttpRedirectCompartment.go.html to see an example of how to use ChangeHttpRedirectCompartment API.
func (client *RedirectClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client RedirectClient) CreateHttpRedirect(ctx context.Context, request CreateHttpRedirectRequest) (response CreateHttpRedirectResponse, err error)
CreateHttpRedirect Creates a new HTTP Redirect on the WAF edge.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/CreateHttpRedirect.go.html to see an example of how to use CreateHttpRedirect API.
func (client RedirectClient) DeleteHttpRedirect(ctx context.Context, request DeleteHttpRedirectRequest) (response DeleteHttpRedirectResponse, err error)
DeleteHttpRedirect Deletes a redirect.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/DeleteHttpRedirect.go.html to see an example of how to use DeleteHttpRedirect API.
func (client RedirectClient) GetHttpRedirect(ctx context.Context, request GetHttpRedirectRequest) (response GetHttpRedirectResponse, err error)
GetHttpRedirect Gets the details of a HTTP Redirect.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetHttpRedirect.go.html to see an example of how to use GetHttpRedirect API. A default retry strategy applies to this operation GetHttpRedirect()
func (client RedirectClient) ListHttpRedirects(ctx context.Context, request ListHttpRedirectsRequest) (response ListHttpRedirectsResponse, err error)
ListHttpRedirects Gets a list of HTTP Redirects.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListHttpRedirects.go.html to see an example of how to use ListHttpRedirects API. A default retry strategy applies to this operation ListHttpRedirects()
func (client *RedirectClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client RedirectClient) UpdateHttpRedirect(ctx context.Context, request UpdateHttpRedirectRequest) (response UpdateHttpRedirectResponse, err error)
UpdateHttpRedirect Updates the details of a HTTP Redirect, including target and tags. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateHttpRedirect.go.html to see an example of how to use UpdateHttpRedirect API.
RemoveHttpResponseHeaderAction An object that represents the action of removing from a response all occurrences of header fields with a specified name.
type RemoveHttpResponseHeaderAction struct {
// A header field name that conforms to RFC 7230.
// Example: `example_header_name`
Header *string `mandatory:"true" json:"header"`
}
func (m RemoveHttpResponseHeaderAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RemoveHttpResponseHeaderAction) String() string
func (m RemoveHttpResponseHeaderAction) ValidateEnumValue() (bool, error)
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
RoundRobinLoadBalancingMethod An object that represents the `round-robin` load balancing method.
type RoundRobinLoadBalancingMethod struct {
}
func (m RoundRobinLoadBalancingMethod) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RoundRobinLoadBalancingMethod) String() string
func (m RoundRobinLoadBalancingMethod) ValidateEnumValue() (bool, error)
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
StickyCookieLoadBalancingMethod An object that represents the `sticky-cookie` load balancing method and its properties.
type StickyCookieLoadBalancingMethod struct {
// The name of the cookie used to track the persistence.
// Can contain any US-ASCII character except separator or control character.
Name *string `mandatory:"false" json:"name"`
// The domain for which the cookie is set, defaults to WAAS policy domain.
Domain *string `mandatory:"false" json:"domain"`
// The time for which a browser should keep the cookie in seconds.
// Empty value will cause the cookie to expire at the end of a browser session.
ExpirationTimeInSeconds *int `mandatory:"false" json:"expirationTimeInSeconds"`
}
func (m StickyCookieLoadBalancingMethod) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StickyCookieLoadBalancingMethod) String() string
func (m StickyCookieLoadBalancingMethod) ValidateEnumValue() (bool, error)
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
ThreatFeed The settings of the threat intelligence feed. You can block requests from IP addresses based on their reputations with various commercial and open source threat feeds.
type ThreatFeed struct {
// The unique key of the threat intelligence feed.
Key *string `mandatory:"false" json:"key"`
// The name of the threat intelligence feed.
Name *string `mandatory:"false" json:"name"`
// The action to take when traffic is flagged as malicious by data from the threat intelligence feed. If unspecified, defaults to `OFF`.
Action ThreatFeedActionEnum `mandatory:"false" json:"action,omitempty"`
// The description of the threat intelligence feed.
Description *string `mandatory:"false" json:"description"`
}
func (m ThreatFeed) String() string
func (m ThreatFeed) ValidateEnumValue() (bool, error)
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
ThreatFeedAction The action to take for a request that has been determined to be potentially malicious.
type ThreatFeedAction struct {
// The unique key of the object for which the action applies.
Key *string `mandatory:"true" json:"key"`
// The selected action. If unspecified, defaults to `OFF`.
Action ThreatFeedActionActionEnum `mandatory:"true" json:"action"`
}
func (m ThreatFeedAction) String() string
func (m ThreatFeedAction) ValidateEnumValue() (bool, error)
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
ThreatFeedActionActionEnum Enum with underlying type: string
type ThreatFeedActionActionEnum string
Set of constants representing the allowable values for ThreatFeedActionActionEnum
const (
ThreatFeedActionActionOff ThreatFeedActionActionEnum = "OFF"
ThreatFeedActionActionDetect ThreatFeedActionActionEnum = "DETECT"
ThreatFeedActionActionBlock ThreatFeedActionActionEnum = "BLOCK"
)
func GetMappingThreatFeedActionActionEnum(val string) (ThreatFeedActionActionEnum, bool)
GetMappingThreatFeedActionActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetThreatFeedActionActionEnumValues() []ThreatFeedActionActionEnum
GetThreatFeedActionActionEnumValues Enumerates the set of values for ThreatFeedActionActionEnum
ThreatFeedActionEnum Enum with underlying type: string
type ThreatFeedActionEnum string
Set of constants representing the allowable values for ThreatFeedActionEnum
const (
ThreatFeedActionOff ThreatFeedActionEnum = "OFF"
ThreatFeedActionDetect ThreatFeedActionEnum = "DETECT"
ThreatFeedActionBlock ThreatFeedActionEnum = "BLOCK"
)
func GetMappingThreatFeedActionEnum(val string) (ThreatFeedActionEnum, bool)
GetMappingThreatFeedActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetThreatFeedActionEnumValues() []ThreatFeedActionEnum
GetThreatFeedActionEnumValues Enumerates the set of values for ThreatFeedActionEnum
UpdateAccessRulesRequest wrapper for the UpdateAccessRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateAccessRules.go.html to see an example of how to use UpdateAccessRulesRequest.
type UpdateAccessRulesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
AccessRules []AccessRule `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateAccessRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAccessRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAccessRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAccessRulesRequest) String() string
func (request UpdateAccessRulesRequest) ValidateEnumValue() (bool, error)
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
UpdateAccessRulesResponse wrapper for the UpdateAccessRules operation
type UpdateAccessRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateAccessRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAccessRulesResponse) String() string
UpdateAddressListDetails The data used to update the address list: IP addresses and CIDR notations.
type UpdateAddressListDetails struct {
// A user-friendly name for the address list.
DisplayName *string `mandatory:"false" json:"displayName"`
// A list of IP addresses or CIDR notations.
Addresses []string `mandatory:"false" json:"addresses"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateAddressListDetails) String() string
func (m UpdateAddressListDetails) ValidateEnumValue() (bool, error)
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
UpdateAddressListRequest wrapper for the UpdateAddressList operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateAddressList.go.html to see an example of how to use UpdateAddressListRequest.
type UpdateAddressListRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the address list. This number is generated when the address list is added to the compartment.
AddressListId *string `mandatory:"true" contributesTo:"path" name:"addressListId"`
// 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"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The details of the address list to update.
UpdateAddressListDetails `contributesTo:"body"`
// 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 UpdateAddressListRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAddressListRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAddressListRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAddressListRequest) String() string
func (request UpdateAddressListRequest) ValidateEnumValue() (bool, error)
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
UpdateAddressListResponse wrapper for the UpdateAddressList operation
type UpdateAddressListResponse struct {
// The underlying http response
RawResponse *http.Response
// The AddressList instance
AddressList `presentIn:"body"`
// 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateAddressListResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAddressListResponse) String() string
UpdateCachingRulesRequest wrapper for the UpdateCachingRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateCachingRules.go.html to see an example of how to use UpdateCachingRulesRequest.
type UpdateCachingRulesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
CachingRulesDetails []CachingRule `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateCachingRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateCachingRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateCachingRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateCachingRulesRequest) String() string
func (request UpdateCachingRulesRequest) ValidateEnumValue() (bool, error)
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
UpdateCachingRulesResponse wrapper for the UpdateCachingRules operation
type UpdateCachingRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateCachingRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateCachingRulesResponse) String() string
UpdateCaptchasRequest wrapper for the UpdateCaptchas operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateCaptchas.go.html to see an example of how to use UpdateCaptchasRequest.
type UpdateCaptchasRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
// A list of CAPTCHA details.
Captchas []Captcha `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateCaptchasRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateCaptchasRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateCaptchasRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateCaptchasRequest) String() string
func (request UpdateCaptchasRequest) ValidateEnumValue() (bool, error)
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
UpdateCaptchasResponse wrapper for the UpdateCaptchas operation
type UpdateCaptchasResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateCaptchasResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateCaptchasResponse) String() string
UpdateCertificateDetails The data used to create a new SSL certificate. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type UpdateCertificateDetails struct {
// A user-friendly name for the SSL certificate. The name can be changed and does not need to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateCertificateDetails) String() string
func (m UpdateCertificateDetails) ValidateEnumValue() (bool, error)
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
UpdateCertificateRequest wrapper for the UpdateCertificate operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateCertificate.go.html to see an example of how to use UpdateCertificateRequest.
type UpdateCertificateRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the SSL certificate used in the WAAS policy. This number is generated when the certificate is added to the policy.
CertificateId *string `mandatory:"true" contributesTo:"path" name:"certificateId"`
// 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"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The new display name, freeform tags, and defined tags to apply to a certificate.
UpdateCertificateDetails `contributesTo:"body"`
// 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 UpdateCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateCertificateRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateCertificateRequest) String() string
func (request UpdateCertificateRequest) ValidateEnumValue() (bool, error)
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
UpdateCertificateResponse wrapper for the UpdateCertificate operation
type UpdateCertificateResponse struct {
// The underlying http response
RawResponse *http.Response
// The Certificate instance
Certificate `presentIn:"body"`
// 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateCertificateResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateCertificateResponse) String() string
UpdateCustomProtectionRuleDetails Updates the configuration details of a custom protection rule. Custom protection rules can only be updated if they are not active in a WAAS policy. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type UpdateCustomProtectionRuleDetails struct {
// A user-friendly name for the custom protection rule.
DisplayName *string `mandatory:"false" json:"displayName"`
// A description for the custom protection rule.
Description *string `mandatory:"false" json:"description"`
// The template text of the custom protection rule. All custom protection rules are expressed in ModSecurity Rule Language.
// Additionally, each rule must include two placeholder variables that are updated by the WAF service upon publication of the rule.
// `id: {{id_1}}` - This field is populated with a unique rule ID generated by the WAF service which identifies a `SecRule`. More than one `SecRule` can be defined in the `template` field of a CreateCustomSecurityRule call. The value of the first `SecRule` must be `id: {{id_1}}` and the `id` field of each subsequent `SecRule` should increase by one, as shown in the example.
// `ctl:ruleEngine={{mode}}` - The action to be taken when the criteria of the `SecRule` are met, either `OFF`, `DETECT` or `BLOCK`. This field is automatically populated with the corresponding value of the `action` field of the `CustomProtectionRuleSetting` schema when the `WafConfig` is updated.
// *Example:*
// ```
// SecRule REQUEST_COOKIES "regex matching SQL injection - part 1/2" \
// "phase:2, \
// msg:'Detects chained SQL injection attempts 1/2.', \
// id: {{id_1}}, \
// ctl:ruleEngine={{mode}}, \
// deny"
// SecRule REQUEST_COOKIES "regex matching SQL injection - part 2/2" \
// "phase:2, \
// msg:'Detects chained SQL injection attempts 2/2.', \
// id: {{id_2}}, \
// ctl:ruleEngine={{mode}}, \
// deny"
// ```
//
// The example contains two `SecRules` each having distinct regex expression to match the `Cookie` header value during the second input analysis phase.
// For more information about custom protection rules, see Custom Protection Rules (https://docs.oracle.com/iaas/Content/WAF/Tasks/customprotectionrules.htm).
// For more information about ModSecurity syntax, see Making Rules: The Basic Syntax (https://www.modsecurity.org/CRS/Documentation/making.html).
// For more information about ModSecurity's open source WAF rules, see Mod Security's OWASP Core Rule Set documentation (https://www.modsecurity.org/CRS/Documentation/index.html).
Template *string `mandatory:"false" json:"template"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateCustomProtectionRuleDetails) String() string
func (m UpdateCustomProtectionRuleDetails) ValidateEnumValue() (bool, error)
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
UpdateCustomProtectionRuleRequest wrapper for the UpdateCustomProtectionRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateCustomProtectionRule.go.html to see an example of how to use UpdateCustomProtectionRuleRequest.
type UpdateCustomProtectionRuleRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule. This number is generated when the custom protection rule is added to the compartment.
CustomProtectionRuleId *string `mandatory:"true" contributesTo:"path" name:"customProtectionRuleId"`
// The details of the custom protection rule to update.
UpdateCustomProtectionRuleDetails `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateCustomProtectionRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateCustomProtectionRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateCustomProtectionRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateCustomProtectionRuleRequest) String() string
func (request UpdateCustomProtectionRuleRequest) ValidateEnumValue() (bool, error)
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
UpdateCustomProtectionRuleResponse wrapper for the UpdateCustomProtectionRule operation
type UpdateCustomProtectionRuleResponse struct {
// The underlying http response
RawResponse *http.Response
// The CustomProtectionRule instance
CustomProtectionRule `presentIn:"body"`
// 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateCustomProtectionRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateCustomProtectionRuleResponse) String() string
UpdateDeviceFingerprintChallengeRequest wrapper for the UpdateDeviceFingerprintChallenge operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateDeviceFingerprintChallenge.go.html to see an example of how to use UpdateDeviceFingerprintChallengeRequest.
type UpdateDeviceFingerprintChallengeRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
// The device fingerprint challenge settings to be updated.
UpdateDeviceFingerprintChallengeDetails DeviceFingerprintChallenge `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateDeviceFingerprintChallengeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDeviceFingerprintChallengeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDeviceFingerprintChallengeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDeviceFingerprintChallengeRequest) String() string
func (request UpdateDeviceFingerprintChallengeRequest) ValidateEnumValue() (bool, error)
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
UpdateDeviceFingerprintChallengeResponse wrapper for the UpdateDeviceFingerprintChallenge operation
type UpdateDeviceFingerprintChallengeResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateDeviceFingerprintChallengeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDeviceFingerprintChallengeResponse) String() string
UpdateGoodBotsRequest wrapper for the UpdateGoodBots operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateGoodBots.go.html to see an example of how to use UpdateGoodBotsRequest.
type UpdateGoodBotsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
GoodBots []GoodBot `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateGoodBotsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateGoodBotsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateGoodBotsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateGoodBotsRequest) String() string
func (request UpdateGoodBotsRequest) ValidateEnumValue() (bool, error)
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
UpdateGoodBotsResponse wrapper for the UpdateGoodBots operation
type UpdateGoodBotsResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateGoodBotsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateGoodBotsResponse) String() string
UpdateHttpRedirectDetails The details of a HTTP Redirect configured to redirect traffic from one hostname to another. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type UpdateHttpRedirectDetails struct {
// The user-friendly name of the HTTP Redirect. The name can be changed and does not need to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// The redirect target object including all the redirect data.
Target *HttpRedirectTarget `mandatory:"false" json:"target"`
// The response code returned for the redirect to the client. For more information, see RFC 7231 (https://tools.ietf.org/html/rfc7231#section-6.4).
ResponseCode *int `mandatory:"false" json:"responseCode"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateHttpRedirectDetails) String() string
func (m UpdateHttpRedirectDetails) ValidateEnumValue() (bool, error)
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
UpdateHttpRedirectRequest wrapper for the UpdateHttpRedirect operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateHttpRedirect.go.html to see an example of how to use UpdateHttpRedirectRequest.
type UpdateHttpRedirectRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HTTP Redirect.
HttpRedirectId *string `mandatory:"true" contributesTo:"path" name:"httpRedirectId"`
// The details of the HTTP Redirect to update.
UpdateHttpRedirectDetails `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateHttpRedirectRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateHttpRedirectRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateHttpRedirectRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateHttpRedirectRequest) String() string
func (request UpdateHttpRedirectRequest) ValidateEnumValue() (bool, error)
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
UpdateHttpRedirectResponse wrapper for the UpdateHttpRedirect operation
type UpdateHttpRedirectResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateHttpRedirectResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateHttpRedirectResponse) String() string
UpdateHumanInteractionChallengeRequest wrapper for the UpdateHumanInteractionChallenge operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateHumanInteractionChallenge.go.html to see an example of how to use UpdateHumanInteractionChallengeRequest.
type UpdateHumanInteractionChallengeRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
// The human interaction challenge settings.
UpdateHumanInteractionChallengeDetails HumanInteractionChallenge `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateHumanInteractionChallengeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateHumanInteractionChallengeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateHumanInteractionChallengeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateHumanInteractionChallengeRequest) String() string
func (request UpdateHumanInteractionChallengeRequest) ValidateEnumValue() (bool, error)
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
UpdateHumanInteractionChallengeResponse wrapper for the UpdateHumanInteractionChallenge operation
type UpdateHumanInteractionChallengeResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateHumanInteractionChallengeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateHumanInteractionChallengeResponse) String() string
UpdateJsChallengeRequest wrapper for the UpdateJsChallenge operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateJsChallenge.go.html to see an example of how to use UpdateJsChallengeRequest.
type UpdateJsChallengeRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
// The JavaScript challenge settings to be updated.
UpdateJsChallengeDetails JsChallenge `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateJsChallengeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateJsChallengeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateJsChallengeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateJsChallengeRequest) String() string
func (request UpdateJsChallengeRequest) ValidateEnumValue() (bool, error)
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
UpdateJsChallengeResponse wrapper for the UpdateJsChallenge operation
type UpdateJsChallengeResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateJsChallengeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateJsChallengeResponse) String() string
UpdatePolicyConfigRequest wrapper for the UpdatePolicyConfig operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdatePolicyConfig.go.html to see an example of how to use UpdatePolicyConfigRequest.
type UpdatePolicyConfigRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
// The new configuration to apply to a WAAS policy.
UpdatePolicyConfigDetails PolicyConfig `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdatePolicyConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePolicyConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePolicyConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePolicyConfigRequest) String() string
func (request UpdatePolicyConfigRequest) ValidateEnumValue() (bool, error)
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
UpdatePolicyConfigResponse wrapper for the UpdatePolicyConfig operation
type UpdatePolicyConfigResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdatePolicyConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePolicyConfigResponse) String() string
UpdateProtectionRulesRequest wrapper for the UpdateProtectionRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateProtectionRules.go.html to see an example of how to use UpdateProtectionRulesRequest.
type UpdateProtectionRulesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
ProtectionRules []ProtectionRuleAction `contributesTo:"body"`
// 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"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateProtectionRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateProtectionRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateProtectionRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateProtectionRulesRequest) String() string
func (request UpdateProtectionRulesRequest) ValidateEnumValue() (bool, error)
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
UpdateProtectionRulesResponse wrapper for the UpdateProtectionRules operation
type UpdateProtectionRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateProtectionRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateProtectionRulesResponse) String() string
UpdateProtectionSettingsRequest wrapper for the UpdateProtectionSettings operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateProtectionSettings.go.html to see an example of how to use UpdateProtectionSettingsRequest.
type UpdateProtectionSettingsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
// The details of the protection settings to be updated.
UpdateProtectionSettingsDetails ProtectionSettings `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateProtectionSettingsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateProtectionSettingsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateProtectionSettingsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateProtectionSettingsRequest) String() string
func (request UpdateProtectionSettingsRequest) ValidateEnumValue() (bool, error)
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
UpdateProtectionSettingsResponse wrapper for the UpdateProtectionSettings operation
type UpdateProtectionSettingsResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateProtectionSettingsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateProtectionSettingsResponse) String() string
UpdateThreatFeedsRequest wrapper for the UpdateThreatFeeds operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateThreatFeeds.go.html to see an example of how to use UpdateThreatFeedsRequest.
type UpdateThreatFeedsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
// A list of threat feeds for which to update the actions.
ThreatFeeds []ThreatFeedAction `contributesTo:"body"`
// 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"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateThreatFeedsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateThreatFeedsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateThreatFeedsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateThreatFeedsRequest) String() string
func (request UpdateThreatFeedsRequest) ValidateEnumValue() (bool, error)
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
UpdateThreatFeedsResponse wrapper for the UpdateThreatFeeds operation
type UpdateThreatFeedsResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateThreatFeedsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateThreatFeedsResponse) String() string
UpdateWaasPolicyCustomProtectionRulesRequest wrapper for the UpdateWaasPolicyCustomProtectionRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateWaasPolicyCustomProtectionRules.go.html to see an example of how to use UpdateWaasPolicyCustomProtectionRulesRequest.
type UpdateWaasPolicyCustomProtectionRulesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
UpdateCustomProtectionRulesDetails []CustomProtectionRuleSetting `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateWaasPolicyCustomProtectionRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateWaasPolicyCustomProtectionRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateWaasPolicyCustomProtectionRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateWaasPolicyCustomProtectionRulesRequest) String() string
func (request UpdateWaasPolicyCustomProtectionRulesRequest) ValidateEnumValue() (bool, error)
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
UpdateWaasPolicyCustomProtectionRulesResponse wrapper for the UpdateWaasPolicyCustomProtectionRules operation
type UpdateWaasPolicyCustomProtectionRulesResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateWaasPolicyCustomProtectionRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateWaasPolicyCustomProtectionRulesResponse) String() string
UpdateWaasPolicyDetails Updates the configuration details of a WAAS policy. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type UpdateWaasPolicyDetails struct {
// A user-friendly name for the WAAS policy. The name can be changed and does not need to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// An array of additional domains protected by this WAAS policy.
AdditionalDomains []string `mandatory:"false" json:"additionalDomains"`
// A map of host to origin for the web application. The key should be a customer friendly name for the host, ex. primary, secondary, etc.
Origins map[string]Origin `mandatory:"false" json:"origins"`
// The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests.
// To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request.
OriginGroups map[string]OriginGroup `mandatory:"false" json:"originGroups"`
PolicyConfig *PolicyConfig `mandatory:"false" json:"policyConfig"`
WafConfig *WafConfig `mandatory:"false" json:"wafConfig"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateWaasPolicyDetails) String() string
func (m UpdateWaasPolicyDetails) ValidateEnumValue() (bool, error)
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
UpdateWaasPolicyRequest wrapper for the UpdateWaasPolicy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateWaasPolicy.go.html to see an example of how to use UpdateWaasPolicyRequest.
type UpdateWaasPolicyRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
// The details of the WAAS policy to update.
UpdateWaasPolicyDetails `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateWaasPolicyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateWaasPolicyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateWaasPolicyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateWaasPolicyRequest) String() string
func (request UpdateWaasPolicyRequest) ValidateEnumValue() (bool, error)
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
UpdateWaasPolicyResponse wrapper for the UpdateWaasPolicy operation
type UpdateWaasPolicyResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateWaasPolicyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateWaasPolicyResponse) String() string
UpdateWafAddressRateLimitingRequest wrapper for the UpdateWafAddressRateLimiting operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateWafAddressRateLimiting.go.html to see an example of how to use UpdateWafAddressRateLimitingRequest.
type UpdateWafAddressRateLimitingRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
// The address rate limiting settings.
UpdateWafAddressRateLimitingDetails AddressRateLimiting `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateWafAddressRateLimitingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateWafAddressRateLimitingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateWafAddressRateLimitingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateWafAddressRateLimitingRequest) String() string
func (request UpdateWafAddressRateLimitingRequest) ValidateEnumValue() (bool, error)
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
UpdateWafAddressRateLimitingResponse wrapper for the UpdateWafAddressRateLimiting operation
type UpdateWafAddressRateLimitingResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateWafAddressRateLimitingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateWafAddressRateLimitingResponse) String() string
UpdateWafConfigRequest wrapper for the UpdateWafConfig operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateWafConfig.go.html to see an example of how to use UpdateWafConfigRequest.
type UpdateWafConfigRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
// The new Web Application Firewall configuration to apply to a WAAS policy.
UpdateWafConfigDetails WafConfig `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateWafConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateWafConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateWafConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateWafConfigRequest) String() string
func (request UpdateWafConfigRequest) ValidateEnumValue() (bool, error)
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
UpdateWafConfigResponse wrapper for the UpdateWafConfig operation
type UpdateWafConfigResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateWafConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateWafConfigResponse) String() string
UpdateWhitelistsRequest wrapper for the UpdateWhitelists operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateWhitelists.go.html to see an example of how to use UpdateWhitelistsRequest.
type UpdateWhitelistsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
WaasPolicyId *string `mandatory:"true" contributesTo:"path" name:"waasPolicyId"`
Whitelists []Whitelist `contributesTo:"body"`
// 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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
// *Example:* If a resource has been deleted and purged from the system, then a retry of the original delete request may be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match` parameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource will be updated or deleted only if the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 UpdateWhitelistsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateWhitelistsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateWhitelistsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateWhitelistsRequest) String() string
func (request UpdateWhitelistsRequest) ValidateEnumValue() (bool, error)
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
UpdateWhitelistsResponse wrapper for the UpdateWhitelists operation
type UpdateWhitelistsResponse struct {
// The underlying http response
RawResponse *http.Response
// 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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateWhitelistsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateWhitelistsResponse) String() string
WaasClient a client for Waas
type WaasClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewWaasClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WaasClient, err error)
NewWaasClientWithConfigurationProvider Creates a new default Waas client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewWaasClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WaasClient, err error)
NewWaasClientWithOboToken Creates a new default Waas client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client WaasClient) AcceptRecommendations(ctx context.Context, request AcceptRecommendationsRequest) (response AcceptRecommendationsResponse, err error)
AcceptRecommendations Accepts a list of recommended Web Application Firewall protection rules. Web Application Firewall protection rule recommendations are sets of rules generated by observed traffic patterns through the Web Application Firewall and are meant to optimize the Web Application Firewall's security profile. Only the rules specified in the request body will be updated; all other rules will remain unchanged. Use the `GET /waasPolicies/{waasPolicyId}/wafConfig/recommendations` method to view a list of recommended Web Application Firewall protection rules. For more information, see WAF Protection Rules (https://docs.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/AcceptRecommendations.go.html to see an example of how to use AcceptRecommendations API.
func (client WaasClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancels a specified work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API.
func (client WaasClient) ChangeAddressListCompartment(ctx context.Context, request ChangeAddressListCompartmentRequest) (response ChangeAddressListCompartmentResponse, err error)
ChangeAddressListCompartment Moves address list into a different compartment. When provided, If-Match is checked against ETag values of the address list. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ChangeAddressListCompartment.go.html to see an example of how to use ChangeAddressListCompartment API.
func (client WaasClient) ChangeCertificateCompartment(ctx context.Context, request ChangeCertificateCompartmentRequest) (response ChangeCertificateCompartmentResponse, err error)
ChangeCertificateCompartment Moves certificate into a different compartment. When provided, If-Match is checked against ETag values of the certificate. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ChangeCertificateCompartment.go.html to see an example of how to use ChangeCertificateCompartment API.
func (client WaasClient) ChangeCustomProtectionRuleCompartment(ctx context.Context, request ChangeCustomProtectionRuleCompartmentRequest) (response ChangeCustomProtectionRuleCompartmentResponse, err error)
ChangeCustomProtectionRuleCompartment Moves a custom protection rule into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the custom protection rule. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ChangeCustomProtectionRuleCompartment.go.html to see an example of how to use ChangeCustomProtectionRuleCompartment API.
func (client WaasClient) ChangeWaasPolicyCompartment(ctx context.Context, request ChangeWaasPolicyCompartmentRequest) (response ChangeWaasPolicyCompartmentResponse, err error)
ChangeWaasPolicyCompartment Moves WAAS policy into a different compartment. When provided, If-Match is checked against ETag values of the WAAS policy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ChangeWaasPolicyCompartment.go.html to see an example of how to use ChangeWaasPolicyCompartment API.
func (client *WaasClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client WaasClient) CreateAddressList(ctx context.Context, request CreateAddressListRequest) (response CreateAddressListResponse, err error)
CreateAddressList Creates an address list in a set compartment and allows it to be used in a WAAS policy and referenced by access rules. Addresses can be IP addresses and CIDR notations.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/CreateAddressList.go.html to see an example of how to use CreateAddressList API.
func (client WaasClient) CreateCertificate(ctx context.Context, request CreateCertificateRequest) (response CreateCertificateResponse, err error)
CreateCertificate Allows an SSL certificate to be added to a WAAS policy. The Web Application Firewall terminates SSL connections to inspect requests in runtime, and then re-encrypts requests before sending them to the origin for fulfillment. For more information, see WAF Settings (https://docs.oracle.com/iaas/Content/WAF/Tasks/wafsettings.htm).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/CreateCertificate.go.html to see an example of how to use CreateCertificate API.
func (client WaasClient) CreateCustomProtectionRule(ctx context.Context, request CreateCustomProtectionRuleRequest) (response CreateCustomProtectionRuleResponse, err error)
CreateCustomProtectionRule Creates a new custom protection rule in the specified compartment. Custom protection rules allow you to create rules in addition to the rulesets provided by the Web Application Firewall service, including rules from ModSecurity (https://modsecurity.org/). The syntax for custom rules is based on the ModSecurity syntax. For more information about custom protection rules, see Custom Protection Rules (https://docs.oracle.com/iaas/Content/WAF/Tasks/customprotectionrules.htm).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/CreateCustomProtectionRule.go.html to see an example of how to use CreateCustomProtectionRule API.
func (client WaasClient) CreateWaasPolicy(ctx context.Context, request CreateWaasPolicyRequest) (response CreateWaasPolicyResponse, err error)
CreateWaasPolicy Creates a new Web Application Acceleration and Security (WAAS) policy in the specified compartment. A WAAS policy must be established before creating Web Application Firewall (WAF) rules. To use WAF rules, your web application's origin servers must defined in the `WaasPolicy` schema. A domain name must be specified when creating a WAAS policy. The domain name should be different from the origins specified in your `WaasPolicy`. Once domain name is entered and stored, it is unchangeable. Use the record data returned in the `cname` field of the `WaasPolicy` object to create a CNAME record in your DNS configuration that will direct your domain's traffic through the WAF. For the purposes of access control, you must provide the OCID of the compartment where you want the service to reside. For information about access control and compartments, see Overview of the IAM Service (https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). You must specify a display name and domain for the WAAS policy. The display name does not have to be unique and can be changed. The domain name should be different from every origin specified in `WaasPolicy`. All Oracle Cloud Infrastructure resources, including WAAS policies, receive a unique, Oracle-assigned ID called an Oracle Cloud Identifier (OCID). When a resource is created, you can find its OCID in the response. You can also retrieve a resource's OCID by using a list API operation for that resource type, or by viewing the resource in the Console. Fore more information, see Resource Identifiers (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). **Note:** After sending the POST request, the new object's state will temporarily be `CREATING`. Ensure that the resource's state has changed to `ACTIVE` before use.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/CreateWaasPolicy.go.html to see an example of how to use CreateWaasPolicy API.
func (client WaasClient) DeleteAddressList(ctx context.Context, request DeleteAddressListRequest) (response DeleteAddressListResponse, err error)
DeleteAddressList Deletes the address list from the compartment if it is not used.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/DeleteAddressList.go.html to see an example of how to use DeleteAddressList API.
func (client WaasClient) DeleteCertificate(ctx context.Context, request DeleteCertificateRequest) (response DeleteCertificateResponse, err error)
DeleteCertificate Deletes an SSL certificate from the WAAS service.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/DeleteCertificate.go.html to see an example of how to use DeleteCertificate API.
func (client WaasClient) DeleteCustomProtectionRule(ctx context.Context, request DeleteCustomProtectionRuleRequest) (response DeleteCustomProtectionRuleResponse, err error)
DeleteCustomProtectionRule Deletes a Custom Protection rule.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/DeleteCustomProtectionRule.go.html to see an example of how to use DeleteCustomProtectionRule API.
func (client WaasClient) DeleteWaasPolicy(ctx context.Context, request DeleteWaasPolicyRequest) (response DeleteWaasPolicyResponse, err error)
DeleteWaasPolicy Deletes a policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/DeleteWaasPolicy.go.html to see an example of how to use DeleteWaasPolicy API.
func (client WaasClient) GetAddressList(ctx context.Context, request GetAddressListRequest) (response GetAddressListResponse, err error)
GetAddressList Gets the details of an address list.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetAddressList.go.html to see an example of how to use GetAddressList API. A default retry strategy applies to this operation GetAddressList()
func (client WaasClient) GetCertificate(ctx context.Context, request GetCertificateRequest) (response GetCertificateResponse, err error)
GetCertificate Gets the details of an SSL certificate.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetCertificate.go.html to see an example of how to use GetCertificate API. A default retry strategy applies to this operation GetCertificate()
func (client WaasClient) GetCustomProtectionRule(ctx context.Context, request GetCustomProtectionRuleRequest) (response GetCustomProtectionRuleResponse, err error)
GetCustomProtectionRule Gets the details of a custom protection rule.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetCustomProtectionRule.go.html to see an example of how to use GetCustomProtectionRule API. A default retry strategy applies to this operation GetCustomProtectionRule()
func (client WaasClient) GetDeviceFingerprintChallenge(ctx context.Context, request GetDeviceFingerprintChallengeRequest) (response GetDeviceFingerprintChallengeResponse, err error)
GetDeviceFingerprintChallenge Gets the device fingerprint challenge settings in the Web Application Firewall configuration for a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetDeviceFingerprintChallenge.go.html to see an example of how to use GetDeviceFingerprintChallenge API. A default retry strategy applies to this operation GetDeviceFingerprintChallenge()
func (client WaasClient) GetHumanInteractionChallenge(ctx context.Context, request GetHumanInteractionChallengeRequest) (response GetHumanInteractionChallengeResponse, err error)
GetHumanInteractionChallenge Gets the human interaction challenge settings in the Web Application Firewall configuration for a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetHumanInteractionChallenge.go.html to see an example of how to use GetHumanInteractionChallenge API. A default retry strategy applies to this operation GetHumanInteractionChallenge()
func (client WaasClient) GetJsChallenge(ctx context.Context, request GetJsChallengeRequest) (response GetJsChallengeResponse, err error)
GetJsChallenge Gets the JavaScript challenge settings in the Web Application Firewall configuration for a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetJsChallenge.go.html to see an example of how to use GetJsChallenge API. A default retry strategy applies to this operation GetJsChallenge()
func (client WaasClient) GetPolicyConfig(ctx context.Context, request GetPolicyConfigRequest) (response GetPolicyConfigResponse, err error)
GetPolicyConfig Gets the configuration of a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetPolicyConfig.go.html to see an example of how to use GetPolicyConfig API. A default retry strategy applies to this operation GetPolicyConfig()
func (client WaasClient) GetProtectionRule(ctx context.Context, request GetProtectionRuleRequest) (response GetProtectionRuleResponse, err error)
GetProtectionRule Gets the details of a protection rule in the Web Application Firewall configuration for a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetProtectionRule.go.html to see an example of how to use GetProtectionRule API. A default retry strategy applies to this operation GetProtectionRule()
func (client WaasClient) GetProtectionSettings(ctx context.Context, request GetProtectionSettingsRequest) (response GetProtectionSettingsResponse, err error)
GetProtectionSettings Gets the protection settings in the Web Application Firewall configuration for a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetProtectionSettings.go.html to see an example of how to use GetProtectionSettings API. A default retry strategy applies to this operation GetProtectionSettings()
func (client WaasClient) GetWaasPolicy(ctx context.Context, request GetWaasPolicyRequest) (response GetWaasPolicyResponse, err error)
GetWaasPolicy Gets the details of a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetWaasPolicy.go.html to see an example of how to use GetWaasPolicy API. A default retry strategy applies to this operation GetWaasPolicy()
func (client WaasClient) GetWafAddressRateLimiting(ctx context.Context, request GetWafAddressRateLimitingRequest) (response GetWafAddressRateLimitingResponse, err error)
GetWafAddressRateLimiting Gets the address rate limiting settings of the Web Application Firewall configuration for a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetWafAddressRateLimiting.go.html to see an example of how to use GetWafAddressRateLimiting API. A default retry strategy applies to this operation GetWafAddressRateLimiting()
func (client WaasClient) GetWafConfig(ctx context.Context, request GetWafConfigRequest) (response GetWafConfigResponse, err error)
GetWafConfig Gets the Web Application Firewall configuration details for a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetWafConfig.go.html to see an example of how to use GetWafConfig API. A default retry strategy applies to this operation GetWafConfig()
func (client WaasClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the details of a specified work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client WaasClient) ListAccessRules(ctx context.Context, request ListAccessRulesRequest) (response ListAccessRulesResponse, err error)
ListAccessRules Gets the currently configured access rules for the Web Application Firewall configuration of a specified WAAS policy. The order of the access rules is important. The rules will be checked in the order they are specified and the first matching rule will be used.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListAccessRules.go.html to see an example of how to use ListAccessRules API. A default retry strategy applies to this operation ListAccessRules()
func (client WaasClient) ListAddressLists(ctx context.Context, request ListAddressListsRequest) (response ListAddressListsResponse, err error)
ListAddressLists Gets a list of address lists that can be used in a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListAddressLists.go.html to see an example of how to use ListAddressLists API. A default retry strategy applies to this operation ListAddressLists()
func (client WaasClient) ListCachingRules(ctx context.Context, request ListCachingRulesRequest) (response ListCachingRulesResponse, err error)
ListCachingRules Gets the currently configured caching rules for the Web Application Firewall configuration of a specified WAAS policy. The rules are processed in the order they are specified in and the first matching rule will be used when processing a request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListCachingRules.go.html to see an example of how to use ListCachingRules API. A default retry strategy applies to this operation ListCachingRules()
func (client WaasClient) ListCaptchas(ctx context.Context, request ListCaptchasRequest) (response ListCaptchasResponse, err error)
ListCaptchas Gets the list of currently configured CAPTCHA challenges in the Web Application Firewall configuration of a WAAS policy. The order of the CAPTCHA challenges is important. The URL for each CAPTCHA will be checked in the order they are created.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListCaptchas.go.html to see an example of how to use ListCaptchas API. A default retry strategy applies to this operation ListCaptchas()
func (client WaasClient) ListCertificates(ctx context.Context, request ListCertificatesRequest) (response ListCertificatesResponse, err error)
ListCertificates Gets a list of SSL certificates that can be used in a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListCertificates.go.html to see an example of how to use ListCertificates API. A default retry strategy applies to this operation ListCertificates()
func (client WaasClient) ListCustomProtectionRules(ctx context.Context, request ListCustomProtectionRulesRequest) (response ListCustomProtectionRulesResponse, err error)
ListCustomProtectionRules Gets a list of custom protection rules for the specified Web Application Firewall.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListCustomProtectionRules.go.html to see an example of how to use ListCustomProtectionRules API. A default retry strategy applies to this operation ListCustomProtectionRules()
func (client WaasClient) ListEdgeSubnets(ctx context.Context, request ListEdgeSubnetsRequest) (response ListEdgeSubnetsResponse, err error)
ListEdgeSubnets Return the list of the tenant's edge node subnets. Use these CIDR blocks to restrict incoming traffic to your origin. These subnets are owned by OCI and forward traffic to customer origins. They are not associated with specific regions or compartments.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListEdgeSubnets.go.html to see an example of how to use ListEdgeSubnets API. A default retry strategy applies to this operation ListEdgeSubnets()
func (client WaasClient) ListGoodBots(ctx context.Context, request ListGoodBotsRequest) (response ListGoodBotsResponse, err error)
ListGoodBots Gets the list of good bots defined in the Web Application Firewall configuration for a WAAS policy. The list is sorted by `key`, in ascending order.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListGoodBots.go.html to see an example of how to use ListGoodBots API. A default retry strategy applies to this operation ListGoodBots()
func (client WaasClient) ListProtectionRules(ctx context.Context, request ListProtectionRulesRequest) (response ListProtectionRulesResponse, err error)
ListProtectionRules Gets the list of available protection rules for a WAAS policy. Use the `GetWafConfig` operation to view a list of currently configured protection rules for the Web Application Firewall, or use the `ListRecommendations` operation to get a list of recommended protection rules for the Web Application Firewall. The list is sorted by `key`, in ascending order.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListProtectionRules.go.html to see an example of how to use ListProtectionRules API. A default retry strategy applies to this operation ListProtectionRules()
func (client WaasClient) ListRecommendations(ctx context.Context, request ListRecommendationsRequest) (response ListRecommendationsResponse, err error)
ListRecommendations Gets the list of recommended Web Application Firewall protection rules. Use the `POST /waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations` method to accept recommended Web Application Firewall protection rules. For more information, see WAF Protection Rules (https://docs.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm). The list is sorted by `key`, in ascending order.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListRecommendations.go.html to see an example of how to use ListRecommendations API. A default retry strategy applies to this operation ListRecommendations()
func (client WaasClient) ListThreatFeeds(ctx context.Context, request ListThreatFeedsRequest) (response ListThreatFeedsResponse, err error)
ListThreatFeeds Gets the list of available web application threat intelligence feeds and the actions set for each feed. The list is sorted by `key`, in ascending order.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListThreatFeeds.go.html to see an example of how to use ListThreatFeeds API. A default retry strategy applies to this operation ListThreatFeeds()
func (client WaasClient) ListWaasPolicies(ctx context.Context, request ListWaasPoliciesRequest) (response ListWaasPoliciesResponse, err error)
ListWaasPolicies Gets a list of WAAS policies.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWaasPolicies.go.html to see an example of how to use ListWaasPolicies API. A default retry strategy applies to this operation ListWaasPolicies()
func (client WaasClient) ListWaasPolicyCustomProtectionRules(ctx context.Context, request ListWaasPolicyCustomProtectionRulesRequest) (response ListWaasPolicyCustomProtectionRulesResponse, err error)
ListWaasPolicyCustomProtectionRules Gets the list of currently configured custom protection rules for a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWaasPolicyCustomProtectionRules.go.html to see an example of how to use ListWaasPolicyCustomProtectionRules API. A default retry strategy applies to this operation ListWaasPolicyCustomProtectionRules()
func (client WaasClient) ListWafBlockedRequests(ctx context.Context, request ListWafBlockedRequestsRequest) (response ListWafBlockedRequestsResponse, err error)
ListWafBlockedRequests Gets the number of blocked requests by a Web Application Firewall feature in five minute blocks, sorted by `timeObserved` in ascending order (starting from oldest data).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWafBlockedRequests.go.html to see an example of how to use ListWafBlockedRequests API. A default retry strategy applies to this operation ListWafBlockedRequests()
func (client WaasClient) ListWafLogs(ctx context.Context, request ListWafLogsRequest) (response ListWafLogsResponse, err error)
ListWafLogs Gets structured Web Application Firewall event logs for a WAAS policy. Sorted by the `timeObserved` in ascending order (starting from the oldest recorded event).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWafLogs.go.html to see an example of how to use ListWafLogs API. A default retry strategy applies to this operation ListWafLogs()
func (client WaasClient) ListWafRequests(ctx context.Context, request ListWafRequestsRequest) (response ListWafRequestsResponse, err error)
ListWafRequests Gets the number of requests managed by a Web Application Firewall over a specified period of time, including blocked requests. Sorted by `timeObserved` in ascending order (starting from oldest requests).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWafRequests.go.html to see an example of how to use ListWafRequests API. A default retry strategy applies to this operation ListWafRequests()
func (client WaasClient) ListWafTraffic(ctx context.Context, request ListWafTrafficRequest) (response ListWafTrafficResponse, err error)
ListWafTraffic Gets the Web Application Firewall traffic data for a WAAS policy. Sorted by `timeObserved` in ascending order (starting from oldest data).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWafTraffic.go.html to see an example of how to use ListWafTraffic API. A default retry strategy applies to this operation ListWafTraffic()
func (client WaasClient) ListWhitelists(ctx context.Context, request ListWhitelistsRequest) (response ListWhitelistsResponse, err error)
ListWhitelists Gets the list of whitelists defined in the Web Application Firewall configuration for a WAAS policy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWhitelists.go.html to see an example of how to use ListWhitelists API. A default retry strategy applies to this operation ListWhitelists()
func (client WaasClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Gets a list of subnets (CIDR notation) from which the WAAS EDGE may make requests. The subnets are owned by OCI and forward traffic to your origins. Allow traffic from these subnets to your origins. They are not associated with specific regions or compartments.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client WaasClient) PurgeCache(ctx context.Context, request PurgeCacheRequest) (response PurgeCacheResponse, err error)
PurgeCache Performs a purge of the cache for each specified resource. If no resources are passed, the cache for the entire Web Application Firewall will be purged. For more information, see Caching Rules (https://docs.oracle.com/iaas/Content/WAF/Tasks/cachingrules.htm#purge).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/PurgeCache.go.html to see an example of how to use PurgeCache API.
func (client *WaasClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client WaasClient) UpdateAccessRules(ctx context.Context, request UpdateAccessRulesRequest) (response UpdateAccessRulesResponse, err error)
UpdateAccessRules Updates the list of access rules in the Web Application Firewall configuration for a specified WAAS policy. Access rules allow explicit actions to be defined and executed for requests that meet various conditions. A rule action can be set to allow, detect, or block requests. The detect setting allows the request to pass through the Web Application Firewall and is tagged with a `DETECT` flag in the Web Application Firewall's log. This operation can create, delete, update, and/or reorder access rules depending on the structure of the request body. Access rules can be updated by changing the properties of the access rule object with the rule's key specified in the key field. Access rules can be reordered by changing the order of the access rules in the list when updating. Access rules can be created by adding a new access rule object to the list without a `key` property specified. A `key` will be generated for the new access rule upon update. Any existing access rules that are not specified with a `key` in the list of access rules will be deleted upon update.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateAccessRules.go.html to see an example of how to use UpdateAccessRules API.
func (client WaasClient) UpdateAddressList(ctx context.Context, request UpdateAddressListRequest) (response UpdateAddressListResponse, err error)
UpdateAddressList Updates the details of an address list. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateAddressList.go.html to see an example of how to use UpdateAddressList API.
func (client WaasClient) UpdateCachingRules(ctx context.Context, request UpdateCachingRulesRequest) (response UpdateCachingRulesResponse, err error)
UpdateCachingRules Updates the configuration for each specified caching rule. Caching rules WAF policies allow you to selectively cache content on Oracle Cloud Infrastructure's edge servers, such as webpages or certain file types. For more information about caching rules, see Caching Rules (https://docs.oracle.com/iaas/Content/WAF/Tasks/cachingrules.htm). This operation can create, delete, update, and/or reorder caching rules depending on the structure of the request body. Caching rules can be updated by changing the properties of the caching rule object with the rule's key specified in the key field. Any existing caching rules that are not specified with a key in the list of access rules will be deleted upon update. The order the caching rules are specified in is important. The rules are processed in the order they are specified and the first matching rule will be used when processing a request. Use `ListCachingRules` to view a list of all available caching rules in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateCachingRules.go.html to see an example of how to use UpdateCachingRules API.
func (client WaasClient) UpdateCaptchas(ctx context.Context, request UpdateCaptchasRequest) (response UpdateCaptchasResponse, err error)
UpdateCaptchas Updates the list of CAPTCHA challenges in the Web Application Firewall configuration for a WAAS policy. This operation can create, update, or delete CAPTCHAs depending on the structure of the request body. CAPTCHA challenges can be updated by changing the properties of the CAPTCHA object with the rule's key specified in the key field. CAPTCHA challenges can be reordered by changing the order of the CAPTCHA challenges in the list when updating. CAPTCHA challenges can be created by adding a new access rule object to the list without a `key` property specified. A `key` will be generated for the new CAPTCHA challenges upon update. Any existing CAPTCHA challenges that are not specified with a `key` in the list of CAPTCHA challenges will be deleted upon update. Query parameters are allowed in CAPTCHA URL.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateCaptchas.go.html to see an example of how to use UpdateCaptchas API.
func (client WaasClient) UpdateCertificate(ctx context.Context, request UpdateCertificateRequest) (response UpdateCertificateResponse, err error)
UpdateCertificate It is not possible to update a certificate, only create and delete. Therefore, this operation can only update the display name, freeform tags, and defined tags of a certificate.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateCertificate.go.html to see an example of how to use UpdateCertificate API.
func (client WaasClient) UpdateCustomProtectionRule(ctx context.Context, request UpdateCustomProtectionRuleRequest) (response UpdateCustomProtectionRuleResponse, err error)
UpdateCustomProtectionRule Updates the configuration of a custom protection rule. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateCustomProtectionRule.go.html to see an example of how to use UpdateCustomProtectionRule API.
func (client WaasClient) UpdateDeviceFingerprintChallenge(ctx context.Context, request UpdateDeviceFingerprintChallengeRequest) (response UpdateDeviceFingerprintChallengeResponse, err error)
UpdateDeviceFingerprintChallenge Updates the Device Fingerprint Challenge (DFC) settings in the Web Application Firewall configuration for a policy. The DFC generates a hashed signature of both virtual and real browsers based on 50+ attributes. These proprietary signatures are then leveraged for real-time correlation to identify and block malicious bots. The signature is based on a library of attributes detected via JavaScript listeners; the attributes include OS, screen resolution, fonts, UserAgent, IP address, etc. We are constantly making improvements and considering new libraries to include in our DFC build. We can also exclude attributes from the signature as needed. DFC collects attributes to generate a hashed signature about a client - if a fingerprint is not possible, then it will result in a block or alert action. Actions can be enforced across multiple devices if they share they have the same fingerprint.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateDeviceFingerprintChallenge.go.html to see an example of how to use UpdateDeviceFingerprintChallenge API.
func (client WaasClient) UpdateGoodBots(ctx context.Context, request UpdateGoodBotsRequest) (response UpdateGoodBotsResponse, err error)
UpdateGoodBots Updates the list of good bots in the Web Application Firewall configuration for a policy. Only the fields specified in the request body will be updated, all other configuration properties will remain unchanged. Good bots allows you to manage access for bots from known providers, such as Google or Baidu. For more information about good bots, see Bot Management (https://docs.oracle.com/iaas/Content/WAF/Tasks/botmanagement.htm).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateGoodBots.go.html to see an example of how to use UpdateGoodBots API.
func (client WaasClient) UpdateHumanInteractionChallenge(ctx context.Context, request UpdateHumanInteractionChallengeRequest) (response UpdateHumanInteractionChallengeResponse, err error)
UpdateHumanInteractionChallenge Updates the Human Interaction Challenge (HIC) settings in the Web Application Firewall configuration for a WAAS policy. HIC is a countermeasure that allows the proxy to check the user's browser for various behaviors that distinguish a human presence from a bot.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateHumanInteractionChallenge.go.html to see an example of how to use UpdateHumanInteractionChallenge API.
func (client WaasClient) UpdateJsChallenge(ctx context.Context, request UpdateJsChallengeRequest) (response UpdateJsChallengeResponse, err error)
UpdateJsChallenge Updates the JavaScript challenge settings in the Web Application Firewall configuration for a WAAS policy. JavaScript Challenge validates that the client can accept JavaScript with a binary decision. For more information, see Bot Management (https://docs.oracle.com/iaas/Content/WAF/Tasks/botmanagement.htm).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateJsChallenge.go.html to see an example of how to use UpdateJsChallenge API.
func (client WaasClient) UpdatePolicyConfig(ctx context.Context, request UpdatePolicyConfigRequest) (response UpdatePolicyConfigResponse, err error)
UpdatePolicyConfig Updates the configuration for a WAAS policy. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdatePolicyConfig.go.html to see an example of how to use UpdatePolicyConfig API.
func (client WaasClient) UpdateProtectionRules(ctx context.Context, request UpdateProtectionRulesRequest) (response UpdateProtectionRulesResponse, err error)
UpdateProtectionRules Updates the action for each specified protection rule. Requests can either be allowed, blocked, or trigger an alert if they meet the parameters of an applied rule. For more information on protection rules, see WAF Protection Rules (https://docs.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm). This operation can update or disable protection rules depending on the structure of the request body. Protection rules can be updated by changing the properties of the protection rule object with the rule's key specified in the key field.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateProtectionRules.go.html to see an example of how to use UpdateProtectionRules API.
func (client WaasClient) UpdateProtectionSettings(ctx context.Context, request UpdateProtectionSettingsRequest) (response UpdateProtectionSettingsResponse, err error)
UpdateProtectionSettings Updates the protection settings in the Web Application Firewall configuration for a WAAS policy. Protection settings allow you define what action is taken when a request is blocked by the Web Application Firewall, such as returning a response code or block page. Only the fields specified in the request body will be updated; all other fields will remain unchanged.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateProtectionSettings.go.html to see an example of how to use UpdateProtectionSettings API.
func (client WaasClient) UpdateThreatFeeds(ctx context.Context, request UpdateThreatFeedsRequest) (response UpdateThreatFeedsResponse, err error)
UpdateThreatFeeds Updates the action to take when a request's IP address matches an address in the specified threat intelligence feed. Threat intelligence feeds are compiled lists of IP addresses with malicious reputations based on internet intelligence. Only the threat feeds specified in the request body will be updated; all other threat feeds will remain unchanged.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateThreatFeeds.go.html to see an example of how to use UpdateThreatFeeds API.
func (client WaasClient) UpdateWaasPolicy(ctx context.Context, request UpdateWaasPolicyRequest) (response UpdateWaasPolicyResponse, err error)
UpdateWaasPolicy Updates the details of a WAAS policy, including origins and tags. Only the fields specified in the request body will be updated; all other properties will remain unchanged. To update platform provided resources such as `GoodBots`, `ProtectionRules`, and `ThreatFeeds`, first retrieve the list of available resources with the related list operation such as `GetThreatFeeds` or `GetProtectionRules`. The returned list will contain objects with `key` properties that can be used to update the resource during the `UpdateWaasPolicy` request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateWaasPolicy.go.html to see an example of how to use UpdateWaasPolicy API.
func (client WaasClient) UpdateWaasPolicyCustomProtectionRules(ctx context.Context, request UpdateWaasPolicyCustomProtectionRulesRequest) (response UpdateWaasPolicyCustomProtectionRulesResponse, err error)
UpdateWaasPolicyCustomProtectionRules Updates the action for each specified custom protection rule. Only the `DETECT` and `BLOCK` actions can be set. Disabled rules should not be included in the list. For more information on protection rules, see WAF Protection Rules (https://docs.oracle.com/iaas/Content/WAF/Tasks/wafprotectionrules.htm).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateWaasPolicyCustomProtectionRules.go.html to see an example of how to use UpdateWaasPolicyCustomProtectionRules API.
func (client WaasClient) UpdateWafAddressRateLimiting(ctx context.Context, request UpdateWafAddressRateLimitingRequest) (response UpdateWafAddressRateLimitingResponse, err error)
UpdateWafAddressRateLimiting Updates the address rate limiting settings in the Web Application Firewall configuration for a policy. Rate limiting allows you to configure a threshold for the number of requests from a unique IP address for the given period. You can also define the response code for the requests from the same address that exceed the threshold.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateWafAddressRateLimiting.go.html to see an example of how to use UpdateWafAddressRateLimiting API.
func (client WaasClient) UpdateWafConfig(ctx context.Context, request UpdateWafConfigRequest) (response UpdateWafConfigResponse, err error)
UpdateWafConfig Updates the Web Application Firewall configuration for a specified WAAS policy. To update platform provided resources such as `GoodBots`, `ProtectionRules`, and `ThreatFeeds`, first retrieve the list of available resources with the related list operation, such as `GetThreatFeeds` or `GetProtectionRules`. The returned list will contain objects with `key` properties that can be used to update the resource during the `UpdateWafConfig` request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateWafConfig.go.html to see an example of how to use UpdateWafConfig API.
func (client WaasClient) UpdateWhitelists(ctx context.Context, request UpdateWhitelistsRequest) (response UpdateWhitelistsResponse, err error)
UpdateWhitelists Updates the list of IP addresses that bypass the Web Application Firewall for a WAAS policy. Supports single IP addresses, subnet masks (CIDR notation) and Address Lists. This operation can create, delete, update, and/or reorder whitelists depending on the structure of the request body. Whitelists can be updated by changing the properties of the whitelist object with the rule's key specified in the `key` field. Whitelists can be reordered by changing the order of the whitelists in the list of objects when updating. Whitelists can be created by adding a new whitelist object to the list without a `key` property specified. A `key` will be generated for the new whitelist upon update. Whitelists can be deleted by removing the existing whitelist object from the list. Any existing whitelists that are not specified with a `key` in the list of access rules will be deleted upon update.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/waas/UpdateWhitelists.go.html to see an example of how to use UpdateWhitelists API.
WaasPolicy The details of a Web Application Acceleration and Security (WAAS) policy. A policy describes how the WAAS service should operate for the configured web application. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type WaasPolicy struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy's compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The user-friendly name of the WAAS policy. The name can be changed and does not need to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// The web application domain that the WAAS policy protects.
Domain *string `mandatory:"false" json:"domain"`
// An array of additional domains for this web application.
AdditionalDomains []string `mandatory:"false" json:"additionalDomains"`
// The CNAME record to add to your DNS configuration to route traffic for the domain, and all additional domains, through the WAF.
Cname *string `mandatory:"false" json:"cname"`
// The current lifecycle state of the WAAS policy.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the policy was created, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// A map of host servers (origins) and their keys for the web application. Origin keys are used to associate origins to specific protection rules. The key should be a user-friendly name for the host. **Examples:** `primary` or `secondary`.
Origins map[string]Origin `mandatory:"false" json:"origins"`
// The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests.
OriginGroups map[string]OriginGroup `mandatory:"false" json:"originGroups"`
PolicyConfig *PolicyConfig `mandatory:"false" json:"policyConfig"`
WafConfig *WafConfig `mandatory:"false" json:"wafConfig"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m WaasPolicy) String() string
func (m WaasPolicy) ValidateEnumValue() (bool, error)
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
WaasPolicyCustomProtectionRuleSummary The OCID and action of a custom protection rule.
type WaasPolicyCustomProtectionRuleSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom protection rule.
Id *string `mandatory:"false" json:"id"`
// The user-friendly name of the custom protection rule.
DisplayName *string `mandatory:"false" json:"displayName"`
// The action to take when the custom protection rule is triggered.
// `DETECT` - Logs the request when the criteria of the custom protection rule are met. `BLOCK` - Blocks the request when the criteria of the custom protection rule are met.
Action WaasPolicyCustomProtectionRuleSummaryActionEnum `mandatory:"false" json:"action,omitempty"`
// The list of the ModSecurity rule IDs that apply to this protection rule. For more information about ModSecurity's open source WAF rules, see Mod Security's documentation (https://www.modsecurity.org/CRS/Documentation/index.html).
ModSecurityRuleIds []string `mandatory:"false" json:"modSecurityRuleIds"`
Exclusions []ProtectionRuleExclusion `mandatory:"false" json:"exclusions"`
}
func (m WaasPolicyCustomProtectionRuleSummary) String() string
func (m WaasPolicyCustomProtectionRuleSummary) ValidateEnumValue() (bool, error)
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
WaasPolicyCustomProtectionRuleSummaryActionEnum Enum with underlying type: string
type WaasPolicyCustomProtectionRuleSummaryActionEnum string
Set of constants representing the allowable values for WaasPolicyCustomProtectionRuleSummaryActionEnum
const (
WaasPolicyCustomProtectionRuleSummaryActionDetect WaasPolicyCustomProtectionRuleSummaryActionEnum = "DETECT"
WaasPolicyCustomProtectionRuleSummaryActionBlock WaasPolicyCustomProtectionRuleSummaryActionEnum = "BLOCK"
)
func GetMappingWaasPolicyCustomProtectionRuleSummaryActionEnum(val string) (WaasPolicyCustomProtectionRuleSummaryActionEnum, bool)
GetMappingWaasPolicyCustomProtectionRuleSummaryActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWaasPolicyCustomProtectionRuleSummaryActionEnumValues() []WaasPolicyCustomProtectionRuleSummaryActionEnum
GetWaasPolicyCustomProtectionRuleSummaryActionEnumValues Enumerates the set of values for WaasPolicyCustomProtectionRuleSummaryActionEnum
WaasPolicyLifecycleStateEnum is an alias to type: LifecycleStatesEnum Consider using LifecycleStatesEnum instead Deprecated
type WaasPolicyLifecycleStateEnum = LifecycleStatesEnum
WaasPolicySummary Summary information about a WAAS policy. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type WaasPolicySummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the WAAS policy's compartment.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The user-friendly name of the WAAS policy. The name can be changed and does not need to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// The web application domain that the WAAS policy protects.
Domain *string `mandatory:"false" json:"domain"`
// The current lifecycle state of the WAAS policy.
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the policy was created, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m WaasPolicySummary) String() string
func (m WaasPolicySummary) ValidateEnumValue() (bool, error)
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
WaasPolicySummaryLifecycleStateEnum is an alias to type: LifecycleStatesEnum Consider using LifecycleStatesEnum instead Deprecated
type WaasPolicySummaryLifecycleStateEnum = LifecycleStatesEnum
WafBlockedRequest The representation of WafBlockedRequest
type WafBlockedRequest struct {
// The date and time the blocked requests were observed, expressed in RFC 3339 timestamp format.
TimeObserved *common.SDKTime `mandatory:"false" json:"timeObserved"`
// The number of seconds the data covers.
TimeRangeInSeconds *int `mandatory:"false" json:"timeRangeInSeconds"`
// The specific Web Application Firewall feature that blocked the requests, such as JavaScript Challenge or Access Control.
WafFeature WafBlockedRequestWafFeatureEnum `mandatory:"false" json:"wafFeature,omitempty"`
// The count of blocked requests.
Count *int `mandatory:"false" json:"count"`
}
func (m WafBlockedRequest) String() string
func (m WafBlockedRequest) ValidateEnumValue() (bool, error)
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
WafBlockedRequestWafFeatureEnum Enum with underlying type: string
type WafBlockedRequestWafFeatureEnum string
Set of constants representing the allowable values for WafBlockedRequestWafFeatureEnum
const (
WafBlockedRequestWafFeatureProtectionRules WafBlockedRequestWafFeatureEnum = "PROTECTION_RULES"
WafBlockedRequestWafFeatureJsChallenge WafBlockedRequestWafFeatureEnum = "JS_CHALLENGE"
WafBlockedRequestWafFeatureAccessRules WafBlockedRequestWafFeatureEnum = "ACCESS_RULES"
WafBlockedRequestWafFeatureThreatFeeds WafBlockedRequestWafFeatureEnum = "THREAT_FEEDS"
WafBlockedRequestWafFeatureHumanInteractionChallenge WafBlockedRequestWafFeatureEnum = "HUMAN_INTERACTION_CHALLENGE"
WafBlockedRequestWafFeatureDeviceFingerprintChallenge WafBlockedRequestWafFeatureEnum = "DEVICE_FINGERPRINT_CHALLENGE"
WafBlockedRequestWafFeatureCaptcha WafBlockedRequestWafFeatureEnum = "CAPTCHA"
WafBlockedRequestWafFeatureAddressRateLimiting WafBlockedRequestWafFeatureEnum = "ADDRESS_RATE_LIMITING"
)
func GetMappingWafBlockedRequestWafFeatureEnum(val string) (WafBlockedRequestWafFeatureEnum, bool)
GetMappingWafBlockedRequestWafFeatureEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWafBlockedRequestWafFeatureEnumValues() []WafBlockedRequestWafFeatureEnum
GetWafBlockedRequestWafFeatureEnumValues Enumerates the set of values for WafBlockedRequestWafFeatureEnum
WafConfig The Web Application Firewall configuration for the WAAS policy.
type WafConfig struct {
// The access rules applied to the Web Application Firewall. Used for defining custom access policies with the combination of `ALLOW`, `DETECT`, and `BLOCK` rules, based on different criteria.
AccessRules []AccessRule `mandatory:"false" json:"accessRules"`
// The IP address rate limiting settings used to limit the number of requests from an address.
AddressRateLimiting *AddressRateLimiting `mandatory:"false" json:"addressRateLimiting"`
// A list of CAPTCHA challenge settings. These are used to challenge requests with a CAPTCHA to block bots.
Captchas []Captcha `mandatory:"false" json:"captchas"`
// The device fingerprint challenge settings. Used to detect unique devices based on the device fingerprint information collected in order to block bots.
DeviceFingerprintChallenge *DeviceFingerprintChallenge `mandatory:"false" json:"deviceFingerprintChallenge"`
// A list of bots allowed to access the web application.
GoodBots []GoodBot `mandatory:"false" json:"goodBots"`
// The human interaction challenge settings. Used to look for natural human interactions such as mouse movements, time on site, and page scrolling to identify bots.
HumanInteractionChallenge *HumanInteractionChallenge `mandatory:"false" json:"humanInteractionChallenge"`
// The JavaScript challenge settings. Used to challenge requests with a JavaScript challenge and take the action if a browser has no JavaScript support in order to block bots.
JsChallenge *JsChallenge `mandatory:"false" json:"jsChallenge"`
// The key in the map of origins referencing the origin used for the Web Application Firewall. The origin must already be included in `Origins`. Required when creating the `WafConfig` resource, but not on update.
Origin *string `mandatory:"false" json:"origin"`
// A list of caching rules applied to the web application.
CachingRules []CachingRule `mandatory:"false" json:"cachingRules"`
// A list of the custom protection rule OCIDs and their actions.
CustomProtectionRules []CustomProtectionRuleSetting `mandatory:"false" json:"customProtectionRules"`
// The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests.
// To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request.
OriginGroups []string `mandatory:"false" json:"originGroups"`
// A list of the protection rules and their details.
ProtectionRules []ProtectionRule `mandatory:"false" json:"protectionRules"`
// The settings to apply to protection rules.
ProtectionSettings *ProtectionSettings `mandatory:"false" json:"protectionSettings"`
// A list of threat intelligence feeds and the actions to apply to known malicious traffic based on internet intelligence.
ThreatFeeds []ThreatFeed `mandatory:"false" json:"threatFeeds"`
// A list of IP addresses that bypass the Web Application Firewall.
Whitelists []Whitelist `mandatory:"false" json:"whitelists"`
}
func (m WafConfig) String() string
func (m WafConfig) ValidateEnumValue() (bool, error)
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
WafConfigDetails The Web Application Firewall configuration for the WAAS policy creation.
type WafConfigDetails struct {
// The access rules applied to the Web Application Firewall. Access rules allow custom content access policies to be defined and `ALLOW`, `DETECT`, or `BLOCK` actions to be taken on a request when specified criteria are met.
AccessRules []AccessRule `mandatory:"false" json:"accessRules"`
// The settings used to limit the number of requests from an IP address.
AddressRateLimiting *AddressRateLimiting `mandatory:"false" json:"addressRateLimiting"`
// A list of CAPTCHA challenge settings. CAPTCHAs challenge requests to ensure a human is attempting to reach the specified URL and not a bot.
Captchas []Captcha `mandatory:"false" json:"captchas"`
// The device fingerprint challenge settings. Blocks bots based on unique device fingerprint information.
DeviceFingerprintChallenge *DeviceFingerprintChallenge `mandatory:"false" json:"deviceFingerprintChallenge"`
// The human interaction challenge settings. Detects natural human interactions such as mouse movements, time on site, and page scrolling to identify bots.
HumanInteractionChallenge *HumanInteractionChallenge `mandatory:"false" json:"humanInteractionChallenge"`
// The JavaScript challenge settings. Blocks bots by challenging requests from browsers that have no JavaScript support.
JsChallenge *JsChallenge `mandatory:"false" json:"jsChallenge"`
// The key in the map of origins referencing the origin used for the Web Application Firewall. The origin must already be included in `Origins`. Required when creating the `WafConfig` resource, but is not required upon updating the configuration.
Origin *string `mandatory:"false" json:"origin"`
// A list of caching rules applied to the web application.
CachingRules []CachingRule `mandatory:"false" json:"cachingRules"`
// A list of the custom protection rule OCIDs and their actions.
CustomProtectionRules []CustomProtectionRuleSetting `mandatory:"false" json:"customProtectionRules"`
// The map of origin groups and their keys used to associate origins to the `wafConfig`. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests.
// To add additional origins to your WAAS policy, update the `origins` field of a `UpdateWaasPolicy` request.
OriginGroups []string `mandatory:"false" json:"originGroups"`
// The settings applied to protection rules.
ProtectionSettings *ProtectionSettings `mandatory:"false" json:"protectionSettings"`
// A list of IP addresses that bypass the Web Application Firewall.
Whitelists []Whitelist `mandatory:"false" json:"whitelists"`
}
func (m WafConfigDetails) String() string
func (m WafConfigDetails) ValidateEnumValue() (bool, error)
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
WafLog A list of Web Application Firewall log entries. Each entry is a JSON object, including a timestamp property and other fields varying based on log type. Logs record what rules and countermeasures are triggered by requests and are used as a basis to move request handling into block mode. For more information about WAF logs, see Logs (https://docs.oracle.com/iaas/Content/WAF/Tasks/logs.htm).
type WafLog struct {
// The action taken on the request, either `ALLOW`, `DETECT`, or `BLOCK`.
Action *string `mandatory:"false" json:"action"`
// The CAPTCHA action taken on the request, `ALLOW` or `BLOCK`. For more information about
// CAPTCHAs, see `UpdateCaptchas`.
CaptchaAction *string `mandatory:"false" json:"captchaAction"`
// The CAPTCHA challenge answer that was expected.
CaptchaExpected *string `mandatory:"false" json:"captchaExpected"`
// The CAPTCHA challenge answer that was received.
CaptchaReceived *string `mandatory:"false" json:"captchaReceived"`
// The number of times the CAPTCHA challenge was failed.
CaptchaFailCount *string `mandatory:"false" json:"captchaFailCount"`
// The IPv4 address of the requesting client.
ClientAddress *string `mandatory:"false" json:"clientAddress"`
// The name of the country where the request originated.
CountryName *string `mandatory:"false" json:"countryName"`
// The value of the request's `User-Agent` header field.
UserAgent *string `mandatory:"false" json:"userAgent"`
// The `Host` header data of the request.
Domain *string `mandatory:"false" json:"domain"`
// A map of protection rule keys to detection message details. Detections are
// requests that matched the criteria of a protection rule but the rule's
// action was set to `DETECT`.
ProtectionRuleDetections map[string]string `mandatory:"false" json:"protectionRuleDetections"`
// The HTTP method of the request.
HttpMethod *string `mandatory:"false" json:"httpMethod"`
// The path and query string of the request.
RequestUrl *string `mandatory:"false" json:"requestUrl"`
// The map of the request's header names to their respective values.
HttpHeaders map[string]string `mandatory:"false" json:"httpHeaders"`
// The `Referrer` header value of the request.
Referrer *string `mandatory:"false" json:"referrer"`
// The status code of the response.
ResponseCode *int `mandatory:"false" json:"responseCode"`
// The size in bytes of the response.
ResponseSize *int `mandatory:"false" json:"responseSize"`
// The incident key of a request. An incident key is generated for
// each request processed by the Web Application Firewall and is used to
// idenitfy blocked requests in applicable logs.
IncidentKey *string `mandatory:"false" json:"incidentKey"`
// The hashed signature of the device's fingerprint. For more information,
// see `DeviceFingerPrintChallenge`.
Fingerprint *string `mandatory:"false" json:"fingerprint"`
// The type of device that the request was made from.
Device *string `mandatory:"false" json:"device"`
// ISO 3166-1 alpha-2 code of the country from which the request originated.
// For a list of codes, see ISO's website (https://www.iso.org/obp/ui/#search/code/).
CountryCode *string `mandatory:"false" json:"countryCode"`
// A map of header names to values of the request sent to the origin, including any headers
// appended by the Web Application Firewall.
RequestHeaders map[string]string `mandatory:"false" json:"requestHeaders"`
// The `ThreatFeed` key that matched the request. For more information about
// threat feeds, see `UpdateThreatFeeds`.
ThreatFeedKey *string `mandatory:"false" json:"threatFeedKey"`
// The `AccessRule` key that matched the request. For more information about
// access rules, see `UpdateAccessRules`.
AccessRuleKey *string `mandatory:"false" json:"accessRuleKey"`
// The `AddressRateLimiting` key that matched the request. For more information
// about address rate limiting, see `UpdateWafAddressRateLimiting`.
AddressRateLimitingKey *string `mandatory:"false" json:"addressRateLimitingKey"`
// The date and time the Web Application Firewall processed the request and logged it.
Timestamp *common.SDKTime `mandatory:"false" json:"timestamp"`
// The type of log of the request. For more about log types, see Logs (https://docs.oracle.com/iaas/Content/WAF/Tasks/logs.htm).
LogType *string `mandatory:"false" json:"logType"`
// The address of the origin server where the request was sent.
OriginAddress *string `mandatory:"false" json:"originAddress"`
// The amount of time it took the origin server to respond to the request, in seconds.
OriginResponseTime *string `mandatory:"false" json:"originResponseTime"`
}
func (m WafLog) String() string
func (m WafLog) ValidateEnumValue() (bool, error)
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
WafMeterDatum The representation of WafMeterDatum
type WafMeterDatum struct {
// The date and time the traffic was observed, rounded down to the start of a range, and expressed in RFC 3339 timestamp format.
TimeObserved *common.SDKTime `mandatory:"false" json:"timeObserved"`
// The number of seconds this data covers.
TimeRangeInSeconds *int `mandatory:"false" json:"timeRangeInSeconds"`
// The tenancy OCID of the data.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// The compartment OCID of the data.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The policy OCID of the data.
WaasPolicyId *string `mandatory:"false" json:"waasPolicyId"`
// True if origin (endpoint) is an OCI resource. False if external.
IsOciOrigin *bool `mandatory:"false" json:"isOciOrigin"`
// True if bot manager is enabled.
IsBotEnabled *bool `mandatory:"false" json:"isBotEnabled"`
// The number of incoming requests.
RequestCount *int `mandatory:"false" json:"requestCount"`
// Traffic in bytes.
TrafficInBytes *int `mandatory:"false" json:"trafficInBytes"`
// The tag slug for the specified `waasPolicyId`.
TagSlug []byte `mandatory:"false" json:"tagSlug"`
}
func (m WafMeterDatum) String() string
func (m WafMeterDatum) ValidateEnumValue() (bool, error)
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
WafRequest A time series of request counts handled by the Web Application Firewall, including blocked requests.
type WafRequest struct {
// The date and time the traffic was observed, rounded down to the start of a range, and expressed in RFC 3339 timestamp format.
TimeObserved *common.SDKTime `mandatory:"false" json:"timeObserved"`
// The number of seconds this data covers.
TimeRangeInSeconds *int `mandatory:"false" json:"timeRangeInSeconds"`
// The total number of requests received in this time period.
Count *int `mandatory:"false" json:"count"`
}
func (m WafRequest) String() string
func (m WafRequest) ValidateEnumValue() (bool, error)
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
WafTrafficDatum A time series of traffic data for the Web Application Firewall configured for a policy.
type WafTrafficDatum struct {
// The date and time the traffic was observed, rounded down to the start of the range, and expressed in RFC 3339 timestamp format.
TimeObserved *common.SDKTime `mandatory:"false" json:"timeObserved"`
// The number of seconds this data covers.
TimeRangeInSeconds *int `mandatory:"false" json:"timeRangeInSeconds"`
// The tenancy OCID of the data.
TenancyId *string `mandatory:"false" json:"tenancyId"`
// The compartment OCID of the data.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The policy OCID of the data.
WaasPolicyId *string `mandatory:"false" json:"waasPolicyId"`
// Traffic in bytes.
TrafficInBytes *int `mandatory:"false" json:"trafficInBytes"`
}
func (m WafTrafficDatum) String() string
func (m WafTrafficDatum) ValidateEnumValue() (bool, error)
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
Whitelist An array of IP addresses that bypass the Web Application Firewall. Supports both single IP addresses or subnet masks (CIDR notation).
type Whitelist struct {
// The unique name of the whitelist.
Name *string `mandatory:"true" json:"name"`
// A set of IP addresses or CIDR notations to include in the whitelist.
Addresses []string `mandatory:"false" json:"addresses"`
// A list of OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of IP address lists to include in the whitelist.
AddressLists []string `mandatory:"false" json:"addressLists"`
}
func (m Whitelist) String() string
func (m Whitelist) ValidateEnumValue() (bool, error)
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
WorkRequest Many of the API requests you use to create and configure WAAS policies do not take effect immediately. In these cases, the request spawns an asynchronous work flow to fulfill the request. `WorkRequest` objects provide visibility for in-progress work flows. For more information about work requests, see Viewing the State of a Work Request (https://docs.oracle.com/iaas/Content/Balance/Tasks/viewingworkrequest.htm).
type WorkRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// A description of the operation requested by the work request.
OperationType WorkRequestOperationTypesEnum `mandatory:"true" json:"operationType"`
// The current status of the work request.
Status WorkRequestStatusValuesEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the work request was created, in the format defined by RFC3339.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request moved from the `ACCEPTED` state to the `IN_PROGRESS` state, expressed in RFC 3339 timestamp format.
TimeStarted *common.SDKTime `mandatory:"true" json:"timeStarted"`
// The date and time the work request was fulfilled or terminated, expressed in RFC 3339 timestamp format.
TimeFinished *common.SDKTime `mandatory:"true" json:"timeFinished"`
// The resources being used to complete the work request operation.
Resources []WorkRequestResource `mandatory:"false" json:"resources"`
// The percentage of work completed by the work request.
PercentComplete *int `mandatory:"false" json:"percentComplete"`
// The list of log entries from the work request workflow.
Logs []WorkRequestLogEntry `mandatory:"false" json:"logs"`
// The list of errors that occurred while fulfilling the work request.
Errors []WorkRequestError `mandatory:"false" json:"errors"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
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
WorkRequestError An object returned in the event of a work request error.
type WorkRequestError struct {
// A machine-usable code for the error that occurred.
Code *string `mandatory:"false" json:"code"`
// The error message.
Message *string `mandatory:"false" json:"message"`
// The date and time the work request error happened, expressed in RFC 3339 timestamp format.
Timestamp *common.SDKTime `mandatory:"false" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
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
WorkRequestLogEntry A log message for a work request.
type WorkRequestLogEntry struct {
// The log message.
Message *string `mandatory:"false" json:"message"`
// The date and time the work request log event happend, expressed in RFC 3339 timestamp format.
Timestamp *common.SDKTime `mandatory:"false" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
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
WorkRequestOperationTypeEnum is an alias to type: WorkRequestOperationTypesEnum Consider using WorkRequestOperationTypesEnum instead Deprecated
type WorkRequestOperationTypeEnum = WorkRequestOperationTypesEnum
WorkRequestOperationTypesEnum Enum with underlying type: string
type WorkRequestOperationTypesEnum string
Set of constants representing the allowable values for WorkRequestOperationTypesEnum Deprecated
const (
WorkRequestOperationTypeCreateWaasPolicy WorkRequestOperationTypesEnum = "CREATE_WAAS_POLICY"
WorkRequestOperationTypeUpdateWaasPolicy WorkRequestOperationTypesEnum = "UPDATE_WAAS_POLICY"
WorkRequestOperationTypeDeleteWaasPolicy WorkRequestOperationTypesEnum = "DELETE_WAAS_POLICY"
WorkRequestOperationTypeCreateHttpRedirect WorkRequestOperationTypesEnum = "CREATE_HTTP_REDIRECT"
WorkRequestOperationTypeUpdateHttpRedirect WorkRequestOperationTypesEnum = "UPDATE_HTTP_REDIRECT"
WorkRequestOperationTypeDeleteHttpRedirect WorkRequestOperationTypesEnum = "DELETE_HTTP_REDIRECT"
WorkRequestOperationTypePurgeWaasPolicyCache WorkRequestOperationTypesEnum = "PURGE_WAAS_POLICY_CACHE"
WorkRequestOperationTypeCreateCustomProtectionRule WorkRequestOperationTypesEnum = "CREATE_CUSTOM_PROTECTION_RULE"
WorkRequestOperationTypeUpdateCustomProtectionRule WorkRequestOperationTypesEnum = "UPDATE_CUSTOM_PROTECTION_RULE"
WorkRequestOperationTypeDeleteCustomProtectionRule WorkRequestOperationTypesEnum = "DELETE_CUSTOM_PROTECTION_RULE"
)
Set of constants representing the allowable values for WorkRequestOperationTypesEnum
const (
WorkRequestOperationTypesCreateWaasPolicy WorkRequestOperationTypesEnum = "CREATE_WAAS_POLICY"
WorkRequestOperationTypesUpdateWaasPolicy WorkRequestOperationTypesEnum = "UPDATE_WAAS_POLICY"
WorkRequestOperationTypesDeleteWaasPolicy WorkRequestOperationTypesEnum = "DELETE_WAAS_POLICY"
WorkRequestOperationTypesCreateHttpRedirect WorkRequestOperationTypesEnum = "CREATE_HTTP_REDIRECT"
WorkRequestOperationTypesUpdateHttpRedirect WorkRequestOperationTypesEnum = "UPDATE_HTTP_REDIRECT"
WorkRequestOperationTypesDeleteHttpRedirect WorkRequestOperationTypesEnum = "DELETE_HTTP_REDIRECT"
WorkRequestOperationTypesPurgeWaasPolicyCache WorkRequestOperationTypesEnum = "PURGE_WAAS_POLICY_CACHE"
WorkRequestOperationTypesCreateCustomProtectionRule WorkRequestOperationTypesEnum = "CREATE_CUSTOM_PROTECTION_RULE"
WorkRequestOperationTypesUpdateCustomProtectionRule WorkRequestOperationTypesEnum = "UPDATE_CUSTOM_PROTECTION_RULE"
WorkRequestOperationTypesDeleteCustomProtectionRule WorkRequestOperationTypesEnum = "DELETE_CUSTOM_PROTECTION_RULE"
)
Set of constants representing the allowable values for WorkRequestOperationTypesEnum Deprecated
const (
WorkRequestSummaryOperationTypeCreateWaasPolicy WorkRequestOperationTypesEnum = "CREATE_WAAS_POLICY"
WorkRequestSummaryOperationTypeUpdateWaasPolicy WorkRequestOperationTypesEnum = "UPDATE_WAAS_POLICY"
WorkRequestSummaryOperationTypeDeleteWaasPolicy WorkRequestOperationTypesEnum = "DELETE_WAAS_POLICY"
WorkRequestSummaryOperationTypeCreateHttpRedirect WorkRequestOperationTypesEnum = "CREATE_HTTP_REDIRECT"
WorkRequestSummaryOperationTypeUpdateHttpRedirect WorkRequestOperationTypesEnum = "UPDATE_HTTP_REDIRECT"
WorkRequestSummaryOperationTypeDeleteHttpRedirect WorkRequestOperationTypesEnum = "DELETE_HTTP_REDIRECT"
WorkRequestSummaryOperationTypePurgeWaasPolicyCache WorkRequestOperationTypesEnum = "PURGE_WAAS_POLICY_CACHE"
WorkRequestSummaryOperationTypeCreateCustomProtectionRule WorkRequestOperationTypesEnum = "CREATE_CUSTOM_PROTECTION_RULE"
WorkRequestSummaryOperationTypeUpdateCustomProtectionRule WorkRequestOperationTypesEnum = "UPDATE_CUSTOM_PROTECTION_RULE"
WorkRequestSummaryOperationTypeDeleteCustomProtectionRule WorkRequestOperationTypesEnum = "DELETE_CUSTOM_PROTECTION_RULE"
)
func GetMappingWorkRequestOperationTypesEnum(val string) (WorkRequestOperationTypesEnum, bool)
GetMappingWorkRequestOperationTypesEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestOperationTypesEnumValues() []WorkRequestOperationTypesEnum
GetWorkRequestOperationTypesEnumValues Enumerates the set of values for WorkRequestOperationTypesEnum
WorkRequestResource The resource on which the work request is operating.
type WorkRequestResource struct {
// How the work request affects the resource.
ActionType WorkRequestResourceActionTypeEnum `mandatory:"false" json:"actionType,omitempty"`
// The resource type the work request affects.
EntityType *string `mandatory:"false" json:"entityType"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that the work request affects.
Identifier *string `mandatory:"false" json:"identifier"`
// The URI path used while performing a `GET` to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
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
WorkRequestResourceActionTypeEnum Enum with underlying type: string
type WorkRequestResourceActionTypeEnum string
Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum
const (
WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
WorkRequestResourceActionTypeCreated WorkRequestResourceActionTypeEnum = "CREATED"
WorkRequestResourceActionTypeUpdated WorkRequestResourceActionTypeEnum = "UPDATED"
WorkRequestResourceActionTypeDeleted WorkRequestResourceActionTypeEnum = "DELETED"
WorkRequestResourceActionTypeRelated WorkRequestResourceActionTypeEnum = "RELATED"
WorkRequestResourceActionTypePurged WorkRequestResourceActionTypeEnum = "PURGED"
)
func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)
GetMappingWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum
WorkRequestStatusEnum is an alias to type: WorkRequestStatusValuesEnum Consider using WorkRequestStatusValuesEnum instead Deprecated
type WorkRequestStatusEnum = WorkRequestStatusValuesEnum
WorkRequestStatusValuesEnum Enum with underlying type: string
type WorkRequestStatusValuesEnum string
Set of constants representing the allowable values for WorkRequestStatusValuesEnum Deprecated
const (
WorkRequestStatusAccepted WorkRequestStatusValuesEnum = "ACCEPTED"
WorkRequestStatusInProgress WorkRequestStatusValuesEnum = "IN_PROGRESS"
WorkRequestStatusFailed WorkRequestStatusValuesEnum = "FAILED"
WorkRequestStatusSucceeded WorkRequestStatusValuesEnum = "SUCCEEDED"
WorkRequestStatusCanceling WorkRequestStatusValuesEnum = "CANCELING"
WorkRequestStatusCanceled WorkRequestStatusValuesEnum = "CANCELED"
)
Set of constants representing the allowable values for WorkRequestStatusValuesEnum
const (
WorkRequestStatusValuesAccepted WorkRequestStatusValuesEnum = "ACCEPTED"
WorkRequestStatusValuesInProgress WorkRequestStatusValuesEnum = "IN_PROGRESS"
WorkRequestStatusValuesFailed WorkRequestStatusValuesEnum = "FAILED"
WorkRequestStatusValuesSucceeded WorkRequestStatusValuesEnum = "SUCCEEDED"
WorkRequestStatusValuesCanceling WorkRequestStatusValuesEnum = "CANCELING"
WorkRequestStatusValuesCanceled WorkRequestStatusValuesEnum = "CANCELED"
)
Set of constants representing the allowable values for WorkRequestStatusValuesEnum Deprecated
const (
WorkRequestSummaryStatusAccepted WorkRequestStatusValuesEnum = "ACCEPTED"
WorkRequestSummaryStatusInProgress WorkRequestStatusValuesEnum = "IN_PROGRESS"
WorkRequestSummaryStatusFailed WorkRequestStatusValuesEnum = "FAILED"
WorkRequestSummaryStatusSucceeded WorkRequestStatusValuesEnum = "SUCCEEDED"
WorkRequestSummaryStatusCanceling WorkRequestStatusValuesEnum = "CANCELING"
WorkRequestSummaryStatusCanceled WorkRequestStatusValuesEnum = "CANCELED"
)
func GetMappingWorkRequestStatusValuesEnum(val string) (WorkRequestStatusValuesEnum, bool)
GetMappingWorkRequestStatusValuesEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestStatusValuesEnumValues() []WorkRequestStatusValuesEnum
GetWorkRequestStatusValuesEnumValues Enumerates the set of values for WorkRequestStatusValuesEnum
WorkRequestSummary The summarized details of a work request.
type WorkRequestSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// A description of the operation requested by the work request.
OperationType WorkRequestOperationTypesEnum `mandatory:"true" json:"operationType"`
// The current status of the work request.
Status WorkRequestStatusValuesEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the work request was created, expressed in RFC 3339 timestamp format.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request moved from the `ACCEPTED` state to the `IN_PROGRESS` state, expressed in RFC 3339 timestamp format.
TimeStarted *common.SDKTime `mandatory:"true" json:"timeStarted"`
// The date and time the work request was fulfilled or terminated, in the format defined by RFC3339.
TimeFinished *common.SDKTime `mandatory:"true" json:"timeFinished"`
// The resources being used to complete the work request operation.
Resources []WorkRequestResource `mandatory:"false" json:"resources"`
// The percentage of work completed by the work request.
PercentComplete *int `mandatory:"false" json:"percentComplete"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
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
WorkRequestSummaryOperationTypeEnum is an alias to type: WorkRequestOperationTypesEnum Consider using WorkRequestOperationTypesEnum instead Deprecated
type WorkRequestSummaryOperationTypeEnum = WorkRequestOperationTypesEnum
WorkRequestSummaryStatusEnum is an alias to type: WorkRequestStatusValuesEnum Consider using WorkRequestStatusValuesEnum instead Deprecated
type WorkRequestSummaryStatusEnum = WorkRequestStatusValuesEnum