Documentation

DevicePreviewRunDtoQaBundle
in package
implements ModelInterface, ArrayAccess, JsonSerializable

DevicePreviewRunDtoQaBundle Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Table of Contents

DISCRIMINATOR  = null
DOMAIN_MONITOR_STATUS_COMPLETE  = 'COMPLETE'
DOMAIN_MONITOR_STATUS_FAILED  = 'FAILED'
DOMAIN_MONITOR_STATUS_NOT_REQUESTED  = 'NOT_REQUESTED'
DOMAIN_MONITOR_STATUS_PENDING  = 'PENDING'
DOMAIN_MONITOR_STATUS_SKIPPED  = 'SKIPPED'
EMAIL_AUDIT_STATUS_COMPLETE  = 'COMPLETE'
EMAIL_AUDIT_STATUS_FAILED  = 'FAILED'
EMAIL_AUDIT_STATUS_NOT_REQUESTED  = 'NOT_REQUESTED'
EMAIL_AUDIT_STATUS_PENDING  = 'PENDING'
EMAIL_AUDIT_STATUS_SKIPPED  = 'SKIPPED'
STATUS_COMPLETE  = 'COMPLETE'
STATUS_COMPLETE_WITH_ERRORS  = 'COMPLETE_WITH_ERRORS'
STATUS_COMPLETE_WITH_SKIPS  = 'COMPLETE_WITH_SKIPS'
STATUS_PENDING  = 'PENDING'
$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
getDomainMonitorId()  : string|null
Gets domain_monitor_id
getDomainMonitorMessage()  : string|null
Gets domain_monitor_message
getDomainMonitorRunId()  : string|null
Gets domain_monitor_run_id
getDomainMonitorStatus()  : string
Gets domain_monitor_status
getDomainMonitorStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getEmailAuditId()  : string|null
Gets email_audit_id
getEmailAuditMessage()  : string|null
Gets email_audit_message
getEmailAuditStatus()  : string
Gets email_audit_status
getEmailAuditStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getId()  : string
Gets id
getModelName()  : string
The original name of the model.
getRequestedDomainMonitor()  : bool
Gets requested_domain_monitor
getRequestedEmailAudit()  : bool
Gets requested_email_audit
getRunId()  : string
Gets run_id
getSenderDomain()  : string|null
Gets sender_domain
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)
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
setDomainMonitorId()  : self
Sets domain_monitor_id
setDomainMonitorMessage()  : self
Sets domain_monitor_message
setDomainMonitorRunId()  : self
Sets domain_monitor_run_id
setDomainMonitorStatus()  : self
Sets domain_monitor_status
setEmailAuditId()  : self
Sets email_audit_id
setEmailAuditMessage()  : self
Sets email_audit_message
setEmailAuditStatus()  : self
Sets email_audit_status
setId()  : self
Sets id
setRequestedDomainMonitor()  : self
Sets requested_domain_monitor
setRequestedEmailAudit()  : self
Sets requested_email_audit
setRunId()  : self
Sets run_id
setSenderDomain()  : self
Sets sender_domain
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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

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', 'run_id' => 'runId', 'user_id' => 'userId', 'requested_email_audit' => 'requestedEmailAudit', 'requested_domain_monitor' => 'requestedDomainMonitor', 'status' => 'status', 'email_audit_status' => 'emailAuditStatus', 'domain_monitor_status' => 'domainMonitorStatus', 'email_audit_id' => 'emailAuditId', 'domain_monitor_id' => 'domainMonitorId', 'domain_monitor_run_id' => 'domainMonitorRunId', 'sender_domain' => 'senderDomain', 'email_audit_message' => 'emailAuditMessage', 'domain_monitor_message' => 'domainMonitorMessage', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['id' => 'getId', 'run_id' => 'getRunId', 'user_id' => 'getUserId', 'requested_email_audit' => 'getRequestedEmailAudit', 'requested_domain_monitor' => 'getRequestedDomainMonitor', 'status' => 'getStatus', 'email_audit_status' => 'getEmailAuditStatus', 'domain_monitor_status' => 'getDomainMonitorStatus', 'email_audit_id' => 'getEmailAuditId', 'domain_monitor_id' => 'getDomainMonitorId', 'domain_monitor_run_id' => 'getDomainMonitorRunId', 'sender_domain' => 'getSenderDomain', 'email_audit_message' => 'getEmailAuditMessage', 'domain_monitor_message' => 'getDomainMonitorMessage', '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', 'run_id' => 'uuid', 'user_id' => 'uuid', 'requested_email_audit' => null, 'requested_domain_monitor' => null, 'status' => null, 'email_audit_status' => null, 'domain_monitor_status' => null, 'email_audit_id' => 'uuid', 'domain_monitor_id' => 'uuid', 'domain_monitor_run_id' => 'uuid', 'sender_domain' => null, 'email_audit_message' => null, 'domain_monitor_message' => null, 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'DevicePreviewRunDto_qaBundle'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'run_id' => false, 'user_id' => false, 'requested_email_audit' => false, 'requested_domain_monitor' => false, 'status' => false, 'email_audit_status' => false, 'domain_monitor_status' => false, 'email_audit_id' => true, 'domain_monitor_id' => true, 'domain_monitor_run_id' => true, 'sender_domain' => true, 'email_audit_message' => true, 'domain_monitor_message' => true, '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', 'run_id' => 'string', 'user_id' => 'string', 'requested_email_audit' => 'bool', 'requested_domain_monitor' => 'bool', 'status' => 'string', 'email_audit_status' => 'string', 'domain_monitor_status' => 'string', 'email_audit_id' => 'string', 'domain_monitor_id' => 'string', 'domain_monitor_run_id' => 'string', 'sender_domain' => 'string', 'email_audit_message' => 'string', 'domain_monitor_message' => 'string', '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', 'run_id' => 'setRunId', 'user_id' => 'setUserId', 'requested_email_audit' => 'setRequestedEmailAudit', 'requested_domain_monitor' => 'setRequestedDomainMonitor', 'status' => 'setStatus', 'email_audit_status' => 'setEmailAuditStatus', 'domain_monitor_status' => 'setDomainMonitorStatus', 'email_audit_id' => 'setEmailAuditId', 'domain_monitor_id' => 'setDomainMonitorId', 'domain_monitor_run_id' => 'setDomainMonitorRunId', 'sender_domain' => 'setSenderDomain', 'email_audit_message' => 'setEmailAuditMessage', 'domain_monitor_message' => 'setDomainMonitorMessage', '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 —

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> —

