Documentation

DomainMonitorInsightsDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

DomainMonitorInsightsDto 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
$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
getAttentionSignals()  : array<string|int, string>
Gets attention_signals
getAverageHealthScore()  : float
Gets average_health_score
getBefore()  : DateTime
Gets before
getBestHealthyStreak()  : int
Gets best_healthy_streak
getCriticalRuns()  : int
Gets critical_runs
getCurrentHealthyStreak()  : int
Gets current_healthy_streak
getDegradedRuns()  : int
Gets degraded_runs
getFailedRuns()  : int
Gets failed_runs
getGoodPerformanceSignals()  : array<string|int, string>
Gets good_performance_signals
getHealthyRuns()  : int
Gets healthy_runs
getLatestRun()  : DomainMonitorInsightsDtoLatestRun|null
Gets latest_run
getModelName()  : string
The original name of the model.
getMonitorId()  : string
Gets monitor_id
getSince()  : DateTime
Gets since
getSuccessRate()  : float
Gets success_rate
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTopFindings()  : array<string|int, string>
Gets top_findings
getTotalRuns()  : int
Gets total_runs
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
setAttentionSignals()  : self
Sets attention_signals
setAverageHealthScore()  : self
Sets average_health_score
setBefore()  : self
Sets before
setBestHealthyStreak()  : self
Sets best_healthy_streak
setCriticalRuns()  : self
Sets critical_runs
setCurrentHealthyStreak()  : self
Sets current_healthy_streak
setDegradedRuns()  : self
Sets degraded_runs
setFailedRuns()  : self
Sets failed_runs
setGoodPerformanceSignals()  : self
Sets good_performance_signals
setHealthyRuns()  : self
Sets healthy_runs
setLatestRun()  : self
Sets latest_run
setMonitorId()  : self
Sets monitor_id
setSince()  : self
Sets since
setSuccessRate()  : self
Sets success_rate
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTopFindings()  : self
Sets top_findings
setTotalRuns()  : self
Sets total_runs
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 = ['monitor_id' => 'monitorId', 'since' => 'since', 'before' => 'before', 'total_runs' => 'totalRuns', 'healthy_runs' => 'healthyRuns', 'degraded_runs' => 'degradedRuns', 'critical_runs' => 'criticalRuns', 'failed_runs' => 'failedRuns', 'success_rate' => 'successRate', 'average_health_score' => 'averageHealthScore', 'current_healthy_streak' => 'currentHealthyStreak', 'best_healthy_streak' => 'bestHealthyStreak', 'good_performance_signals' => 'goodPerformanceSignals', 'attention_signals' => 'attentionSignals', 'top_findings' => 'topFindings', 'latest_run' => 'latestRun']

