oci-networkfirewall 2.131.2 → 2.134.1

package/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * Network Firewall API
- * Use the Network Firewall API to create network firewalls and configure policies that regulates network traffic in and across VCNs.
+ * Use the Network Firewall API to create network firewalls and configure policies that regulates network traffic in and across VCNs. For more information, see [Overview of Network Firewall](https://docs.oracle.com/iaas/Content/network-firewall/overview.htm).
  * OpenAPI spec version: 20230501
  *
  *

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * Network Firewall API
- * Use the Network Firewall API to create network firewalls and configure policies that regulates network traffic in and across VCNs.
+ * Use the Network Firewall API to create network firewalls and configure policies that regulates network traffic in and across VCNs. For more information, see [Overview of Network Firewall](https://docs.oracle.com/iaas/Content/network-firewall/overview.htm).
  * OpenAPI spec version: 20230501
  *
  *

package/lib/client.d.ts

@@ -1,6 +1,6 @@
 /**
  * Network Firewall API
- * Use the Network Firewall API to create network firewalls and configure policies that regulates network traffic in and across VCNs.
+ * Use the Network Firewall API to create network firewalls and configure policies that regulates network traffic in and across VCNs. For more information, see [Overview of Network Firewall](https://docs.oracle.com/iaas/Content/network-firewall/overview.htm).
  * OpenAPI spec version: 20230501
  *
  *
@@ -597,6 +597,16 @@ export declare class NetworkFirewallClient {
      * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/networkfirewall/GetNetworkFirewall.ts.html |here} to see how to use GetNetworkFirewall API.
      */
     getNetworkFirewall(getNetworkFirewallRequest: requests.GetNetworkFirewallRequest): Promise<responses.GetNetworkFirewallResponse>;
+    /**
+     * Get Overall health status of Network Firewall
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetNetworkFirewallHealthStatusRequest
+     * @return GetNetworkFirewallHealthStatusResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/networkfirewall/GetNetworkFirewallHealthStatus.ts.html |here} to see how to use GetNetworkFirewallHealthStatus API.
+     */
+    getNetworkFirewallHealthStatus(getNetworkFirewallHealthStatusRequest: requests.GetNetworkFirewallHealthStatusRequest): Promise<responses.GetNetworkFirewallHealthStatusResponse>;
     /**
      * Gets a NetworkFirewallPolicy given the network firewall policy identifier.
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

package/lib/client.js

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * Network Firewall API
- * Use the Network Firewall API to create network firewalls and configure policies that regulates network traffic in and across VCNs.
+ * Use the Network Firewall API to create network firewalls and configure policies that regulates network traffic in and across VCNs. For more information, see [Overview of Network Firewall](https://docs.oracle.com/iaas/Content/network-firewall/overview.htm).
  * OpenAPI spec version: 20230501
  *
  *
@@ -3521,6 +3521,70 @@ class NetworkFirewallClient {
             }
         });
     }
+    /**
+     * Get Overall health status of Network Firewall
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetNetworkFirewallHealthStatusRequest
+     * @return GetNetworkFirewallHealthStatusResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/networkfirewall/GetNetworkFirewallHealthStatus.ts.html |here} to see how to use GetNetworkFirewallHealthStatus API.
+     */
+    getNetworkFirewallHealthStatus(getNetworkFirewallHealthStatusRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation NetworkFirewallClient#getNetworkFirewallHealthStatus.");
+            const operationName = "getNetworkFirewallHealthStatus";
+            const apiReferenceLink = "";
+            const pathParams = {
+                "{networkFirewallId}": getNetworkFirewallHealthStatusRequest.networkFirewallId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": getNetworkFirewallHealthStatusRequest.opcRequestId
+            };
+            const specRetryConfiguration = common.OciSdkDefaultRetryConfiguration;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, getNetworkFirewallHealthStatusRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/networkFirewalls/{networkFirewallId}/healthStatus",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request, this.targetService, operationName, apiReferenceLink);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "networkFirewallHealthStatus",
+                    bodyModel: model.NetworkFirewallHealthStatus,
+                    type: "model.NetworkFirewallHealthStatus",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
     /**
      * Gets a NetworkFirewallPolicy given the network firewall policy identifier.
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.