oci-waas 2.76.1 → 2.77.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (164) hide show
  1. package/lib/client.d.ts +84 -74
  2. package/lib/client.js +89 -72
  3. package/lib/client.js.map +1 -1
  4. package/lib/model/access-rule-criteria.d.ts +25 -25
  5. package/lib/model/access-rule.d.ts +15 -15
  6. package/lib/model/add-http-response-header-action.d.ts +2 -2
  7. package/lib/model/address-list-summary.d.ts +2 -2
  8. package/lib/model/address-list.d.ts +2 -2
  9. package/lib/model/address-rate-limiting.d.ts +3 -3
  10. package/lib/model/block-challenge-settings.d.ts +10 -10
  11. package/lib/model/caching-rule-criteria.d.ts +5 -5
  12. package/lib/model/caching-rule-summary.d.ts +5 -5
  13. package/lib/model/caching-rule.d.ts +5 -5
  14. package/lib/model/captcha.d.ts +4 -4
  15. package/lib/model/certificate-summary.d.ts +2 -2
  16. package/lib/model/certificate.d.ts +3 -3
  17. package/lib/model/create-address-list-details.d.ts +2 -2
  18. package/lib/model/create-certificate-details.d.ts +4 -4
  19. package/lib/model/create-custom-protection-rule-details.d.ts +7 -7
  20. package/lib/model/create-http-redirect-details.d.ts +2 -2
  21. package/lib/model/create-waas-policy-details.d.ts +4 -4
  22. package/lib/model/custom-protection-rule-setting.d.ts +1 -1
  23. package/lib/model/custom-protection-rule-summary.d.ts +2 -2
  24. package/lib/model/custom-protection-rule.d.ts +7 -7
  25. package/lib/model/device-fingerprint-challenge.d.ts +6 -6
  26. package/lib/model/extend-http-response-header-action.d.ts +2 -2
  27. package/lib/model/health-check.d.ts +1 -1
  28. package/lib/model/http-redirect-summary.d.ts +2 -2
  29. package/lib/model/http-redirect.d.ts +2 -2
  30. package/lib/model/human-interaction-challenge.d.ts +7 -7
  31. package/lib/model/i-phash-load-balancing-method.d.ts +1 -1
  32. package/lib/model/js-challenge.d.ts +4 -4
  33. package/lib/model/origin.d.ts +3 -3
  34. package/lib/model/policy-config.d.ts +15 -15
  35. package/lib/model/protection-rule-action.d.ts +2 -2
  36. package/lib/model/protection-rule-exclusion.d.ts +2 -2
  37. package/lib/model/protection-rule.d.ts +2 -2
  38. package/lib/model/protection-settings.d.ts +18 -18
  39. package/lib/model/purge-cache.d.ts +1 -1
  40. package/lib/model/recommendation.d.ts +1 -1
  41. package/lib/model/remove-http-response-header-action.d.ts +1 -1
  42. package/lib/model/round-robin-load-balancing-method.d.ts +1 -1
  43. package/lib/model/sticky-cookie-load-balancing-method.d.ts +1 -1
  44. package/lib/model/threat-feed-action.d.ts +1 -1
  45. package/lib/model/threat-feed.d.ts +1 -1
  46. package/lib/model/update-address-list-details.d.ts +2 -2
  47. package/lib/model/update-certificate-details.d.ts +2 -2
  48. package/lib/model/update-custom-protection-rule-details.d.ts +7 -7
  49. package/lib/model/update-http-redirect-details.d.ts +2 -2
  50. package/lib/model/update-waas-policy-details.d.ts +4 -4
  51. package/lib/model/waas-policy-custom-protection-rule-summary.d.ts +1 -1
  52. package/lib/model/waas-policy-summary.d.ts +2 -2
  53. package/lib/model/waas-policy.d.ts +4 -4
  54. package/lib/model/waf-config-details.d.ts +4 -4
  55. package/lib/model/waf-config.d.ts +4 -4
  56. package/lib/model/waf-log.d.ts +14 -14
  57. package/lib/model/waf-meter-datum.d.ts +1 -1
  58. package/lib/model/work-request-resource.d.ts +1 -1
  59. package/lib/model/work-request-summary.d.ts +1 -1
  60. package/lib/model/work-request.d.ts +2 -2
  61. package/lib/request/accept-recommendations-request.d.ts +2 -2
  62. package/lib/request/cancel-work-request-request.d.ts +2 -2
  63. package/lib/request/change-address-list-compartment-request.d.ts +2 -2
  64. package/lib/request/change-certificate-compartment-request.d.ts +2 -2
  65. package/lib/request/change-custom-protection-rule-compartment-request.d.ts +2 -2
  66. package/lib/request/change-http-redirect-compartment-request.d.ts +2 -2
  67. package/lib/request/change-waas-policy-compartment-request.d.ts +2 -2
  68. package/lib/request/create-address-list-request.d.ts +1 -1
  69. package/lib/request/create-certificate-request.d.ts +1 -1
  70. package/lib/request/create-custom-protection-rule-request.d.ts +1 -1
  71. package/lib/request/create-http-redirect-request.d.ts +1 -1
  72. package/lib/request/create-waas-policy-request.d.ts +1 -1
  73. package/lib/request/delete-address-list-request.d.ts +2 -2
  74. package/lib/request/delete-certificate-request.d.ts +2 -2
  75. package/lib/request/delete-custom-protection-rule-request.d.ts +2 -2
  76. package/lib/request/delete-http-redirect-request.d.ts +2 -2
  77. package/lib/request/delete-waas-policy-request.d.ts +2 -2
  78. package/lib/request/get-address-list-request.d.ts +1 -1
  79. package/lib/request/get-certificate-request.d.ts +1 -1
  80. package/lib/request/get-custom-protection-rule-request.d.ts +1 -1
  81. package/lib/request/get-device-fingerprint-challenge-request.d.ts +1 -1
  82. package/lib/request/get-http-redirect-request.d.ts +1 -1
  83. package/lib/request/get-human-interaction-challenge-request.d.ts +1 -1
  84. package/lib/request/get-js-challenge-request.d.ts +1 -1
  85. package/lib/request/get-policy-config-request.d.ts +1 -1
  86. package/lib/request/get-protection-rule-request.d.ts +1 -1
  87. package/lib/request/get-protection-settings-request.d.ts +1 -1
  88. package/lib/request/get-waas-policy-request.d.ts +1 -1
  89. package/lib/request/get-waf-address-rate-limiting-request.d.ts +1 -1
  90. package/lib/request/get-waf-config-request.d.ts +1 -1
  91. package/lib/request/get-work-request-request.d.ts +1 -1
  92. package/lib/request/list-access-rules-request.d.ts +3 -3
  93. package/lib/request/list-address-lists-request.d.ts +5 -5
  94. package/lib/request/list-caching-rules-request.d.ts +3 -3
  95. package/lib/request/list-captchas-request.d.ts +3 -3
  96. package/lib/request/list-certificates-request.d.ts +5 -5
  97. package/lib/request/list-custom-protection-rules-request.d.ts +5 -5
  98. package/lib/request/list-edge-subnets-request.d.ts +5 -5
  99. package/lib/request/list-good-bots-request.d.ts +3 -3
  100. package/lib/request/list-http-redirects-request.d.ts +4 -4
  101. package/lib/request/list-protection-rules-request.d.ts +3 -3
  102. package/lib/request/list-recommendations-request.d.ts +3 -3
  103. package/lib/request/list-threat-feeds-request.d.ts +3 -3
  104. package/lib/request/list-waas-policies-request.d.ts +5 -5
  105. package/lib/request/list-waas-policy-custom-protection-rules-request.d.ts +3 -3
  106. package/lib/request/list-waf-blocked-requests-request.d.ts +3 -3
  107. package/lib/request/list-waf-logs-request.d.ts +3 -3
  108. package/lib/request/list-waf-requests-request.d.ts +3 -3
  109. package/lib/request/list-waf-traffic-request.d.ts +3 -3
  110. package/lib/request/list-whitelists-request.d.ts +3 -3
  111. package/lib/request/list-work-requests-request.d.ts +5 -5
  112. package/lib/request/purge-cache-request.d.ts +2 -2
  113. package/lib/request/update-access-rules-request.d.ts +2 -2
  114. package/lib/request/update-address-list-request.d.ts +2 -2
  115. package/lib/request/update-caching-rules-request.d.ts +2 -2
  116. package/lib/request/update-captchas-request.d.ts +2 -2
  117. package/lib/request/update-certificate-request.d.ts +2 -2
  118. package/lib/request/update-custom-protection-rule-request.d.ts +2 -2
  119. package/lib/request/update-device-fingerprint-challenge-request.d.ts +2 -2
  120. package/lib/request/update-good-bots-request.d.ts +2 -2
  121. package/lib/request/update-http-redirect-request.d.ts +2 -2
  122. package/lib/request/update-human-interaction-challenge-request.d.ts +2 -2
  123. package/lib/request/update-js-challenge-request.d.ts +2 -2
  124. package/lib/request/update-policy-config-request.d.ts +2 -2
  125. package/lib/request/update-protection-rules-request.d.ts +2 -2
  126. package/lib/request/update-protection-settings-request.d.ts +2 -2
  127. package/lib/request/update-threat-feeds-request.d.ts +2 -2
  128. package/lib/request/update-waas-policy-custom-protection-rules-request.d.ts +2 -2
  129. package/lib/request/update-waas-policy-request.d.ts +2 -2
  130. package/lib/request/update-waf-address-rate-limiting-request.d.ts +2 -2
  131. package/lib/request/update-waf-config-request.d.ts +2 -2
  132. package/lib/request/update-whitelists-request.d.ts +2 -2
  133. package/lib/response/create-address-list-response.d.ts +1 -1
  134. package/lib/response/create-certificate-response.d.ts +1 -1
  135. package/lib/response/create-custom-protection-rule-response.d.ts +1 -1
  136. package/lib/response/create-waas-policy-response.d.ts +1 -1
  137. package/lib/response/get-address-list-response.d.ts +1 -1
  138. package/lib/response/get-certificate-response.d.ts +1 -1
  139. package/lib/response/get-custom-protection-rule-response.d.ts +1 -1
  140. package/lib/response/get-device-fingerprint-challenge-response.d.ts +1 -1
  141. package/lib/response/get-http-redirect-response.d.ts +1 -1
  142. package/lib/response/get-human-interaction-challenge-response.d.ts +1 -1
  143. package/lib/response/get-js-challenge-response.d.ts +1 -1
  144. package/lib/response/get-policy-config-response.d.ts +1 -1
  145. package/lib/response/get-protection-rule-response.d.ts +1 -1
  146. package/lib/response/get-protection-settings-response.d.ts +1 -1
  147. package/lib/response/get-waas-policy-response.d.ts +1 -1
  148. package/lib/response/get-waf-address-rate-limiting-response.d.ts +1 -1
  149. package/lib/response/get-waf-config-response.d.ts +1 -1
  150. package/lib/response/get-work-request-response.d.ts +1 -1
  151. package/lib/response/list-access-rules-response.d.ts +1 -1
  152. package/lib/response/list-caching-rules-response.d.ts +1 -1
  153. package/lib/response/list-captchas-response.d.ts +1 -1
  154. package/lib/response/list-edge-subnets-response.d.ts +1 -1
  155. package/lib/response/list-good-bots-response.d.ts +1 -1
  156. package/lib/response/list-protection-rules-response.d.ts +1 -1
  157. package/lib/response/list-recommendations-response.d.ts +1 -1
  158. package/lib/response/list-threat-feeds-response.d.ts +1 -1
  159. package/lib/response/list-waas-policy-custom-protection-rules-response.d.ts +1 -1
  160. package/lib/response/list-whitelists-response.d.ts +1 -1
  161. package/lib/response/update-address-list-response.d.ts +1 -1
  162. package/lib/response/update-certificate-response.d.ts +1 -1
  163. package/lib/response/update-custom-protection-rule-response.d.ts +1 -1
  164. package/package.json +3 -3
