DeliverabilitySimulationJobEventDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DeliverabilitySimulationJobEventDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- EVENT_TYPE_JOB_CANCELLED = 'JOB_CANCELLED'
- EVENT_TYPE_JOB_COMPLETED = 'JOB_COMPLETED'
- EVENT_TYPE_JOB_CREATED = 'JOB_CREATED'
- EVENT_TYPE_JOB_FAILED = 'JOB_FAILED'
- EVENT_TYPE_JOB_PAUSED = 'JOB_PAUSED'
- EVENT_TYPE_JOB_RESUMED = 'JOB_RESUMED'
- EVENT_TYPE_JOB_STARTED = 'JOB_STARTED'
- EVENT_TYPE_SEND_FAILURE = 'SEND_FAILURE'
- EVENT_TYPE_SEND_SUCCESS = 'SEND_SUCCESS'
- $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
- getAttempt() : int|null
- Gets attempt
- getCreatedAt() : DateTime
- Gets created_at
- getEntityId() : string|null
- Gets entity_id
- getError() : string|null
- Gets error
- getEventType() : string
- Gets event_type
- getEventTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getExpectationName() : string|null
- Gets expectation_name
- getId() : string
- Gets id
- getMessage() : string|null
- Gets message
- getModelName() : string
- The original name of the model.
- getSendIndex() : int|null
- Gets send_index
- getTargetLabel() : string|null
- Gets target_label
- 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
- setAttempt() : self
- Sets attempt
- setCreatedAt() : self
- Sets created_at
- setEntityId() : self
- Sets entity_id
- setError() : self
- Sets error
- setEventType() : self
- Sets event_type
- setExpectationName() : self
- Sets expectation_name
- setId() : self
- Sets id
- setMessage() : self
- Sets message
- setSendIndex() : self
- Sets send_index
- setTargetLabel() : self
- Sets target_label
- 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
EVENT_TYPE_JOB_CANCELLED
public
mixed
EVENT_TYPE_JOB_CANCELLED
= 'JOB_CANCELLED'
EVENT_TYPE_JOB_COMPLETED
public
mixed
EVENT_TYPE_JOB_COMPLETED
= 'JOB_COMPLETED'
EVENT_TYPE_JOB_CREATED
public
mixed
EVENT_TYPE_JOB_CREATED
= 'JOB_CREATED'
EVENT_TYPE_JOB_FAILED
public
mixed
EVENT_TYPE_JOB_FAILED
= 'JOB_FAILED'
EVENT_TYPE_JOB_PAUSED
public
mixed
EVENT_TYPE_JOB_PAUSED
= 'JOB_PAUSED'
EVENT_TYPE_JOB_RESUMED
public
mixed
EVENT_TYPE_JOB_RESUMED
= 'JOB_RESUMED'
EVENT_TYPE_JOB_STARTED
public
mixed
EVENT_TYPE_JOB_STARTED
= 'JOB_STARTED'
EVENT_TYPE_SEND_FAILURE
public
mixed
EVENT_TYPE_SEND_FAILURE
= 'SEND_FAILURE'
EVENT_TYPE_SEND_SUCCESS
public
mixed
EVENT_TYPE_SEND_SUCCESS
= 'SEND_SUCCESS'
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
= ['id' => 'id', 'event_type' => 'eventType', 'send_index' => 'sendIndex', 'entity_id' => 'entityId', 'target_label' => 'targetLabel', 'expectation_name' => 'expectationName', 'attempt' => 'attempt', 'message' => 'message', 'error' => 'error', 'created_at' => 'createdAt']
$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
= ['id' => 'getId', 'event_type' => 'getEventType', 'send_index' => 'getSendIndex', 'entity_id' => 'getEntityId', 'target_label' => 'getTargetLabel', 'expectation_name' => 'getExpectationName', 'attempt' => 'getAttempt', 'message' => 'getMessage', 'error' => 'getError', 'created_at' => 'getCreatedAt']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'event_type' => null, 'send_index' => 'int64', 'entity_id' => 'uuid', 'target_label' => null, 'expectation_name' => null, 'attempt' => 'int32', 'message' => null, 'error' => null, 'created_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DeliverabilitySimulationJobEventDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'event_type' => false, 'send_index' => true, 'entity_id' => true, 'target_label' => true, 'expectation_name' => true, 'attempt' => true, 'message' => true, 'error' => true, 'created_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
= ['id' => 'string', 'event_type' => 'string', 'send_index' => 'int', 'entity_id' => 'string', 'target_label' => 'string', 'expectation_name' => 'string', 'attempt' => 'int', 'message' => 'string', 'error' => 'string', 'created_at' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'event_type' => 'setEventType', 'send_index' => 'setSendIndex', 'entity_id' => 'setEntityId', 'target_label' => 'setTargetLabel', 'expectation_name' => 'setExpectationName', 'attempt' => 'setAttempt', 'message' => 'setMessage', 'error' => 'setError', 'created_at' => 'setCreatedAt']
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> —getAttempt()
Gets attempt
public
getAttempt() : int|null
Return values
int|null —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getEntityId()
Gets entity_id
public
getEntityId() : string|null
Return values
string|null —getError()
Gets error
public
getError() : string|null
Return values
string|null —getEventType()
Gets event_type
public
getEventType() : string
Return values
string —getEventTypeAllowableValues()
Gets allowable values of the enum
public
getEventTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getExpectationName()
Gets expectation_name
public
getExpectationName() : string|null
Return values
string|null —getId()
Gets id
public
getId() : string
Return values
string —getMessage()
Gets message
public
getMessage() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getSendIndex()
Gets send_index
public
getSendIndex() : int|null
Return values
int|null —getTargetLabel()
Gets target_label
public
getTargetLabel() : 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> —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> —setAttempt()
Sets attempt
public
setAttempt(int|null $attempt) : self
Parameters
- $attempt : int|null
-
attempt
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setEntityId()
Sets entity_id
public
setEntityId(string|null $entity_id) : self
Parameters
- $entity_id : string|null
-
entity_id
Return values
self —setError()
Sets error
public
setError(string|null $error) : self
Parameters
- $error : string|null
-
error
Return values
self —setEventType()
Sets event_type
public
setEventType(string $event_type) : self
Parameters
- $event_type : string
-
event_type
Return values
self —setExpectationName()
Sets expectation_name
public
setExpectationName(string|null $expectation_name) : self
Parameters
- $expectation_name : string|null
-
expectation_name
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setMessage()
Sets message
public
setMessage(string|null $message) : self
Parameters
- $message : string|null
-
message
Return values
self —setSendIndex()
Sets send_index
public
setSendIndex(int|null $send_index) : self
Parameters
- $send_index : int|null
-
send_index
Return values
self —setTargetLabel()
Sets target_label
public
setTargetLabel(string|null $target_label) : self
Parameters
- $target_label : string|null
-
target_label
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>