Documentation

CampaignProbeRunComparisonDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CampaignProbeRunComparisonDto 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
getAddedInsights()  : array<string|int, string>
Gets added_insights
getAttachmentMentionIssueDelta()  : int
Gets attachment_mention_issue_delta
getBaseline()  : CampaignProbeRunDto
Gets baseline
getCompatibilityNotSupportedDelta()  : int
Gets compatibility_not_supported_delta
getCompatibilityWarningDelta()  : int
Gets compatibility_warning_delta
getCurrent()  : CampaignProbeRunDto
Gets current
getHealthScoreDelta()  : int
Gets health_score_delta
getHtmlErrorDelta()  : int
Gets html_error_delta
getHtmlWarningDelta()  : int
Gets html_warning_delta
getImageIssueDelta()  : int
Gets image_issue_delta
getLinkIssueDelta()  : int
Gets link_issue_delta
getModelName()  : string
The original name of the model.
getRemovedInsights()  : array<string|int, string>
Gets removed_insights
getReputationFailureDelta()  : int
Gets reputation_failure_delta
getStatusChanged()  : bool
Gets status_changed
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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
setAddedInsights()  : self
Sets added_insights
setAttachmentMentionIssueDelta()  : self
Sets attachment_mention_issue_delta
setBaseline()  : self
Sets baseline
setCompatibilityNotSupportedDelta()  : self
Sets compatibility_not_supported_delta
setCompatibilityWarningDelta()  : self
Sets compatibility_warning_delta
setCurrent()  : self
Sets current
setHealthScoreDelta()  : self
Sets health_score_delta
setHtmlErrorDelta()  : self
Sets html_error_delta
setHtmlWarningDelta()  : self
Sets html_warning_delta
setImageIssueDelta()  : self
Sets image_issue_delta
setLinkIssueDelta()  : self
Sets link_issue_delta
setRemovedInsights()  : self
Sets removed_insights
setReputationFailureDelta()  : self
Sets reputation_failure_delta
setStatusChanged()  : self
Sets status_changed
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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 = ['baseline' => 'baseline', 'current' => 'current', 'health_score_delta' => 'healthScoreDelta', 'status_changed' => 'statusChanged', 'link_issue_delta' => 'linkIssueDelta', 'image_issue_delta' => 'imageIssueDelta', 'compatibility_warning_delta' => 'compatibilityWarningDelta', 'compatibility_not_supported_delta' => 'compatibilityNotSupportedDelta', 'html_error_delta' => 'htmlErrorDelta', 'html_warning_delta' => 'htmlWarningDelta', 'reputation_failure_delta' => 'reputationFailureDelta', 'attachment_mention_issue_delta' => 'attachmentMentionIssueDelta', 'added_insights' => 'addedInsights', 'removed_insights' => 'removedInsights']

$getters

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

