CreateNetworkPiiRequest implements ModelInterface, ArrayAccess
CreateNetworkPiiRequest Class Doc Comment
Tags
Interfaces, Classes and Traits
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- TYPE_DELETE = 'delete'
- TYPE_RESTRICT_PROCESSING = 'restrict processing'
- $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
- getDatasets() : array<string|int, string>
- Gets datasets
- getEmail() : string
- Gets email
- getMac() : string
- Gets mac
- getModelName() : string
- The original name of the model.
- getSmDeviceId() : string
- Gets sm_device_id
- getSmUserId() : string
- Gets sm_user_id
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getType() : string
- Gets type
- getTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getUsername() : string
- Gets username
- 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.
- setDatasets() : $this
- Sets datasets
- setEmail() : $this
- Sets email
- setMac() : $this
- Sets mac
- setSmDeviceId() : $this
- Sets sm_device_id
- setSmUserId() : $this
- Sets sm_user_id
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setType() : $this
- Sets type
- setUsername() : $this
- Sets username
- 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
TYPE_DELETE
public
mixed
TYPE_DELETE
= 'delete'
TYPE_RESTRICT_PROCESSING
public
mixed
TYPE_RESTRICT_PROCESSING
= 'restrict processing'
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
= ['type' => 'type', 'datasets' => 'datasets', 'username' => 'username', 'email' => 'email', 'mac' => 'mac', 'sm_device_id' => 'smDeviceId', 'sm_user_id' => 'smUserId']
$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
= ['type' => 'getType', 'datasets' => 'getDatasets', 'username' => 'getUsername', 'email' => 'getEmail', 'mac' => 'getMac', 'sm_device_id' => 'getSmDeviceId', 'sm_user_id' => 'getSmUserId']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['type' => 'setType', 'datasets' => 'setDatasets', 'username' => 'setUsername', 'email' => 'setEmail', 'mac' => 'setMac', 'sm_device_id' => 'setSmDeviceId', 'sm_user_id' => 'setSmUserId']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['type' => null, 'datasets' => null, 'username' => null, 'email' => null, 'mac' => null, 'sm_device_id' => null, 'sm_user_id' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'createNetworkPiiRequest'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['type' => 'string', 'datasets' => 'string[]', 'username' => 'string', 'email' => 'string', 'mac' => 'string', 'sm_device_id' => 'string', 'sm_user_id' => '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> —getDatasets()
Gets datasets
public
getDatasets() : array<string|int, string>
Return values
array<string|int, string> —getEmail()
Gets email
public
getEmail() : string
Return values
string —getMac()
Gets mac
public
getMac() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getSmDeviceId()
Gets sm_device_id
public
getSmDeviceId() : string
Return values
string —getSmUserId()
Gets sm_user_id
public
getSmUserId() : 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> —getType()
Gets type
public
getType() : string
Return values
string —getTypeAllowableValues()
Gets allowable values of the enum
public
getTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getUsername()
Gets username
public
getUsername() : 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 —setDatasets()
Sets datasets
public
setDatasets(array<string|int, string> $datasets) : $this
Parameters
- $datasets : array<string|int, string>
-
The datasets related to the provided key that should be deleted. Only applies to "delete" requests. The value "all" will be expanded to all datasets applicable to this type. The datasets by applicable to each type are: mac (usage, events, traffic), email (users, loginAttempts), username (users, loginAttempts), bluetoothMac (client, connectivity), smDeviceId (device), smUserId (user)
Return values
$this —setEmail()
Sets email
public
setEmail(string $email) : $this
Parameters
- $email : string
-
The email of a network user account. Only applies to "delete" requests.
Return values
$this —setMac()
Sets mac
public
setMac(string $mac) : $this
Parameters
- $mac : string
-
The MAC of a network client device. Applies to both "restrict processing" and "delete" requests.
Return values
$this —setSmDeviceId()
Sets sm_device_id
public
setSmDeviceId(string $sm_device_id) : $this
Parameters
- $sm_device_id : string
-
The sm_device_id of a Systems Manager device. The only way to "restrict processing" or "delete" a Systems Manager device. Must include "device" in the dataset for a "delete" request to destroy the device.
Return values
$this —setSmUserId()
Sets sm_user_id
public
setSmUserId(string $sm_user_id) : $this
Parameters
- $sm_user_id : string
-
The sm_user_id of a Systems Manager user. The only way to "restrict processing" or "delete" a Systems Manager user. Must include "user" in the dataset for a "delete" request to destroy the user.
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
-
One of "delete" or "restrict processing"
Return values
$this —setUsername()
Sets username
public
setUsername(string $username) : $this
Parameters
- $username : string
-
The username of a network log in. Only applies to "delete" requests.
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