Documentation

CheckDomainMonitorResults
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CheckDomainMonitorResults Class Doc Comment

Tags
category

Class

description

One-shot public domain monitor check results

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
STATUS_CRITICAL  = 'CRITICAL'
STATUS_DEGRADED  = 'DEGRADED'
STATUS_FAILED  = 'FAILED'
STATUS_HEALTHY  = 'HEALTHY'
$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
getBimiOk()  : bool
Gets bimi_ok
getBlacklistChecked()  : bool
Gets blacklist_checked
getBlacklistListed()  : bool
Gets blacklist_listed
getBlacklistOk()  : bool
Gets blacklist_ok
getDkimOk()  : bool
Gets dkim_ok
getDmarcEnforced()  : bool
Gets dmarc_enforced
getDmarcOk()  : bool
Gets dmarc_ok
getDomain()  : string
Gets domain
getErrorMessage()  : string|null
Gets error_message
getFailingChecks()  : int
Gets failing_checks
getHealthScore()  : int
Gets health_score
getInsights()  : array<string|int, string>
Gets insights
getModelName()  : string
The original name of the model.
getMtaStsOk()  : bool
Gets mta_sts_ok
getMxOk()  : bool
Gets mx_ok
getPassingChecks()  : int
Gets passing_checks
getSpfOk()  : bool
Gets spf_ok
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)
getTlsReportingOk()  : bool
Gets tls_reporting_ok
getTotalChecks()  : int
Gets total_checks
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
setBimiOk()  : self
Sets bimi_ok
setBlacklistChecked()  : self
Sets blacklist_checked
setBlacklistListed()  : self
Sets blacklist_listed
setBlacklistOk()  : self
Sets blacklist_ok
setDkimOk()  : self
Sets dkim_ok
setDmarcEnforced()  : self
Sets dmarc_enforced
setDmarcOk()  : self
Sets dmarc_ok
setDomain()  : self
Sets domain
setErrorMessage()  : self
Sets error_message
setFailingChecks()  : self
Sets failing_checks
setHealthScore()  : self
Sets health_score
setInsights()  : self
Sets insights
setMtaStsOk()  : self
Sets mta_sts_ok
setMxOk()  : self
Sets mx_ok
setPassingChecks()  : self
Sets passing_checks
setSpfOk()  : self
Sets spf_ok
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTlsReportingOk()  : self
Sets tls_reporting_ok
setTotalChecks()  : self
Sets total_checks
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 = ['domain' => 'domain', 'status' => 'status', 'health_score' => 'healthScore', 'total_checks' => 'totalChecks', 'passing_checks' => 'passingChecks', 'failing_checks' => 'failingChecks', 'spf_ok' => 'spfOk', 'dmarc_ok' => 'dmarcOk', 'dmarc_enforced' => 'dmarcEnforced', 'mx_ok' => 'mxOk', 'dkim_ok' => 'dkimOk', 'bimi_ok' => 'bimiOk', 'mta_sts_ok' => 'mtaStsOk', 'tls_reporting_ok' => 'tlsReportingOk', 'blacklist_checked' => 'blacklistChecked', 'blacklist_ok' => 'blacklistOk', 'blacklist_listed' => 'blacklistListed', 'insights' => 'insights', 'error_message' => 'errorMessage']

