oci-loadbalancer 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 (154) hide show
  1. package/lib/client.d.ts +68 -62
  2. package/lib/client.js +70 -61
  3. package/lib/client.js.map +1 -1
  4. package/lib/model/add-http-request-header-rule.d.ts +5 -5
  5. package/lib/model/add-http-response-header-rule.d.ts +5 -5
  6. package/lib/model/allow-rule.d.ts +5 -5
  7. package/lib/model/backend-details.d.ts +8 -8
  8. package/lib/model/backend-health.d.ts +4 -4
  9. package/lib/model/backend-set-details.d.ts +2 -2
  10. package/lib/model/backend-set-health.d.ts +14 -14
  11. package/lib/model/backend-set.d.ts +3 -3
  12. package/lib/model/backend.d.ts +9 -9
  13. package/lib/model/certificate-details.d.ts +1 -1
  14. package/lib/model/certificate.d.ts +1 -1
  15. package/lib/model/connection-configuration.d.ts +2 -2
  16. package/lib/model/control-access-using-http-methods-rule.d.ts +5 -5
  17. package/lib/model/create-backend-details.d.ts +8 -8
  18. package/lib/model/create-backend-set-details.d.ts +3 -3
  19. package/lib/model/create-certificate-details.d.ts +1 -1
  20. package/lib/model/create-hostname-details.d.ts +2 -2
  21. package/lib/model/create-listener-details.d.ts +7 -7
  22. package/lib/model/create-load-balancer-details.d.ts +8 -8
  23. package/lib/model/create-path-route-set-details.d.ts +1 -1
  24. package/lib/model/create-routing-policy-details.d.ts +2 -2
  25. package/lib/model/create-rule-set-details.d.ts +1 -1
  26. package/lib/model/create-ss-lcipher-suite-details.d.ts +2 -2
  27. package/lib/model/extend-http-request-header-value-rule.d.ts +8 -8
  28. package/lib/model/extend-http-response-header-value-rule.d.ts +8 -8
  29. package/lib/model/forward-to-backend-set.d.ts +1 -1
  30. package/lib/model/health-check-result.d.ts +2 -2
  31. package/lib/model/health-checker-details.d.ts +10 -10
  32. package/lib/model/health-checker.d.ts +10 -10
  33. package/lib/model/hostname-details.d.ts +2 -2
  34. package/lib/model/hostname.d.ts +2 -2
  35. package/lib/model/http-header-rule.d.ts +1 -1
  36. package/lib/model/ip-address.d.ts +1 -1
  37. package/lib/model/l-bcookie-session-persistence-configuration-details.d.ts +34 -34
  38. package/lib/model/listener-details.d.ts +6 -6
  39. package/lib/model/listener.d.ts +7 -7
  40. package/lib/model/load-balancer-health-summary.d.ts +7 -7
  41. package/lib/model/load-balancer-health.d.ts +16 -16
  42. package/lib/model/load-balancer-shape.d.ts +1 -1
  43. package/lib/model/load-balancer.d.ts +7 -7
  44. package/lib/model/path-match-condition.d.ts +6 -6
  45. package/lib/model/path-match-type.d.ts +6 -6
  46. package/lib/model/path-route-set.d.ts +1 -1
  47. package/lib/model/path-route.d.ts +2 -2
  48. package/lib/model/redirect-rule.d.ts +5 -5
  49. package/lib/model/redirect-uri.d.ts +43 -43
  50. package/lib/model/remove-http-request-header-rule.d.ts +2 -2
  51. package/lib/model/remove-http-response-header-rule.d.ts +2 -2
  52. package/lib/model/routing-policy.d.ts +2 -2
  53. package/lib/model/rule-set.d.ts +1 -1
  54. package/lib/model/s-sl-cipher-suite-details.d.ts +2 -2
  55. package/lib/model/s-sl-cipher-suite.d.ts +2 -2
  56. package/lib/model/s-sl-configuration-details.d.ts +17 -17
  57. package/lib/model/s-sl-configuration.d.ts +17 -17
  58. package/lib/model/session-persistence-configuration-details.d.ts +7 -7
  59. package/lib/model/shape-details.d.ts +2 -2
  60. package/lib/model/source-vcn-id-condition.d.ts +2 -2
  61. package/lib/model/source-vcn-ip-address-condition.d.ts +1 -1
  62. package/lib/model/update-backend-details.d.ts +6 -6
  63. package/lib/model/update-backend-set-details.d.ts +2 -2
  64. package/lib/model/update-health-checker-details.d.ts +9 -9
  65. package/lib/model/update-hostname-details.d.ts +1 -1
  66. package/lib/model/update-listener-details.d.ts +6 -6
  67. package/lib/model/update-load-balancer-details.d.ts +3 -3
  68. package/lib/model/update-load-balancer-shape-details.d.ts +2 -2
  69. package/lib/model/update-routing-policy-details.d.ts +1 -1
  70. package/lib/model/update-ss-lcipher-suite-details.d.ts +1 -1
  71. package/lib/model/work-request.d.ts +3 -3
  72. package/lib/request/change-load-balancer-compartment-request.d.ts +2 -2
  73. package/lib/request/create-backend-request.d.ts +3 -3
  74. package/lib/request/create-backend-set-request.d.ts +2 -2
  75. package/lib/request/create-certificate-request.d.ts +2 -2
  76. package/lib/request/create-hostname-request.d.ts +2 -2
  77. package/lib/request/create-listener-request.d.ts +2 -2
  78. package/lib/request/create-load-balancer-request.d.ts +1 -1
  79. package/lib/request/create-path-route-set-request.d.ts +2 -2
  80. package/lib/request/create-routing-policy-request.d.ts +2 -2
  81. package/lib/request/create-rule-set-request.d.ts +2 -2
  82. package/lib/request/create-sslcipher-suite-request.d.ts +2 -2
  83. package/lib/request/delete-backend-request.d.ts +4 -4
  84. package/lib/request/delete-backend-set-request.d.ts +3 -3
  85. package/lib/request/delete-certificate-request.d.ts +3 -3
  86. package/lib/request/delete-hostname-request.d.ts +3 -3
  87. package/lib/request/delete-listener-request.d.ts +3 -3
  88. package/lib/request/delete-load-balancer-request.d.ts +2 -2
  89. package/lib/request/delete-path-route-set-request.d.ts +3 -3
  90. package/lib/request/delete-routing-policy-request.d.ts +3 -3
  91. package/lib/request/delete-rule-set-request.d.ts +3 -3
  92. package/lib/request/delete-sslcipher-suite-request.d.ts +3 -3
  93. package/lib/request/get-backend-health-request.d.ts +4 -4
  94. package/lib/request/get-backend-request.d.ts +4 -4
  95. package/lib/request/get-backend-set-health-request.d.ts +3 -3
  96. package/lib/request/get-backend-set-request.d.ts +3 -3
  97. package/lib/request/get-health-checker-request.d.ts +3 -3
  98. package/lib/request/get-hostname-request.d.ts +3 -3
  99. package/lib/request/get-load-balancer-health-request.d.ts +2 -2
  100. package/lib/request/get-load-balancer-request.d.ts +2 -2
  101. package/lib/request/get-path-route-set-request.d.ts +3 -3
  102. package/lib/request/get-routing-policy-request.d.ts +3 -3
  103. package/lib/request/get-rule-set-request.d.ts +3 -3
  104. package/lib/request/get-sslcipher-suite-request.d.ts +3 -3
  105. package/lib/request/get-work-request-request.d.ts +1 -1
  106. package/lib/request/list-backend-sets-request.d.ts +2 -2
  107. package/lib/request/list-backends-request.d.ts +3 -3
  108. package/lib/request/list-certificates-request.d.ts +2 -2
  109. package/lib/request/list-hostnames-request.d.ts +2 -2
  110. package/lib/request/list-listener-rules-request.d.ts +2 -2
  111. package/lib/request/list-load-balancer-healths-request.d.ts +4 -4
  112. package/lib/request/list-load-balancers-request.d.ts +10 -10
  113. package/lib/request/list-path-route-sets-request.d.ts +2 -2
  114. package/lib/request/list-policies-request.d.ts +4 -4
  115. package/lib/request/list-protocols-request.d.ts +4 -4
  116. package/lib/request/list-routing-policies-request.d.ts +5 -5
  117. package/lib/request/list-rule-sets-request.d.ts +2 -2
  118. package/lib/request/list-shapes-request.d.ts +4 -4
  119. package/lib/request/list-sslcipher-suites-request.d.ts +2 -2
  120. package/lib/request/list-work-requests-request.d.ts +4 -4
  121. package/lib/request/update-backend-request.d.ts +4 -4
  122. package/lib/request/update-backend-set-request.d.ts +3 -3
  123. package/lib/request/update-health-checker-request.d.ts +3 -3
  124. package/lib/request/update-hostname-request.d.ts +3 -3
  125. package/lib/request/update-listener-request.d.ts +3 -3
  126. package/lib/request/update-load-balancer-request.d.ts +2 -2
  127. package/lib/request/update-load-balancer-shape-request.d.ts +2 -2
  128. package/lib/request/update-network-security-groups-request.d.ts +2 -2
  129. package/lib/request/update-path-route-set-request.d.ts +3 -3
  130. package/lib/request/update-routing-policy-request.d.ts +3 -3
  131. package/lib/request/update-rule-set-request.d.ts +3 -3
  132. package/lib/request/update-sslcipher-suite-request.d.ts +3 -3
  133. package/lib/response/get-backend-health-response.d.ts +1 -1
  134. package/lib/response/get-backend-response.d.ts +1 -1
  135. package/lib/response/get-backend-set-health-response.d.ts +1 -1
  136. package/lib/response/get-backend-set-response.d.ts +1 -1
  137. package/lib/response/get-health-checker-response.d.ts +1 -1
  138. package/lib/response/get-hostname-response.d.ts +1 -1
  139. package/lib/response/get-load-balancer-health-response.d.ts +1 -1
  140. package/lib/response/get-load-balancer-response.d.ts +1 -1
  141. package/lib/response/get-path-route-set-response.d.ts +1 -1
  142. package/lib/response/get-routing-policy-response.d.ts +1 -1
  143. package/lib/response/get-rule-set-response.d.ts +1 -1
  144. package/lib/response/get-sslcipher-suite-response.d.ts +1 -1
  145. package/lib/response/list-backend-sets-response.d.ts +1 -1
  146. package/lib/response/list-backends-response.d.ts +1 -1
  147. package/lib/response/list-certificates-response.d.ts +1 -1
  148. package/lib/response/list-hostnames-response.d.ts +1 -1
  149. package/lib/response/list-listener-rules-response.d.ts +1 -1
  150. package/lib/response/list-path-route-sets-response.d.ts +1 -1
  151. package/lib/response/list-routing-policies-response.d.ts +1 -1
  152. package/lib/response/list-rule-sets-response.d.ts +1 -1
  153. package/lib/response/list-sslcipher-suites-response.d.ts +1 -1
  154. package/package.json +3 -3
