ScheduledJob
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
ScheduledJob Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- STATUS_ABORTED = 'ABORTED'
- STATUS_CANCELLED = 'CANCELLED'
- STATUS_COMPLETED = 'COMPLETED'
- STATUS_FAILED = 'FAILED'
- STATUS_SUBMITTED = 'SUBMITTED'
- $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
- getCreatedAt() : DateTime
- Gets created_at
- getGroupId() : string
- Gets group_id
- getId() : string
- Gets id
- getInboxId() : string
- Gets inbox_id
- getJobId() : string
- Gets job_id
- getModelName() : string
- The original name of the model.
- getSendAtTimestamp() : DateTime
- Gets send_at_timestamp
- getStatus() : string
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTriggerId() : string
- Gets trigger_id
- getUpdatedAt() : DateTime
- Gets updated_at
- getUserId() : string
- Gets user_id
- 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
- setCreatedAt() : self
- Sets created_at
- setGroupId() : self
- Sets group_id
- setId() : self
- Sets id
- setInboxId() : self
- Sets inbox_id
- setJobId() : self
- Sets job_id
- setSendAtTimestamp() : self
- Sets send_at_timestamp
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTriggerId() : self
- Sets trigger_id
- setUpdatedAt() : self
- Sets updated_at
- setUserId() : self
- Sets user_id
- 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
STATUS_ABORTED
public
mixed
STATUS_ABORTED
= 'ABORTED'
STATUS_CANCELLED
public
mixed
STATUS_CANCELLED
= 'CANCELLED'
STATUS_COMPLETED
public
mixed
STATUS_COMPLETED
= 'COMPLETED'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_SUBMITTED
public
mixed
STATUS_SUBMITTED
= 'SUBMITTED'
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', 'user_id' => 'userId', 'inbox_id' => 'inboxId', 'job_id' => 'jobId', 'group_id' => 'groupId', 'trigger_id' => 'triggerId', 'status' => 'status', 'send_at_timestamp' => 'sendAtTimestamp', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']
$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', 'user_id' => 'getUserId', 'inbox_id' => 'getInboxId', 'job_id' => 'getJobId', 'group_id' => 'getGroupId', 'trigger_id' => 'getTriggerId', 'status' => 'getStatus', 'send_at_timestamp' => 'getSendAtTimestamp', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'user_id' => 'uuid', 'inbox_id' => 'uuid', 'job_id' => null, 'group_id' => null, 'trigger_id' => null, 'status' => null, 'send_at_timestamp' => 'date-time', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'ScheduledJob'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'user_id' => false, 'inbox_id' => false, 'job_id' => false, 'group_id' => false, 'trigger_id' => false, 'status' => false, 'send_at_timestamp' => false, 'created_at' => false, 'updated_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', 'user_id' => 'string', 'inbox_id' => 'string', 'job_id' => 'string', 'group_id' => 'string', 'trigger_id' => 'string', 'status' => 'string', 'send_at_timestamp' => '\\DateTime', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'user_id' => 'setUserId', 'inbox_id' => 'setInboxId', 'job_id' => 'setJobId', 'group_id' => 'setGroupId', 'trigger_id' => 'setTriggerId', 'status' => 'setStatus', 'send_at_timestamp' => 'setSendAtTimestamp', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt']
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> —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getGroupId()
Gets group_id
public
getGroupId() : string
Return values
string —getId()
Gets id
public
getId() : string
Return values
string —getInboxId()
Gets inbox_id
public
getInboxId() : string
Return values
string —getJobId()
Gets job_id
public
getJobId() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getSendAtTimestamp()
Gets send_at_timestamp
public
getSendAtTimestamp() : DateTime
Return values
DateTime —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> —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTriggerId()
Gets trigger_id
public
getTriggerId() : string
Return values
string —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —getUserId()
Gets user_id
public
getUserId() : string
Return values
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> —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setGroupId()
Sets group_id
public
setGroupId(string $group_id) : self
Parameters
- $group_id : string
-
group_id
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setInboxId()
Sets inbox_id
public
setInboxId(string $inbox_id) : self
Parameters
- $inbox_id : string
-
inbox_id
Return values
self —setJobId()
Sets job_id
public
setJobId(string $job_id) : self
Parameters
- $job_id : string
-
job_id
Return values
self —setSendAtTimestamp()
Sets send_at_timestamp
public
setSendAtTimestamp(DateTime $send_at_timestamp) : self
Parameters
- $send_at_timestamp : DateTime
-
send_at_timestamp
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
status
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> —setTriggerId()
Sets trigger_id
public
setTriggerId(string $trigger_id) : self
Parameters
- $trigger_id : string
-
trigger_id
Return values
self —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
updated_at
Return values
self —setUserId()
Sets user_id
public
setUserId(string $user_id) : self
Parameters
- $user_id : string
-
user_id
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>