NatRuleSummary¶
- class oci.network_firewall.models.NatRuleSummary(**kwargs)¶
Bases:
objectSummary of NAT rules used in the firewall policy. A NAT rule defines which traffic NAT should be applied to by the firewall, and how it should do so.
Attributes:
A constant which can be used with the type property of a NatRuleSummary.
Gets the description of this NatRuleSummary.
[Required] Gets the name of this NatRuleSummary.
[Required] Gets the parent_resource_id of this NatRuleSummary.
[Required] Gets the priority_order of this NatRuleSummary.
[Required] Gets the type of this NatRuleSummary.
Methods:
__init__(**kwargs)Initializes a new NatRuleSummary object with values from keyword arguments.
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_NATV4 = 'NATV4'¶
A constant which can be used with the type property of a NatRuleSummary. This constant has a value of “NATV4”
- __init__(**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:
The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
name (str) – The value to assign to the name property of this NatRuleSummary.
type (str) – 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’.
description (str) – The value to assign to the description property of this NatRuleSummary.
priority_order (int) – The value to assign to the priority_order property of this NatRuleSummary.
parent_resource_id (str) – The value to assign to the parent_resource_id property of this NatRuleSummary.
- property description¶
Gets the description of this NatRuleSummary. Description of a NAT rule. This field can be used to add additional info.
- Returns
The description of this NatRuleSummary.
- Return type
str
- static 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.
- property name¶
[Required] Gets the name of this NatRuleSummary. Name for the NAT rule, must be unique within the policy.
- Returns
The name of this NatRuleSummary.
- Return type
str
- property parent_resource_id¶
[Required] Gets the parent_resource_id of this NatRuleSummary. The OCID of the Network Firewall Policy this NAT rule belongs to.
- Returns
The parent_resource_id of this NatRuleSummary.
- Return type
str
- property priority_order¶
[Required] Gets the priority_order of this NatRuleSummary. The priority order in which this rule should be evaluated.
- Returns
The priority_order of this NatRuleSummary.
- Return type
int
- property type¶
[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’.
- Returns
The type of this NatRuleSummary.
- Return type
str