TspHealthCheckStatusDescription
in package
implements
ModelInterface, ArrayAccess
TspHealthCheckStatusDescription Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- 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
- getDescription() : string|null
- Gets description
- getError() : string|null
- Gets error
- getHostname() : string|null
- Gets hostname
- getModelName() : string
- The original name of the model.
- getResponseSeconds() : string|null
- Gets response_seconds
- getStatus() : string|null
- Gets status
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getType() : string|null
- Gets type
- 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.
- setDescription() : $this
- Sets description
- setError() : $this
- Sets error
- setHostname() : $this
- Sets hostname
- setResponseSeconds() : $this
- Sets response_seconds
- setStatus() : $this
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setType() : $this
- Sets type
- 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
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
= ['description' => 'description', 'error' => 'error', 'hostname' => 'hostname', 'response_seconds' => 'responseSeconds', 'status' => 'status', 'type' => 'type']
$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
= ['description' => 'getDescription', 'error' => 'getError', 'hostname' => 'getHostname', 'response_seconds' => 'getResponseSeconds', 'status' => 'getStatus', 'type' => 'getType']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['description' => 'setDescription', 'error' => 'setError', 'hostname' => 'setHostname', 'response_seconds' => 'setResponseSeconds', 'status' => 'setStatus', 'type' => 'setType']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['description' => null, 'error' => null, 'hostname' => null, 'response_seconds' => null, 'status' => null, 'type' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'tspHealthCheckStatusDescription'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['description' => '?string', 'error' => '?string', 'hostname' => '?string', 'response_seconds' => '?string', 'status' => '?string', '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> —getDescription()
Gets description
public
getDescription() : string|null
Return values
string|null —getError()
Gets error
public
getError() : string|null
Return values
string|null —getHostname()
Gets hostname
public
getHostname() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getResponseSeconds()
Gets response_seconds
public
getResponseSeconds() : string|null
Return values
string|null —getStatus()
Gets status
public
getStatus() : string|null
Return values
string|null —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|null
Return values
string|null —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 —setDescription()
Sets description
public
setDescription(string|null $description) : $this
Parameters
- $description : string|null
Return values
$this —setError()
Sets error
public
setError(string|null $error) : $this
Parameters
- $error : string|null
Return values
$this —setHostname()
Sets hostname
public
setHostname(string|null $hostname) : $this
Parameters
- $hostname : string|null
Return values
$this —setResponseSeconds()
Sets response_seconds
public
setResponseSeconds(string|null $response_seconds) : $this
Parameters
- $response_seconds : string|null
Return values
$this —setStatus()
Sets status
public
setStatus(string|null $status) : $this
Parameters
- $status : string|null
-
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
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|null $type) : $this
Parameters
- $type : string|null
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