getDomainMonitorId()

Gets domain_monitor_id

public getDomainMonitorId() : string|null
Return values
string|null —

getDomainMonitorMessage()

Gets domain_monitor_message

public getDomainMonitorMessage() : string|null
Return values
string|null —

getDomainMonitorRunId()

Gets domain_monitor_run_id

public getDomainMonitorRunId() : string|null
Return values
string|null —

getDomainMonitorStatus()

Gets domain_monitor_status

public getDomainMonitorStatus() : string
Return values
string —

getDomainMonitorStatusAllowableValues()

Gets allowable values of the enum

public getDomainMonitorStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getEmailAuditMessage()

Gets email_audit_message

public getEmailAuditMessage() : string|null
Return values
string|null —

getEmailAuditStatusAllowableValues()

Gets allowable values of the enum

public getEmailAuditStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getRequestedDomainMonitor()

Gets requested_domain_monitor

public getRequestedDomainMonitor() : bool
Return values
bool —

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> —

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 —

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 —

setDomainMonitorId()

Sets domain_monitor_id

public setDomainMonitorId(string|null $domain_monitor_id) : self
Parameters
$domain_monitor_id : string|null

domain_monitor_id

Return values
self —

setDomainMonitorMessage()

Sets domain_monitor_message

public setDomainMonitorMessage(string|null $domain_monitor_message) : self
Parameters
$domain_monitor_message : string|null

domain_monitor_message

Return values
self —

setDomainMonitorRunId()

Sets domain_monitor_run_id

public setDomainMonitorRunId(string|null $domain_monitor_run_id) : self
Parameters
$domain_monitor_run_id : string|null

domain_monitor_run_id

Return values
self —

setDomainMonitorStatus()

Sets domain_monitor_status

public setDomainMonitorStatus(string $domain_monitor_status) : self
Parameters
$domain_monitor_status : string

domain_monitor_status

Return values
self —

setEmailAuditId()

Sets email_audit_id

public setEmailAuditId(string|null $email_audit_id) : self
Parameters
$email_audit_id : string|null

email_audit_id

Return values
self —

setEmailAuditMessage()

Sets email_audit_message

public setEmailAuditMessage(string|null $email_audit_message) : self
Parameters
$email_audit_message : string|null

email_audit_message

Return values
self —

setEmailAuditStatus()

Sets email_audit_status

public setEmailAuditStatus(string $email_audit_status) : self
Parameters
$email_audit_status : string

email_audit_status

Return values
self —

setRequestedDomainMonitor()

Sets requested_domain_monitor

public setRequestedDomainMonitor(bool $requested_domain_monitor) : self
Parameters
$requested_domain_monitor : bool

requested_domain_monitor

Return values
self —

setRequestedEmailAudit()

Sets requested_email_audit

public setRequestedEmailAudit(bool $requested_email_audit) : self
Parameters
$requested_email_audit : bool

requested_email_audit

Return values
self —

setRunId()

Sets run_id

public setRunId(string $run_id) : self
Parameters
$run_id : string

run_id

Return values
self —

setSenderDomain()

Sets sender_domain

public setSenderDomain(string|null $sender_domain) : self
Parameters
$sender_domain : string|null

sender_domain

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> —

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>
Return values
void —

Search results