Documentation

DomainNameRecord
in package
implements ModelInterface, ArrayAccess, JsonSerializable

DomainNameRecord Class Doc Comment

Tags
category

Class

description

DNS Record required for verification of a domain. Record vary depending on domain type.

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
LABEL_DKIM  = 'DKIM'
LABEL_DMARC  = 'DMARC'
LABEL_MX  = 'MX'
LABEL_SPF  = 'SPF'
LABEL_VERIFICATION  = 'VERIFICATION'
RECORD_TYPE_A  = 'A'
RECORD_TYPE_A6  = 'A6'
RECORD_TYPE_AAAA  = 'AAAA'
RECORD_TYPE_AFSDB  = 'AFSDB'
RECORD_TYPE_AMTRELAY  = 'AMTRELAY'
RECORD_TYPE_ANY  = 'ANY'
RECORD_TYPE_APL  = 'APL'
RECORD_TYPE_ATMA  = 'ATMA'
RECORD_TYPE_AVC  = 'AVC'
RECORD_TYPE_AXFR  = 'AXFR'
RECORD_TYPE_CAA  = 'CAA'
RECORD_TYPE_CDNSKEY  = 'CDNSKEY'
RECORD_TYPE_CDS  = 'CDS'
RECORD_TYPE_CERT  = 'CERT'
RECORD_TYPE_CNAME  = 'CNAME'
RECORD_TYPE_CSYNC  = 'CSYNC'
RECORD_TYPE_DHCID  = 'DHCID'
RECORD_TYPE_DLV  = 'DLV'
RECORD_TYPE_DNAME  = 'DNAME'
RECORD_TYPE_DNSKEY  = 'DNSKEY'
RECORD_TYPE_DOA  = 'DOA'
RECORD_TYPE_DS  = 'DS'
RECORD_TYPE_EID  = 'EID'
RECORD_TYPE_EUI48  = 'EUI48'
RECORD_TYPE_EUI64  = 'EUI64'
RECORD_TYPE_GID  = 'GID'
RECORD_TYPE_GPOS  = 'GPOS'
RECORD_TYPE_HINFO  = 'HINFO'
RECORD_TYPE_HIP  = 'HIP'
RECORD_TYPE_HTTPS  = 'HTTPS'
RECORD_TYPE_IPSECKEY  = 'IPSECKEY'
RECORD_TYPE_ISDN  = 'ISDN'
RECORD_TYPE_IXFR  = 'IXFR'
RECORD_TYPE_KEY  = 'KEY'
RECORD_TYPE_KX  = 'KX'
RECORD_TYPE_L32  = 'L32'
RECORD_TYPE_L64  = 'L64'
RECORD_TYPE_LOC  = 'LOC'
RECORD_TYPE_LP  = 'LP'
RECORD_TYPE_MAILA  = 'MAILA'
RECORD_TYPE_MAILB  = 'MAILB'
RECORD_TYPE_MB  = 'MB'
RECORD_TYPE_MD  = 'MD'
RECORD_TYPE_MF  = 'MF'
RECORD_TYPE_MG  = 'MG'
RECORD_TYPE_MINFO  = 'MINFO'
RECORD_TYPE_MR  = 'MR'
RECORD_TYPE_MX  = 'MX'
RECORD_TYPE_NAPTR  = 'NAPTR'
RECORD_TYPE_NID  = 'NID'
RECORD_TYPE_NIMLOC  = 'NIMLOC'
RECORD_TYPE_NINFO  = 'NINFO'
RECORD_TYPE_NS  = 'NS'
RECORD_TYPE_NSAP  = 'NSAP'
RECORD_TYPE_NSAP_PTR  = 'NSAP_PTR'
RECORD_TYPE_NSEC  = 'NSEC'
RECORD_TYPE_NSEC3  = 'NSEC3'
RECORD_TYPE_NSEC3_PARAM  = 'NSEC3PARAM'
RECORD_TYPE_NULL  = 'NULL'
RECORD_TYPE_NXT  = 'NXT'
RECORD_TYPE_OPENPGPKEY  = 'OPENPGPKEY'
RECORD_TYPE_OPT  = 'OPT'
RECORD_TYPE_PTR  = 'PTR'
RECORD_TYPE_PX  = 'PX'
RECORD_TYPE_RKEY  = 'RKEY'
RECORD_TYPE_RP  = 'RP'
RECORD_TYPE_RRSIG  = 'RRSIG'
RECORD_TYPE_RT  = 'RT'
RECORD_TYPE_SIG  = 'SIG'
RECORD_TYPE_SINK  = 'SINK'
RECORD_TYPE_SMIMEA  = 'SMIMEA'
RECORD_TYPE_SOA  = 'SOA'
RECORD_TYPE_SPF  = 'SPF'
RECORD_TYPE_SRV  = 'SRV'
RECORD_TYPE_SSHFP  = 'SSHFP'
RECORD_TYPE_SVCB  = 'SVCB'
RECORD_TYPE_TA  = 'TA'
RECORD_TYPE_TALINK  = 'TALINK'
RECORD_TYPE_TKEY  = 'TKEY'
RECORD_TYPE_TLSA  = 'TLSA'
RECORD_TYPE_TSIG  = 'TSIG'
RECORD_TYPE_TXT  = 'TXT'
RECORD_TYPE_UID  = 'UID'
RECORD_TYPE_UINFO  = 'UINFO'
RECORD_TYPE_UNSPEC  = 'UNSPEC'
RECORD_TYPE_URI  = 'URI'
RECORD_TYPE_WKS  = 'WKS'
RECORD_TYPE_X25  = 'X25'
RECORD_TYPE_ZONEMD  = 'ZONEMD'
$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
getAlternativeRecordEntries()  : array<string|int, string>|null
Gets alternative_record_entries
getLabel()  : string
Gets label
getLabelAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getModelName()  : string
The original name of the model.
getName()  : string
Gets name
getRecordEntries()  : array<string|int, string>
Gets record_entries
getRecordType()  : string
Gets record_type
getRecordTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getRequired()  : bool
Gets required
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTtl()  : int
Gets ttl
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
setAlternativeRecordEntries()  : self
Sets alternative_record_entries
setLabel()  : self
Sets label
setName()  : self
Sets name
setRecordEntries()  : self
Sets record_entries
setRecordType()  : self
Sets record_type
setRequired()  : self
Sets required
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTtl()  : self
Sets ttl
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

