Documentation

TenantReputationStatusRowDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

TenantReputationStatusRowDto 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

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
$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
Gets account_region
getAccountRegionAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getAwsManagedSendingStatus()  : string|null
Gets aws_managed_sending_status
getBounceRate()  : float|null
Gets bounce_rate
getComplaintRate()  : float|null
Gets complaint_rate
getCustomerManagedSendingStatus()  : string|null
Gets customer_managed_sending_status
getError()  : string|null
Gets error
getFindingCount()  : int
Gets finding_count
getMetricTimestamp()  : DateTime|null
Gets metric_timestamp
getModelName()  : string
The original name of the model.
getReputationPolicy()  : string|null
Gets reputation_policy
getReputationStatus()  : string|null
Gets reputation_status
getSendingStatus()  : string|null
Gets sending_status
getSendLastHour()  : float|null
Gets send_last_hour
getTenantArn()  : string|null
Gets tenant_arn
getTenantName()  : string
Gets tenant_name
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
setAccountRegion()  : self
Sets account_region
setAwsManagedSendingStatus()  : self
Sets aws_managed_sending_status
setBounceRate()  : self
Sets bounce_rate
setComplaintRate()  : self
Sets complaint_rate
setCustomerManagedSendingStatus()  : self
Sets customer_managed_sending_status
setError()  : self
Sets error
setFindingCount()  : self
Sets finding_count
setMetricTimestamp()  : self
Sets metric_timestamp
setReputationPolicy()  : self
Sets reputation_policy
setReputationStatus()  : self
Sets reputation_status
setSendingStatus()  : self
Sets sending_status
setSendLastHour()  : self
Sets send_last_hour
setTenantArn()  : self
Sets tenant_arn
setTenantName()  : self
Sets tenant_name
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

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_STAGING

public mixed ACCOUNT_REGION_EU_WEST_1_ACCOUNT_STAGING = 'EU_WEST_1_ACCOUNT_STAGING'

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_STAGING

public mixed ACCOUNT_REGION_US_WEST_2_ACCOUNT_STAGING = 'US_WEST_2_ACCOUNT_STAGING'

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 = ['account_region' => 'accountRegion', 'tenant_name' => 'tenantName', 'tenant_arn' => 'tenantArn', 'sending_status' => 'sendingStatus', 'reputation_status' => 'reputationStatus', 'reputation_policy' => 'reputationPolicy', 'customer_managed_sending_status' => 'customerManagedSendingStatus', 'aws_managed_sending_status' => 'awsManagedSendingStatus', 'finding_count' => 'findingCount', 'bounce_rate' => 'bounceRate', 'complaint_rate' => 'complaintRate', 'send_last_hour' => 'sendLastHour', 'metric_timestamp' => 'metricTimestamp', 'error' => 'error']

$getters

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