@@ -16,56 +16,56 @@
16
16
  export interface AccessRuleCriteria {
17
17
  /**
18
18
  * The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request.
19
- * - **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 `/`.
20
- * - **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 `/`.
21
- * - **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 `/`.
22
- * - **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field.
23
- * - **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field.
19
+ * - **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the {@code value} field. URL must start with a {@code /}.
20
+ * - **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical to the contents of the {@code value} field. URL must start with a {@code /}.
21
+ * - **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the {@code value} field. URL must start with a {@code /}.
22
+ * - **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the {@code value} field.
23
+ * - **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the {@code value} field.
24
24
  * - **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).
25
- * - **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).
26
- * - **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.
27
- * - **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query does not contain the contents of the `value` field.
28
- * - **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.
29
- * - **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 \
25
+ * - **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is not described by the regular expression in the {@code value} field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org).
26
+ * - **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does not start with the contents of the {@code value} field.
27
+ * - **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query does not contain the contents of the {@code value} field.
28
+ * - **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and query does not end with the contents of the {@code value} field.
29
+ * - **IP_IS:** Matches if the request originates from one of the IP addresses contained in the defined address list. The {@code value} in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \
30
30
  * <p>
31
31
  *Example:* \"1.1.1.1\
32
32
  * 1.1.1.2\
33
33
  * 1.2.2.1/30\"
34
- * - **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 \
34
+ * - **IP_IS_NOT:** Matches if the request does not originate from any of the IP addresses contained in the defined address list. The {@code value} in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \
35
35
  * <p>
36
36
  *Example:* \"1.1.1.1\
37
37
  * 1.1.1.2\
38
38
  * 1.2.2.1/30\"
39
- * - **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.
40
- * - **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.
41
- * - **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.
42
- * *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.
43
- * - **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 \
44
- * The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`
39
+ * - **IP_IN_LIST:** Matches if the request originates from one of the IP addresses contained in the referenced address list. The {@code value} in this case is OCID of the address list.
40
+ * - **IP_NOT_IN_LIST:** Matches if the request does not originate from any IP address contained in the referenced address list. The {@code value} field in this case is OCID of the address list.
41
+ * - **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. {@code host:test.example.com} is an example of a criteria value where {@code host} is the header field name and {@code 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.
42
+ * *Example:* With a criteria value of {@code host:test.example.com}, where {@code host} is the name of the field and {@code test.example.com} is the value of the host field, a request with the header values, {@code Host: www.test.example.com} will match, where as a request with header values of {@code host: www.example.com} or {@code host: test.sub.example.com} will not match.
43
+ * - **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in field. The {@code value} in this case is string with one or multiple HTTP methods separated by new line symbol \
44
+ * The list of available methods: {@code GET}, {@code HEAD}, {@code POST}, {@code PUT}, {@code DELETE}, {@code CONNECT}, {@code OPTIONS}, {@code TRACE}, {@code PATCH}
45
45
  * <p>
46
46
  *Example:* \"GET\
47
47
  * POST\"
48
48
  * <p>
49
- - **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 \
50
- * The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH`
49
+ - **HTTP_METHOD_IS_NOT:** Matches if the request is not identical to any of the contents of the {@code value} field. The {@code value} in this case is string with one or multiple HTTP methods separated by new line symbol \
50
+ * The list of available methods: {@code GET}, {@code HEAD}, {@code POST}, {@code PUT}, {@code DELETE}, {@code CONNECT}, {@code OPTIONS}, {@code TRACE}, {@code PATCH}
51
51
  * <p>
52
52
  *Example:* \"GET\
53
53
  * POST\"
54
54
  * <p>
55
- - **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 \
55
+ - **COUNTRY_IS:** Matches if the request originates from one of countries in the {@code value} field. The {@code value} in this case is string with one or multiple countries separated by new line symbol \
56
56
  * 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/).
57
57
  * *Example:* \"AL\
58
58
  * DZ\
59
59
  * AM\"
60
- * - **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 \
60
+ * - **COUNTRY_IS_NOT:** Matches if the request does not originate from any of countries in the {@code value} field. The {@code value} in this case is string with one or multiple countries separated by new line symbol \
61
61
  * 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/).
62
62
  * *Example:* \"AL\
63
63
  * DZ\
64
64
  * AM\"
65
- * - **USER_AGENT_IS:** Matches if the requesting user agent is identical to the contents of the `value` field.
66
- * *Example:* `Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0`
67
- * - **USER_AGENT_IS_NOT:** Matches if the requesting user agent is not identical to the contents of the `value` field.
68
- * *Example:* `Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0`
65
+ * - **USER_AGENT_IS:** Matches if the requesting user agent is identical to the contents of the {@code value} field.
66
+ * *Example:* {@code Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0}
67
+ * - **USER_AGENT_IS_NOT:** Matches if the requesting user agent is not identical to the contents of the {@code value} field.
68
+ * *Example:* {@code Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0}
69
69
  */
70
70
  "condition": AccessRuleCriteria.Condition;
71
71
  /**
@@ -24,7 +24,7 @@ export interface AccessRule {
24
24
  */
25
25
  "criteria": Array<model.AccessRuleCriteria>;
26
26
  /**
27
- * The action to take when the access criteria are met for a rule. If unspecified, defaults to `ALLOW`.
27
+ * The action to take when the access criteria are met for a rule. If unspecified, defaults to {@code ALLOW}.
28
28
  * <p>
29
29
  - **ALLOW:** Takes no action, just logs the request.
30
30
  * <p>
@@ -34,7 +34,7 @@ export interface AccessRule {
34
34
  * <p>
35
35
  - **BYPASS:** Bypasses some or all challenges.
36
36
  * <p>
37
- - **REDIRECT:** Redirects the request to the specified URL. These fields are required when `REDIRECT` is selected: `redirectUrl`, `redirectResponseCode`.
37
+ - **REDIRECT:** Redirects the request to the specified URL. These fields are required when {@code REDIRECT} is selected: {@code redirectUrl}, {@code redirectResponseCode}.
38
38
  * <p>
39
39
  - **SHOW_CAPTCHA:** Show a CAPTCHA Challenge page instead of the requested page.
40
40
  * <p>
@@ -42,27 +42,27 @@ export interface AccessRule {
42
42
  */
43
43
  "action": AccessRule.Action;
44
44
  /**
45
- * 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`.
45
+ * The method used to block requests if {@code action} is set to {@code BLOCK} and the access criteria are met. If unspecified, defaults to {@code SET_RESPONSE_CODE}.
46
46
  */
47
47
  "blockAction"?: AccessRule.BlockAction;
48
48
  /**
49
- * 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`. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
49
+ * The response status code to return when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SET_RESPONSE_CODE}, and the access criteria are met. If unspecified, defaults to {@code 403}. The list of available response codes: {@code 200}, {@code 201}, {@code 202}, {@code 204}, {@code 206}, {@code 300}, {@code 301}, {@code 302}, {@code 303}, {@code 304}, {@code 307}, {@code 400}, {@code 401}, {@code 403}, {@code 404}, {@code 405}, {@code 408}, {@code 409}, {@code 411}, {@code 412}, {@code 413}, {@code 414}, {@code 415}, {@code 416}, {@code 422}, {@code 444}, {@code 494}, {@code 495}, {@code 496}, {@code 497}, {@code 499}, {@code 500}, {@code 501}, {@code 502}, {@code 503}, {@code 504}, {@code 507}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
50
50
  */
51
51
  "blockResponseCode"?: number;
52
52
  /**
53
- * 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.'
53
+ * The message to show on the error page when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_ERROR_PAGE}, and the access criteria are met. If unspecified, defaults to 'Access to the website is blocked.'
54
54
  */
55
55
  "blockErrorPageMessage"?: string;
56
56
  /**
57
- * 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'.
57
+ * The error code to show on the error page when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_ERROR_PAGE}, and the access criteria are met. If unspecified, defaults to 'Access rules'.
58
58
  */
59
59
  "blockErrorPageCode"?: string;
60
60
  /**
61
- * 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.'
61
+ * The description text to show on the error page when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_ERROR_PAGE}, and the access criteria are met. If unspecified, defaults to 'Access blocked by website owner. Please contact support.'
62
62
  */
63
63
  "blockErrorPageDescription"?: string;
64
64
  /**
65
- * The list of challenges to bypass when `action` is set to `BYPASS`. If unspecified or empty, all challenges are bypassed.
65
+ * The list of challenges to bypass when {@code action} is set to {@code BYPASS}. If unspecified or empty, all challenges are bypassed.
66
66
  * <p>
67
67
  - **JS_CHALLENGE:** Bypasses JavaScript Challenge.
68
68
  * <p>
@@ -74,11 +74,11 @@ export interface AccessRule {
74
74
  */
75
75
  "bypassChallenges"?: Array<AccessRule.BypassChallenges>;
76
76
  /**
77
- * The target to which the request should be redirected, represented as a URI reference. Required when `action` is `REDIRECT`.
77
+ * The target to which the request should be redirected, represented as a URI reference. Required when {@code action} is {@code REDIRECT}.
78
78
  */
79
79
  "redirectUrl"?: string;
80
80
  /**
81
- * The response status code to return when `action` is set to `REDIRECT`.
81
+ * The response status code to return when {@code action} is set to {@code REDIRECT}.
82
82
  * <p>
83
83
  - **MOVED_PERMANENTLY:** Used for designating the permanent movement of a page (numerical code - 301).
84
84
  * <p>
@@ -86,23 +86,23 @@ export interface AccessRule {
86
86
  */
87
87
  "redirectResponseCode"?: AccessRule.RedirectResponseCode;
88
88
  /**
89
- * The title used when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged.
89
+ * The title used when showing a CAPTCHA challenge when {@code action} is set to {@code SHOW_CAPTCHA} and the request is challenged.
90
90
  */
91
91
  "captchaTitle"?: string;
92
92
  /**
93
- * The text to show in the header when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged.
93
+ * The text to show in the header when showing a CAPTCHA challenge when {@code action} is set to {@code SHOW_CAPTCHA} and the request is challenged.
94
94
  */
95
95
  "captchaHeader"?: string;
96
96
  /**
97
- * The text to show in the footer when showing a CAPTCHA challenge when `action` is set to `SHOW_CAPTCHA` and the request is challenged.
97
+ * The text to show in the footer when showing a CAPTCHA challenge when {@code action} is set to {@code SHOW_CAPTCHA} and the request is challenged.
98
98
  */
99
99
  "captchaFooter"?: string;
100
100
  /**
101
- * 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.
101
+ * The text to show on the label of the CAPTCHA challenge submit button when {@code action} is set to {@code SHOW_CAPTCHA} and the request is challenged.
102
102
  */
103
103
  "captchaSubmitLabel"?: string;
104
104
  /**
105
- * An object that represents an action to apply to an HTTP response headers if all rule criteria will be matched regardless of `action` value.
105
+ * An object that represents an action to apply to an HTTP response headers if all rule criteria will be matched regardless of {@code action} value.
106
106
  */
107
107
  "responseHeaderManipulation"?: Array<model.HeaderManipulationAction>;
108
108
  }
