NetworksnetworkIdswitchroutingospfAreas implements ModelInterface, ArrayAccess
NetworksnetworkIdswitchroutingospfAreas Class Doc Comment
Tags
Interfaces, Classes and Traits
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- AREA_TYPE_NORMAL = 'normal'
- AREA_TYPE_NSSA = 'nssa'
- AREA_TYPE_STUB = 'stub'
- 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
- getAreaId() : int
- Gets area_id
- getAreaName() : string
- Gets area_name
- getAreaType() : string
- Gets area_type
- getAreaTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getModelName() : string
- The original name of the model.
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- 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.
- setAreaId() : $this
- Sets area_id
- setAreaName() : $this
- Sets area_name
- setAreaType() : $this
- Sets area_type
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
AREA_TYPE_NORMAL
public
mixed
AREA_TYPE_NORMAL
= 'normal'
AREA_TYPE_NSSA
public
mixed
AREA_TYPE_NSSA
= 'nssa'
AREA_TYPE_STUB
public
mixed
AREA_TYPE_STUB
= 'stub'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['area_id' => 'areaId', 'area_name' => 'areaName', 'area_type' => 'areaType']
$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
= ['area_id' => 'getAreaId', 'area_name' => 'getAreaName', 'area_type' => 'getAreaType']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['area_id' => 'setAreaId', 'area_name' => 'setAreaName', 'area_type' => 'setAreaType']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['area_id' => null, 'area_name' => null, 'area_type' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'networksnetworkIdswitchroutingospf_areas'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['area_id' => 'int', 'area_name' => 'string', 'area_type' => '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> —getAreaId()
Gets area_id
public
getAreaId() : int
Return values
int —getAreaName()
Gets area_name
public
getAreaName() : string
Return values
string —getAreaType()
Gets area_type
public
getAreaType() : string
Return values
string —getAreaTypeAllowableValues()
Gets allowable values of the enum
public
getAreaTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getModelName()
The original name of the model.
public
getModelName() : 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> —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 —setAreaId()
Sets area_id
public
setAreaId(int $area_id) : $this
Parameters
- $area_id : int
-
OSPF area ID
Return values
$this —setAreaName()
Sets area_name
public
setAreaName(string $area_name) : $this
Parameters
- $area_name : string
-
Name of the OSPF area
Return values
$this —setAreaType()
Sets area_type
public
setAreaType(string $area_type) : $this
Parameters
- $area_type : string
-
Area types in OSPF. Must be one of: ["normal", "stub", "nssa"]
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> —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