Documentation

DomainHealthEventDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

DomainHealthEventDto Class Doc Comment

Tags
category

Class

description

User-facing domain health event stored for a custom domain.

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

ACCOUNT_REGION_EU_WEST_1  = 'EU_WEST_1'
ACCOUNT_REGION_EU_WEST_1_ACCOUNT_BYTEWISE  = 'EU_WEST_1_ACCOUNT_BYTEWISE'
ACCOUNT_REGION_EU_WEST_1_ACCOUNT_SES_1  = 'EU_WEST_1_ACCOUNT_SES_1'
ACCOUNT_REGION_EU_WEST_1_ACCOUNT_SES_2  = 'EU_WEST_1_ACCOUNT_SES_2'
ACCOUNT_REGION_EU_WEST_1_ACCOUNT_STAGING  = 'EU_WEST_1_ACCOUNT_STAGING'
ACCOUNT_REGION_US_EAST_1  = 'US_EAST_1'
ACCOUNT_REGION_US_EAST_1_ACCOUNT_SES_1  = 'US_EAST_1_ACCOUNT_SES_1'
ACCOUNT_REGION_US_EAST_1_ACCOUNT_STAGING  = 'US_EAST_1_ACCOUNT_STAGING'
ACCOUNT_REGION_US_WEST_2  = 'US_WEST_2'
ACCOUNT_REGION_US_WEST_2_ACCOUNT_BYTEWISE  = 'US_WEST_2_ACCOUNT_BYTEWISE'
ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_1  = 'US_WEST_2_ACCOUNT_SES_1'
ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_2  = 'US_WEST_2_ACCOUNT_SES_2'
ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_3  = 'US_WEST_2_ACCOUNT_SES_3'
ACCOUNT_REGION_US_WEST_2_ACCOUNT_STAGING  = 'US_WEST_2_ACCOUNT_STAGING'
DISCRIMINATOR  = null
EVENT_TYPE_BIMI_RECORD_ISSUE  = 'BIMI_RECORD_ISSUE'
EVENT_TYPE_DKIM_RECORDS_MISSING  = 'DKIM_RECORDS_MISSING'
EVENT_TYPE_DKIM_SETUP_REVOKED  = 'DKIM_SETUP_REVOKED'
EVENT_TYPE_DKIM_VERIFICATION_FAILED  = 'DKIM_VERIFICATION_FAILED'
EVENT_TYPE_DMARC_RECORD_ISSUE  = 'DMARC_RECORD_ISSUE'
EVENT_TYPE_DOMAIN_AUTHENTICATION_ISSUE  = 'DOMAIN_AUTHENTICATION_ISSUE'
EVENT_TYPE_SENDING_DISABLED  = 'SENDING_DISABLED'
EVENT_TYPE_SENDING_ENABLED  = 'SENDING_ENABLED'
EVENT_TYPE_SPF_RECORD_ISSUE  = 'SPF_RECORD_ISSUE'
SEVERITY_CRITICAL  = 'CRITICAL'
SEVERITY_INFO  = 'INFO'
SEVERITY_WARNING  = 'WARNING'
STATUS_OPEN  = 'OPEN'
STATUS_RESOLVED  = 'RESOLVED'
$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
getAccountRegion()  : string|null
Gets account_region
getAccountRegionAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCreatedAt()  : DateTime
Gets created_at
getDomainId()  : string|null
Gets domain_id
getDomainName()  : string|null
Gets domain_name
getEventTime()  : DateTime
Gets event_time
getEventType()  : string
Gets event_type
getEventTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getId()  : string
Gets id
getMessage()  : string
Gets message
getModelName()  : string
The original name of the model.
getRecommendation()  : string|null
Gets recommendation
getSeverity()  : string
Gets severity
getSeverityAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
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)
getTitle()  : string
Gets title
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
setAccountRegion()  : self
Sets account_region
setCreatedAt()  : self
Sets created_at
setDomainId()  : self
Sets domain_id
setDomainName()  : self
Sets domain_name
setEventTime()  : self
Sets event_time
setEventType()  : self
Sets event_type
setId()  : self
Sets id
setMessage()  : self
Sets message
setRecommendation()  : self
Sets recommendation
setSeverity()  : self
Sets severity
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTitle()  : self
Sets title
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