protected static array<string|int, string> $getters = ['baseline' => 'getBaseline', 'current' => 'getCurrent', 'health_score_delta' => 'getHealthScoreDelta', 'status_changed' => 'getStatusChanged', 'link_issue_delta' => 'getLinkIssueDelta', 'image_issue_delta' => 'getImageIssueDelta', 'compatibility_warning_delta' => 'getCompatibilityWarningDelta', 'compatibility_not_supported_delta' => 'getCompatibilityNotSupportedDelta', 'html_error_delta' => 'getHtmlErrorDelta', 'html_warning_delta' => 'getHtmlWarningDelta', 'reputation_failure_delta' => 'getReputationFailureDelta', 'attachment_mention_issue_delta' => 'getAttachmentMentionIssueDelta', 'added_insights' => 'getAddedInsights', 'removed_insights' => 'getRemovedInsights']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['baseline' => null, 'current' => null, 'health_score_delta' => 'int32', 'status_changed' => null, 'link_issue_delta' => 'int32', 'image_issue_delta' => 'int32', 'compatibility_warning_delta' => 'int32', 'compatibility_not_supported_delta' => 'int32', 'html_error_delta' => 'int32', 'html_warning_delta' => 'int32', 'reputation_failure_delta' => 'int32', 'attachment_mention_issue_delta' => 'int32', 'added_insights' => null, 'removed_insights' => 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 = 'CampaignProbeRunComparisonDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['baseline' => false, 'current' => false, 'health_score_delta' => false, 'status_changed' => false, 'link_issue_delta' => false, 'image_issue_delta' => false, 'compatibility_warning_delta' => false, 'compatibility_not_supported_delta' => false, 'html_error_delta' => false, 'html_warning_delta' => false, 'reputation_failure_delta' => false, 'attachment_mention_issue_delta' => false, 'added_insights' => false, 'removed_insights' => 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 = ['baseline' => '\\MailSlurp\\Models\\CampaignProbeRunDto', 'current' => '\\MailSlurp\\Models\\CampaignProbeRunDto', 'health_score_delta' => 'int', 'status_changed' => 'bool', 'link_issue_delta' => 'int', 'image_issue_delta' => 'int', 'compatibility_warning_delta' => 'int', 'compatibility_not_supported_delta' => 'int', 'html_error_delta' => 'int', 'html_warning_delta' => 'int', 'reputation_failure_delta' => 'int', 'attachment_mention_issue_delta' => 'int', 'added_insights' => 'string[]', 'removed_insights' => 'string[]']

$setters

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

protected static array<string|int, string> $setters = ['baseline' => 'setBaseline', 'current' => 'setCurrent', 'health_score_delta' => 'setHealthScoreDelta', 'status_changed' => 'setStatusChanged', 'link_issue_delta' => 'setLinkIssueDelta', 'image_issue_delta' => 'setImageIssueDelta', 'compatibility_warning_delta' => 'setCompatibilityWarningDelta', 'compatibility_not_supported_delta' => 'setCompatibilityNotSupportedDelta', 'html_error_delta' => 'setHtmlErrorDelta', 'html_warning_delta' => 'setHtmlWarningDelta', 'reputation_failure_delta' => 'setReputationFailureDelta', 'attachment_mention_issue_delta' => 'setAttachmentMentionIssueDelta', 'added_insights' => 'setAddedInsights', 'removed_insights' => 'setRemovedInsights']

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

getAddedInsights()

Gets added_insights

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

getAttachmentMentionIssueDelta()

Gets attachment_mention_issue_delta

public getAttachmentMentionIssueDelta() : int
Return values
int —

getCompatibilityNotSupportedDelta()

Gets compatibility_not_supported_delta

public getCompatibilityNotSupportedDelta() : int
Return values
int —

getCompatibilityWarningDelta()

Gets compatibility_warning_delta

public getCompatibilityWarningDelta() : int
Return values
int —

getRemovedInsights()

Gets removed_insights

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

setAddedInsights()

Sets added_insights

public setAddedInsights(array<string|int, string> $added_insights) : self
Parameters
$added_insights : array<string|int, string>

added_insights

Return values
self —

setAttachmentMentionIssueDelta()

Sets attachment_mention_issue_delta

public setAttachmentMentionIssueDelta(int $attachment_mention_issue_delta) : self
Parameters
$attachment_mention_issue_delta : int

attachment_mention_issue_delta

Return values
self —

setCompatibilityNotSupportedDelta()

Sets compatibility_not_supported_delta

public setCompatibilityNotSupportedDelta(int $compatibility_not_supported_delta) : self
Parameters
$compatibility_not_supported_delta : int

compatibility_not_supported_delta

Return values
self —

setCompatibilityWarningDelta()

Sets compatibility_warning_delta

public setCompatibilityWarningDelta(int $compatibility_warning_delta) : self
Parameters
$compatibility_warning_delta : int

compatibility_warning_delta

Return values
self —

setHealthScoreDelta()

Sets health_score_delta

public setHealthScoreDelta(int $health_score_delta) : self
Parameters
$health_score_delta : int

health_score_delta

Return values
self —

setHtmlErrorDelta()

Sets html_error_delta

public setHtmlErrorDelta(int $html_error_delta) : self
Parameters
$html_error_delta : int

html_error_delta

Return values
self —

setHtmlWarningDelta()

Sets html_warning_delta

public setHtmlWarningDelta(int $html_warning_delta) : self
Parameters
$html_warning_delta : int

html_warning_delta

Return values
self —

setImageIssueDelta()

Sets image_issue_delta

public setImageIssueDelta(int $image_issue_delta) : self
Parameters
$image_issue_delta : int

image_issue_delta

Return values
self —

setLinkIssueDelta()

Sets link_issue_delta

public setLinkIssueDelta(int $link_issue_delta) : self
Parameters
$link_issue_delta : int

link_issue_delta

Return values
self —

setRemovedInsights()

Sets removed_insights

public setRemovedInsights(array<string|int, string> $removed_insights) : self
Parameters
$removed_insights : array<string|int, string>

removed_insights

Return values
self —

setReputationFailureDelta()

Sets reputation_failure_delta

public setReputationFailureDelta(int $reputation_failure_delta) : self
Parameters
$reputation_failure_delta : int

reputation_failure_delta

Return values
self —

setStatusChanged()

Sets status_changed

public setStatusChanged(bool $status_changed) : self
Parameters
$status_changed : bool

status_changed

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

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