oci-networkfirewall 2.32.0

package/lib/client.d.ts

@@ -0,0 +1,232 @@
+/**
+ * Network Firewall API
+ * Use the Network Firewall API to create network firewalls and configure policies that regulates network traffic in and across VCNs.
+ * OpenAPI spec version: 20211001
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates.  All rights reserved.
+ * 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.
+ */
+import common = require("oci-common");
+import * as requests from "./request";
+import * as responses from "./response";
+import { NetworkFirewallWaiter } from "./networkfirewall-waiter";
+export declare enum NetworkFirewallApiKeys {
+}
+/**
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+ */
+export declare class NetworkFirewallClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": NetworkFirewallWaiter;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: null;
+    protected _httpOptions: any;
+    targetService: string;
+    protected _httpClient: common.HttpClient;
+    constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint(): string;
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint: string);
+    get logger(): import("oci-common/lib/log").Logger;
+    /**
+     * Sets the region to call (ex, Region.US_PHOENIX_1).
+     * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+     * @param region The region of the service.
+     */
+    set region(region: common.Region);
+    /**
+     * Sets the regionId to call (ex, 'us-phoenix-1').
+     *
+     * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
+     * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
+     * and then call {@link #endpoint(String) endpoint}.
+     * @param regionId The public region ID.
+     */
+    set regionId(regionId: string);
+    /**
+     * Creates a new NetworkFirewallWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): NetworkFirewallWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): NetworkFirewallWaiter;
+    /**
+     * Cancel work request with the given ID.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CancelWorkRequestRequest
+     * @return CancelWorkRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
+     */
+    cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
+    /**
+     * Moves a NetworkFirewall resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ChangeNetworkFirewallCompartmentRequest
+     * @return ChangeNetworkFirewallCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/ChangeNetworkFirewallCompartment.ts.html |here} to see how to use ChangeNetworkFirewallCompartment API.
+     */
+    changeNetworkFirewallCompartment(changeNetworkFirewallCompartmentRequest: requests.ChangeNetworkFirewallCompartmentRequest): Promise<responses.ChangeNetworkFirewallCompartmentResponse>;
+    /**
+     * Moves a NetworkFirewallPolicy resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ChangeNetworkFirewallPolicyCompartmentRequest
+     * @return ChangeNetworkFirewallPolicyCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/ChangeNetworkFirewallPolicyCompartment.ts.html |here} to see how to use ChangeNetworkFirewallPolicyCompartment API.
+     */
+    changeNetworkFirewallPolicyCompartment(changeNetworkFirewallPolicyCompartmentRequest: requests.ChangeNetworkFirewallPolicyCompartmentRequest): Promise<responses.ChangeNetworkFirewallPolicyCompartmentResponse>;
+    /**
+     * Creates a new NetworkFirewall.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateNetworkFirewallRequest
+     * @return CreateNetworkFirewallResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/CreateNetworkFirewall.ts.html |here} to see how to use CreateNetworkFirewall API.
+     */
+    createNetworkFirewall(createNetworkFirewallRequest: requests.CreateNetworkFirewallRequest): Promise<responses.CreateNetworkFirewallResponse>;
+    /**
+     * Creates a new Network Firewall Policy.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateNetworkFirewallPolicyRequest
+     * @return CreateNetworkFirewallPolicyResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/CreateNetworkFirewallPolicy.ts.html |here} to see how to use CreateNetworkFirewallPolicy API.
+     */
+    createNetworkFirewallPolicy(createNetworkFirewallPolicyRequest: requests.CreateNetworkFirewallPolicyRequest): Promise<responses.CreateNetworkFirewallPolicyResponse>;
+    /**
+     * Deletes a NetworkFirewall resource by identifier
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteNetworkFirewallRequest
+     * @return DeleteNetworkFirewallResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/DeleteNetworkFirewall.ts.html |here} to see how to use DeleteNetworkFirewall API.
+     */
+    deleteNetworkFirewall(deleteNetworkFirewallRequest: requests.DeleteNetworkFirewallRequest): Promise<responses.DeleteNetworkFirewallResponse>;
+    /**
+     * Deletes a NetworkFirewallPolicy resource with the given identifier.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteNetworkFirewallPolicyRequest
+     * @return DeleteNetworkFirewallPolicyResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/DeleteNetworkFirewallPolicy.ts.html |here} to see how to use DeleteNetworkFirewallPolicy API.
+     */
+    deleteNetworkFirewallPolicy(deleteNetworkFirewallPolicyRequest: requests.DeleteNetworkFirewallPolicyRequest): Promise<responses.DeleteNetworkFirewallPolicyResponse>;
+    /**
+     * Gets a NetworkFirewall by identifier
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetNetworkFirewallRequest
+     * @return GetNetworkFirewallResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/GetNetworkFirewall.ts.html |here} to see how to use GetNetworkFirewall API.
+     */
+    getNetworkFirewall(getNetworkFirewallRequest: requests.GetNetworkFirewallRequest): Promise<responses.GetNetworkFirewallResponse>;
+    /**
+     * 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.
+     * @param GetNetworkFirewallPolicyRequest
+     * @return GetNetworkFirewallPolicyResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/GetNetworkFirewallPolicy.ts.html |here} to see how to use GetNetworkFirewallPolicy API.
+     */
+    getNetworkFirewallPolicy(getNetworkFirewallPolicyRequest: requests.GetNetworkFirewallPolicyRequest): Promise<responses.GetNetworkFirewallPolicyResponse>;
+    /**
+     * Gets the status of the work request with the given ID.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetWorkRequestRequest
+     * @return GetWorkRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     */
+    getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
+    /**
+     * Returns a list of Network Firewall Policies.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListNetworkFirewallPoliciesRequest
+     * @return ListNetworkFirewallPoliciesResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/ListNetworkFirewallPolicies.ts.html |here} to see how to use ListNetworkFirewallPolicies API.
+     */
+    listNetworkFirewallPolicies(listNetworkFirewallPoliciesRequest: requests.ListNetworkFirewallPoliciesRequest): Promise<responses.ListNetworkFirewallPoliciesResponse>;
+    /**
+     * Returns a list of NetworkFirewalls.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListNetworkFirewallsRequest
+     * @return ListNetworkFirewallsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/ListNetworkFirewalls.ts.html |here} to see how to use ListNetworkFirewalls API.
+     */
+    listNetworkFirewalls(listNetworkFirewallsRequest: requests.ListNetworkFirewallsRequest): Promise<responses.ListNetworkFirewallsResponse>;
+    /**
+     * Return a (paginated) list of errors for a given work request.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkRequestErrorsRequest
+     * @return ListWorkRequestErrorsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
+     */
+    listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
+    /**
+     * Return a (paginated) list of logs for a given work request.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkRequestLogsRequest
+     * @return ListWorkRequestLogsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
+     */
+    listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
+    /**
+     * Lists the work requests in a compartment.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkRequestsRequest
+     * @return ListWorkRequestsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     */
+    listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
+    /**
+     * Updates the NetworkFirewall
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateNetworkFirewallRequest
+     * @return UpdateNetworkFirewallResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/UpdateNetworkFirewall.ts.html |here} to see how to use UpdateNetworkFirewall API.
+     */
+    updateNetworkFirewall(updateNetworkFirewallRequest: requests.UpdateNetworkFirewallRequest): Promise<responses.UpdateNetworkFirewallResponse>;
+    /**
+     * Updates the NetworkFirewallPolicy
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateNetworkFirewallPolicyRequest
+     * @return UpdateNetworkFirewallPolicyResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.32.0/networkfirewall/UpdateNetworkFirewallPolicy.ts.html |here} to see how to use UpdateNetworkFirewallPolicy API.
+     */
+    updateNetworkFirewallPolicy(updateNetworkFirewallPolicyRequest: requests.UpdateNetworkFirewallPolicyRequest): Promise<responses.UpdateNetworkFirewallPolicyResponse>;
+}