@@ -22,28 +22,28 @@ export interface SSLConfigurationDetails {
22
22
  /**
23
23
  * The maximum depth for peer certificate chain verification.
24
24
  * <p>
25
- Example: `3`
25
+ Example: {@code 3}
26
26
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
27
27
  */
28
28
  "verifyDepth"?: number;
29
29
  /**
30
30
  * Whether the load balancer listener should verify peer certificates.
31
31
  * <p>
32
- Example: `true`
32
+ Example: {@code true}
33
33
  *
34
34
  */
35
35
  "verifyPeerCertificate"?: boolean;
36
36
  /**
37
37
  * Ids for OCI certificates service CA or CA bundles for the load balancer to trust.
38
38
  * <p>
39
- Example: `[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]`
39
+ Example: {@code [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]}
40
40
  *
41
41
  */
42
42
  "trustedCertificateAuthorityIds"?: Array<string>;
43
43
  /**
44
44
  * Ids for OCI certificates service certificates. Currently only a single Id may be passed.
45
45
  * <p>
46
- Example: `[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]`
46
+ Example: {@code [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]}
47
47
  *
48
48
  */
49
49
  "certificateIds"?: Array<string>;
@@ -52,7 +52,7 @@ export interface SSLConfigurationDetails {
52
52
  * Valid certificate bundle names include only alphanumeric characters, dashes, and underscores.
53
53
  * Certificate bundle names cannot contain spaces. Avoid entering confidential information.
54
54
  * <p>
55
- Example: `example_certificate_bundle`
55
+ Example: {@code example_certificate_bundle}
56
56
  *
57
57
  */
58
58
  "certificateName"?: string;
@@ -77,17 +77,17 @@ export interface SSLConfigurationDetails {
77
77
  * The handshake to establish an SSL connection fails if the client supports none of the specified protocols.
78
78
  * * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher
79
79
  * suite.
80
- * * For all existing load balancer listeners and backend sets that predate this feature, the `GET` operation
80
+ * * For all existing load balancer listeners and backend sets that predate this feature, the {@code GET} operation
81
81
  * displays a list of SSL protocols currently used by those resources.
82
82
  * <p>
83
- example: `[\"TLSv1.1\", \"TLSv1.2\"]`
83
+ example: {@code [\"TLSv1.1\", \"TLSv1.2\"]}
84
84
  *
85
85
  */
86
86
  "protocols"?: Array<string>;
87
87
  /**
88
88
  * The name of the cipher suite to use for HTTPS or SSL connections.
89
89
  * <p>
90
- If this field is not specified, the default is `oci-default-ssl-cipher-suite-v1`.
90
+ If this field is not specified, the default is {@code oci-default-ssl-cipher-suite-v1}.
91
91
  * <p>
92
92
  **Notes:**
93
93
  * <p>
@@ -96,20 +96,20 @@ export interface SSLConfigurationDetails {
96
96
  * * You must ensure compatibility between the ciphers configured in the cipher suite and the configured
97
97
  * certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA
98
98
  * certificates.
99
- * * If the cipher configuration is not modified after load balancer creation, the `GET` operation returns
100
- * `oci-default-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing listeners
99
+ * * If the cipher configuration is not modified after load balancer creation, the {@code GET} operation returns
100
+ * {@code oci-default-ssl-cipher-suite-v1} as the value of this field in the SSL configuration for existing listeners
101
101
  * that predate this feature.
102
- * * If the cipher configuration was modified using Oracle operations after load balancer creation, the `GET`
103
- * operation returns `oci-customized-ssl-cipher-suite` as the value of this field in the SSL configuration for
102
+ * * If the cipher configuration was modified using Oracle operations after load balancer creation, the {@code GET}
103
+ * operation returns {@code oci-customized-ssl-cipher-suite} as the value of this field in the SSL configuration for
104
104
  * existing listeners that predate this feature.
105
- * * The `GET` operation returns `oci-wider-compatible-ssl-cipher-suite-v1` as the value of this field in the SSL
105
+ * * The {@code GET} operation returns {@code oci-wider-compatible-ssl-cipher-suite-v1} as the value of this field in the SSL
106
106
  * configuration for existing backend sets that predate this feature.
107
- * * If the `GET` operation on a listener returns `oci-customized-ssl-cipher-suite` as the value of this field,
107
+ * * If the {@code GET} operation on a listener returns {@code oci-customized-ssl-cipher-suite} as the value of this field,
108
108
  * you must specify an appropriate predefined or custom cipher suite name when updating the resource.
109
- * * The `oci-customized-ssl-cipher-suite` Oracle reserved cipher suite name is not accepted as valid input for
109
+ * * The {@code oci-customized-ssl-cipher-suite} Oracle reserved cipher suite name is not accepted as valid input for
110
110
  * this field.
111
111
  * <p>
112
- example: `example_cipher_suite`
112
+ example: {@code example_cipher_suite}
113
113
  *
114
114
  */
115
115
  "cipherSuiteName"?: string;
@@ -118,7 +118,7 @@ export interface SSLConfigurationDetails {
118
118
  * ciphers.
119
119
  * <p>
120
120
  **Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This
121
- * field is ignored when the `SSLConfiguration` object is associated with a backend set.
121
+ * field is ignored when the {@code SSLConfiguration} object is associated with a backend set.
122
122
  *
123
123
  */
124
124
  "serverOrderPreference"?: SSLConfigurationDetails.ServerOrderPreference;
@@ -24,28 +24,28 @@ export interface SSLConfiguration {
24
24
  /**
25
25
  * The maximum depth for peer certificate chain verification.
26
26
  * <p>
27
- Example: `3`
27
+ Example: {@code 3}
28
28
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
29
29
  */
30
30
  "verifyDepth": number;
31
31
  /**
32
32
  * Whether the load balancer listener should verify peer certificates.
33
33
  * <p>
34
- Example: `true`
34
+ Example: {@code true}
35
35
  *
36
36
  */
37
37
  "verifyPeerCertificate": boolean;
38
38
  /**
39
39
  * Ids for OCI certificates service CA or CA bundles for the load balancer to trust.
40
40
  * <p>
41
- Example: `[ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]`
41
+ Example: {@code [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]}
42
42
  *
43
43
  */
44
44
  "trustedCertificateAuthorityIds"?: Array<string>;
45
45
  /**
46
46
  * Ids for OCI certificates service certificates. Currently only a single Id may be passed.
47
47
  * <p>
48
- Example: `[ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]`
48
+ Example: {@code [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]}
49
49
  *
50
50
  */
51
51
  "certificateIds"?: Array<string>;
@@ -54,7 +54,7 @@ export interface SSLConfiguration {
54
54
  * Valid certificate bundle names include only alphanumeric characters, dashes, and underscores.
55
55
  * Certificate bundle names cannot contain spaces. Avoid entering confidential information.
56
56
  * <p>
57
- Example: `example_certificate_bundle`
57
+ Example: {@code example_certificate_bundle}
58
58
  *
59
59
  */
60
60
  "certificateName"?: string;
@@ -63,14 +63,14 @@ export interface SSLConfiguration {
63
63
  * ciphers.
64
64
  * <p>
65
65
  **Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This
66
- * field is ignored when the `SSLConfiguration` object is associated with a backend set.
66
+ * field is ignored when the {@code SSLConfiguration} object is associated with a backend set.
67
67
  *
68
68
  */
69
69
  "serverOrderPreference"?: SSLConfiguration.ServerOrderPreference;
70
70
  /**
71
71
  * The name of the cipher suite to use for HTTPS or SSL connections.
72
72
  * <p>
73
- If this field is not specified, the default is `oci-default-ssl-cipher-suite-v1`.
73
+ If this field is not specified, the default is {@code oci-default-ssl-cipher-suite-v1}.
74
74
  * <p>
75
75
  **Notes:**
76
76
  * <p>
@@ -79,20 +79,20 @@ export interface SSLConfiguration {
79
79
  * * You must ensure compatibility between the ciphers configured in the cipher suite and the configured
80
80
  * certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA
81
81
  * certificates.
82
- * * If the cipher configuration is not modified after load balancer creation, the `GET` operation returns
83
- * `oci-default-ssl-cipher-suite-v1` as the value of this field in the SSL configuration for existing listeners
82
+ * * If the cipher configuration is not modified after load balancer creation, the {@code GET} operation returns
83
+ * {@code oci-default-ssl-cipher-suite-v1} as the value of this field in the SSL configuration for existing listeners
84
84
  * that predate this feature.
85
- * * If the cipher configuration was modified using Oracle operations after load balancer creation, the `GET`
86
- * operation returns `oci-customized-ssl-cipher-suite` as the value of this field in the SSL configuration for
85
+ * * If the cipher configuration was modified using Oracle operations after load balancer creation, the {@code GET}
86
+ * operation returns {@code oci-customized-ssl-cipher-suite} as the value of this field in the SSL configuration for
87
87
  * existing listeners that predate this feature.
88
- * * The `GET` operation returns `oci-wider-compatible-ssl-cipher-suite-v1` as the value of this field in the SSL
88
+ * * The {@code GET} operation returns {@code oci-wider-compatible-ssl-cipher-suite-v1} as the value of this field in the SSL
89
89
  * configuration for existing backend sets that predate this feature.
90
- * * If the `GET` operation on a listener returns `oci-customized-ssl-cipher-suite` as the value of this field,
90
+ * * If the {@code GET} operation on a listener returns {@code oci-customized-ssl-cipher-suite} as the value of this field,
91
91
  * you must specify an appropriate predefined or custom cipher suite name when updating the resource.
92
- * * The `oci-customized-ssl-cipher-suite` Oracle reserved cipher suite name is not accepted as valid input for
92
+ * * The {@code oci-customized-ssl-cipher-suite} Oracle reserved cipher suite name is not accepted as valid input for
93
93
  * this field.
94
94
  * <p>
95
- example: `example_cipher_suite`
95
+ example: {@code example_cipher_suite}
96
96
  *
97
97
  */
98
98
  "cipherSuiteName"?: string;
@@ -117,10 +117,10 @@ export interface SSLConfiguration {
117
117
  * The handshake to establish an SSL connection fails if the client supports none of the specified protocols.
118
118
  * * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher
119
119
  * suite.
120
- * * For all existing load balancer listeners and backend sets that predate this feature, the `GET` operation
120
+ * * For all existing load balancer listeners and backend sets that predate this feature, the {@code GET} operation
121
121
  * displays a list of SSL protocols currently used by those resources.
122
122
  * <p>
123
- example: `[\"TLSv1.1\", \"TLSv1.2\"]`
123
+ example: {@code [\"TLSv1.1\", \"TLSv1.2\"]}
124
124
  *
125
125
  */
126
126
  "protocols"?: Array<string>;
@@ -21,15 +21,15 @@ Session persistence enables the Load Balancing service to direct any number of r
21
21
  * [Session Persistence](https://docs.cloud.oracle.com/Content/Balance/Reference/sessionpersistence.htm).
22
22
  * <p>
23
23
  With application cookie stickiness, the load balancer enables session persistence only when the response from a backend
24
- * application server includes a `Set-cookie` header with the user-specified cookie name.
24
+ * application server includes a {@code Set-cookie} header with the user-specified cookie name.
25
25
  * <p>
26
26
  To disable application cookie stickiness on a running load balancer, use the
27
- * {@link #updateBackendSet(UpdateBackendSetRequest) updateBackendSet} operation and specify `null` for the
28
- * `SessionPersistenceConfigurationDetails` object.
27
+ * {@link #updateBackendSet(UpdateBackendSetRequest) updateBackendSet} operation and specify {@code null} for the
28
+ * {@code SessionPersistenceConfigurationDetails} object.
29
29
  * <p>
30
- Example: `SessionPersistenceConfigurationDetails: null`
30
+ Example: {@code SessionPersistenceConfigurationDetails: null}
31
31
  * <p>
32
- **Note:** `SessionPersistenceConfigurationDetails` (application cookie stickiness) and `LBCookieSessionPersistenceConfigurationDetails`
32
+ **Note:** {@code SessionPersistenceConfigurationDetails} (application cookie stickiness) and {@code LBCookieSessionPersistenceConfigurationDetails}
33
33
  * (LB cookie stickiness) are mutually exclusive. An error results if you try to enable both types of session persistence.
34
34
  * <p>
35
35
  **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
@@ -40,7 +40,7 @@ export interface SessionPersistenceConfigurationDetails {
40
40
  * The name of the cookie used to detect a session initiated by the backend server. Use '*' to specify
41
41
  * that any cookie set by the backend causes the session to persist.
42
42
  * <p>
43
- Example: `example_cookie`
43
+ Example: {@code example_cookie}
44
44
  *
45
45
  */
46
46
  "cookieName": string;
@@ -48,7 +48,7 @@ export interface SessionPersistenceConfigurationDetails {
48
48
  * Whether the load balancer is prevented from directing traffic from a persistent session client to
49
49
  * a different backend server if the original server is unavailable. Defaults to false.
50
50
  * <p>
51
- Example: `false`
51
+ Example: {@code false}
52
52
  *
53
53
  */
54
54
  "disableFallback"?: boolean;
@@ -21,7 +21,7 @@ export interface ShapeDetails {
21
21
  * Bandwidth in Mbps that determines the total pre-provisioned bandwidth (ingress plus egress).
22
22
  * The values must be between 10 and the maximumBandwidthInMbps.
23
23
  * <p>
24
- Example: `150`
24
+ Example: {@code 150}
25
25
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
26
26
  */
27
27
  "minimumBandwidthInMbps": number;
@@ -32,7 +32,7 @@ export interface ShapeDetails {
32
32
  * <p>
33
33
  The values must be between minimumBandwidthInMbps and 8000 (8Gbps).
34
34
  * <p>
35
- Example: `1500`
35
+ Example: {@code 1500}
36
36
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
37
37
  */
38
38
  "maximumBandwidthInMbps": number;
@@ -22,9 +22,9 @@ export interface SourceVcnIdCondition extends model.RuleCondition {
22
22
  * The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the originating VCN that an incoming packet
23
23
  * must match.
24
24
  * <p>
25
- You can use this condition in conjunction with `SourceVcnIpAddressCondition`.
25
+ You can use this condition in conjunction with {@code SourceVcnIpAddressCondition}.
26
26
  * <p>
27
- **NOTE:** If you define this condition for a rule without a `SourceVcnIpAddressCondition`, this condition
27
+ **NOTE:** If you define this condition for a rule without a {@code SourceVcnIpAddressCondition}, this condition
28
28
  * matches all incoming traffic in the specified VCN.
29
29
  *
30
30
  */
@@ -15,7 +15,7 @@ information, see [Overview of Load Balancing](/iaas/Content/Balance/Concepts/bal
15
15
  import * as model from "../model";
16
16
  /**
17
17
  * An access control rule condition that requires a match on the specified source VCN and IP address range.
18
- * This condition must be used only in conjunction with `SourceVcnIdCondition`.
18
+ * This condition must be used only in conjunction with {@code SourceVcnIdCondition}.
19
19
  *
20
20
  */
21
21
  export interface SourceVcnIpAddressCondition extends model.RuleCondition {
@@ -23,17 +23,17 @@ export interface UpdateBackendDetails {
23
23
  * For more information on load balancing policies, see
24
24
  * [How Load Balancing Policies Work](https://docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm).
25
25
  * <p>
26
- Example: `3`
26
+ Example: {@code 3}
27
27
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
28
28
  */
29
29
  "weight": number;
30
30
  /**
31
- * Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress
31
+ * Whether the load balancer should treat this server as a backup unit. If {@code true}, the load balancer forwards no ingress
32
32
  * traffic to this backend server unless all other backend servers not marked as \"backup\" fail the health check policy.
33
33
  * <p>
34
- **Note:** You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy.
34
+ **Note:** You cannot add a backend server marked as {@code backup} to a backend set that uses the IP Hash policy.
35
35
  * <p>
36
- Example: `false`
36
+ Example: {@code false}
37
37
  *
38
38
  */
39
39
  "backup": boolean;
@@ -41,7 +41,7 @@ export interface UpdateBackendDetails {
41
41
  * Whether the load balancer should drain this server. Servers marked \"drain\" receive no new
42
42
  * incoming traffic.
43
43
  * <p>
44
- Example: `false`
44
+ Example: {@code false}
45
45
  *
46
46
  */
47
47
  "drain": boolean;
@@ -49,7 +49,7 @@ export interface UpdateBackendDetails {
49
49
  * Whether the load balancer should treat this server as offline. Offline servers receive no incoming
50
50
  * traffic.
51
51
  * <p>
52
- Example: `false`
52
+ Example: {@code false}
53
53
  *
54
54
  */
55
55
  "offline": boolean;
@@ -18,7 +18,7 @@ import * as model from "../model";
18
18
  * For more information on backend set configuration, see
19
19
  * [Managing Backend Sets](https://docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendsets.htm).
20
20
  * <p>
21
- **Note:** The `sessionPersistenceConfiguration` (application cookie stickiness) and `lbCookieSessionPersistenceConfiguration`
21
+ **Note:** The {@code sessionPersistenceConfiguration} (application cookie stickiness) and {@code lbCookieSessionPersistenceConfiguration}
22
22
  * (LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two
23
23
  * attributes per backend set.
24
24
  * <p>
@@ -30,7 +30,7 @@ export interface UpdateBackendSetDetails {
30
30
  * The load balancer policy for the backend set. To get a list of available policies, use the
31
31
  * {@link #listPolicies(ListPoliciesRequest) listPolicies} operation.
32
32
  * <p>
33
- Example: `LEAST_CONNECTIONS`
33
+ Example: {@code LEAST_CONNECTIONS}
34
34
  *
35
35
  */
36
36
  "policy": string;
@@ -19,28 +19,28 @@ export interface UpdateHealthCheckerDetails {
19
19
  /**
20
20
  * The protocol the health check must use; either HTTP or TCP.
21
21
  * <p>
22
- Example: `HTTP`
22
+ Example: {@code HTTP}
23
23
  *
24
24
  */
25
25
  "protocol": string;
26
26
  /**
27
27
  * The path against which to run the health check.
28
28
  * <p>
29
- Example: `/healthcheck`
29
+ Example: {@code /healthcheck}
30
30
  *
31
31
  */
32
32
  "urlPath"?: string;
33
33
  /**
34
34
  * The backend server port against which to run the health check.
35
35
  * <p>
36
- Example: `8080`
36
+ Example: {@code 8080}
37
37
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
38
38
  */
39
39
  "port": number;
40
40
  /**
41
41
  * The status code a healthy backend server should return.
42
42
  * <p>
43
- Example: `200`
43
+ Example: {@code 200}
44
44
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
45
45
  */
46
46
  "returnCode": number;
@@ -48,7 +48,7 @@ export interface UpdateHealthCheckerDetails {
48
48
  * The number of retries to attempt before a backend server is considered \"unhealthy\". This number also applies
49
49
  * when recovering a server to the \"healthy\" state.
50
50
  * <p>
51
- Example: `3`
51
+ Example: {@code 3}
52
52
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
53
53
  */
54
54
  "retries": number;
@@ -56,21 +56,21 @@ export interface UpdateHealthCheckerDetails {
56
56
  * The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply
57
57
  * returns within this timeout period.
58
58
  * <p>
59
- Example: `3000`
59
+ Example: {@code 3000}
60
60
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
61
61
  */
62
62
  "timeoutInMillis": number;
63
63
  /**
64
64
  * The interval between health checks, in milliseconds.
65
65
  * <p>
66
- Example: `10000`
66
+ Example: {@code 10000}
67
67
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
68
68
  */
69
69
  "intervalInMillis": number;
70
70
  /**
71
71
  * A regular expression for parsing the response body from the backend server.
72
72
  * <p>
73
- Example: `^((?!false).|\\s)*$`
73
+ Example: {@code ^((?!false).|\\s)*$}
74
74
  *
75
75
  */
76
76
  "responseBodyRegex": string;
@@ -84,7 +84,7 @@ export interface UpdateHealthCheckerDetails {
84
84
  If \"false\", health checks will be done using SSL encryption if the associated backend set is configured
85
85
  * to use SSL. If the backend set is not so configured the health checks will be done using plain text.
86
86
  * <p>
87
- Example: `true`
87
+ Example: {@code true}
88
88
  *
89
89
  */
90
90
  "isForcePlainText"?: boolean;
@@ -23,7 +23,7 @@ export interface UpdateHostnameDetails {
23
23
  * The virtual hostname to update. For more information about virtual hostname string construction, see
24
24
  * [Managing Request Routing](https://docs.cloud.oracle.com/Content/Balance/Tasks/managingrequest.htm#routing).
25
25
  * <p>
26
- Example: `app.example.com`
26
+ Example: {@code app.example.com}
27
27
  *
28
28
  */
29
29
  "hostname"?: string;
@@ -20,14 +20,14 @@ export interface UpdateListenerDetails {
20
20
  /**
21
21
  * The name of the associated backend set.
22
22
  * <p>
23
- Example: `example_backend_set`
23
+ Example: {@code example_backend_set}
24
24
  *
25
25
  */
26
26
  "defaultBackendSetName": string;
27
27
  /**
28
28
  * The communication port for the listener.
29
29
  * <p>
30
- Example: `80`
30
+ Example: {@code 80}
31
31
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
32
32
  */
33
33
  "port": number;
@@ -36,7 +36,7 @@ export interface UpdateListenerDetails {
36
36
  * To get a list of valid protocols, use the {@link #listProtocols(ListProtocolsRequest) listProtocols}
37
37
  * operation.
38
38
  * <p>
39
- Example: `HTTP`
39
+ Example: {@code HTTP}
40
40
  *
41
41
  */
42
42
  "protocol": string;
@@ -45,19 +45,19 @@ export interface UpdateListenerDetails {
45
45
  */
46
46
  "hostnameNames"?: Array<string>;
47
47
  /**
48
- * Deprecated. Please use `routingPolicies` instead.
48
+ * Deprecated. Please use {@code routingPolicies} instead.
49
49
  * <p>
50
50
  The name of the set of path-based routing rules, {@link PathRouteSet},
51
51
  * applied to this listener's traffic.
52
52
  * <p>
53
- Example: `example_path_route_set`
53
+ Example: {@code example_path_route_set}
54
54
  *
55
55
  */
56
56
  "pathRouteSetName"?: string;
57
57
  /**
58
58
  * The name of the routing policy applied to this listener's traffic.
59
59
  * <p>
60
- Example: `example_routing_policy`
60
+ Example: {@code example_routing_policy}
61
61
  *
62
62
  */
63
63
  "routingPolicyName"?: string;
@@ -23,7 +23,7 @@ export interface UpdateLoadBalancerDetails {
23
23
  * The user-friendly display name for the load balancer. It does not have to be unique, and it is changeable.
24
24
  * Avoid entering confidential information.
25
25
  * <p>
26
- Example: `example_load_balancer`
26
+ Example: {@code example_load_balancer}
27
27
  *
28
28
  */
29
29
  "displayName"?: string;
@@ -31,7 +31,7 @@ export interface UpdateLoadBalancerDetails {
31
31
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
32
32
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
33
33
  * <p>
34
- Example: `{\"Department\": \"Finance\"}`
34
+ Example: {@code {\"Department\": \"Finance\"}}
35
35
  *
36
36
  */
37
37
  "freeformTags"?: {
@@ -41,7 +41,7 @@ export interface UpdateLoadBalancerDetails {
41
41
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
42
42
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
43
43
  * <p>
44
- Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
44
+ Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
45
45
  *
46
46
  */
47
47
  "definedTags"?: {
@@ -24,10 +24,10 @@ export interface UpdateLoadBalancerShapeDetails {
24
24
  * * 8000Mbps
25
25
  * * Flexible
26
26
  * <p>
27
- Example: `flexible`
27
+ Example: {@code flexible}
28
28
  * <p>
29
29
  * NOTE: Fixed shapes 10Mbps, 100Mbps, 400Mbps, 8000Mbps will be deprecated from May 2023. This api
30
- * * will only support `Flexible` shape after that date.
30
+ * * will only support {@code Flexible} shape after that date.
31
31
  *
32
32
  */
33
33
  "shapeName": string;
@@ -18,7 +18,7 @@ import * as model from "../model";
18
18
  */
19
19
  export interface UpdateRoutingPolicyDetails {
20
20
  /**
21
- * The version of the language in which `condition` of `rules` are composed.
21
+ * The version of the language in which {@code condition} of {@code rules} are composed.
22
22
  *
23
23
  */
24
24
  "conditionLanguageVersion"?: UpdateRoutingPolicyDetails.ConditionLanguageVersion;
@@ -125,7 +125,7 @@ export interface UpdateSSLCipherSuiteDetails {
125
125
  * \"RC4-SHA\"
126
126
  * \"SEED-SHA\"
127
127
  * <p>
128
- example: `[\"ECDHE-RSA-AES256-GCM-SHA384\",\"ECDHE-ECDSA-AES256-GCM-SHA384\",\"ECDHE-RSA-AES128-GCM-SHA256\"]`
128
+ example: {@code [\"ECDHE-RSA-AES256-GCM-SHA384\",\"ECDHE-ECDSA-AES256-GCM-SHA384\",\"ECDHE-RSA-AES128-GCM-SHA256\"]}
129
129
  *
130
130
  */
131
131
  "ciphers": Array<string>;
@@ -34,7 +34,7 @@ export interface WorkRequest {
34
34
  /**
35
35
  * The type of action the work request represents.
36
36
  * <p>
37
- Example: `CreateListener`
37
+ Example: {@code CreateListener}
38
38
  *
39
39
  */
40
40
  "type": string;
@@ -62,14 +62,14 @@ export interface WorkRequest {
62
62
  /**
63
63
  * The date and time the work request was created, in the format defined by RFC3339.
64
64
  * <p>
65
- Example: `2016-08-25T21:10:29.600Z`
65
+ Example: {@code 2016-08-25T21:10:29.600Z}
66
66
  *
67
67
  */
68
68
  "timeAccepted": Date;
69
69
  /**
70
70
  * The date and time the work request was completed, in the format defined by RFC3339.
71
71
  * <p>
72
- Example: `2016-08-25T21:10:29.600Z`
72
+ Example: {@code 2016-08-25T21:10:29.600Z}
73
73
  *
74
74
  */
75
75
  "timeFinished"?: Date;
@@ -13,7 +13,7 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/loadbalancer/ChangeLoadBalancerCompartment.ts.html |here} to see how to use ChangeLoadBalancerCompartmentRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.1/loadbalancer/ChangeLoadBalancerCompartment.ts.html |here} to see how to use ChangeLoadBalancerCompartmentRequest.
17
17
  */
18
18
  export interface ChangeLoadBalancerCompartmentRequest extends common.BaseRequest {
19
19
  /**
@@ -49,7 +49,7 @@ export interface ChangeLoadBalancerCompartmentRequest extends common.BaseRequest
49
49
  The resource is updated or deleted only if the ETag you provide matches the resource's current
50
50
  * ETag value.
51
51
  * <p>
52
- Example: `example-etag`
52
+ Example: {@code example-etag}
53
53
  *
54
54
  */
55
55
  "ifMatch"?: string;
@@ -13,7 +13,7 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/loadbalancer/CreateBackend.ts.html |here} to see how to use CreateBackendRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.1/loadbalancer/CreateBackend.ts.html |here} to see how to use CreateBackendRequest.
17
17
  */
18
18
  export interface CreateBackendRequest extends common.BaseRequest {
19
19
  /**
@@ -27,7 +27,7 @@ export interface CreateBackendRequest extends common.BaseRequest {
27
27
  /**
28
28
  * The name of the backend set to add the backend server to.
29
29
  * <p>
30
- Example: `example_backend_set`
30
+ Example: {@code example_backend_set}
31
31
  *
32
32
  */
33
33
  "backendSetName": string;
@@ -47,7 +47,7 @@ export interface CreateBackendRequest extends common.BaseRequest {
47
47
  The resource is updated or deleted only if the ETag you provide matches the resource's current
48
48
  * ETag value.
49
49
  * <p>
50
- Example: `example-etag`
50
+ Example: {@code example-etag}
51
51
  *
52
52
  */
53
53
  "ifMatch"?: string;
@@ -13,7 +13,7 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/loadbalancer/CreateBackendSet.ts.html |here} to see how to use CreateBackendSetRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.1/loadbalancer/CreateBackendSet.ts.html |here} to see how to use CreateBackendSetRequest.
17
17
  */
18
18
  export interface CreateBackendSetRequest extends common.BaseRequest {
19
19
  /**
@@ -49,7 +49,7 @@ export interface CreateBackendSetRequest extends common.BaseRequest {
49
49
  The resource is updated or deleted only if the ETag you provide matches the resource's current
50
50
  * ETag value.
51
51
  * <p>
52
- Example: `example-etag`
52
+ Example: {@code example-etag}
53
53
  *
54
54
  */
55
55
  "ifMatch"?: string;