NetworksnetworkIdappliancefirewallportForwardingRulesRules implements ModelInterface, ArrayAccess
NetworksnetworkIdappliancefirewallportForwardingRulesRules Class Doc Comment
Tags
Interfaces, Classes and Traits
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- PROTOCOL_TCP = 'tcp'
- PROTOCOL_UDP = 'udp'
- UPLINK_BOTH = 'both'
- UPLINK_INTERNET1 = 'internet1'
- UPLINK_INTERNET2 = 'internet2'
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAllowedIps() : array<string|int, string>
- Gets allowed_ips
- getLanIp() : string
- Gets lan_ip
- getLocalPort() : string
- Gets local_port
- getModelName() : string
- The original name of the model.
- getName() : string
- Gets name
- getProtocol() : string
- Gets protocol
- getProtocolAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getPublicPort() : string
- Gets public_port
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUplink() : string
- Gets uplink
- getUplinkAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setAllowedIps() : $this
- Sets allowed_ips
- setLanIp() : $this
- Sets lan_ip
- setLocalPort() : $this
- Sets local_port
- setName() : $this
- Sets name
- setProtocol() : $this
- Sets protocol
- setPublicPort() : $this
- Sets public_port
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUplink() : $this
- Sets uplink
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
PROTOCOL_TCP
public
mixed
PROTOCOL_TCP
= 'tcp'
PROTOCOL_UDP
public
mixed
PROTOCOL_UDP
= 'udp'
UPLINK_BOTH
public
mixed
UPLINK_BOTH
= 'both'
UPLINK_INTERNET1
public
mixed
UPLINK_INTERNET1
= 'internet1'
UPLINK_INTERNET2
public
mixed
UPLINK_INTERNET2
= 'internet2'
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['name' => 'name', 'lan_ip' => 'lanIp', 'uplink' => 'uplink', 'public_port' => 'publicPort', 'local_port' => 'localPort', 'allowed_ips' => 'allowedIps', 'protocol' => 'protocol']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['name' => 'getName', 'lan_ip' => 'getLanIp', 'uplink' => 'getUplink', 'public_port' => 'getPublicPort', 'local_port' => 'getLocalPort', 'allowed_ips' => 'getAllowedIps', 'protocol' => 'getProtocol']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['name' => 'setName', 'lan_ip' => 'setLanIp', 'uplink' => 'setUplink', 'public_port' => 'setPublicPort', 'local_port' => 'setLocalPort', 'allowed_ips' => 'setAllowedIps', 'protocol' => 'setProtocol']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['name' => null, 'lan_ip' => null, 'uplink' => null, 'public_port' => null, 'local_port' => null, 'allowed_ips' => null, 'protocol' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'networksnetworkIdappliancefirewallportForwardingRules_rules'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['name' => 'string', 'lan_ip' => 'string', 'uplink' => 'string', 'public_port' => 'string', 'local_port' => 'string', 'allowed_ips' => 'string[]', 'protocol' => 'string']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAllowedIps()
Gets allowed_ips
public
getAllowedIps() : array<string|int, string>
Return values
array<string|int, string> —getLanIp()
Gets lan_ip
public
getLanIp() : string
Return values
string —getLocalPort()
Gets local_port
public
getLocalPort() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string
Return values
string —getProtocol()
Gets protocol
public
getProtocol() : string
Return values
string —getProtocolAllowableValues()
Gets allowable values of the enum
public
getProtocolAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getPublicPort()
Gets public_port
public
getPublicPort() : string
Return values
string —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUplink()
Gets uplink
public
getUplink() : string
Return values
string —getUplinkAllowableValues()
Gets allowable values of the enum
public
getUplinkAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setAllowedIps()
Sets allowed_ips
public
setAllowedIps(array<string|int, string> $allowed_ips) : $this
Parameters
- $allowed_ips : array<string|int, string>
-
An array of ranges of WAN IP addresses that are allowed to make inbound connections on the specified ports or port ranges (or any)
Return values
$this —setLanIp()
Sets lan_ip
public
setLanIp(string $lan_ip) : $this
Parameters
- $lan_ip : string
-
The IP address of the server or device that hosts the internal resource that you wish to make available on the WAN
Return values
$this —setLocalPort()
Sets local_port
public
setLocalPort(string $local_port) : $this
Parameters
- $local_port : string
-
A port or port ranges that will receive the forwarded traffic from the WAN
Return values
$this —setName()
Sets name
public
setName(string $name) : $this
Parameters
- $name : string
-
A descriptive name for the rule
Return values
$this —setProtocol()
Sets protocol
public
setProtocol(string $protocol) : $this
Parameters
- $protocol : string
-
TCP or UDP
Return values
$this —setPublicPort()
Sets public_port
public
setPublicPort(string $public_port) : $this
Parameters
- $public_port : string
-
A port or port ranges that will be forwarded to the host on the LAN
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setUplink()
Sets uplink
public
setUplink(string $uplink) : $this
Parameters
- $uplink : string
-
The physical WAN interface on which the traffic will arrive ('internet1' or, if available, 'internet2' or 'both')
Return values
$this —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid