DevicePreviewProviderProgressDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DevicePreviewProviderProgressDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- PROVIDER_GMAIL = 'GMAIL'
- PROVIDER_OUTLOOK = 'OUTLOOK'
- PROVIDER_YAHOO = 'YAHOO'
- STATUS_CAPTURING = 'CAPTURING'
- STATUS_COMPLETE = 'COMPLETE'
- STATUS_FAILED = 'FAILED'
- STATUS_PARTIAL_COMPLETE = 'PARTIAL_COMPLETE'
- STATUS_PENDING = 'PENDING'
- $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)
- $openAPIFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string|int, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- __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
- getCapturingCount() : int
- Gets capturing_count
- getFailedCount() : int
- Gets failed_count
- getModelName() : string
- The original name of the model.
- getPendingCount() : int
- Gets pending_count
- getProvider() : string
- Gets provider
- getProviderAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getReadyCount() : int
- Gets ready_count
- getRun() : DevicePreviewRunDto
- Gets run
- getScreenshots() : array<string|int, DevicePreviewScreenshotDto>
- Gets screenshots
- getStatus() : string
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTargetCount() : int
- Gets target_count
- getTargets() : array<string|int, DevicePreviewTargetDto>
- Gets targets
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- isNullable() : bool
- Checks if a property is nullable
- isNullableSetToNull() : bool
- Checks if a nullable property is set to null.
- jsonSerialize() : mixed
- Serializes the object to a value that can be serialized natively by json_encode().
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed|null
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- openAPIFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- setCapturingCount() : self
- Sets capturing_count
- setFailedCount() : self
- Sets failed_count
- setPendingCount() : self
- Sets pending_count
- setProvider() : self
- Sets provider
- setReadyCount() : self
- Sets ready_count
- setRun() : self
- Sets run
- setScreenshots() : self
- Sets screenshots
- setStatus() : self
- Sets status
- setTargetCount() : self
- Sets target_count
- setTargets() : self
- Sets targets
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- toHeaderValue() : string
- Gets a header-safe presentation of the object
- valid() : bool
- Validate all the properties in the model return true if all passed
- openAPINullables() : array<string|int, mixed>
- Array of nullable properties
- getOpenAPINullablesSetToNull() : array<string|int, bool>
- Array of nullable field names deliberately set to null
- setIfExists() : void
- Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
PROVIDER_GMAIL
public
mixed
PROVIDER_GMAIL
= 'GMAIL'
PROVIDER_OUTLOOK
public
mixed
PROVIDER_OUTLOOK
= 'OUTLOOK'
PROVIDER_YAHOO
public
mixed
PROVIDER_YAHOO
= 'YAHOO'
STATUS_CAPTURING
public
mixed
STATUS_CAPTURING
= 'CAPTURING'
STATUS_COMPLETE
public
mixed
STATUS_COMPLETE
= 'COMPLETE'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_PARTIAL_COMPLETE
public
mixed
STATUS_PARTIAL_COMPLETE
= 'PARTIAL_COMPLETE'
STATUS_PENDING
public
mixed
STATUS_PENDING
= 'PENDING'
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
= ['run' => 'run', 'provider' => 'provider', 'status' => 'status', 'target_count' => 'targetCount', 'ready_count' => 'readyCount', 'failed_count' => 'failedCount', 'capturing_count' => 'capturingCount', 'pending_count' => 'pendingCount', 'targets' => 'targets', 'screenshots' => 'screenshots']
$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
= ['run' => 'getRun', 'provider' => 'getProvider', 'status' => 'getStatus', 'target_count' => 'getTargetCount', 'ready_count' => 'getReadyCount', 'failed_count' => 'getFailedCount', 'capturing_count' => 'getCapturingCount', 'pending_count' => 'getPendingCount', 'targets' => 'getTargets', 'screenshots' => 'getScreenshots']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['run' => null, 'provider' => null, 'status' => null, 'target_count' => 'int64', 'ready_count' => 'int64', 'failed_count' => 'int64', 'capturing_count' => 'int64', 'pending_count' => 'int64', 'targets' => null, 'screenshots' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DevicePreviewProviderProgressDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['run' => false, 'provider' => false, 'status' => false, 'target_count' => false, 'ready_count' => false, 'failed_count' => false, 'capturing_count' => false, 'pending_count' => false, 'targets' => false, 'screenshots' => false]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['run' => '\\MailSlurp\\Models\\DevicePreviewRunDto', 'provider' => 'string', 'status' => 'string', 'target_count' => 'int', 'ready_count' => 'int', 'failed_count' => 'int', 'capturing_count' => 'int', 'pending_count' => 'int', 'targets' => '\\MailSlurp\\Models\\DevicePreviewTargetDto[]', 'screenshots' => '\\MailSlurp\\Models\\DevicePreviewScreenshotDto[]']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['run' => 'setRun', 'provider' => 'setProvider', 'status' => 'setStatus', 'target_count' => 'setTargetCount', 'ready_count' => 'setReadyCount', 'failed_count' => 'setFailedCount', 'capturing_count' => 'setCapturingCount', 'pending_count' => 'setPendingCount', 'targets' => 'setTargets', 'screenshots' => 'setScreenshots']
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> —getCapturingCount()
Gets capturing_count
public
getCapturingCount() : int
Return values
int —getFailedCount()
Gets failed_count
public
getFailedCount() : int
Return values
int —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPendingCount()
Gets pending_count
public
getPendingCount() : int
Return values
int —getProvider()
Gets provider
public
getProvider() : string
Return values
string —getProviderAllowableValues()
Gets allowable values of the enum
public
getProviderAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getReadyCount()
Gets ready_count
public
getReadyCount() : int
Return values
int —getRun()
Gets run
public
getRun() : DevicePreviewRunDto
Return values
DevicePreviewRunDto —getScreenshots()
Gets screenshots
public
getScreenshots() : array<string|int, DevicePreviewScreenshotDto>
Return values
array<string|int, DevicePreviewScreenshotDto> —getStatus()
Gets status
public
getStatus() : string
Return values
string —getStatusAllowableValues()
Gets allowable values of the enum
public
getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getTargetCount()
Gets target_count
public
getTargetCount() : int
Return values
int —getTargets()
Gets targets
public
getTargets() : array<string|int, DevicePreviewTargetDto>
Return values
array<string|int, DevicePreviewTargetDto> —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
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|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
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 —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setCapturingCount()
Sets capturing_count
public
setCapturingCount(int $capturing_count) : self
Parameters
- $capturing_count : int
-
capturing_count
Return values
self —setFailedCount()
Sets failed_count
public
setFailedCount(int $failed_count) : self
Parameters
- $failed_count : int
-
failed_count
Return values
self —setPendingCount()
Sets pending_count
public
setPendingCount(int $pending_count) : self
Parameters
- $pending_count : int
-
pending_count
Return values
self —setProvider()
Sets provider
public
setProvider(string $provider) : self
Parameters
- $provider : string
-
provider
Return values
self —setReadyCount()
Sets ready_count
public
setReadyCount(int $ready_count) : self
Parameters
- $ready_count : int
-
ready_count
Return values
self —setRun()
Sets run
public
setRun(DevicePreviewRunDto $run) : self
Parameters
- $run : DevicePreviewRunDto
-
run
Return values
self —setScreenshots()
Sets screenshots
public
setScreenshots(array<string|int, DevicePreviewScreenshotDto> $screenshots) : self
Parameters
- $screenshots : array<string|int, DevicePreviewScreenshotDto>
-
screenshots
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
Return values
self —setTargetCount()
Sets target_count
public
setTargetCount(int $target_count) : self
Parameters
- $target_count : int
-
target_count
Return values
self —setTargets()
Sets targets
public
setTargets(array<string|int, DevicePreviewTargetDto> $targets) : self
Parameters
- $targets : array<string|int, DevicePreviewTargetDto>
-
targets
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —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
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —setIfExists()
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
private
setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed
Return values
void —setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string|int, bool>