@nutanix-scratch/microseg-js-client 4.0.1-beta.1 → 4.0.1

package/dist/lib/models/microseg/v4/config/ApplicationRuleSpec.d.ts

@@ -1,10 +1,10 @@
 /**
  * The ApplicationRuleSpec model module.
  * @module Ntnx/ApplicationRuleSpec
- * @version 4.0.1-beta-1
+ * @version 4.0.1
  * @class ApplicationRuleSpec
  *
- * @param { Array } securedGroupCategoryReferences A set of network endpoints which is protected by a Network Security Policy and defined as a list of categories.
+ * @param { string[] } securedGroupCategoryReferences A set of network endpoints which is protected by a Network Security Policy and defined as a list of categories.
  */
 export default class ApplicationRuleSpec {
     /**
@@ -15,200 +15,240 @@ export default class ApplicationRuleSpec {
      * @param callFromChild {Boolean} Flag to recognise calling instance
      * @return {module:Ntnx/ApplicationRuleSpec} The populated <code>ApplicationRuleSpec</code> instance.
      */
-    static constructFromObject(data: any, obj: any, callFromChild?: boolean): any;
+    static constructFromObject(data: any, obj?: any, callFromChild?: boolean): any;
+    /**
+    * Converts a given snake_case string to camelCase.
+    * @param {string} snakeStr - The input string in snake_case format.
+    * @returns {string} - The converted string in camelCase format.
+    */
+    static snakeToCamel(snakeStr: string): string;
     /**
      * Constructs a new <code>ApplicationRuleSpec</code>.
      * A rule for specifying allowed traffic for an application.
      * @alias module:Ntnx/ApplicationRuleSpec
      *
-     * @param { Array } securedGroupCategoryReferences A set of network endpoints which is protected by a Network Security Policy and defined as a list of categories.
+     * @param { string[] } securedGroupCategoryReferences A set of network endpoints which is protected by a Network Security Policy and defined as a list of categories.
     */
-    constructor(securedGroupCategoryReferences: any[]);
-    securedGroupCategoryReferences: any[];
+    constructor(securedGroupCategoryReferences: string[]);
+    securedGroupCategoryReferences: string[];
     $objectType: string;
-    $reserved: {
-        $fv: string;
-    };
-    $unknownFields: {};
+    /** @type {object<string, any>} */
+    $reserved: object;
+    /** @type {object<string, any>} */
+    $unknownFields: object;
     /**
      * Returns A set of network endpoints which is protected by a Network Security Policy and defined as a list of categories.
-     * @return {}
+     * @return {string[]}
      */
-    getSecuredGroupCategoryReferences(): any;
+    getSecuredGroupCategoryReferences(): string[];
     /**
      * Sets A set of network endpoints which is protected by a Network Security Policy and defined as a list of categories.
-     * @param {} securedGroupCategoryReferences A set of network endpoints which is protected by a Network Security Policy and defined as a list of categories.
+     * @param {string[]} securedGroupCategoryReferences A set of network endpoints which is protected by a Network Security Policy and defined as a list of categories.
      */
-    setSecuredGroupCategoryReferences(securedGroupCategoryReferences: any): void;
+    setSecuredGroupCategoryReferences(securedGroupCategoryReferences: string[]): void;
     /**
-     * @return {}
+     * @return {AllowType}
      */
-    getSrcAllowSpec(): any;
+    getSrcAllowSpec(): AllowType;
     /**
-     * @param {} srcAllowSpec
+     * @param {AllowType} srcAllowSpec
      */
-    setSrcAllowSpec(srcAllowSpec: any): void;
-    srcAllowSpec: any;
+    setSrcAllowSpec(srcAllowSpec: AllowType): void;
+    srcAllowSpec: string;
     /**
-     * @return {}
+     * @return {AllowType}
      */
-    getDestAllowSpec(): any;
+    getDestAllowSpec(): AllowType;
     /**
-     * @param {} destAllowSpec
+     * @param {AllowType} destAllowSpec
      */
-    setDestAllowSpec(destAllowSpec: any): void;
-    destAllowSpec: any;
+    setDestAllowSpec(destAllowSpec: AllowType): void;
+    destAllowSpec: string;
     /**
      * Returns List of categories that define a set of network endpoints as inbound.
-     * @return {}
+     * @return {string[]}
      */
-    getSrcCategoryReferences(): any;
+    getSrcCategoryReferences(): string[];
     /**
      * Sets List of categories that define a set of network endpoints as inbound.
-     * @param {} srcCategoryReferences List of categories that define a set of network endpoints as inbound.
+     * @param {string[]} srcCategoryReferences List of categories that define a set of network endpoints as inbound.
      */
-    setSrcCategoryReferences(srcCategoryReferences: any): void;
-    srcCategoryReferences: any;
+    setSrcCategoryReferences(srcCategoryReferences: string[]): void;
+    srcCategoryReferences: string[];
     /**
      * Returns List of categories that define a set of network endpoints as outbound.
-     * @return {}
+     * @return {string[]}
      */
-    getDestCategoryReferences(): any;
+    getDestCategoryReferences(): string[];
     /**
      * Sets List of categories that define a set of network endpoints as outbound.
-     * @param {} destCategoryReferences List of categories that define a set of network endpoints as outbound.
+     * @param {string[]} destCategoryReferences List of categories that define a set of network endpoints as outbound.
      */
-    setDestCategoryReferences(destCategoryReferences: any): void;
-    destCategoryReferences: any;
+    setDestCategoryReferences(destCategoryReferences: string[]): void;
+    destCategoryReferences: string[];
     /**
-     * @return {}
+     * @return {IPv4Address}
      */
-    getSrcSubnet(): any;
+    getSrcSubnet(): IPv4Address;
     /**
-     * @param {} srcSubnet
+     * @param {IPv4Address} srcSubnet
      */
-    setSrcSubnet(srcSubnet: any): void;
-    srcSubnet: any;
+    setSrcSubnet(srcSubnet: IPv4Address): void;
+    srcSubnet: IPv4Address;
     /**
-     * @return {}
+     * @return {IPv4Address}
      */
-    getDestSubnet(): any;
+    getDestSubnet(): IPv4Address;
     /**
-     * @param {} destSubnet
+     * @param {IPv4Address} destSubnet
      */
-    setDestSubnet(destSubnet: any): void;
-    destSubnet: any;
+    setDestSubnet(destSubnet: IPv4Address): void;
+    destSubnet: IPv4Address;
     /**
      * Returns A list of address group references.
-     * @return {}
+     * @return {string[]}
      */
-    getSrcAddressGroupReferences(): any;
+    getSrcAddressGroupReferences(): string[];
     /**
      * Sets A list of address group references.
-     * @param {} srcAddressGroupReferences A list of address group references.
+     * @param {string[]} srcAddressGroupReferences A list of address group references.
      */
-    setSrcAddressGroupReferences(srcAddressGroupReferences: any): void;
-    srcAddressGroupReferences: any;
+    setSrcAddressGroupReferences(srcAddressGroupReferences: string[]): void;
+    srcAddressGroupReferences: string[];
     /**
      * Returns A list of address group references.
-     * @return {}
+     * @return {string[]}
      */
-    getDestAddressGroupReferences(): any;
+    getDestAddressGroupReferences(): string[];
     /**
      * Sets A list of address group references.
-     * @param {} destAddressGroupReferences A list of address group references.
+     * @param {string[]} destAddressGroupReferences A list of address group references.
      */
-    setDestAddressGroupReferences(destAddressGroupReferences: any): void;
-    destAddressGroupReferences: any;
+    setDestAddressGroupReferences(destAddressGroupReferences: string[]): void;
+    destAddressGroupReferences: string[];
     /**
-     * @return {}
+     * Returns A list of service group references.
+     * @return {string[]}
      */
-    getServiceGroupReferences(): any;
+    getServiceGroupReferences(): string[];
     /**
-     * @param {} serviceGroupReferences
+     * Sets A list of service group references.
+     * @param {string[]} serviceGroupReferences A list of service group references.
      */
-    setServiceGroupReferences(serviceGroupReferences: any): void;
-    serviceGroupReferences: any;
+    setServiceGroupReferences(serviceGroupReferences: string[]): void;
+    serviceGroupReferences: string[];
     /**
-     * Returns Denotes if rule allows traffic for all protocol.
-     * @return {}
+     * Returns Denotes whether the rule allows traffic for all protocols. If set to true, the rule allows traffic for all protocols. If set to false or not specified, specifying at least one protocol service or service group is mandatory.
+     * @return {boolean}
      */
-    getIsAllProtocolAllowed(): any;
+    getIsAllProtocolAllowed(): boolean;
     /**
-     * Sets Denotes if rule allows traffic for all protocol.
-     * @param {} isAllProtocolAllowed Denotes if rule allows traffic for all protocol.
+     * Sets Denotes whether the rule allows traffic for all protocols. If set to true, the rule allows traffic for all protocols. If set to false or not specified, specifying at least one protocol service or service group is mandatory.
+     * @param {boolean} isAllProtocolAllowed Denotes whether the rule allows traffic for all protocols. If set to true, the rule allows traffic for all protocols. If set to false or not specified, specifying at least one protocol service or service group is mandatory.
      */
-    setIsAllProtocolAllowed(isAllProtocolAllowed: any): void;
-    isAllProtocolAllowed: any;
+    setIsAllProtocolAllowed(isAllProtocolAllowed: boolean): void;
+    isAllProtocolAllowed: boolean;
     /**
-     * @return {}
+     * @return {TcpPortRangeSpec[]}
      */
-    getTcpServices(): any;
+    getTcpServices(): TcpPortRangeSpec[];
     /**
-     * @param {} tcpServices
+     * @param {TcpPortRangeSpec[]} tcpServices
      */
-    setTcpServices(tcpServices: any): void;
-    tcpServices: any;
+    setTcpServices(tcpServices: TcpPortRangeSpec[]): void;
+    tcpServices: TcpPortRangeSpec[];
     /**
-     * @return {}
+     * @return {UdpPortRangeSpec[]}
      */
-    getUdpServices(): any;
+    getUdpServices(): UdpPortRangeSpec[];
     /**
-     * @param {} udpServices
+     * @param {UdpPortRangeSpec[]} udpServices
      */
-    setUdpServices(udpServices: any): void;
-    udpServices: any;
+    setUdpServices(udpServices: UdpPortRangeSpec[]): void;
+    udpServices: UdpPortRangeSpec[];
     /**
-     * Returns Icmp Type Code List.
-     * @return {}
+     * Returns ICMP Type Code List.
+     * @return {IcmpTypeCodeSpec[]}
      */
-    getIcmpServices(): any;
+    getIcmpServices(): IcmpTypeCodeSpec[];
     /**
-     * Sets Icmp Type Code List.
-     * @param {} icmpServices Icmp Type Code List.
+     * Sets ICMP Type Code List.
+     * @param {IcmpTypeCodeSpec[]} icmpServices ICMP Type Code List.
      */
-    setIcmpServices(icmpServices: any): void;
-    icmpServices: any;
+    setIcmpServices(icmpServices: IcmpTypeCodeSpec[]): void;
+    icmpServices: IcmpTypeCodeSpec[];
     /**
      * Returns A reference to the network function chain in the rule.
-     * @return {}
+     * @return {string}
      */
-    getNetworkFunctionChainReference(): any;
+    getNetworkFunctionChainReference(): string;
     /**
      * Sets A reference to the network function chain in the rule.
-     * @param {} networkFunctionChainReference A reference to the network function chain in the rule.
+     * @param {string} networkFunctionChainReference A reference to the network function chain in the rule.
      */
-    setNetworkFunctionChainReference(networkFunctionChainReference: any): void;
-    networkFunctionChainReference: any;
-    get$Reserved(): {
-        $fv: string;
-    };
+    setNetworkFunctionChainReference(networkFunctionChainReference: string): void;
+    networkFunctionChainReference: string;
+    get$Reserved(): any;
     get$ObjectType(): string;
-    get$UnknownFields(): {};
+    get$UnknownFields(): any;
     toJson(forMutation: any): {
-        $reserved: {
-            $fv: string;
-        };
+        $reserved: any;
         $objectType: string;
-        $unknownFields: {};
-        networkFunctionChainReference?: any;
-        icmpServices?: any;
-        udpServices?: any;
-        tcpServices?: any;
-        isAllProtocolAllowed?: any;
-        serviceGroupReferences?: any;
-        destAddressGroupReferences?: any;
-        srcAddressGroupReferences?: any;
-        destSubnet?: any;
-        srcSubnet?: any;
-        destCategoryReferences?: any;
-        srcCategoryReferences?: any;
-        destAllowSpec?: any;
-        srcAllowSpec?: any;
-        securedGroupCategoryReferences?: any;
+        $unknownFields: any;
+        networkFunctionChainReference?: string;
+        icmpServices?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            code?: number;
+            type?: number;
+            isAllAllowed?: boolean;
+        }[];
+        udpServices?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            endPort?: number;
+            startPort?: number;
+        }[];
+        tcpServices?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            endPort?: number;
+            startPort?: number;
+        }[];
+        isAllProtocolAllowed?: boolean;
+        serviceGroupReferences?: string[];
+        destAddressGroupReferences?: string[];
+        srcAddressGroupReferences?: string[];
+        destSubnet?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            prefixLength?: number;
+            value?: string;
+        };
+        srcSubnet?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            prefixLength?: number;
+            value?: string;
+        };
+        destCategoryReferences?: string[];
+        srcCategoryReferences?: string[];
+        destAllowSpec?: string;
+        srcAllowSpec?: string;
+        securedGroupCategoryReferences?: string[];
     };
     validate(scope: any, properties: any, ...args: any[]): Promise<any>;
     validateProperty(scope: any, property: any): ValidationError;
     #private;
 }
+import AllowType from "./AllowType";
+import IPv4Address from "../../../common/v1/config/IPv4Address";
+import TcpPortRangeSpec from "./TcpPortRangeSpec";
+import UdpPortRangeSpec from "./UdpPortRangeSpec";
+import IcmpTypeCodeSpec from "./IcmpTypeCodeSpec";
 import ValidationError from "../../../validation/ValidationError";