@@ -20,14 +20,14 @@ export interface AddHttpResponseHeaderAction extends model.HeaderManipulationAct
20
20
  /**
21
21
  * A header field name that conforms to RFC 7230.
22
22
  * <p>
23
- Example: `example_header_name`
23
+ Example: {@code example_header_name}
24
24
  *
25
25
  */
26
26
  "header": string;
27
27
  /**
28
28
  * A header field value that conforms to RFC 7230.
29
29
  * <p>
30
- Example: `example_value`
30
+ Example: {@code example_value}
31
31
  *
32
32
  */
33
33
  "value": string;
@@ -35,7 +35,7 @@ export interface AddressListSummary {
35
35
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
36
36
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
37
37
  * <p>
38
- Example: `{\"Department\": \"Finance\"}`
38
+ Example: {@code {\"Department\": \"Finance\"}}
39
39
  *
40
40
  */
41
41
  "freeformTags"?: {
@@ -45,7 +45,7 @@ export interface AddressListSummary {
45
45
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
46
46
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
47
47
  * <p>
48
- Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
48
+ Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
49
49
  *
50
50
  */
51
51
  "definedTags"?: {
@@ -40,7 +40,7 @@ export interface AddressList {
40
40
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
41
41
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
42
42
  * <p>
43
- Example: `{\"Department\": \"Finance\"}`
43
+ Example: {@code {\"Department\": \"Finance\"}}
44
44
  *
45
45
  */
46
46
  "freeformTags"?: {
@@ -50,7 +50,7 @@ export interface AddressList {
50
50
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
51
51
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
52
52
  * <p>
53
- Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
53
+ Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
54
54
  *
55
55
  */
56
56
  "definedTags"?: {
@@ -19,15 +19,15 @@ export interface AddressRateLimiting {
19
19
  */
20
20
  "isEnabled": boolean;
21
21
  /**
22
- * The number of allowed requests per second from one IP address. If unspecified, defaults to `1`. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
22
+ * The number of allowed requests per second from one IP address. If unspecified, defaults to {@code 1}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
23
23
  */
24
24
  "allowedRatePerAddress"?: number;
25
25
  /**
26
- * The maximum number of requests allowed to be queued before subsequent requests are dropped. If unspecified, defaults to `10`. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
26
+ * The maximum number of requests allowed to be queued before subsequent requests are dropped. If unspecified, defaults to {@code 10}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
27
27
  */
28
28
  "maxDelayedCountPerAddress"?: number;
29
29
  /**
30
- * 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`. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
30
+ * The response status code returned when a request is blocked. If unspecified, defaults to {@code 503}. The list of available response codes: {@code 400}, {@code 401}, {@code 403}, {@code 404}, {@code 405}, {@code 408}, {@code 409}, {@code 411}, {@code 412}, {@code 413}, {@code 414}, {@code 415}, {@code 416}, {@code 422}, {@code 494}, {@code 495}, {@code 496}, {@code 497}, {@code 499}, {@code 500}, {@code 501}, {@code 502}, {@code 503}, {@code 504}, {@code 507}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
31
31
  */
32
32
  "blockResponseCode"?: number;
33
33
  }
@@ -11,43 +11,43 @@
11
11
  * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
12
12
  */
13
13
  /**
14
- * The challenge settings if `action` is set to `BLOCK`.
14
+ * The challenge settings if {@code action} is set to {@code BLOCK}.
15
15
  */
16
16
  export interface BlockChallengeSettings {
17
17
  /**
18
- * The method used to block requests that fail the challenge, if `action` is set to `BLOCK`. If unspecified, defaults to `SHOW_ERROR_PAGE`.
18
+ * The method used to block requests that fail the challenge, if {@code action} is set to {@code BLOCK}. If unspecified, defaults to {@code SHOW_ERROR_PAGE}.
19
19
  */
20
20
  "blockAction"?: BlockChallengeSettings.BlockAction;
21
21
  /**
22
- * 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`. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
22
+ * The response status code to return when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SET_RESPONSE_CODE} or {@code SHOW_ERROR_PAGE}, and the request is blocked. If unspecified, defaults to {@code 403}. The list of available response codes: {@code 200}, {@code 201}, {@code 202}, {@code 204}, {@code 206}, {@code 300}, {@code 301}, {@code 302}, {@code 303}, {@code 304}, {@code 307}, {@code 400}, {@code 401}, {@code 403}, {@code 404}, {@code 405}, {@code 408}, {@code 409}, {@code 411}, {@code 412}, {@code 413}, {@code 414}, {@code 415}, {@code 416}, {@code 422}, {@code 444}, {@code 494}, {@code 495}, {@code 496}, {@code 497}, {@code 499}, {@code 500}, {@code 501}, {@code 502}, {@code 503}, {@code 504}, {@code 507}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
23
23
  */
24
24
  "blockResponseCode"?: number;
25
25
  /**
26
- * 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`.
26
+ * The message to show on the error page when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_ERROR_PAGE}, and the request is blocked. If unspecified, defaults to {@code Access to the website is blocked}.
27
27
  */
28
28
  "blockErrorPageMessage"?: string;
29
29
  /**
30
- * 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.`
30
+ * The description text to show on the error page when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_ERROR_PAGE}, and the request is blocked. If unspecified, defaults to {@code Access blocked by website owner. Please contact support.}
31
31
  */
32
32
  "blockErrorPageDescription"?: string;
33
33
  /**
34
- * 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`.
34
+ * The error code to show on the error page when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_ERROR_PAGE} and the request is blocked. If unspecified, defaults to {@code 403}.
35
35
  */
36
36
  "blockErrorPageCode"?: string;
37
37
  /**
38
- * 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?`
38
+ * The title used when showing a CAPTCHA challenge when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_CAPTCHA}, and the request is blocked. If unspecified, defaults to {@code Are you human?}
39
39
  */
40
40
  "captchaTitle"?: string;
41
41
  /**
42
- * 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.`
42
+ * The text to show in the header when showing a CAPTCHA challenge when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_CAPTCHA}, and the request is blocked. If unspecified, defaults to {@code 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.}
43
43
  */
44
44
  "captchaHeader"?: string;
45
45
  /**
46
- * 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`.
46
+ * The text to show in the footer when showing a CAPTCHA challenge when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_CAPTCHA}, and the request is blocked. If unspecified, default to {@code Enter the letters and numbers as they are shown in image above}.
47
47
  */
48
48
  "captchaFooter"?: string;
49
49
  /**
50
- * 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`.
50
+ * The text to show on the label of the CAPTCHA challenge submit button when {@code action} is set to {@code BLOCK}, {@code blockAction} is set to {@code SHOW_CAPTCHA}, and the request is blocked. If unspecified, defaults to {@code Yes, I am human}.
51
51
  */
52
52
  "captchaSubmitLabel"?: string;
53
53
  }
@@ -16,15 +16,15 @@
16
16
  export interface CachingRuleCriteria {
17
17
  /**
18
18
  * The condition of the caching rule criteria.
19
- * - **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the `value` field.
19
+ * - **URL_IS:** Matches if the concatenation of request URL path and query is identical to the contents of the {@code value} field.
20
20
  * <p>
21
- - **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the `value` field.
21
+ - **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with the contents of the {@code value} field.
22
22
  * <p>
23
- - **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the `value` field.
23
+ - **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with the contents of the {@code value} field.
24
24
  * <p>
25
- - **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the `value` field.
25
+ - **URL_PART_CONTAINS:** Matches if the concatenation of request URL path and query contains the contents of the {@code value} field.
26
26
  * <p>
27
- 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.
27
+ URLs must start with a {@code /}. URLs can't contain restricted double slashes {@code //}. URLs can't contain the restricted {@code '} {@code &} {@code ?} symbols. Resources to cache can only be specified by a URL, any query parameters are ignored.
28
28
  */
29
29
  "condition": CachingRuleCriteria.Condition;
30
30
  /**
@@ -31,18 +31,18 @@ export interface CachingRuleSummary {
31
31
  */
32
32
  "action": CachingRuleSummary.Action;
33
33
  /**
34
- * 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`.
35
- * Example: `PT1H`
34
+ * 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 {@code 99}. Mixing of multiple units is not supported. Only applies when the {@code action} is set to {@code CACHE}.
35
+ * Example: {@code PT1H}
36
36
  */
37
37
  "cachingDuration"?: string;
38
38
  /**
39
39
  * Enables or disables client caching.
40
- * 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.
40
+ * Browsers use the {@code Cache-Control} header value for caching content locally in the browser. This setting overrides the addition of a {@code Cache-Control} header in responses.
41
41
  */
42
42
  "isClientCachingEnabled"?: boolean;
43
43
  /**
44
- * 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`.
45
- * Example: `PT1H`
44
+ * 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 {@code 99}. Mixing of multiple units is not supported. Only applies when the {@code action} is set to {@code CACHE}.
45
+ * Example: {@code PT1H}
46
46
  */
47
47
  "clientCachingDuration"?: string;
48
48
  /**
@@ -28,18 +28,18 @@ export interface CachingRule {
28
28
  */
29
29
  "action": CachingRule.Action;
30
30
  /**
31
- * 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`.
32
- * Example: `PT1H`
31
+ * 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 {@code 99}. Mixing of multiple units is not supported. Only applies when the {@code action} is set to {@code CACHE}.
32
+ * Example: {@code PT1H}
33
33
  */
34
34
  "cachingDuration"?: string;
35
35
  /**
36
36
  * Enables or disables client caching.
37
- * 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.
37
+ * Browsers use the {@code Cache-Control} header value for caching content locally in the browser. This setting overrides the addition of a {@code Cache-Control} header in responses.
38
38
  */
39
39
  "isClientCachingEnabled"?: boolean;
40
40
  /**
41
- * 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`.
42
- * Example: `PT1H`
41
+ * 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 {@code 99}. Mixing of multiple units is not supported. Only applies when the {@code action} is set to {@code CACHE}.
42
+ * Example: {@code PT1H}
43
43
  */
44
44
  "clientCachingDuration"?: string;
45
45
  /**
@@ -21,11 +21,11 @@ export interface Captcha {
21
21
  */
22
22
  "url": string;
23
23
  /**
24
- * The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to `300`. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
24
+ * The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to {@code 300}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
25
25
  */
26
26
  "sessionExpirationInSeconds": number;
27
27
  /**
28
- * The title used when displaying a CAPTCHA challenge. If unspecified, defaults to `Are you human?`
28
+ * The title used when displaying a CAPTCHA challenge. If unspecified, defaults to {@code Are you human?}
29
29
  */
30
30
  "title": string;
31
31
  /**
@@ -37,11 +37,11 @@ export interface Captcha {
37
37
  */
38
38
  "footerText"?: string;
39
39
  /**
40
- * The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to `The CAPTCHA was incorrect. Try again.`
40
+ * The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to {@code The CAPTCHA was incorrect. Try again.}
41
41
  */
42
42
  "failureMessage": string;
43
43
  /**
44
- * The text to show on the label of the CAPTCHA challenge submit button. If unspecified, defaults to `Yes, I am human`.
44
+ * The text to show on the label of the CAPTCHA challenge submit button. If unspecified, defaults to {@code Yes, I am human}.
45
45
  */
46
46
  "submitLabel": string;
47
47
  }
@@ -36,7 +36,7 @@ export interface CertificateSummary {
36
36
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
37
37
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
38
38
  * <p>
39
- Example: `{\"Department\": \"Finance\"}`
39
+ Example: {@code {\"Department\": \"Finance\"}}
40
40
  *
41
41
  */
42
42
  "freeformTags"?: {
@@ -46,7 +46,7 @@ export interface CertificateSummary {
46
46
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
47
47
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
48
48
  * <p>
49
- Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
49
+ Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
50
50
  *
51
51
  */
52
52
  "definedTags"?: {
@@ -60,7 +60,7 @@ export interface Certificate {
60
60
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
61
61
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
62
62
  * <p>
63
- Example: `{\"Department\": \"Finance\"}`
63
+ Example: {@code {\"Department\": \"Finance\"}}
64
64
  *
65
65
  */
66
66
  "freeformTags"?: {
@@ -70,7 +70,7 @@ export interface Certificate {
70
70
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
71
71
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
72
72
  * <p>
73
- Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
73
+ Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
74
74
  *
75
75
  */
76
76
  "definedTags"?: {
@@ -88,7 +88,7 @@ export interface Certificate {
88
88
  "timeCreated"?: Date;
89
89
  /**
90
90
  * This indicates whether trust verification was disabled during the creation of SSL certificate.
91
- * If `true` SSL certificate trust verification was disabled and this SSL certificate is most likely self-signed.
91
+ * If {@code true} SSL certificate trust verification was disabled and this SSL certificate is most likely self-signed.
92
92
  *
93
93
  */
94
94
  "isTrustVerificationDisabled"?: boolean;
@@ -30,7 +30,7 @@ export interface CreateAddressListDetails {
30
30
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
31
31
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
32
32
  * <p>
33
- Example: `{\"Department\": \"Finance\"}`
33
+ Example: {@code {\"Department\": \"Finance\"}}
34
34
  *
35
35
  */
36
36
  "freeformTags"?: {
@@ -40,7 +40,7 @@ export interface CreateAddressListDetails {
40
40
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
41
41
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
42
42
  * <p>
43
- Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
43
+ Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
44
44
  *
45
45
  */
46
46
  "definedTags"?: {
@@ -30,7 +30,7 @@ export interface CreateCertificateDetails {
30
30
 
31
31
  * **Note:** Many SSL certificate providers require an intermediate certificate chain to ensure a trusted status.
32
32
  * If your SSL certificate requires an intermediate certificate chain, please append the intermediate certificate
33
- * key in the `certificateData` field after the leaf certificate issued by the SSL certificate provider. If you
33
+ * key in the {@code certificateData} field after the leaf certificate issued by the SSL certificate provider. If you
34
34
  * are unsure if your certificate requires an intermediate certificate chain, see your certificate
35
35
  * provider's documentation.
36
36
  * <p>
@@ -44,14 +44,14 @@ export interface CreateCertificateDetails {
44
44
  */
45
45
  "privateKeyData": string;
46
46
  /**
47
- * Set to `true` if the SSL certificate is self-signed.
47
+ * Set to {@code true} if the SSL certificate is self-signed.
48
48
  */
49
49
  "isTrustVerificationDisabled"?: boolean;
50
50
  /**
51
51
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
52
52
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
53
53
  * <p>
54
- Example: `{\"Department\": \"Finance\"}`
54
+ Example: {@code {\"Department\": \"Finance\"}}
55
55
  *
56
56
  */
57
57
  "freeformTags"?: {
@@ -61,7 +61,7 @@ export interface CreateCertificateDetails {
61
61
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
62
62
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
63
63
  * <p>
64
- Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
64
+ Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
65
65
  *
66
66
  */
67
67
  "definedTags"?: {
@@ -33,12 +33,12 @@ export interface CreateCustomProtectionRuleDetails {
33
33
  * <p>
34
34
  Additionally, each rule must include two placeholder variables that are updated by the WAF service upon publication of the rule.
35
35
  * <p>
36
- `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.
36
+ {@code id: {{id_1}}} - This field is populated with a unique rule ID generated by the WAF service which identifies a {@code SecRule}. More than one {@code SecRule} can be defined in the {@code template} field of a CreateCustomSecurityRule call. The value of the first {@code SecRule} must be {@code id: {{id_1}}} and the {@code id} field of each subsequent {@code SecRule} should increase by one, as shown in the example.
37
37
  * <p>
38
- `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.
38
+ {@code ctl:ruleEngine={{mode}}} - The action to be taken when the criteria of the {@code SecRule} are met, either {@code OFF}, {@code DETECT} or {@code BLOCK}. This field is automatically populated with the corresponding value of the {@code action} field of the {@code CustomProtectionRuleSetting} schema when the {@code WafConfig} is updated.
39
39
  * <p>
40
40
  *Example:*
41
- * ```
41
+ * {@code
42
42
  * SecRule REQUEST_COOKIES \"regex matching SQL injection - part 1/2\" \\
43
43
  * \"phase:2, \\
44
44
  * msg:'Detects chained SQL injection attempts 1/2.', \\
@@ -51,10 +51,10 @@ export interface CreateCustomProtectionRuleDetails {
51
51
  * id: {{id_2}}, \\
52
52
  * ctl:ruleEngine={{mode}}, \\
53
53
  * deny\"
54
- * ```
54
+ * }
55
55
  * <p>
56
56
 
57
- * The example contains two `SecRules` each having distinct regex expression to match the `Cookie` header value during the second input analysis phase.
57
+ * The example contains two {@code SecRules} each having distinct regex expression to match the {@code Cookie} header value during the second input analysis phase.
58
58
  * <p>
59
59
  For more information about custom protection rules, see [Custom Protection Rules](https://docs.cloud.oracle.com/Content/WAF/Tasks/customprotectionrules.htm).
60
60
  * <p>
@@ -67,7 +67,7 @@ export interface CreateCustomProtectionRuleDetails {
67
67
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
68
68
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
69
69
  * <p>
70
- Example: `{\"Department\": \"Finance\"}`
70
+ Example: {@code {\"Department\": \"Finance\"}}
71
71
  *
72
72
  */
73
73
  "freeformTags"?: {
@@ -77,7 +77,7 @@ export interface CreateCustomProtectionRuleDetails {
77
77
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
78
78
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
79
79
  * <p>
80
- Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
80
+ Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
81
81
  *
82
82
  */
83
83
  "definedTags"?: {