DevicePreviewNativeTargetDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DevicePreviewNativeTargetDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- TIER_PREMIUM = 'PREMIUM'
- TIER_STANDARD = 'STANDARD'
- $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
- getAppearance() : string
- Gets appearance
- getBaseTarget() : string
- Gets base_target
- getClient() : string
- Gets client
- getCreditCost() : int
- Gets credit_cost
- getEngine() : string
- Gets engine
- getFormFactor() : string
- Gets form_factor
- getModelName() : string
- The original name of the model.
- getPlatform() : string
- Gets platform
- getProvider() : string|null
- Gets provider
- getSurface() : string
- Gets surface
- getTarget() : string
- Gets target
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTier() : string
- Gets tier
- getTierAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getTimeoutSeconds() : int
- Gets timeout_seconds
- 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
- setAppearance() : self
- Sets appearance
- setBaseTarget() : self
- Sets base_target
- setClient() : self
- Sets client
- setCreditCost() : self
- Sets credit_cost
- setEngine() : self
- Sets engine
- setFormFactor() : self
- Sets form_factor
- setPlatform() : self
- Sets platform
- setProvider() : self
- Sets provider
- setSurface() : self
- Sets surface
- setTarget() : self
- Sets target
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTier() : self
- Sets tier
- setTimeoutSeconds() : self
- Sets timeout_seconds
- 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
TIER_PREMIUM
public
mixed
TIER_PREMIUM
= 'PREMIUM'
TIER_STANDARD
public
mixed
TIER_STANDARD
= 'STANDARD'
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
= ['target' => 'target', 'base_target' => 'baseTarget', 'provider' => 'provider', 'client' => 'client', 'surface' => 'surface', 'platform' => 'platform', 'form_factor' => 'formFactor', 'engine' => 'engine', 'appearance' => 'appearance', 'credit_cost' => 'creditCost', 'tier' => 'tier', 'timeout_seconds' => 'timeoutSeconds']
$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
= ['target' => 'getTarget', 'base_target' => 'getBaseTarget', 'provider' => 'getProvider', 'client' => 'getClient', 'surface' => 'getSurface', 'platform' => 'getPlatform', 'form_factor' => 'getFormFactor', 'engine' => 'getEngine', 'appearance' => 'getAppearance', 'credit_cost' => 'getCreditCost', 'tier' => 'getTier', 'timeout_seconds' => 'getTimeoutSeconds']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['target' => null, 'base_target' => null, 'provider' => null, 'client' => null, 'surface' => null, 'platform' => null, 'form_factor' => null, 'engine' => null, 'appearance' => null, 'credit_cost' => 'int64', 'tier' => null, 'timeout_seconds' => 'int64']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DevicePreviewNativeTargetDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['target' => false, 'base_target' => false, 'provider' => true, 'client' => false, 'surface' => false, 'platform' => false, 'form_factor' => false, 'engine' => false, 'appearance' => false, 'credit_cost' => false, 'tier' => false, 'timeout_seconds' => 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
= ['target' => 'string', 'base_target' => 'string', 'provider' => 'string', 'client' => 'string', 'surface' => 'string', 'platform' => 'string', 'form_factor' => 'string', 'engine' => 'string', 'appearance' => 'string', 'credit_cost' => 'int', 'tier' => 'string', 'timeout_seconds' => 'int']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['target' => 'setTarget', 'base_target' => 'setBaseTarget', 'provider' => 'setProvider', 'client' => 'setClient', 'surface' => 'setSurface', 'platform' => 'setPlatform', 'form_factor' => 'setFormFactor', 'engine' => 'setEngine', 'appearance' => 'setAppearance', 'credit_cost' => 'setCreditCost', 'tier' => 'setTier', 'timeout_seconds' => 'setTimeoutSeconds']
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> —getAppearance()
Gets appearance
public
getAppearance() : string
Return values
string —getBaseTarget()
Gets base_target
public
getBaseTarget() : string
Return values
string —getClient()
Gets client
public
getClient() : string
Return values
string —getCreditCost()
Gets credit_cost
public
getCreditCost() : int
Return values
int —getEngine()
Gets engine
public
getEngine() : string
Return values
string —getFormFactor()
Gets form_factor
public
getFormFactor() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPlatform()
Gets platform
public
getPlatform() : string
Return values
string —getProvider()
Gets provider
public
getProvider() : string|null
Return values
string|null —getSurface()
Gets surface
public
getSurface() : string
Return values
string —getTarget()
Gets target
public
getTarget() : 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> —getTier()
Gets tier
public
getTier() : string
Return values
string —getTierAllowableValues()
Gets allowable values of the enum
public
getTierAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getTimeoutSeconds()
Gets timeout_seconds
public
getTimeoutSeconds() : int
Return values
int —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> —setAppearance()
Sets appearance
public
setAppearance(string $appearance) : self
Parameters
- $appearance : string
-
appearance
Return values
self —setBaseTarget()
Sets base_target
public
setBaseTarget(string $base_target) : self
Parameters
- $base_target : string
-
base_target
Return values
self —setClient()
Sets client
public
setClient(string $client) : self
Parameters
- $client : string
-
client
Return values
self —setCreditCost()
Sets credit_cost
public
setCreditCost(int $credit_cost) : self
Parameters
- $credit_cost : int
-
credit_cost
Return values
self —setEngine()
Sets engine
public
setEngine(string $engine) : self
Parameters
- $engine : string
-
engine
Return values
self —setFormFactor()
Sets form_factor
public
setFormFactor(string $form_factor) : self
Parameters
- $form_factor : string
-
form_factor
Return values
self —setPlatform()
Sets platform
public
setPlatform(string $platform) : self
Parameters
- $platform : string
-
platform
Return values
self —setProvider()
Sets provider
public
setProvider(string|null $provider) : self
Parameters
- $provider : string|null
-
provider
Return values
self —setSurface()
Sets surface
public
setSurface(string $surface) : self
Parameters
- $surface : string
-
surface
Return values
self —setTarget()
Sets target
public
setTarget(string $target) : self
Parameters
- $target : string
-
target
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> —setTier()
Sets tier
public
setTier(string $tier) : self
Parameters
- $tier : string
-
tier
Return values
self —setTimeoutSeconds()
Sets timeout_seconds
public
setTimeoutSeconds(int $timeout_seconds) : self
Parameters
- $timeout_seconds : int
-
timeout_seconds
Return values
self —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>