Documentation

CampaignProbeSeriesPointDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CampaignProbeSeriesPointDto 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
getAverageHealthScore()  : float
Gets average_health_score
getBucketStart()  : DateTime
Gets bucket_start
getFailedCount()  : int
Gets failed_count
getHealthyCount()  : int
Gets healthy_count
getHealthyRate()  : float
Gets healthy_rate
getModelName()  : string
The original name of the model.
getRunCount()  : int
Gets run_count
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getWarningCount()  : int
Gets warning_count
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
setAverageHealthScore()  : self
Sets average_health_score
setBucketStart()  : self
Sets bucket_start
setFailedCount()  : self
Sets failed_count
setHealthyCount()  : self
Sets healthy_count
setHealthyRate()  : self
Sets healthy_rate
setRunCount()  : self
Sets run_count
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setWarningCount()  : self
Sets warning_count
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 = ['bucket_start' => 'bucketStart', 'run_count' => 'runCount', 'healthy_count' => 'healthyCount', 'warning_count' => 'warningCount', 'failed_count' => 'failedCount', 'healthy_rate' => 'healthyRate', 'average_health_score' => 'averageHealthScore']

$getters

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

protected static array<string|int, string> $getters = ['bucket_start' => 'getBucketStart', 'run_count' => 'getRunCount', 'healthy_count' => 'getHealthyCount', 'warning_count' => 'getWarningCount', 'failed_count' => 'getFailedCount', 'healthy_rate' => 'getHealthyRate', 'average_health_score' => 'getAverageHealthScore']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['bucket_start' => 'date-time', 'run_count' => 'int32', 'healthy_count' => 'int32', 'warning_count' => 'int32', 'failed_count' => 'int32', 'healthy_rate' => 'double', 'average_health_score' => 'double']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'CampaignProbeSeriesPointDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['bucket_start' => false, 'run_count' => false, 'healthy_count' => false, 'warning_count' => false, 'failed_count' => false, 'healthy_rate' => false, 'average_health_score' => 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 = ['bucket_start' => '\\DateTime', 'run_count' => 'int', 'healthy_count' => 'int', 'warning_count' => 'int', 'failed_count' => 'int', 'healthy_rate' => 'float', 'average_health_score' => 'float']

$setters

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

protected static array<string|int, string> $setters = ['bucket_start' => 'setBucketStart', 'run_count' => 'setRunCount', 'healthy_count' => 'setHealthyCount', 'warning_count' => 'setWarningCount', 'failed_count' => 'setFailedCount', 'healthy_rate' => 'setHealthyRate', 'average_health_score' => 'setAverageHealthScore']

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

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

setAverageHealthScore()

Sets average_health_score

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

average_health_score

Return values
self —

setBucketStart()

Sets bucket_start

public setBucketStart(DateTime $bucket_start) : self
Parameters
$bucket_start : DateTime

bucket_start

Return values
self —

setFailedCount()

Sets failed_count

public setFailedCount(int $failed_count) : self
Parameters
$failed_count : int

failed_count

Return values
self —

setHealthyCount()

Sets healthy_count

public setHealthyCount(int $healthy_count) : self
Parameters
$healthy_count : int

healthy_count

Return values
self —

setHealthyRate()

Sets healthy_rate

public setHealthyRate(float $healthy_rate) : self
Parameters
$healthy_rate : float

healthy_rate

Return values
self —

setRunCount()

Sets run_count

public setRunCount(int $run_count) : self
Parameters
$run_count : int

run_count

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

setWarningCount()

Sets warning_count

public setWarningCount(int $warning_count) : self
Parameters
$warning_count : int

warning_count

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