Documentation

DevicesserialswitchroutinginterfacesOspfSettings implements ModelInterface, ArrayAccess

DevicesserialswitchroutinginterfacesOspfSettings Class Doc Comment

Tags
category

Class

description

The OSPF routing settings of the interface.

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
getArea()  : string
Gets area
getCost()  : int
Gets cost
getIsPassiveEnabled()  : bool
Gets is_passive_enabled
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.
setArea()  : $this
Sets area
setCost()  : $this
Sets cost
setIsPassiveEnabled()  : $this
Sets is_passive_enabled
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

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' => 'area', 'cost' => 'cost', 'is_passive_enabled' => 'isPassiveEnabled']

$getters

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

protected static array<string|int, string> $getters = ['area' => 'getArea', 'cost' => 'getCost', 'is_passive_enabled' => 'getIsPassiveEnabled']

$setters

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

protected static array<string|int, string> $setters = ['area' => 'setArea', 'cost' => 'setCost', 'is_passive_enabled' => 'setIsPassiveEnabled']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['area' => null, 'cost' => null, 'is_passive_enabled' => null]

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['area' => 'string', 'cost' => 'int', 'is_passive_enabled' => 'bool']

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>

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>

invalid properties with reasons

setArea()

Sets area

public setArea(string $area) : $this
Parameters
$area : string

The OSPF area to which this interface should belong. Can be either 'disabled' or the identifier of an existing OSPF area. Defaults to 'disabled'.

Return values
$this

setCost()

Sets cost

public setCost(int $cost) : $this
Parameters
$cost : int

The path cost for this interface. Defaults to 1, but can be increased up to 65535 to give lower priority.

Return values
$this

setIsPassiveEnabled()

Sets is_passive_enabled

public setIsPassiveEnabled(bool $is_passive_enabled) : $this
Parameters
$is_passive_enabled : bool

When enabled, OSPF will not run on the interface, but the subnet will still be advertised.

Return values
$this

Search results