Documentation

UpdateNetworkAppliancePort implements ModelInterface, ArrayAccess

UpdateNetworkAppliancePort Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes and Traits

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$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
getAccessPolicy()  : string
Gets access_policy
getAllowedVlans()  : string
Gets allowed_vlans
getDropUntaggedTraffic()  : bool
Gets drop_untagged_traffic
getEnabled()  : bool
Gets enabled
getModelName()  : string
The original name of the model.
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getType()  : string
Gets type
getVlan()  : int
Gets vlan
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.
setAccessPolicy()  : $this
Sets access_policy
setAllowedVlans()  : $this
Sets allowed_vlans
setDropUntaggedTraffic()  : $this
Sets drop_untagged_traffic
setEnabled()  : $this
Sets enabled
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setType()  : $this
Sets type
setVlan()  : $this
Sets vlan
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

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 = ['enabled' => 'enabled', 'drop_untagged_traffic' => 'dropUntaggedTraffic', 'type' => 'type', 'vlan' => 'vlan', 'allowed_vlans' => 'allowedVlans', 'access_policy' => 'accessPolicy']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['enabled' => 'getEnabled', 'drop_untagged_traffic' => 'getDropUntaggedTraffic', 'type' => 'getType', 'vlan' => 'getVlan', 'allowed_vlans' => 'getAllowedVlans', 'access_policy' => 'getAccessPolicy']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['enabled' => 'setEnabled', 'drop_untagged_traffic' => 'setDropUntaggedTraffic', 'type' => 'setType', 'vlan' => 'setVlan', 'allowed_vlans' => 'setAllowedVlans', 'access_policy' => 'setAccessPolicy']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['enabled' => null, 'drop_untagged_traffic' => null, 'type' => null, 'vlan' => null, 'allowed_vlans' => null, 'access_policy' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'updateNetworkAppliancePort'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['enabled' => 'bool', 'drop_untagged_traffic' => 'bool', 'type' => 'string', 'vlan' => 'int', 'allowed_vlans' => 'string', 'access_policy' => '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 —

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> —

getDropUntaggedTraffic()

Gets drop_untagged_traffic

public getDropUntaggedTraffic() : bool
Return values
bool —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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 —

setAccessPolicy()

Sets access_policy

public setAccessPolicy(string $access_policy) : $this
Parameters
$access_policy : string

The name of the policy. Only applicable to Access ports. Valid values are: 'open', '8021x-radius', 'mac-radius', 'hybris-radius' for MX64 or Z3 or any MX supporting the per port authentication feature. Otherwise, 'open' is the only valid value and 'open' is the default value if the field is missing.

Return values
$this —

setAllowedVlans()

Sets allowed_vlans

public setAllowedVlans(string $allowed_vlans) : $this
Parameters
$allowed_vlans : string

Comma-delimited list of the VLAN ID's allowed on the port, or 'all' to permit all VLAN's on the port.

Return values
$this —

setDropUntaggedTraffic()

Sets drop_untagged_traffic

public setDropUntaggedTraffic(bool $drop_untagged_traffic) : $this
Parameters
$drop_untagged_traffic : bool

Trunk port can Drop all Untagged traffic. When true, no VLAN is required. Access ports cannot have dropUntaggedTraffic set to true.

Return values
$this —

setEnabled()

Sets enabled

public setEnabled(bool $enabled) : $this
Parameters
$enabled : bool

The status of the port

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> —

setType()

Sets type

public setType(string $type) : $this
Parameters
$type : string

The type of the port: 'access' or 'trunk'.

Return values
$this —

setVlan()

Sets vlan

public setVlan(int $vlan) : $this
Parameters
$vlan : int

Native VLAN when the port is in Trunk mode. Access VLAN when the port is in Access mode.

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

Search results