protected static array<string|int, string> $getters = ['account_region' => 'getAccountRegion', 'tenant_name' => 'getTenantName', 'tenant_arn' => 'getTenantArn', 'sending_status' => 'getSendingStatus', 'reputation_status' => 'getReputationStatus', 'reputation_policy' => 'getReputationPolicy', 'customer_managed_sending_status' => 'getCustomerManagedSendingStatus', 'aws_managed_sending_status' => 'getAwsManagedSendingStatus', 'finding_count' => 'getFindingCount', 'bounce_rate' => 'getBounceRate', 'complaint_rate' => 'getComplaintRate', 'send_last_hour' => 'getSendLastHour', 'metric_timestamp' => 'getMetricTimestamp', 'error' => 'getError']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['account_region' => null, 'tenant_name' => null, 'tenant_arn' => null, 'sending_status' => null, 'reputation_status' => null, 'reputation_policy' => null, 'customer_managed_sending_status' => null, 'aws_managed_sending_status' => null, 'finding_count' => 'int32', 'bounce_rate' => 'double', 'complaint_rate' => 'double', 'send_last_hour' => 'double', 'metric_timestamp' => 'date-time', 'error' => 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 = 'TenantReputationStatusRowDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['account_region' => false, 'tenant_name' => false, 'tenant_arn' => true, 'sending_status' => true, 'reputation_status' => true, 'reputation_policy' => true, 'customer_managed_sending_status' => true, 'aws_managed_sending_status' => true, 'finding_count' => false, 'bounce_rate' => true, 'complaint_rate' => true, 'send_last_hour' => true, 'metric_timestamp' => true, 'error' => 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 = ['account_region' => 'string', 'tenant_name' => 'string', 'tenant_arn' => 'string', 'sending_status' => 'string', 'reputation_status' => 'string', 'reputation_policy' => 'string', 'customer_managed_sending_status' => 'string', 'aws_managed_sending_status' => 'string', 'finding_count' => 'int', 'bounce_rate' => 'float', 'complaint_rate' => 'float', 'send_last_hour' => 'float', 'metric_timestamp' => '\\DateTime', 'error' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['account_region' => 'setAccountRegion', 'tenant_name' => 'setTenantName', 'tenant_arn' => 'setTenantArn', 'sending_status' => 'setSendingStatus', 'reputation_status' => 'setReputationStatus', 'reputation_policy' => 'setReputationPolicy', 'customer_managed_sending_status' => 'setCustomerManagedSendingStatus', 'aws_managed_sending_status' => 'setAwsManagedSendingStatus', 'finding_count' => 'setFindingCount', 'bounce_rate' => 'setBounceRate', 'complaint_rate' => 'setComplaintRate', 'send_last_hour' => 'setSendLastHour', 'metric_timestamp' => 'setMetricTimestamp', 'error' => 'setError']

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

getAccountRegionAllowableValues()

Gets allowable values of the enum

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

getAwsManagedSendingStatus()

Gets aws_managed_sending_status

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

getCustomerManagedSendingStatus()

Gets customer_managed_sending_status

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

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 $account_region) : self
Parameters
$account_region : string

account_region

Return values
self —

setAwsManagedSendingStatus()

Sets aws_managed_sending_status

public setAwsManagedSendingStatus(string|null $aws_managed_sending_status) : self
Parameters
$aws_managed_sending_status : string|null

aws_managed_sending_status

Return values
self —

setBounceRate()

Sets bounce_rate

public setBounceRate(float|null $bounce_rate) : self
Parameters
$bounce_rate : float|null

bounce_rate

Return values
self —

setComplaintRate()

Sets complaint_rate

public setComplaintRate(float|null $complaint_rate) : self
Parameters
$complaint_rate : float|null

complaint_rate

Return values
self —

setCustomerManagedSendingStatus()

Sets customer_managed_sending_status

public setCustomerManagedSendingStatus(string|null $customer_managed_sending_status) : self
Parameters
$customer_managed_sending_status : string|null

customer_managed_sending_status

Return values
self —

setError()

Sets error

public setError(string|null $error) : self
Parameters
$error : string|null

error

Return values
self —

setFindingCount()

Sets finding_count

public setFindingCount(int $finding_count) : self
Parameters
$finding_count : int

finding_count

Return values
self —

setMetricTimestamp()

Sets metric_timestamp

public setMetricTimestamp(DateTime|null $metric_timestamp) : self
Parameters
$metric_timestamp : DateTime|null

metric_timestamp

Return values
self —

setReputationPolicy()

Sets reputation_policy

public setReputationPolicy(string|null $reputation_policy) : self
Parameters
$reputation_policy : string|null

reputation_policy

Return values
self —

setReputationStatus()

Sets reputation_status

public setReputationStatus(string|null $reputation_status) : self
Parameters
$reputation_status : string|null

reputation_status

Return values
self —

setSendingStatus()

Sets sending_status

public setSendingStatus(string|null $sending_status) : self
Parameters
$sending_status : string|null

sending_status

Return values
self —

setSendLastHour()

Sets send_last_hour

public setSendLastHour(float|null $send_last_hour) : self
Parameters
$send_last_hour : float|null

send_last_hour

Return values
self —

setTenantArn()

Sets tenant_arn

public setTenantArn(string|null $tenant_arn) : self
Parameters
$tenant_arn : string|null

tenant_arn

Return values
self —

setTenantName()

Sets tenant_name

public setTenantName(string $tenant_name) : self
Parameters
$tenant_name : string

tenant_name

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

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