$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 = ['monitor_id' => 'getMonitorId', 'since' => 'getSince', 'before' => 'getBefore', 'total_runs' => 'getTotalRuns', 'healthy_runs' => 'getHealthyRuns', 'degraded_runs' => 'getDegradedRuns', 'critical_runs' => 'getCriticalRuns', 'failed_runs' => 'getFailedRuns', 'success_rate' => 'getSuccessRate', 'average_health_score' => 'getAverageHealthScore', 'current_healthy_streak' => 'getCurrentHealthyStreak', 'best_healthy_streak' => 'getBestHealthyStreak', 'good_performance_signals' => 'getGoodPerformanceSignals', 'attention_signals' => 'getAttentionSignals', 'top_findings' => 'getTopFindings', 'latest_run' => 'getLatestRun']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['monitor_id' => 'uuid', 'since' => 'date-time', 'before' => 'date-time', 'total_runs' => 'int32', 'healthy_runs' => 'int32', 'degraded_runs' => 'int32', 'critical_runs' => 'int32', 'failed_runs' => 'int32', 'success_rate' => 'double', 'average_health_score' => 'double', 'current_healthy_streak' => 'int32', 'best_healthy_streak' => 'int32', 'good_performance_signals' => null, 'attention_signals' => null, 'top_findings' => null, 'latest_run' => 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 = 'DomainMonitorInsightsDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['monitor_id' => false, 'since' => false, 'before' => false, 'total_runs' => false, 'healthy_runs' => false, 'degraded_runs' => false, 'critical_runs' => false, 'failed_runs' => false, 'success_rate' => false, 'average_health_score' => false, 'current_healthy_streak' => false, 'best_healthy_streak' => false, 'good_performance_signals' => false, 'attention_signals' => false, 'top_findings' => false, 'latest_run' => 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 = ['monitor_id' => 'string', 'since' => '\\DateTime', 'before' => '\\DateTime', 'total_runs' => 'int', 'healthy_runs' => 'int', 'degraded_runs' => 'int', 'critical_runs' => 'int', 'failed_runs' => 'int', 'success_rate' => 'float', 'average_health_score' => 'float', 'current_healthy_streak' => 'int', 'best_healthy_streak' => 'int', 'good_performance_signals' => 'string[]', 'attention_signals' => 'string[]', 'top_findings' => 'string[]', 'latest_run' => '\\MailSlurp\\Models\\DomainMonitorInsightsDtoLatestRun']

$setters

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

protected static array<string|int, string> $setters = ['monitor_id' => 'setMonitorId', 'since' => 'setSince', 'before' => 'setBefore', 'total_runs' => 'setTotalRuns', 'healthy_runs' => 'setHealthyRuns', 'degraded_runs' => 'setDegradedRuns', 'critical_runs' => 'setCriticalRuns', 'failed_runs' => 'setFailedRuns', 'success_rate' => 'setSuccessRate', 'average_health_score' => 'setAverageHealthScore', 'current_healthy_streak' => 'setCurrentHealthyStreak', 'best_healthy_streak' => 'setBestHealthyStreak', 'good_performance_signals' => 'setGoodPerformanceSignals', 'attention_signals' => 'setAttentionSignals', 'top_findings' => 'setTopFindings', 'latest_run' => 'setLatestRun']

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

getAttentionSignals()

Gets attention_signals

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

getAverageHealthScore()

Gets average_health_score

public getAverageHealthScore() : float
Return values
float —

getBestHealthyStreak()

Gets best_healthy_streak

public getBestHealthyStreak() : int
Return values
int —

getCurrentHealthyStreak()

Gets current_healthy_streak

public getCurrentHealthyStreak() : int
Return values
int —

getGoodPerformanceSignals()

Gets good_performance_signals

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

getTopFindings()

Gets top_findings

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

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

setAttentionSignals()

Sets attention_signals

public setAttentionSignals(array<string|int, string> $attention_signals) : self
Parameters
$attention_signals : array<string|int, string>

attention_signals

Return values
self —

setAverageHealthScore()

Sets average_health_score

public setAverageHealthScore(float $average_health_score) : self
Parameters
$average_health_score : float

average_health_score

Return values
self —

setBefore()

Sets before

public setBefore(DateTime $before) : self
Parameters
$before : DateTime

before

Return values
self —

setBestHealthyStreak()

Sets best_healthy_streak

public setBestHealthyStreak(int $best_healthy_streak) : self
Parameters
$best_healthy_streak : int

best_healthy_streak

Return values
self —

setCriticalRuns()

Sets critical_runs

public setCriticalRuns(int $critical_runs) : self
Parameters
$critical_runs : int

critical_runs

Return values
self —

setCurrentHealthyStreak()

Sets current_healthy_streak

public setCurrentHealthyStreak(int $current_healthy_streak) : self
Parameters
$current_healthy_streak : int

current_healthy_streak

Return values
self —

setDegradedRuns()

Sets degraded_runs

public setDegradedRuns(int $degraded_runs) : self
Parameters
$degraded_runs : int

degraded_runs

Return values
self —

setFailedRuns()

Sets failed_runs

public setFailedRuns(int $failed_runs) : self
Parameters
$failed_runs : int

failed_runs

Return values
self —

setGoodPerformanceSignals()

Sets good_performance_signals

public setGoodPerformanceSignals(array<string|int, string> $good_performance_signals) : self
Parameters
$good_performance_signals : array<string|int, string>

good_performance_signals

Return values
self —

setHealthyRuns()

Sets healthy_runs

public setHealthyRuns(int $healthy_runs) : self
Parameters
$healthy_runs : int

healthy_runs

Return values
self —

setMonitorId()

Sets monitor_id

public setMonitorId(string $monitor_id) : self
Parameters
$monitor_id : string

monitor_id

Return values
self —

setSince()

Sets since

public setSince(DateTime $since) : self
Parameters
$since : DateTime

since

Return values
self —

setSuccessRate()

Sets success_rate

public setSuccessRate(float $success_rate) : self
Parameters
$success_rate : float

success_rate

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

setTopFindings()

Sets top_findings

public setTopFindings(array<string|int, string> $top_findings) : self
Parameters
$top_findings : array<string|int, string>

top_findings

Return values
self —

setTotalRuns()

Sets total_runs

public setTotalRuns(int $total_runs) : self
Parameters
$total_runs : int

total_runs

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