RECORD_TYPE_NSEC3_PARAM

public mixed RECORD_TYPE_NSEC3_PARAM = 'NSEC3PARAM'

RECORD_TYPE_OPENPGPKEY

public mixed RECORD_TYPE_OPENPGPKEY = 'OPENPGPKEY'

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 = ['label' => 'label', 'required' => 'required', 'record_type' => 'recordType', 'name' => 'name', 'record_entries' => 'recordEntries', 'ttl' => 'ttl', 'alternative_record_entries' => 'alternativeRecordEntries']

$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 = ['label' => 'getLabel', 'required' => 'getRequired', 'record_type' => 'getRecordType', 'name' => 'getName', 'record_entries' => 'getRecordEntries', 'ttl' => 'getTtl', 'alternative_record_entries' => 'getAlternativeRecordEntries']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['label' => null, 'required' => null, 'record_type' => null, 'name' => null, 'record_entries' => null, 'ttl' => 'int64', 'alternative_record_entries' => 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 = 'DomainNameRecord'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['label' => false, 'required' => false, 'record_type' => false, 'name' => false, 'record_entries' => false, 'ttl' => false, 'alternative_record_entries' => 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 = ['label' => 'string', 'required' => 'bool', 'record_type' => 'string', 'name' => 'string', 'record_entries' => 'string[]', 'ttl' => 'int', 'alternative_record_entries' => 'string[]']

$setters

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

protected static array<string|int, string> $setters = ['label' => 'setLabel', 'required' => 'setRequired', 'record_type' => 'setRecordType', 'name' => 'setName', 'record_entries' => 'setRecordEntries', 'ttl' => 'setTtl', 'alternative_record_entries' => 'setAlternativeRecordEntries']

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>

getAlternativeRecordEntries()

Gets alternative_record_entries

public getAlternativeRecordEntries() : array<string|int, string>|null
Return values
array<string|int, string>|null

getLabel()

Gets label

public getLabel() : string
Return values
string

getLabelAllowableValues()

Gets allowable values of the enum

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getRecordEntries()

Gets record_entries

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

getRecordType()

Gets record_type

public getRecordType() : string
Return values
string

getRecordTypeAllowableValues()

Gets allowable values of the enum

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

getRequired()

Gets required

public getRequired() : bool
Return values
bool

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>

setAlternativeRecordEntries()

Sets alternative_record_entries

public setAlternativeRecordEntries(array<string|int, string>|null $alternative_record_entries) : self
Parameters
$alternative_record_entries : array<string|int, string>|null

alternative_record_entries

Return values
self

setLabel()

Sets label

public setLabel(string $label) : self
Parameters
$label : string

Domain Name Server Record Label

Return values
self

setName()

Sets name

public setName(string $name) : self
Parameters
$name : string

name

Return values
self

setRecordEntries()

Sets record_entries

public setRecordEntries(array<string|int, string> $record_entries) : self
Parameters
$record_entries : array<string|int, string>

record_entries

Return values
self

setRecordType()

Sets record_type

public setRecordType(string $record_type) : self
Parameters
$record_type : string

Domain Name Server Record Types

Return values
self

setRequired()

Sets required

public setRequired(bool $required) : self
Parameters
$required : bool

required

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>

setTtl()

Sets ttl

public setTtl(int $ttl) : self
Parameters
$ttl : int

ttl

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