oci-vnmonitoring 2.76.1 → 2.77.0

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 (212) hide show
  1. package/lib/client.d.ts +12 -12
  2. package/lib/client.js +12 -12
  3. package/lib/model/add-drg-route-rule-details.d.ts +3 -3
  4. package/lib/model/add-public-ip-pool-capacity-details.d.ts +3 -3
  5. package/lib/model/add-security-rule-details.d.ts +21 -21
  6. package/lib/model/add-subnet-ipv6-cidr-details.d.ts +1 -1
  7. package/lib/model/add-vcn-ipv6-cidr-details.d.ts +1 -1
  8. package/lib/model/bgp-session-info.d.ts +15 -15
  9. package/lib/model/byoip-allocated-range-collection.d.ts +1 -1
  10. package/lib/model/byoip-range-collection.d.ts +2 -2
  11. package/lib/model/byoip-range-summary.d.ts +9 -9
  12. package/lib/model/byoip-range-vcn-ipv6-allocation-summary.d.ts +3 -3
  13. package/lib/model/byoip-range.d.ts +15 -15
  14. package/lib/model/byoipv6-cidr-details.d.ts +3 -3
  15. package/lib/model/capture-filter.d.ts +3 -3
  16. package/lib/model/change-path-analyzer-test-compartment-details.d.ts +2 -2
  17. package/lib/model/compute-instance-endpoint.d.ts +2 -2
  18. package/lib/model/connect-remote-peering-connections-details.d.ts +1 -1
  19. package/lib/model/cpe-device-config-answer.d.ts +2 -2
  20. package/lib/model/cpe.d.ts +5 -5
  21. package/lib/model/create-byoip-range-details.d.ts +4 -4
  22. package/lib/model/create-capture-filter-details.d.ts +2 -2
  23. package/lib/model/create-cpe-details.d.ts +4 -4
  24. package/lib/model/create-cross-connect-details.d.ts +4 -4
  25. package/lib/model/create-cross-connect-group-details.d.ts +2 -2
  26. package/lib/model/create-dhcp-details.d.ts +2 -2
  27. package/lib/model/create-drg-attachment-details.d.ts +3 -3
  28. package/lib/model/create-drg-details.d.ts +2 -2
  29. package/lib/model/create-drg-route-distribution-details.d.ts +2 -2
  30. package/lib/model/create-drg-route-table-details.d.ts +2 -2
  31. package/lib/model/create-internet-gateway-details.d.ts +2 -2
  32. package/lib/model/create-ip-sec-connection-details.d.ts +12 -12
  33. package/lib/model/create-ip-sec-connection-tunnel-details.d.ts +3 -3
  34. package/lib/model/create-ip-sec-tunnel-bgp-session-details.d.ts +15 -15
  35. package/lib/model/create-ipv6-details.d.ts +4 -4
  36. package/lib/model/create-local-peering-gateway-details.d.ts +2 -2
  37. package/lib/model/create-nat-gateway-details.d.ts +4 -4
  38. package/lib/model/create-network-security-group-details.d.ts +2 -2
  39. package/lib/model/create-path-analyzer-test-details.d.ts +5 -5
  40. package/lib/model/create-private-ip-details.d.ts +5 -5
  41. package/lib/model/create-public-ip-details.d.ts +2 -2
  42. package/lib/model/create-public-ip-pool-details.d.ts +2 -2
  43. package/lib/model/create-remote-peering-connection-details.d.ts +2 -2
  44. package/lib/model/create-route-table-details.d.ts +2 -2
  45. package/lib/model/create-security-list-details.d.ts +2 -2
  46. package/lib/model/create-service-gateway-details.d.ts +4 -4
  47. package/lib/model/create-subnet-details.d.ts +14 -14
  48. package/lib/model/create-vcn-details.d.ts +11 -11
  49. package/lib/model/create-virtual-circuit-details.d.ts +13 -13
  50. package/lib/model/create-vlan-details.d.ts +4 -4
  51. package/lib/model/create-vnic-details.d.ts +24 -24
  52. package/lib/model/create-vtap-details.d.ts +7 -7
  53. package/lib/model/cross-connect-group.d.ts +4 -4
  54. package/lib/model/cross-connect-location.d.ts +1 -1
  55. package/lib/model/cross-connect-mapping-details.d.ts +6 -6
  56. package/lib/model/cross-connect-mapping.d.ts +7 -7
  57. package/lib/model/cross-connect-port-speed-shape.d.ts +2 -2
  58. package/lib/model/cross-connect-status.d.ts +2 -2
  59. package/lib/model/cross-connect.d.ts +5 -5
  60. package/lib/model/dhcp-dns-option.d.ts +1 -1
  61. package/lib/model/dhcp-options.d.ts +3 -3
  62. package/lib/model/dhcp-search-domain-option.d.ts +2 -2
  63. package/lib/model/drg-attachment-info.d.ts +1 -1
  64. package/lib/model/drg-attachment.d.ts +6 -6
  65. package/lib/model/drg-route-distribution-statement.d.ts +1 -1
  66. package/lib/model/drg-route-distribution.d.ts +4 -4
  67. package/lib/model/drg-route-rule.d.ts +10 -10
  68. package/lib/model/drg-route-table.d.ts +4 -4
  69. package/lib/model/drg.d.ts +3 -3
  70. package/lib/model/egress-security-rule.d.ts +9 -9
  71. package/lib/model/endpoint.d.ts +1 -1
  72. package/lib/model/fast-connect-provider-service-key.d.ts +2 -2
  73. package/lib/model/fast-connect-provider-service.d.ts +1 -1
  74. package/lib/model/flow-log-capture-filter-rule-details.d.ts +1 -1
  75. package/lib/model/i-psec-connection-device-status.d.ts +1 -1
  76. package/lib/model/i-psec-connection-tunnel.d.ts +7 -7
  77. package/lib/model/i-psec-connection.d.ts +14 -14
  78. package/lib/model/icmp-traffic-protocol-parameters.d.ts +1 -1
  79. package/lib/model/ingress-security-rule.d.ts +9 -9
  80. package/lib/model/internet-gateway.d.ts +3 -3
  81. package/lib/model/ip-address-endpoint.d.ts +2 -2
  82. package/lib/model/ipv6.d.ts +7 -7
  83. package/lib/model/letter-of-authority.d.ts +1 -1
  84. package/lib/model/load-balancer-endpoint.d.ts +1 -1
  85. package/lib/model/load-balancer-listener-endpoint.d.ts +1 -1
  86. package/lib/model/local-peering-gateway.d.ts +11 -11
  87. package/lib/model/macsec-key.d.ts +1 -1
  88. package/lib/model/nat-gateway.d.ts +5 -5
  89. package/lib/model/network-load-balancer-endpoint.d.ts +1 -1
  90. package/lib/model/network-load-balancer-listener-endpoint.d.ts +1 -1
  91. package/lib/model/network-security-group-vnic.d.ts +1 -1
  92. package/lib/model/network-security-group.d.ts +3 -3
  93. package/lib/model/path-analysis-work-request-result.d.ts +2 -2
  94. package/lib/model/path-analyzer-test-collection.d.ts +2 -2
  95. package/lib/model/path-analyzer-test-summary.d.ts +9 -9
  96. package/lib/model/path-analyzer-test.d.ts +9 -9
  97. package/lib/model/path.d.ts +1 -1
  98. package/lib/model/persisted-get-path-analysis-details.d.ts +2 -2
  99. package/lib/model/private-ip.d.ts +21 -21
  100. package/lib/model/protocol-parameters.d.ts +1 -1
  101. package/lib/model/public-ip-pool-collection.d.ts +1 -1
  102. package/lib/model/public-ip-pool-summary.d.ts +3 -3
  103. package/lib/model/public-ip-pool.d.ts +3 -3
  104. package/lib/model/public-ip.d.ts +17 -17
  105. package/lib/model/query-options.d.ts +1 -1
  106. package/lib/model/remote-peering-connection.d.ts +7 -7
  107. package/lib/model/remove-public-ip-pool-capacity-details.d.ts +1 -1
  108. package/lib/model/remove-subnet-ipv6-cidr-details.d.ts +1 -1
  109. package/lib/model/remove-vcn-ipv6-cidr-details.d.ts +1 -1
  110. package/lib/model/route-rule.d.ts +13 -13
  111. package/lib/model/route-table.d.ts +4 -4
  112. package/lib/model/security-action.d.ts +1 -1
  113. package/lib/model/security-list.d.ts +3 -3
  114. package/lib/model/security-rule.d.ts +26 -26
  115. package/lib/model/service-gateway.d.ts +7 -7
  116. package/lib/model/service.d.ts +10 -10
  117. package/lib/model/subnet-endpoint.d.ts +2 -2
  118. package/lib/model/subnet.d.ts +21 -21
  119. package/lib/model/tcp-protocol-parameters.d.ts +2 -2
  120. package/lib/model/tcp-traffic-protocol-parameters.d.ts +3 -3
  121. package/lib/model/topology-associated-with-entity-relationship.d.ts +2 -2
  122. package/lib/model/topology-associated-with-relationship-details.d.ts +1 -1
  123. package/lib/model/topology-contains-entity-relationship.d.ts +2 -2
  124. package/lib/model/topology-routes-to-entity-relationship.d.ts +1 -1
  125. package/lib/model/topology-routes-to-relationship-details.d.ts +5 -5
  126. package/lib/model/topology.d.ts +1 -1
  127. package/lib/model/traffic-node.d.ts +1 -1
  128. package/lib/model/traffic-protocol-parameters.d.ts +1 -1
  129. package/lib/model/traffic-route.d.ts +1 -1
  130. package/lib/model/tunnel-config.d.ts +2 -2
  131. package/lib/model/tunnel-cpe-device-config.d.ts +1 -1
  132. package/lib/model/tunnel-phase-one-details.d.ts +1 -1
  133. package/lib/model/tunnel-phase-two-details.d.ts +1 -1
  134. package/lib/model/tunnel-security-association-summary.d.ts +1 -1
  135. package/lib/model/tunnel-status.d.ts +3 -3
  136. package/lib/model/udp-protocol-parameters.d.ts +2 -2
  137. package/lib/model/udp-traffic-protocol-parameters.d.ts +3 -3
  138. package/lib/model/update-byoip-range-details.d.ts +3 -3
  139. package/lib/model/update-capture-filter-details.d.ts +2 -2
  140. package/lib/model/update-cpe-details.d.ts +2 -2
  141. package/lib/model/update-cross-connect-details.d.ts +3 -3
  142. package/lib/model/update-cross-connect-group-details.d.ts +2 -2
  143. package/lib/model/update-dhcp-details.d.ts +2 -2
  144. package/lib/model/update-drg-attachment-details.d.ts +2 -2
  145. package/lib/model/update-drg-details.d.ts +2 -2
  146. package/lib/model/update-drg-route-distribution-details.d.ts +2 -2
  147. package/lib/model/update-drg-route-rule-details.d.ts +3 -3
  148. package/lib/model/update-drg-route-table-details.d.ts +2 -2
  149. package/lib/model/update-internet-gateway-details.d.ts +2 -2
  150. package/lib/model/update-ip-sec-connection-details.d.ts +8 -8
  151. package/lib/model/update-ip-sec-connection-tunnel-details.d.ts +3 -3
  152. package/lib/model/update-ip-sec-tunnel-bgp-session-details.d.ts +16 -16
  153. package/lib/model/update-ipv6-details.d.ts +2 -2
  154. package/lib/model/update-local-peering-gateway-details.d.ts +2 -2
  155. package/lib/model/update-nat-gateway-details.d.ts +4 -4
  156. package/lib/model/update-network-security-group-details.d.ts +2 -2
  157. package/lib/model/update-path-analyzer-test-details.d.ts +4 -4
  158. package/lib/model/update-private-ip-details.d.ts +4 -4
  159. package/lib/model/update-public-ip-details.d.ts +2 -2
  160. package/lib/model/update-public-ip-pool-details.d.ts +2 -2
  161. package/lib/model/update-remote-peering-connection-details.d.ts +2 -2
  162. package/lib/model/update-route-table-details.d.ts +2 -2
  163. package/lib/model/update-security-list-details.d.ts +2 -2
  164. package/lib/model/update-security-rule-details.d.ts +23 -23
  165. package/lib/model/update-service-gateway-details.d.ts +8 -8
  166. package/lib/model/update-subnet-details.d.ts +5 -5
  167. package/lib/model/update-vcn-details.d.ts +2 -2
  168. package/lib/model/update-virtual-circuit-details.d.ts +7 -7
  169. package/lib/model/update-vlan-details.d.ts +3 -3
  170. package/lib/model/update-vnic-details.d.ts +7 -7
  171. package/lib/model/update-vtap-details.d.ts +5 -5
  172. package/lib/model/upgrade-status.d.ts +1 -1
  173. package/lib/model/vcn.d.ts +8 -8
  174. package/lib/model/virtual-circuit-bandwidth-shape.d.ts +2 -2
  175. package/lib/model/virtual-circuit-drg-attachment-network-details.d.ts +1 -1
  176. package/lib/model/virtual-circuit-public-prefix.d.ts +2 -2
  177. package/lib/model/virtual-circuit.d.ts +11 -11
  178. package/lib/model/vlan-endpoint.d.ts +2 -2
  179. package/lib/model/vlan.d.ts +6 -6
  180. package/lib/model/vnic-endpoint.d.ts +2 -2
  181. package/lib/model/vnic.d.ts +16 -16
  182. package/lib/model/vtap.d.ts +8 -8
  183. package/lib/model/work-request-error-collection.d.ts +2 -2
  184. package/lib/model/work-request-log-entry-collection.d.ts +1 -1
  185. package/lib/model/work-request-resource.d.ts +3 -3
  186. package/lib/model/work-request-result-collection.d.ts +2 -2
  187. package/lib/model/work-request-summary-collection.d.ts +2 -2
  188. package/lib/model/work-request-summary.d.ts +2 -2
  189. package/lib/model/work-request.d.ts +2 -2
  190. package/lib/request/change-path-analyzer-test-compartment-request.d.ts +3 -3
  191. package/lib/request/create-path-analyzer-test-request.d.ts +1 -1
  192. package/lib/request/delete-path-analyzer-test-request.d.ts +3 -3
  193. package/lib/request/get-path-analysis-request.d.ts +1 -1
  194. package/lib/request/get-path-analyzer-test-request.d.ts +2 -2
  195. package/lib/request/get-work-request-request.d.ts +1 -1
  196. package/lib/request/list-path-analyzer-tests-request.d.ts +7 -7
  197. package/lib/request/list-work-request-errors-request.d.ts +5 -5
  198. package/lib/request/list-work-request-logs-request.d.ts +5 -5
  199. package/lib/request/list-work-request-results-request.d.ts +3 -3
  200. package/lib/request/list-work-requests-request.d.ts +6 -6
  201. package/lib/request/update-path-analyzer-test-request.d.ts +3 -3
  202. package/lib/response/change-path-analyzer-test-compartment-response.d.ts +1 -1
  203. package/lib/response/create-path-analyzer-test-response.d.ts +1 -1
  204. package/lib/response/get-path-analyzer-test-response.d.ts +1 -1
  205. package/lib/response/get-work-request-response.d.ts +1 -1
  206. package/lib/response/list-path-analyzer-tests-response.d.ts +1 -1
  207. package/lib/response/list-work-request-errors-response.d.ts +1 -1
  208. package/lib/response/list-work-request-logs-response.d.ts +1 -1
  209. package/lib/response/list-work-request-results-response.d.ts +1 -1
  210. package/lib/response/list-work-requests-response.d.ts +1 -1
  211. package/lib/response/update-path-analyzer-test-response.d.ts +1 -1
  212. package/package.json +3 -3