ACCOUNT_REGION_EU_WEST_1_ACCOUNT_BYTEWISE

public mixed ACCOUNT_REGION_EU_WEST_1_ACCOUNT_BYTEWISE = 'EU_WEST_1_ACCOUNT_BYTEWISE'

ACCOUNT_REGION_EU_WEST_1_ACCOUNT_SES_1

public mixed ACCOUNT_REGION_EU_WEST_1_ACCOUNT_SES_1 = 'EU_WEST_1_ACCOUNT_SES_1'

ACCOUNT_REGION_EU_WEST_1_ACCOUNT_SES_2

public mixed ACCOUNT_REGION_EU_WEST_1_ACCOUNT_SES_2 = 'EU_WEST_1_ACCOUNT_SES_2'

ACCOUNT_REGION_EU_WEST_1_ACCOUNT_STAGING

public mixed ACCOUNT_REGION_EU_WEST_1_ACCOUNT_STAGING = 'EU_WEST_1_ACCOUNT_STAGING'

ACCOUNT_REGION_US_EAST_1_ACCOUNT_SES_1

public mixed ACCOUNT_REGION_US_EAST_1_ACCOUNT_SES_1 = 'US_EAST_1_ACCOUNT_SES_1'

ACCOUNT_REGION_US_EAST_1_ACCOUNT_STAGING

public mixed ACCOUNT_REGION_US_EAST_1_ACCOUNT_STAGING = 'US_EAST_1_ACCOUNT_STAGING'

ACCOUNT_REGION_US_WEST_2_ACCOUNT_BYTEWISE

public mixed ACCOUNT_REGION_US_WEST_2_ACCOUNT_BYTEWISE = 'US_WEST_2_ACCOUNT_BYTEWISE'

ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_1

public mixed ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_1 = 'US_WEST_2_ACCOUNT_SES_1'

ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_2

public mixed ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_2 = 'US_WEST_2_ACCOUNT_SES_2'

ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_3

public mixed ACCOUNT_REGION_US_WEST_2_ACCOUNT_SES_3 = 'US_WEST_2_ACCOUNT_SES_3'

ACCOUNT_REGION_US_WEST_2_ACCOUNT_STAGING

public mixed ACCOUNT_REGION_US_WEST_2_ACCOUNT_STAGING = 'US_WEST_2_ACCOUNT_STAGING'

EVENT_TYPE_BIMI_RECORD_ISSUE

public mixed EVENT_TYPE_BIMI_RECORD_ISSUE = 'BIMI_RECORD_ISSUE'

EVENT_TYPE_DKIM_RECORDS_MISSING

public mixed EVENT_TYPE_DKIM_RECORDS_MISSING = 'DKIM_RECORDS_MISSING'

EVENT_TYPE_DKIM_SETUP_REVOKED

public mixed EVENT_TYPE_DKIM_SETUP_REVOKED = 'DKIM_SETUP_REVOKED'

EVENT_TYPE_DKIM_VERIFICATION_FAILED

public mixed EVENT_TYPE_DKIM_VERIFICATION_FAILED = 'DKIM_VERIFICATION_FAILED'

EVENT_TYPE_DMARC_RECORD_ISSUE

public mixed EVENT_TYPE_DMARC_RECORD_ISSUE = 'DMARC_RECORD_ISSUE'

EVENT_TYPE_DOMAIN_AUTHENTICATION_ISSUE

public mixed EVENT_TYPE_DOMAIN_AUTHENTICATION_ISSUE = 'DOMAIN_AUTHENTICATION_ISSUE'

EVENT_TYPE_SENDING_DISABLED

public mixed EVENT_TYPE_SENDING_DISABLED = 'SENDING_DISABLED'

EVENT_TYPE_SPF_RECORD_ISSUE