$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 = ['domain' => 'getDomain', 'status' => 'getStatus', 'health_score' => 'getHealthScore', 'total_checks' => 'getTotalChecks', 'passing_checks' => 'getPassingChecks', 'failing_checks' => 'getFailingChecks', 'spf_ok' => 'getSpfOk', 'dmarc_ok' => 'getDmarcOk', 'dmarc_enforced' => 'getDmarcEnforced', 'mx_ok' => 'getMxOk', 'dkim_ok' => 'getDkimOk', 'bimi_ok' => 'getBimiOk', 'mta_sts_ok' => 'getMtaStsOk', 'tls_reporting_ok' => 'getTlsReportingOk', 'blacklist_checked' => 'getBlacklistChecked', 'blacklist_ok' => 'getBlacklistOk', 'blacklist_listed' => 'getBlacklistListed', 'insights' => 'getInsights', 'error_message' => 'getErrorMessage']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['domain' => null, 'status' => null, 'health_score' => 'int32', 'total_checks' => 'int32', 'passing_checks' => 'int32', 'failing_checks' => 'int32', 'spf_ok' => null, 'dmarc_ok' => null, 'dmarc_enforced' => null, 'mx_ok' => null, 'dkim_ok' => null, 'bimi_ok' => null, 'mta_sts_ok' => null, 'tls_reporting_ok' => null, 'blacklist_checked' => null, 'blacklist_ok' => null, 'blacklist_listed' => null, 'insights' => null, 'error_message' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'CheckDomainMonitorResults'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['domain' => false, 'status' => false, 'health_score' => false, 'total_checks' => false, 'passing_checks' => false, 'failing_checks' => false, 'spf_ok' => false, 'dmarc_ok' => false, 'dmarc_enforced' => false, 'mx_ok' => false, 'dkim_ok' => false, 'bimi_ok' => false, 'mta_sts_ok' => false, 'tls_reporting_ok' => false, 'blacklist_checked' => false, 'blacklist_ok' => false, 'blacklist_listed' => false, 'insights' => false, 'error_message' => true]

$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 = ['domain' => 'string', 'status' => 'string', 'health_score' => 'int', 'total_checks' => 'int', 'passing_checks' => 'int', 'failing_checks' => 'int', 'spf_ok' => 'bool', 'dmarc_ok' => 'bool', 'dmarc_enforced' => 'bool', 'mx_ok' => 'bool', 'dkim_ok' => 'bool', 'bimi_ok' => 'bool', 'mta_sts_ok' => 'bool', 'tls_reporting_ok' => 'bool', 'blacklist_checked' => 'bool', 'blacklist_ok' => 'bool', 'blacklist_listed' => 'bool', 'insights' => 'string[]', 'error_message' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['domain' => 'setDomain', 'status' => 'setStatus', 'health_score' => 'setHealthScore', 'total_checks' => 'setTotalChecks', 'passing_checks' => 'setPassingChecks', 'failing_checks' => 'setFailingChecks', 'spf_ok' => 'setSpfOk', 'dmarc_ok' => 'setDmarcOk', 'dmarc_enforced' => 'setDmarcEnforced', 'mx_ok' => 'setMxOk', 'dkim_ok' => 'setDkimOk', 'bimi_ok' => 'setBimiOk', 'mta_sts_ok' => 'setMtaStsOk', 'tls_reporting_ok' => 'setTlsReportingOk', 'blacklist_checked' => 'setBlacklistChecked', 'blacklist_ok' => 'setBlacklistOk', 'blacklist_listed' => 'setBlacklistListed', 'insights' => 'setInsights', 'error_message' => 'setErrorMessage']

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

getInsights()

Gets insights

public getInsights() : 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> —

setBimiOk()

Sets bimi_ok

public setBimiOk(bool $bimi_ok) : self
Parameters
$bimi_ok : bool

bimi_ok

Return values
self —

setBlacklistChecked()

Sets blacklist_checked

public setBlacklistChecked(bool $blacklist_checked) : self
Parameters
$blacklist_checked : bool

blacklist_checked

Return values
self —

setBlacklistListed()

Sets blacklist_listed

public setBlacklistListed(bool $blacklist_listed) : self
Parameters
$blacklist_listed : bool

blacklist_listed

Return values
self —

setBlacklistOk()

Sets blacklist_ok

public setBlacklistOk(bool $blacklist_ok) : self
Parameters
$blacklist_ok : bool

blacklist_ok

Return values
self —

setDkimOk()

Sets dkim_ok

public setDkimOk(bool $dkim_ok) : self
Parameters
$dkim_ok : bool

dkim_ok

Return values
self —

setDmarcEnforced()

Sets dmarc_enforced

public setDmarcEnforced(bool $dmarc_enforced) : self
Parameters
$dmarc_enforced : bool

dmarc_enforced

Return values
self —

setDmarcOk()

Sets dmarc_ok

public setDmarcOk(bool $dmarc_ok) : self
Parameters
$dmarc_ok : bool

dmarc_ok

Return values
self —

setDomain()

Sets domain

public setDomain(string $domain) : self
Parameters
$domain : string

domain

Return values
self —

setErrorMessage()

Sets error_message

public setErrorMessage(string|null $error_message) : self
Parameters
$error_message : string|null

error_message

Return values
self —

setFailingChecks()

Sets failing_checks

public setFailingChecks(int $failing_checks) : self
Parameters
$failing_checks : int

failing_checks

Return values
self —

setHealthScore()

Sets health_score

public setHealthScore(int $health_score) : self
Parameters
$health_score : int

health_score

Return values
self —

setInsights()

Sets insights

public setInsights(array<string|int, string> $insights) : self
Parameters
$insights : array<string|int, string>

insights

Return values
self —

setMtaStsOk()

Sets mta_sts_ok

public setMtaStsOk(bool $mta_sts_ok) : self
Parameters
$mta_sts_ok : bool

mta_sts_ok

Return values
self —

setMxOk()

Sets mx_ok

public setMxOk(bool $mx_ok) : self
Parameters
$mx_ok : bool

mx_ok

Return values
self —

setPassingChecks()

Sets passing_checks

public setPassingChecks(int $passing_checks) : self
Parameters
$passing_checks : int

passing_checks

Return values
self —

setSpfOk()

Sets spf_ok

public setSpfOk(bool $spf_ok) : self
Parameters
$spf_ok : bool

spf_ok

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

setTlsReportingOk()

Sets tls_reporting_ok

public setTlsReportingOk(bool $tls_reporting_ok) : self
Parameters
$tls_reporting_ok : bool

tls_reporting_ok

Return values
self —

setTotalChecks()

Sets total_checks

public setTotalChecks(int $total_checks) : self
Parameters
$total_checks : int

total_checks

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