CampaignProbeDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
CampaignProbeDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- LAST_RUN_STATUS_FAILED = 'FAILED'
- LAST_RUN_STATUS_HEALTHY = 'HEALTHY'
- LAST_RUN_STATUS_WARNING = 'WARNING'
- $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
- getEmailAddress() : string
- Gets email_address
- getEnabled() : bool
- Gets enabled
- getId() : string
- Gets id
- getIntervalSeconds() : int|null
- Gets interval_seconds
- getLastHealthScore() : int|null
- Gets last_health_score
- getLastIngestAt() : DateTime|null
- Gets last_ingest_at
- getLastRunStatus() : string|null
- Gets last_run_status
- getLastRunStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getLocalPart() : string
- Gets local_part
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getNextRunAt() : DateTime|null
- Gets next_run_at
- getSchedulingEnabled() : bool
- Gets scheduling_enabled
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTotalIngestCount() : int
- Gets total_ingest_count
- 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
- setEmailAddress() : self
- Sets email_address
- setEnabled() : self
- Sets enabled
- setId() : self
- Sets id
- setIntervalSeconds() : self
- Sets interval_seconds
- setLastHealthScore() : self
- Sets last_health_score
- setLastIngestAt() : self
- Sets last_ingest_at
- setLastRunStatus() : self
- Sets last_run_status
- setLocalPart() : self
- Sets local_part
- setName() : self
- Sets name
- setNextRunAt() : self
- Sets next_run_at
- setSchedulingEnabled() : self
- Sets scheduling_enabled
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTotalIngestCount() : self
- Sets total_ingest_count
- 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
LAST_RUN_STATUS_FAILED
public
mixed
LAST_RUN_STATUS_FAILED
= 'FAILED'
LAST_RUN_STATUS_HEALTHY
public
mixed
LAST_RUN_STATUS_HEALTHY
= 'HEALTHY'
LAST_RUN_STATUS_WARNING
public
mixed
LAST_RUN_STATUS_WARNING
= 'WARNING'
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', 'name' => 'name', 'local_part' => 'localPart', 'email_address' => 'emailAddress', 'enabled' => 'enabled', 'interval_seconds' => 'intervalSeconds', 'scheduling_enabled' => 'schedulingEnabled', 'next_run_at' => 'nextRunAt', 'last_run_status' => 'lastRunStatus', 'last_health_score' => 'lastHealthScore', 'last_ingest_at' => 'lastIngestAt', 'total_ingest_count' => 'totalIngestCount', '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', 'name' => 'getName', 'local_part' => 'getLocalPart', 'email_address' => 'getEmailAddress', 'enabled' => 'getEnabled', 'interval_seconds' => 'getIntervalSeconds', 'scheduling_enabled' => 'getSchedulingEnabled', 'next_run_at' => 'getNextRunAt', 'last_run_status' => 'getLastRunStatus', 'last_health_score' => 'getLastHealthScore', 'last_ingest_at' => 'getLastIngestAt', 'total_ingest_count' => 'getTotalIngestCount', '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', 'name' => null, 'local_part' => null, 'email_address' => null, 'enabled' => null, 'interval_seconds' => 'int64', 'scheduling_enabled' => null, 'next_run_at' => 'date-time', 'last_run_status' => null, 'last_health_score' => 'int32', 'last_ingest_at' => 'date-time', 'total_ingest_count' => 'int64', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'CampaignProbeDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'user_id' => false, 'name' => true, 'local_part' => false, 'email_address' => false, 'enabled' => false, 'interval_seconds' => true, 'scheduling_enabled' => false, 'next_run_at' => true, 'last_run_status' => true, 'last_health_score' => true, 'last_ingest_at' => true, 'total_ingest_count' => 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', 'name' => 'string', 'local_part' => 'string', 'email_address' => 'string', 'enabled' => 'bool', 'interval_seconds' => 'int', 'scheduling_enabled' => 'bool', 'next_run_at' => '\\DateTime', 'last_run_status' => 'string', 'last_health_score' => 'int', 'last_ingest_at' => '\\DateTime', 'total_ingest_count' => 'int', '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', 'name' => 'setName', 'local_part' => 'setLocalPart', 'email_address' => 'setEmailAddress', 'enabled' => 'setEnabled', 'interval_seconds' => 'setIntervalSeconds', 'scheduling_enabled' => 'setSchedulingEnabled', 'next_run_at' => 'setNextRunAt', 'last_run_status' => 'setLastRunStatus', 'last_health_score' => 'setLastHealthScore', 'last_ingest_at' => 'setLastIngestAt', 'total_ingest_count' => 'setTotalIngestCount', '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 —getEmailAddress()
Gets email_address
public
getEmailAddress() : string
Return values
string —getEnabled()
Gets enabled
public
getEnabled() : bool
Return values
bool —getId()
Gets id
public
getId() : string
Return values
string —getIntervalSeconds()
Gets interval_seconds
public
getIntervalSeconds() : int|null
Return values
int|null —getLastHealthScore()
Gets last_health_score
public
getLastHealthScore() : int|null
Return values
int|null —getLastIngestAt()
Gets last_ingest_at
public
getLastIngestAt() : DateTime|null
Return values
DateTime|null —getLastRunStatus()
Gets last_run_status
public
getLastRunStatus() : string|null
Return values
string|null —getLastRunStatusAllowableValues()
Gets allowable values of the enum
public
getLastRunStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getLocalPart()
Gets local_part
public
getLocalPart() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getNextRunAt()
Gets next_run_at
public
getNextRunAt() : DateTime|null
Return values
DateTime|null —getSchedulingEnabled()
Gets scheduling_enabled
public
getSchedulingEnabled() : bool
Return values
bool —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTotalIngestCount()
Gets total_ingest_count
public
getTotalIngestCount() : int
Return values
int —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 —setEmailAddress()
Sets email_address
public
setEmailAddress(string $email_address) : self
Parameters
- $email_address : string
-
email_address
Return values
self —setEnabled()
Sets enabled
public
setEnabled(bool $enabled) : self
Parameters
- $enabled : bool
-
enabled
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setIntervalSeconds()
Sets interval_seconds
public
setIntervalSeconds(int|null $interval_seconds) : self
Parameters
- $interval_seconds : int|null
-
interval_seconds
Return values
self —setLastHealthScore()
Sets last_health_score
public
setLastHealthScore(int|null $last_health_score) : self
Parameters
- $last_health_score : int|null
-
last_health_score
Return values
self —setLastIngestAt()
Sets last_ingest_at
public
setLastIngestAt(DateTime|null $last_ingest_at) : self
Parameters
- $last_ingest_at : DateTime|null
-
last_ingest_at
Return values
self —setLastRunStatus()
Sets last_run_status
public
setLastRunStatus(string|null $last_run_status) : self
Parameters
- $last_run_status : string|null
-
last_run_status
Return values
self —setLocalPart()
Sets local_part
public
setLocalPart(string $local_part) : self
Parameters
- $local_part : string
-
local_part
Return values
self —setName()
Sets name
public
setName(string|null $name) : self
Parameters
- $name : string|null
-
name
Return values
self —setNextRunAt()
Sets next_run_at
public
setNextRunAt(DateTime|null $next_run_at) : self
Parameters
- $next_run_at : DateTime|null
-
next_run_at
Return values
self —setSchedulingEnabled()
Sets scheduling_enabled
public
setSchedulingEnabled(bool $scheduling_enabled) : self
Parameters
- $scheduling_enabled : bool
-
scheduling_enabled
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> —setTotalIngestCount()
Sets total_ingest_count
public
setTotalIngestCount(int $total_ingest_count) : self
Parameters
- $total_ingest_count : int
-
total_ingest_count
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>