CampaignProbeRunDueResult
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CampaignProbeRunDueResult Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- TRIGGER_SOURCE_CRON = 'CRON'
- TRIGGER_SOURCE_DIRECT_API = 'DIRECT_API'
- TRIGGER_SOURCE_SCHEDULER = 'SCHEDULER'
- TRIGGER_SOURCE_SES_MONITOR = 'SES_MONITOR'
- TRIGGER_SOURCE_USER_SCHEDULE = 'USER_SCHEDULE'
- $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
- getDueProbeCount() : int
- Gets due_probe_count
- getExecutedAt() : DateTime
- Gets executed_at
- getModelName() : string
- The original name of the model.
- getRequestedMaxRuns() : int
- Gets requested_max_runs
- getRunCount() : int
- Gets run_count
- getSkippedCount() : int
- Gets skipped_count
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTriggerSource() : string
- Gets trigger_source
- getTriggerSourceAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- 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
- setDueProbeCount() : self
- Sets due_probe_count
- setExecutedAt() : self
- Sets executed_at
- setRequestedMaxRuns() : self
- Sets requested_max_runs
- setRunCount() : self
- Sets run_count
- setSkippedCount() : self
- Sets skipped_count
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTriggerSource() : self
- Sets trigger_source
- 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
TRIGGER_SOURCE_CRON
public
mixed
TRIGGER_SOURCE_CRON
= 'CRON'
TRIGGER_SOURCE_DIRECT_API
public
mixed
TRIGGER_SOURCE_DIRECT_API
= 'DIRECT_API'
TRIGGER_SOURCE_SCHEDULER
public
mixed
TRIGGER_SOURCE_SCHEDULER
= 'SCHEDULER'
TRIGGER_SOURCE_SES_MONITOR
public
mixed
TRIGGER_SOURCE_SES_MONITOR
= 'SES_MONITOR'
TRIGGER_SOURCE_USER_SCHEDULE
public
mixed
TRIGGER_SOURCE_USER_SCHEDULE
= 'USER_SCHEDULE'
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
= ['trigger_source' => 'triggerSource', 'run_count' => 'runCount', 'due_probe_count' => 'dueProbeCount', 'skipped_count' => 'skippedCount', 'requested_max_runs' => 'requestedMaxRuns', 'executed_at' => 'executedAt']
$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
= ['trigger_source' => 'getTriggerSource', 'run_count' => 'getRunCount', 'due_probe_count' => 'getDueProbeCount', 'skipped_count' => 'getSkippedCount', 'requested_max_runs' => 'getRequestedMaxRuns', 'executed_at' => 'getExecutedAt']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['trigger_source' => null, 'run_count' => 'int32', 'due_probe_count' => 'int32', 'skipped_count' => 'int32', 'requested_max_runs' => 'int32', 'executed_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CampaignProbeRunDueResult'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['trigger_source' => false, 'run_count' => false, 'due_probe_count' => false, 'skipped_count' => false, 'requested_max_runs' => false, 'executed_at' => 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
= ['trigger_source' => 'string', 'run_count' => 'int', 'due_probe_count' => 'int', 'skipped_count' => 'int', 'requested_max_runs' => 'int', 'executed_at' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['trigger_source' => 'setTriggerSource', 'run_count' => 'setRunCount', 'due_probe_count' => 'setDueProbeCount', 'skipped_count' => 'setSkippedCount', 'requested_max_runs' => 'setRequestedMaxRuns', 'executed_at' => 'setExecutedAt']
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> —getDueProbeCount()
Gets due_probe_count
public
getDueProbeCount() : int
Return values
int —getExecutedAt()
Gets executed_at
public
getExecutedAt() : DateTime
Return values
DateTime —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRequestedMaxRuns()
Gets requested_max_runs
public
getRequestedMaxRuns() : int
Return values
int —getRunCount()
Gets run_count
public
getRunCount() : int
Return values
int —getSkippedCount()
Gets skipped_count
public
getSkippedCount() : int
Return values
int —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTriggerSource()
Gets trigger_source
public
getTriggerSource() : string
Return values
string —getTriggerSourceAllowableValues()
Gets allowable values of the enum
public
getTriggerSourceAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —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> —setDueProbeCount()
Sets due_probe_count
public
setDueProbeCount(int $due_probe_count) : self
Parameters
- $due_probe_count : int
-
due_probe_count
Return values
self —setExecutedAt()
Sets executed_at
public
setExecutedAt(DateTime $executed_at) : self
Parameters
- $executed_at : DateTime
-
executed_at
Return values
self —setRequestedMaxRuns()
Sets requested_max_runs
public
setRequestedMaxRuns(int $requested_max_runs) : self
Parameters
- $requested_max_runs : int
-
requested_max_runs
Return values
self —setRunCount()
Sets run_count
public
setRunCount(int $run_count) : self
Parameters
- $run_count : int
-
run_count
Return values
self —setSkippedCount()
Sets skipped_count
public
setSkippedCount(int $skipped_count) : self
Parameters
- $skipped_count : int
-
skipped_count
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> —setTriggerSource()
Sets trigger_source
public
setTriggerSource(string $trigger_source) : self
Parameters
- $trigger_source : string
-
trigger_source
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>