public mixed EVENT_TYPE_SPF_RECORD_ISSUE = 'SPF_RECORD_ISSUE'

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', 'domain_id' => 'domainId', 'domain_name' => 'domainName', 'account_region' => 'accountRegion', 'event_type' => 'eventType', 'status' => 'status', 'severity' => 'severity', 'title' => 'title', 'message' => 'message', 'recommendation' => 'recommendation', 'event_time' => 'eventTime', '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', 'domain_id' => 'getDomainId', 'domain_name' => 'getDomainName', 'account_region' => 'getAccountRegion', 'event_type' => 'getEventType', 'status' => 'getStatus', 'severity' => 'getSeverity', 'title' => 'getTitle', 'message' => 'getMessage', 'recommendation' => 'getRecommendation', 'event_time' => 'getEventTime', 'created_at' => 'getCreatedAt']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['id' => 'uuid', 'domain_id' => 'uuid', 'domain_name' => null, 'account_region' => null, 'event_type' => null, 'status' => null, 'severity' => null, 'title' => null, 'message' => null, 'recommendation' => null, 'event_time' => 'date-time', 'created_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 = 'DomainHealthEventDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['id' => false, 'domain_id' => true, 'domain_name' => true, 'account_region' => true, 'event_type' => false, 'status' => false, 'severity' => false, 'title' => false, 'message' => false, 'recommendation' => true, 'event_time' => false, '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', 'domain_id' => 'string', 'domain_name' => 'string', 'account_region' => 'string', 'event_type' => 'string', 'status' => 'string', 'severity' => 'string', 'title' => 'string', 'message' => 'string', 'recommendation' => 'string', 'event_time' => '\\DateTime', 'created_at' => '\\DateTime']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['id' => 'setId', 'domain_id' => 'setDomainId', 'domain_name' => 'setDomainName', 'account_region' => 'setAccountRegion', 'event_type' => 'setEventType', 'status' => 'setStatus', 'severity' => 'setSeverity', 'title' => 'setTitle', 'message' => 'setMessage', 'recommendation' => 'setRecommendation', 'event_time' => 'setEventTime', '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> —

getAccountRegion()

Gets account_region

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

getAccountRegionAllowableValues()

Gets allowable values of the enum

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

getCreatedAt()

Gets created_at

public getCreatedAt() : DateTime
Return values
DateTime —

getDomainId()

Gets domain_id

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

getDomainName()

Gets domain_name

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

getEventTime()

Gets event_time

public getEventTime() : DateTime
Return values
DateTime —

getEventTypeAllowableValues()

Gets allowable values of the enum

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getRecommendation()

Gets recommendation

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

getSeverityAllowableValues()

Gets allowable values of the enum

public getSeverityAllowableValues() : array<string|int, string>
Return values
array<string|int, 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> —

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

setAccountRegion()

Sets account_region

public setAccountRegion(string|null $account_region) : self
Parameters
$account_region : string|null

account_region

Return values
self —

setCreatedAt()

Sets created_at

public setCreatedAt(DateTime $created_at) : self
Parameters
$created_at : DateTime

created_at

Return values
self —

setDomainId()

Sets domain_id

public setDomainId(string|null $domain_id) : self
Parameters
$domain_id : string|null

domain_id

Return values
self —

setDomainName()

Sets domain_name

public setDomainName(string|null $domain_name) : self
Parameters
$domain_name : string|null

domain_name

Return values
self —

setEventTime()

Sets event_time

public setEventTime(DateTime $event_time) : self
Parameters
$event_time : DateTime

event_time

Return values
self —

setEventType()

Sets event_type

public setEventType(string $event_type) : self
Parameters
$event_type : string

event_type

Return values
self —

setId()

Sets id

public setId(string $id) : self
Parameters
$id : string

id

Return values
self —

setMessage()

Sets message

public setMessage(string $message) : self
Parameters
$message : string

message

Return values
self —

setRecommendation()

Sets recommendation

public setRecommendation(string|null $recommendation) : self
Parameters
$recommendation : string|null

recommendation

Return values
self —

setSeverity()

Sets severity

public setSeverity(string $severity) : self
Parameters
$severity : string

severity

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

setTitle()

Sets title

public setTitle(string $title) : self
Parameters
$title : string

title

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