@@ -14,12 +14,12 @@ documentation for the [Network Path Analyzer](/iaas/Content/Network/Concepts/pat
14
14
  */
15
15
  import * as model from "../model";
16
16
  /**
17
- * Oracle offers the ability to Bring Your Own IP (BYOIP), importing public IP addresses or IPv6 addresses that you currently own to Oracle Cloud Infrastructure. A `ByoipRange` resource is a record of the imported address block (a BYOIP CIDR block) and also some associated metadata.
17
+ * Oracle offers the ability to Bring Your Own IP (BYOIP), importing public IP addresses or IPv6 addresses that you currently own to Oracle Cloud Infrastructure. A {@code ByoipRange} resource is a record of the imported address block (a BYOIP CIDR block) and also some associated metadata.
18
18
  * The process used to [Bring Your Own IP](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/BYOIP.htm) is explained in the documentation.
19
19
  */
20
20
  export interface ByoipRange {
21
21
  /**
22
- * A list of `ByoipRangeVcnIpv6AllocationSummary` objects.
22
+ * A list of {@code ByoipRangeVcnIpv6AllocationSummary} objects.
23
23
  *
24
24
  */
25
25
  "byoipRangeVcnIpv6Allocations"?: Array<model.ByoipRangeVcnIpv6AllocationSummary>;
@@ -34,7 +34,7 @@ export interface ByoipRange {
34
34
  "compartmentId": string;
35
35
  /**
36
36
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
37
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
37
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
38
38
  *
39
39
  */
40
40
  "definedTags"?: {
@@ -50,14 +50,14 @@ export interface ByoipRange {
50
50
  "displayName"?: string;
51
51
  /**
52
52
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
53
- * Example: `{\"bar-key\": \"value\"}`
53
+ * Example: {@code {\"bar-key\": \"value\"}}
54
54
  *
55
55
  */
56
56
  "freeformTags"?: {
57
57
  [key: string]: string;
58
58
  };
59
59
  /**
60
- * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource.
60
+ * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the {@code ByoipRange} resource.
61
61
  */
62
62
  "id": string;
63
63
  /**
@@ -68,38 +68,38 @@ export interface ByoipRange {
68
68
  */
69
69
  "ipv6CidrBlock"?: string;
70
70
  /**
71
- * The `ByoipRange` resource's current status.
71
+ * The {@code ByoipRange} resource's current status.
72
72
  */
73
73
  "lifecycleDetails"?: ByoipRange.LifecycleDetails;
74
74
  /**
75
- * The `ByoipRange` resource's current state.
75
+ * The {@code ByoipRange} resource's current state.
76
76
  */
77
77
  "lifecycleState": ByoipRange.LifecycleState;
78
78
  /**
79
- * The date and time the `ByoipRange` resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
79
+ * The date and time the {@code ByoipRange} resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
80
80
  * <p>
81
- Example: `2016-08-25T21:10:29.600Z`
81
+ Example: {@code 2016-08-25T21:10:29.600Z}
82
82
  *
83
83
  */
84
84
  "timeCreated": Date;
85
85
  /**
86
- * The date and time the `ByoipRange` resource was validated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
86
+ * The date and time the {@code ByoipRange} resource was validated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
87
87
  * <p>
88
- Example: `2016-08-25T21:10:29.600Z`
88
+ Example: {@code 2016-08-25T21:10:29.600Z}
89
89
  *
90
90
  */
91
91
  "timeValidated"?: Date;
92
92
  /**
93
- * The date and time the `ByoipRange` resource was advertised to the internet by BGP, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
93
+ * The date and time the {@code ByoipRange} resource was advertised to the internet by BGP, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
94
94
  * <p>
95
- Example: `2016-08-25T21:10:29.600Z`
95
+ Example: {@code 2016-08-25T21:10:29.600Z}
96
96
  *
97
97
  */
98
98
  "timeAdvertised"?: Date;
99
99
  /**
100
- * The date and time the `ByoipRange` resource was withdrawn from advertisement by BGP to the internet, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
100
+ * The date and time the {@code ByoipRange} resource was withdrawn from advertisement by BGP to the internet, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
101
101
  * <p>
102
- Example: `2016-08-25T21:10:29.600Z`
102
+ Example: {@code 2016-08-25T21:10:29.600Z}
103
103
  *
104
104
  */
105
105
  "timeWithdrawn"?: Date;
@@ -22,12 +22,12 @@ documentation for the [Network Path Analyzer](/iaas/Content/Network/Concepts/pat
22
22
  */
23
23
  export interface Byoipv6CidrDetails {
24
24
  /**
25
- * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs.
25
+ * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the {@code ByoipRange} resource to which the CIDR block belongs.
26
26
  */
27
27
  "byoipv6RangeId": string;
28
28
  /**
29
- * An IPv6 CIDR block required to create a VCN with a BYOIP prefix. It could be the whole CIDR block identified in `byoipv6RangeId`, or a subrange.
30
- * Example: `2001:0db8:0123::/48`
29
+ * An IPv6 CIDR block required to create a VCN with a BYOIP prefix. It could be the whole CIDR block identified in {@code byoipv6RangeId}, or a subrange.
30
+ * Example: {@code 2001:0db8:0123::/48}
31
31
  *
32
32
  */
33
33
  "ipv6CidrBlock": string;
@@ -26,7 +26,7 @@ export interface CaptureFilter {
26
26
  "compartmentId": string;
27
27
  /**
28
28
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
29
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
29
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
30
30
  *
31
31
  */
32
32
  "definedTags"?: {
@@ -42,7 +42,7 @@ export interface CaptureFilter {
42
42
  "displayName"?: string;
43
43
  /**
44
44
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
45
- * Example: `{\"bar-key\": \"value\"}`
45
+ * Example: {@code {\"bar-key\": \"value\"}}
46
46
  *
47
47
  */
48
48
  "freeformTags"?: {
@@ -64,7 +64,7 @@ export interface CaptureFilter {
64
64
  /**
65
65
  * The date and time the capture filter was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
66
66
  * <p>
67
- Example: `2021-08-25T21:10:29.600Z`
67
+ Example: {@code 2021-08-25T21:10:29.600Z}
68
68
  *
69
69
  */
70
70
  "timeCreated"?: Date;
@@ -13,12 +13,12 @@ documentation for the [Network Path Analyzer](/iaas/Content/Network/Concepts/pat
13
13
  * 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.
14
14
  */
15
15
  /**
16
- * Details of the new `compartmentId` for the `PathAnalyzerTest` resource.
16
+ * Details of the new {@code compartmentId} for the {@code PathAnalyzerTest} resource.
17
17
  */
18
18
  export interface ChangePathAnalyzerTestCompartmentDetails {
19
19
  /**
20
20
  * The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
21
- * into which the `PathAnalyzerTest` resource should be moved.
21
+ * into which the {@code PathAnalyzerTest} resource should be moved.
22
22
  *
23
23
  */
24
24
  "compartmentId": string;
@@ -14,12 +14,12 @@ documentation for the [Network Path Analyzer](/iaas/Content/Network/Concepts/pat
14
14
  */
15
15
  import * as model from "../model";
16
16
  /**
17
- * Defines the details required for a COMPUTE_INSTANCE-type `Endpoint`.
17
+ * Defines the details required for a COMPUTE_INSTANCE-type {@code Endpoint}.
18
18
  *
19
19
  */
20
20
  export interface ComputeInstanceEndpoint extends model.Endpoint {
21
21
  /**
22
- * The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object.
22
+ * The IPv4 address of the COMPUTE_INSTANCE-type {@code Endpoint} object.
23
23
  *
24
24
  */
25
25
  "address": string;
@@ -23,7 +23,7 @@ export interface ConnectRemotePeeringConnectionsDetails {
23
23
  /**
24
24
  * The name of the region that contains the RPC you want to peer with.
25
25
  * <p>
26
- Example: `us-ashburn-1`
26
+ Example: {@code us-ashburn-1}
27
27
  *
28
28
  */
29
29
  "peerRegionName": string;
@@ -16,12 +16,12 @@ documentation for the [Network Path Analyzer](/iaas/Content/Network/Concepts/pat
16
16
  * An individual answer to a CPE device question.
17
17
  * <p>
18
18
  The answers correlate to the questions that are specific to the CPE device type (see the
19
- * `parameters` attribute of {@link CpeDeviceShapeDetail}).
19
+ * {@code parameters} attribute of {@link CpeDeviceShapeDetail}).
20
20
  *
21
21
  */
22
22
  export interface CpeDeviceConfigAnswer {
23
23
  /**
24
- * A string that identifies the question to be answered. See the `key` attribute in
24
+ * A string that identifies the question to be answered. See the {@code key} attribute in
25
25
  * {@link #cpeDeviceConfigQuestion(CpeDeviceConfigQuestionRequest) cpeDeviceConfigQuestion}.
26
26
  *
27
27
  */
@@ -14,7 +14,7 @@ documentation for the [Network Path Analyzer](/iaas/Content/Network/Concepts/pat
14
14
  */
15
15
  /**
16
16
  * An object you create when setting up a Site-to-Site VPN between your on-premises network
17
- * and VCN. The `Cpe` is a virtual representation of your customer-premises equipment,
17
+ * and VCN. The {@code Cpe} is a virtual representation of your customer-premises equipment,
18
18
  * which is the actual router on-premises at your site at your end of the Site-to-Site VPN IPSec connection.
19
19
  * For more information,
20
20
  * see [Overview of the Networking Service](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/overview.htm).
@@ -31,7 +31,7 @@ export interface Cpe {
31
31
  "compartmentId": string;
32
32
  /**
33
33
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
34
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
34
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
35
35
  *
36
36
  */
37
37
  "definedTags"?: {
@@ -47,7 +47,7 @@ export interface Cpe {
47
47
  "displayName"?: string;
48
48
  /**
49
49
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
50
- * Example: `{\"bar-key\": \"value\"}`
50
+ * Example: {@code {\"bar-key\": \"value\"}}
51
51
  *
52
52
  */
53
53
  "freeformTags"?: {
@@ -82,12 +82,12 @@ export interface Cpe {
82
82
  /**
83
83
  * The date and time the CPE was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
84
84
  * <p>
85
- Example: `2016-08-25T21:10:29.600Z`
85
+ Example: {@code 2016-08-25T21:10:29.600Z}
86
86
  *
87
87
  */
88
88
  "timeCreated"?: Date;
89
89
  /**
90
- * Indicates whether this CPE is of type `private` or not.
90
+ * Indicates whether this CPE is of type {@code private} or not.
91
91
  *
92
92
  */
93
93
  "isPrivate"?: boolean;
@@ -13,12 +13,12 @@ documentation for the [Network Path Analyzer](/iaas/Content/Network/Concepts/pat
13
13
  * 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.
14
14
  */
15
15
  /**
16
- * The information used to create a `ByoipRange` resource.
16
+ * The information used to create a {@code ByoipRange} resource.
17
17
  */
18
18
  export interface CreateByoipRangeDetails {
19
19
  /**
20
20
  * The BYOIP CIDR block. You can assign some or all of it to a public IP pool after it is validated.
21
- * Example: `10.0.1.0/24`
21
+ * Example: {@code 10.0.1.0/24}
22
22
  *
23
23
  */
24
24
  "cidrBlock"?: string;
@@ -34,7 +34,7 @@ export interface CreateByoipRangeDetails {
34
34
  "ipv6CidrBlock"?: string;
35
35
  /**
36
36
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
37
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
37
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
38
38
  *
39
39
  */
40
40
  "definedTags"?: {
@@ -50,7 +50,7 @@ export interface CreateByoipRangeDetails {
50
50
  "displayName"?: string;
51
51
  /**
52
52
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
53
- * Example: `{\"bar-key\": \"value\"}`
53
+ * Example: {@code {\"bar-key\": \"value\"}}
54
54
  *
55
55
  */
56
56
  "freeformTags"?: {
@@ -25,7 +25,7 @@ export interface CreateCaptureFilterDetails {
25
25
  "compartmentId": string;
26
26
  /**
27
27
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
28
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
28
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
29
29
  *
30
30
  */
31
31
  "definedTags"?: {
@@ -41,7 +41,7 @@ export interface CreateCaptureFilterDetails {
41
41
  "displayName"?: string;
42
42
  /**
43
43
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
44
- * Example: `{\"bar-key\": \"value\"}`
44
+ * Example: {@code {\"bar-key\": \"value\"}}
45
45
  *
46
46
  */
47
47
  "freeformTags"?: {
@@ -19,7 +19,7 @@ export interface CreateCpeDetails {
19
19
  "compartmentId": string;
20
20
  /**
21
21
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
22
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
22
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
23
23
  *
24
24
  */
25
25
  "definedTags"?: {
@@ -35,7 +35,7 @@ export interface CreateCpeDetails {
35
35
  "displayName"?: string;
36
36
  /**
37
37
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
38
- * Example: `{\"bar-key\": \"value\"}`
38
+ * Example: {@code {\"bar-key\": \"value\"}}
39
39
  *
40
40
  */
41
41
  "freeformTags"?: {
@@ -44,7 +44,7 @@ export interface CreateCpeDetails {
44
44
  /**
45
45
  * The public IP address of the on-premises router.
46
46
  * <p>
47
- Example: `203.0.113.2`
47
+ Example: {@code 203.0.113.2}
48
48
  *
49
49
  */
50
50
  "ipAddress": string;
@@ -65,7 +65,7 @@ export interface CreateCpeDetails {
65
65
  */
66
66
  "cpeDeviceShapeId"?: string;
67
67
  /**
68
- * Indicates whether this CPE is of type `private` or not.
68
+ * Indicates whether this CPE is of type {@code private} or not.
69
69
  *
70
70
  */
71
71
  "isPrivate"?: boolean;
@@ -25,7 +25,7 @@ export interface CreateCrossConnectDetails {
25
25
  "crossConnectGroupId"?: string;
26
26
  /**
27
27
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
28
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
28
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
29
29
  *
30
30
  */
31
31
  "definedTags"?: {
@@ -49,7 +49,7 @@ export interface CreateCrossConnectDetails {
49
49
  "farCrossConnectOrCrossConnectGroupId"?: string;
50
50
  /**
51
51
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
52
- * Example: `{\"bar-key\": \"value\"}`
52
+ * Example: {@code {\"bar-key\": \"value\"}}
53
53
  *
54
54
  */
55
55
  "freeformTags"?: {
@@ -60,7 +60,7 @@ export interface CreateCrossConnectDetails {
60
60
  * To get a list of the available locations, see
61
61
  * {@link #listCrossConnectLocations(ListCrossConnectLocationsRequest) listCrossConnectLocations}.
62
62
  * <p>
63
- Example: `CyrusOne, Chandler, AZ`
63
+ Example: {@code CyrusOne, Chandler, AZ}
64
64
  *
65
65
  */
66
66
  "locationName": string;
@@ -75,7 +75,7 @@ export interface CreateCrossConnectDetails {
75
75
  * The port speed for this cross-connect. To get a list of the available port speeds, see
76
76
  * {@link #listCrossconnectPortSpeedShapes(ListCrossconnectPortSpeedShapesRequest) listCrossconnectPortSpeedShapes}.
77
77
  * <p>
78
- Example: `10 Gbps`
78
+ Example: {@code 10 Gbps}
79
79
  *
80
80
  */
81
81
  "portSpeedShapeName": string;
@@ -20,7 +20,7 @@ export interface CreateCrossConnectGroupDetails {
20
20
  "compartmentId": string;
21
21
  /**
22
22
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
23
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
23
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
24
24
  *
25
25
  */
26
26
  "definedTags"?: {
@@ -42,7 +42,7 @@ export interface CreateCrossConnectGroupDetails {
42
42
  "customerReferenceName"?: string;
43
43
  /**
44
44
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
45
- * Example: `{\"bar-key\": \"value\"}`
45
+ * Example: {@code {\"bar-key\": \"value\"}}
46
46
  *
47
47
  */
48
48
  "freeformTags"?: {
@@ -20,7 +20,7 @@ export interface CreateDhcpDetails {
20
20
  "compartmentId": string;
21
21
  /**
22
22
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
23
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
23
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
24
24
  *
25
25
  */
26
26
  "definedTags"?: {
@@ -36,7 +36,7 @@ export interface CreateDhcpDetails {
36
36
  "displayName"?: string;
37
37
  /**
38
38
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
39
- * Example: `{\"bar-key\": \"value\"}`
39
+ * Example: {@code {\"bar-key\": \"value\"}}
40
40
  *
41
41
  */
42
42
  "freeformTags"?: {
@@ -34,7 +34,7 @@ export interface CreateDrgAttachmentDetails {
34
34
  "networkDetails"?: model.VcnDrgAttachmentNetworkCreateDetails;
35
35
  /**
36
36
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
37
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
37
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
38
38
  *
39
39
  */
40
40
  "definedTags"?: {
@@ -44,7 +44,7 @@ export interface CreateDrgAttachmentDetails {
44
44
  };
45
45
  /**
46
46
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
47
- * Example: `{\"bar-key\": \"value\"}`
47
+ * Example: {@code {\"bar-key\": \"value\"}}
48
48
  *
49
49
  */
50
50
  "freeformTags"?: {
@@ -66,7 +66,7 @@ export interface CreateDrgAttachmentDetails {
66
66
  "routeTableId"?: string;
67
67
  /**
68
68
  * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.
69
- * This field is deprecated. Instead, use the `networkDetails` field to specify the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached resource.
69
+ * This field is deprecated. Instead, use the {@code networkDetails} field to specify the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached resource.
70
70
  *
71
71
  */
72
72
  "vcnId"?: string;
@@ -19,7 +19,7 @@ export interface CreateDrgDetails {
19
19
  "compartmentId": string;
20
20
  /**
21
21
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
22
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
22
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
23
23
  *
24
24
  */
25
25
  "definedTags"?: {
@@ -35,7 +35,7 @@ export interface CreateDrgDetails {
35
35
  "displayName"?: string;
36
36
  /**
37
37
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
38
- * Example: `{\"bar-key\": \"value\"}`
38
+ * Example: {@code {\"bar-key\": \"value\"}}
39
39
  *
40
40
  */
41
41
  "freeformTags"?: {
@@ -19,7 +19,7 @@ documentation for the [Network Path Analyzer](/iaas/Content/Network/Concepts/pat
19
19
  export interface CreateDrgRouteDistributionDetails {
20
20
  /**
21
21
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
22
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
22
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
23
23
  *
24
24
  */
25
25
  "definedTags"?: {
@@ -35,7 +35,7 @@ export interface CreateDrgRouteDistributionDetails {
35
35
  "displayName"?: string;
36
36
  /**
37
37
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
38
- * Example: `{\"bar-key\": \"value\"}`
38
+ * Example: {@code {\"bar-key\": \"value\"}}
39
39
  *
40
40
  */
41
41
  "freeformTags"?: {
@@ -19,7 +19,7 @@ documentation for the [Network Path Analyzer](/iaas/Content/Network/Concepts/pat
19
19
  export interface CreateDrgRouteTableDetails {
20
20
  /**
21
21
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
22
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
22
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
23
23
  *
24
24
  */
25
25
  "definedTags"?: {
@@ -35,7 +35,7 @@ export interface CreateDrgRouteTableDetails {
35
35
  "displayName"?: string;
36
36
  /**
37
37
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
38
- * Example: `{\"bar-key\": \"value\"}`
38
+ * Example: {@code {\"bar-key\": \"value\"}}
39
39
  *
40
40
  */
41
41
  "freeformTags"?: {
@@ -19,7 +19,7 @@ export interface CreateInternetGatewayDetails {
19
19
  "compartmentId": string;
20
20
  /**
21
21
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
22
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
22
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
23
23
  *
24
24
  */
25
25
  "definedTags"?: {
@@ -35,7 +35,7 @@ export interface CreateInternetGatewayDetails {
35
35
  "displayName"?: string;
36
36
  /**
37
37
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
38
- * Example: `{\"bar-key\": \"value\"}`
38
+ * Example: {@code {\"bar-key\": \"value\"}}
39
39
  *
40
40
  */
41
41
  "freeformTags"?: {
@@ -24,7 +24,7 @@ export interface CreateIPSecConnectionDetails {
24
24
  "cpeId": string;
25
25
  /**
26
26
  * Defined tags for this resource. Each key is predefined and scoped to a namespace.
27
- * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
27
+ * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
28
28
  *
29
29
  */
30
30
  "definedTags"?: {
@@ -44,7 +44,7 @@ export interface CreateIPSecConnectionDetails {
44
44
  "drgId": string;
45
45
  /**
46
46
  * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
47
- * Example: `{\"bar-key\": \"value\"}`
47
+ * Example: {@code {\"bar-key\": \"value\"}}
48
48
  *
49
49
  */
50
50
  "freeformTags"?: {
@@ -53,23 +53,23 @@ export interface CreateIPSecConnectionDetails {
53
53
  /**
54
54
  * Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the
55
55
  * fully qualified domain name (FQDN)). The type of identifier you provide here must correspond
56
- * to the value for `cpeLocalIdentifierType`.
56
+ * to the value for {@code cpeLocalIdentifierType}.
57
57
  * <p>
58
- If you don't provide a value, the `ipAddress` attribute for the {@link Cpe}
59
- * object specified by `cpeId` is used as the `cpeLocalIdentifier`.
58
+ If you don't provide a value, the {@code ipAddress} attribute for the {@link Cpe}
59
+ * object specified by {@code cpeId} is used as the {@code cpeLocalIdentifier}.
60
60
  * <p>
61
61
  For information about why you'd provide this value, see
62
62
  * [If Your CPE Is Behind a NAT Device](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/overviewIPsec.htm#nat).
63
63
  * <p>
64
- Example IP address: `10.0.3.3`
64
+ Example IP address: {@code 10.0.3.3}
65
65
  * <p>
66
- Example hostname: `cpe.example.com`
66
+ Example hostname: {@code cpe.example.com}
67
67
  *
68
68
  */
69
69
  "cpeLocalIdentifier"?: string;
70
70
  /**
71
71
  * The type of identifier for your CPE device. The value you provide here must correspond to the value
72
- * for `cpeLocalIdentifier`.
72
+ * for {@code cpeLocalIdentifier}.
73
73
  *
74
74
  */
75
75
  "cpeLocalIdentifierType"?: CreateIPSecConnectionDetails.CpeLocalIdentifierType;
@@ -86,22 +86,22 @@ export interface CreateIPSecConnectionDetails {
86
86
  The CIDR can be either IPv4 or IPv6. IPv6 addressing is supported for all commercial and government regions.
87
87
  * See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
88
88
  * <p>
89
- Example: `10.0.1.0/24`
89
+ Example: {@code 10.0.1.0/24}
90
90
  * <p>
91
- Example: `2001:db8::/32`
91
+ Example: {@code 2001:db8::/32}
92
92
  *
93
93
  */
94
94
  "staticRoutes": Array<string>;
95
95
  /**
96
96
  * Information for creating the individual tunnels in the IPSec connection. You can provide a
97
- * maximum of 2 `tunnelConfiguration` objects in the array (one for each of the
97
+ * maximum of 2 {@code tunnelConfiguration} objects in the array (one for each of the
98
98
  * two tunnels).
99
99
  *
100
100
  */
101
101
  "tunnelConfiguration"?: Array<model.CreateIPSecConnectionTunnelDetails>;
102
102
  /**
103
103
  * The count of tunnels in the IPsec connection. This value should be equal to the number of
104
- * `tunnelConfiguration` objects specified in the `CreateIPSecConnection` request.
104
+ * {@code tunnelConfiguration} objects specified in the {@code CreateIPSecConnection} request.
105
105
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
106
106
  */
107
107
  "tunnelCount"?: number;
@@ -45,13 +45,13 @@ export interface CreateIPSecConnectionTunnelDetails {
45
45
  */
46
46
  "oracleInitiation"?: CreateIPSecConnectionTunnelDetails.OracleInitiation;
47
47
  /**
48
- * By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500,
48
+ * By default (the {@code AUTO} setting), IKE sends packets with a source and destination port set to 500,
49
49
  * and when it detects that the port used to forward packets has changed (most likely because a NAT device
50
50
  * is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T.
51
51
  * <p>
52
- The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets.
52
+ The {@code ENABLED} option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets.
53
53
  * <p>
54
- The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T
54
+ The {@code DISABLED} option directs IKE to completely refuse to negotiate NAT-T
55
55
  * even if it senses there may be a NAT device in use.
56
56
  *
57
57
  */