CreateOrganizationNetwork implements ModelInterface, ArrayAccess
CreateOrganizationNetwork Class Doc Comment
Tags
Interfaces, Classes and Traits
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- PRODUCT_TYPES__SWITCH = 'switch'
- PRODUCT_TYPES_APPLIANCE = 'appliance'
- PRODUCT_TYPES_CAMERA = 'camera'
- PRODUCT_TYPES_CELLULAR_GATEWAY = 'cellularGateway'
- PRODUCT_TYPES_ENVIRONMENTAL = 'environmental'
- PRODUCT_TYPES_SYSTEMS_MANAGER = 'systemsManager'
- PRODUCT_TYPES_WIRELESS = 'wireless'
- $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
- getCopyFromNetworkId() : string
- Gets copy_from_network_id
- getModelName() : string
- The original name of the model.
- getName() : string
- Gets name
- getNotes() : string
- Gets notes
- getProductTypes() : array<string|int, string>
- Gets product_types
- getProductTypesAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTags() : array<string|int, string>
- Gets tags
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTimeZone() : string
- Gets time_zone
- 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.
- setCopyFromNetworkId() : $this
- Sets copy_from_network_id
- setName() : $this
- Sets name
- setNotes() : $this
- Sets notes
- setProductTypes() : $this
- Sets product_types
- setTags() : $this
- Sets tags
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTimeZone() : $this
- Sets time_zone
- 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
PRODUCT_TYPES__SWITCH
public
mixed
PRODUCT_TYPES__SWITCH
= 'switch'
PRODUCT_TYPES_APPLIANCE
public
mixed
PRODUCT_TYPES_APPLIANCE
= 'appliance'
PRODUCT_TYPES_CAMERA
public
mixed
PRODUCT_TYPES_CAMERA
= 'camera'
PRODUCT_TYPES_CELLULAR_GATEWAY
public
mixed
PRODUCT_TYPES_CELLULAR_GATEWAY
= 'cellularGateway'
PRODUCT_TYPES_ENVIRONMENTAL
public
mixed
PRODUCT_TYPES_ENVIRONMENTAL
= 'environmental'
PRODUCT_TYPES_SYSTEMS_MANAGER
public
mixed
PRODUCT_TYPES_SYSTEMS_MANAGER
= 'systemsManager'
PRODUCT_TYPES_WIRELESS
public
mixed
PRODUCT_TYPES_WIRELESS
= 'wireless'
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', 'product_types' => 'productTypes', 'tags' => 'tags', 'time_zone' => 'timeZone', 'copy_from_network_id' => 'copyFromNetworkId', 'notes' => 'notes']
$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', 'product_types' => 'getProductTypes', 'tags' => 'getTags', 'time_zone' => 'getTimeZone', 'copy_from_network_id' => 'getCopyFromNetworkId', 'notes' => 'getNotes']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['name' => 'setName', 'product_types' => 'setProductTypes', 'tags' => 'setTags', 'time_zone' => 'setTimeZone', 'copy_from_network_id' => 'setCopyFromNetworkId', 'notes' => 'setNotes']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['name' => null, 'product_types' => null, 'tags' => null, 'time_zone' => null, 'copy_from_network_id' => null, 'notes' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'createOrganizationNetwork'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['name' => 'string', 'product_types' => 'string[]', 'tags' => 'string[]', 'time_zone' => 'string', 'copy_from_network_id' => 'string', 'notes' => '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> —getCopyFromNetworkId()
Gets copy_from_network_id
public
getCopyFromNetworkId() : 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 —getNotes()
Gets notes
public
getNotes() : string
Return values
string —getProductTypes()
Gets product_types
public
getProductTypes() : array<string|int, string>
Return values
array<string|int, string> —getProductTypesAllowableValues()
Gets allowable values of the enum
public
getProductTypesAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getTags()
Gets tags
public
getTags() : array<string|int, string>
Return values
array<string|int, 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> —getTimeZone()
Gets time_zone
public
getTimeZone() : string
Return values
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 —setCopyFromNetworkId()
Sets copy_from_network_id
public
setCopyFromNetworkId(string $copy_from_network_id) : $this
Parameters
- $copy_from_network_id : string
-
The ID of the network to copy configuration from. Other provided parameters will override the copied configuration, except type which must match this network's type exactly.
Return values
$this —setName()
Sets name
public
setName(string $name) : $this
Parameters
- $name : string
-
The name of the new network
Return values
$this —setNotes()
Sets notes
public
setNotes(string $notes) : $this
Parameters
- $notes : string
-
Add any notes or additional information about this network here.
Return values
$this —setProductTypes()
Sets product_types
public
setProductTypes(array<string|int, string> $product_types) : $this
Parameters
- $product_types : array<string|int, string>
-
The product type(s) of the new network. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, environmental. If more than one type is included, the network will be a combined network.
Return values
$this —setTags()
Sets tags
public
setTags(array<string|int, string> $tags) : $this
Parameters
- $tags : array<string|int, string>
-
A list of tags to be applied to the network
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> —setTimeZone()
Sets time_zone
public
setTimeZone(string $time_zone) : $this
Parameters
- $time_zone : string
-
The timezone of the network. For a list of allowed timezones, please see the 'TZ' column in the table in this article.
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