oci 2.152.0__py3-none-any.whl → 2.153.0__py3-none-any.whl

oci/network_firewall/models/nat_rule.py

@@ -0,0 +1,254 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, 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.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20230501
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class NatRule(object):
+    """
+    A Nat Rule is used to define to which traffic NAT should be applied by the firewall.
+    """
+
+    #: A constant which can be used with the type property of a NatRule.
+    #: This constant has a value of "NATV4"
+    TYPE_NATV4 = "NATV4"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new NatRule object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.network_firewall.models.NatV4NatRule`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param name:
+            The value to assign to the name property of this NatRule.
+        :type name: str
+
+        :param type:
+            The value to assign to the type property of this NatRule.
+            Allowed values for this property are: "NATV4", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type type: str
+
+        :param description:
+            The value to assign to the description property of this NatRule.
+        :type description: str
+
+        :param priority_order:
+            The value to assign to the priority_order property of this NatRule.
+        :type priority_order: int
+
+        :param position:
+            The value to assign to the position property of this NatRule.
+        :type position: oci.network_firewall.models.RulePosition
+
+        :param parent_resource_id:
+            The value to assign to the parent_resource_id property of this NatRule.
+        :type parent_resource_id: str
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'type': 'str',
+            'description': 'str',
+            'priority_order': 'int',
+            'position': 'RulePosition',
+            'parent_resource_id': 'str'
+        }
+        self.attribute_map = {
+            'name': 'name',
+            'type': 'type',
+            'description': 'description',
+            'priority_order': 'priorityOrder',
+            'position': 'position',
+            'parent_resource_id': 'parentResourceId'
+        }
+        self._name = None
+        self._type = None
+        self._description = None
+        self._priority_order = None
+        self._position = None
+        self._parent_resource_id = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['type']
+
+        if type == 'NATV4':
+            return 'NatV4NatRule'
+        else:
+            return 'NatRule'
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this NatRule.
+        Name for the NAT rule, must be unique within the policy.
+
+
+        :return: The name of this NatRule.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this NatRule.
+        Name for the NAT rule, must be unique within the policy.
+
+
+        :param name: The name of this NatRule.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this NatRule.
+        NAT type:
+
+        * NATV4 - NATV4 type NAT.
+
+        Allowed values for this property are: "NATV4", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The type of this NatRule.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this NatRule.
+        NAT type:
+
+        * NATV4 - NATV4 type NAT.
+
+
+        :param type: The type of this NatRule.
+        :type: str
+        """
+        allowed_values = ["NATV4"]
+        if not value_allowed_none_or_none_sentinel(type, allowed_values):
+            type = 'UNKNOWN_ENUM_VALUE'
+        self._type = type
+
+    @property
+    def description(self):
+        """
+        Gets the description of this NatRule.
+        Description of a NAT rule. This field can be used to add additional info.
+
+
+        :return: The description of this NatRule.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this NatRule.
+        Description of a NAT rule. This field can be used to add additional info.
+
+
+        :param description: The description of this NatRule.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def priority_order(self):
+        """
+        Gets the priority_order of this NatRule.
+        The priority order in which this rule should be evaluated
+
+
+        :return: The priority_order of this NatRule.
+        :rtype: int
+        """
+        return self._priority_order
+
+    @priority_order.setter
+    def priority_order(self, priority_order):
+        """
+        Sets the priority_order of this NatRule.
+        The priority order in which this rule should be evaluated
+
+
+        :param priority_order: The priority_order of this NatRule.
+        :type: int
+        """
+        self._priority_order = priority_order
+
+    @property
+    def position(self):
+        """
+        Gets the position of this NatRule.
+
+        :return: The position of this NatRule.
+        :rtype: oci.network_firewall.models.RulePosition
+        """
+        return self._position
+
+    @position.setter
+    def position(self, position):
+        """
+        Sets the position of this NatRule.
+
+        :param position: The position of this NatRule.
+        :type: oci.network_firewall.models.RulePosition
+        """
+        self._position = position
+
+    @property
+    def parent_resource_id(self):
+        """
+        **[Required]** Gets the parent_resource_id of this NatRule.
+        OCID of the Network Firewall Policy this decryption profile belongs to.
+
+
+        :return: The parent_resource_id of this NatRule.
+        :rtype: str
+        """
+        return self._parent_resource_id
+
+    @parent_resource_id.setter
+    def parent_resource_id(self, parent_resource_id):
+        """
+        Sets the parent_resource_id of this NatRule.
+        OCID of the Network Firewall Policy this decryption profile belongs to.
+
+
+        :param parent_resource_id: The parent_resource_id of this NatRule.
+        :type: str
+        """
+        self._parent_resource_id = parent_resource_id
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/network_firewall/models/nat_rule_collection.py

@@ -0,0 +1,70 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, 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.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20230501
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class NatRuleCollection(object):
+    """
+    Collection of Nat Rule Summaries in the network firewall policy
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new NatRuleCollection object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param items:
+            The value to assign to the items property of this NatRuleCollection.
+        :type items: list[oci.network_firewall.models.NatRuleSummary]
+
+        """
+        self.swagger_types = {
+            'items': 'list[NatRuleSummary]'
+        }
+        self.attribute_map = {
+            'items': 'items'
+        }
+        self._items = None
+
+    @property
+    def items(self):
+        """
+        **[Required]** Gets the items of this NatRuleCollection.
+        Collection of Nat Rule Summaries.
+
+
+        :return: The items of this NatRuleCollection.
+        :rtype: list[oci.network_firewall.models.NatRuleSummary]
+        """
+        return self._items
+
+    @items.setter
+    def items(self, items):
+        """
+        Sets the items of this NatRuleCollection.
+        Collection of Nat Rule Summaries.
+
+
+        :param items: The items of this NatRuleCollection.
+        :type: list[oci.network_firewall.models.NatRuleSummary]
+        """
+        self._items = items
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/network_firewall/models/nat_rule_match_criteria.py

@@ -0,0 +1,132 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, 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.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20230501
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class NatRuleMatchCriteria(object):
+    """
+    Match criteria used in NAT Rule used on the firewall policy.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new NatRuleMatchCriteria object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param source_address:
+            The value to assign to the source_address property of this NatRuleMatchCriteria.
+        :type source_address: list[str]
+
+        :param destination_address:
+            The value to assign to the destination_address property of this NatRuleMatchCriteria.
+        :type destination_address: list[str]
+
+        :param service:
+            The value to assign to the service property of this NatRuleMatchCriteria.
+        :type service: str
+
+        """
+        self.swagger_types = {
+            'source_address': 'list[str]',
+            'destination_address': 'list[str]',
+            'service': 'str'
+        }
+        self.attribute_map = {
+            'source_address': 'sourceAddress',
+            'destination_address': 'destinationAddress',
+            'service': 'service'
+        }
+        self._source_address = None
+        self._destination_address = None
+        self._service = None
+
+    @property
+    def source_address(self):
+        """
+        Gets the source_address of this NatRuleMatchCriteria.
+        An array of IP address list names to be evaluated against the traffic source address.
+
+
+        :return: The source_address of this NatRuleMatchCriteria.
+        :rtype: list[str]
+        """
+        return self._source_address
+
+    @source_address.setter
+    def source_address(self, source_address):
+        """
+        Sets the source_address of this NatRuleMatchCriteria.
+        An array of IP address list names to be evaluated against the traffic source address.
+
+
+        :param source_address: The source_address of this NatRuleMatchCriteria.
+        :type: list[str]
+        """
+        self._source_address = source_address
+
+    @property
+    def destination_address(self):
+        """
+        Gets the destination_address of this NatRuleMatchCriteria.
+        An array of IP address list names to be evaluated against the traffic destination address.
+
+
+        :return: The destination_address of this NatRuleMatchCriteria.
+        :rtype: list[str]
+        """
+        return self._destination_address
+
+    @destination_address.setter
+    def destination_address(self, destination_address):
+        """
+        Sets the destination_address of this NatRuleMatchCriteria.
+        An array of IP address list names to be evaluated against the traffic destination address.
+
+
+        :param destination_address: The destination_address of this NatRuleMatchCriteria.
+        :type: list[str]
+        """
+        self._destination_address = destination_address
+
+    @property
+    def service(self):
+        """
+        Gets the service of this NatRuleMatchCriteria.
+        A Service name to be evaluated against the traffic protocol and protocol-specific parameters.
+
+
+        :return: The service of this NatRuleMatchCriteria.
+        :rtype: str
+        """
+        return self._service
+
+    @service.setter
+    def service(self, service):
+        """
+        Sets the service of this NatRuleMatchCriteria.
+        A Service name to be evaluated against the traffic protocol and protocol-specific parameters.
+
+
+        :param service: The service of this NatRuleMatchCriteria.
+        :type: str
+        """
+        self._service = service
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/network_firewall/models/nat_rule_summary.py

@@ -0,0 +1,228 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, 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.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20230501
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class NatRuleSummary(object):
+    """
+    Summary of NAT Rules used in the firewall policy.
+    A Nat Rule is used to define which traffic NAT should be applied by the firewall, and how it should do so.
+    """
+
+    #: A constant which can be used with the type property of a NatRuleSummary.
+    #: This constant has a value of "NATV4"
+    TYPE_NATV4 = "NATV4"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new NatRuleSummary object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.network_firewall.models.NatV4NatSummary`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param name:
+            The value to assign to the name property of this NatRuleSummary.
+        :type name: str
+
+        :param type:
+            The value to assign to the type property of this NatRuleSummary.
+            Allowed values for this property are: "NATV4", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type type: str
+
+        :param description:
+            The value to assign to the description property of this NatRuleSummary.
+        :type description: str
+
+        :param priority_order:
+            The value to assign to the priority_order property of this NatRuleSummary.
+        :type priority_order: int
+
+        :param parent_resource_id:
+            The value to assign to the parent_resource_id property of this NatRuleSummary.
+        :type parent_resource_id: str
+
+        """
+        self.swagger_types = {
+            'name': 'str',
+            'type': 'str',
+            'description': 'str',
+            'priority_order': 'int',
+            'parent_resource_id': 'str'
+        }
+        self.attribute_map = {
+            'name': 'name',
+            'type': 'type',
+            'description': 'description',
+            'priority_order': 'priorityOrder',
+            'parent_resource_id': 'parentResourceId'
+        }
+        self._name = None
+        self._type = None
+        self._description = None
+        self._priority_order = None
+        self._parent_resource_id = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['type']
+
+        if type == 'NATV4':
+            return 'NatV4NatSummary'
+        else:
+            return 'NatRuleSummary'
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this NatRuleSummary.
+        Name for the nat rule, must be unique within the policy.
+
+
+        :return: The name of this NatRuleSummary.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this NatRuleSummary.
+        Name for the nat rule, must be unique within the policy.
+
+
+        :param name: The name of this NatRuleSummary.
+        :type: str
+        """
+        self._name = name
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this NatRuleSummary.
+        NAT type:
+
+        * NATV4 - NATV4 type NAT.
+
+        Allowed values for this property are: "NATV4", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The type of this NatRuleSummary.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this NatRuleSummary.
+        NAT type:
+
+        * NATV4 - NATV4 type NAT.
+
+
+        :param type: The type of this NatRuleSummary.
+        :type: str
+        """
+        allowed_values = ["NATV4"]
+        if not value_allowed_none_or_none_sentinel(type, allowed_values):
+            type = 'UNKNOWN_ENUM_VALUE'
+        self._type = type
+
+    @property
+    def description(self):
+        """
+        Gets the description of this NatRuleSummary.
+        Description of a NAT rule. This field can be used to add additional info.
+
+
+        :return: The description of this NatRuleSummary.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """
+        Sets the description of this NatRuleSummary.
+        Description of a NAT rule. This field can be used to add additional info.
+
+
+        :param description: The description of this NatRuleSummary.
+        :type: str
+        """
+        self._description = description
+
+    @property
+    def priority_order(self):
+        """
+        **[Required]** Gets the priority_order of this NatRuleSummary.
+        The priority order in which this rule should be evaluated.
+
+
+        :return: The priority_order of this NatRuleSummary.
+        :rtype: int
+        """
+        return self._priority_order
+
+    @priority_order.setter
+    def priority_order(self, priority_order):
+        """
+        Sets the priority_order of this NatRuleSummary.
+        The priority order in which this rule should be evaluated.
+
+
+        :param priority_order: The priority_order of this NatRuleSummary.
+        :type: int
+        """
+        self._priority_order = priority_order
+
+    @property
+    def parent_resource_id(self):
+        """
+        **[Required]** Gets the parent_resource_id of this NatRuleSummary.
+        OCID of the Network Firewall Policy this application belongs to.
+
+
+        :return: The parent_resource_id of this NatRuleSummary.
+        :rtype: str
+        """
+        return self._parent_resource_id
+
+    @parent_resource_id.setter
+    def parent_resource_id(self, parent_resource_id):
+        """
+        Sets the parent_resource_id of this NatRuleSummary.
+        OCID of the Network Firewall Policy this application belongs to.
+
+
+        :param parent_resource_id: The parent_resource_id of this NatRuleSummary.
+        :type: str
+        """
+        self._parent_resource_id = parent_resource_id
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other