Documentation

DNSLookupOptions
in package
implements ModelInterface, ArrayAccess, JsonSerializable

DNSLookupOptions Class Doc Comment

Tags
category

Class

description

Options for DNS query.

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
RECORD_TYPES_A  = 'A'
RECORD_TYPES_A6  = 'A6'
RECORD_TYPES_AAAA  = 'AAAA'
RECORD_TYPES_AFSDB  = 'AFSDB'
RECORD_TYPES_AMTRELAY  = 'AMTRELAY'
RECORD_TYPES_ANY  = 'ANY'
RECORD_TYPES_APL  = 'APL'
RECORD_TYPES_ATMA  = 'ATMA'
RECORD_TYPES_AVC  = 'AVC'
RECORD_TYPES_AXFR  = 'AXFR'
RECORD_TYPES_CAA  = 'CAA'
RECORD_TYPES_CDNSKEY  = 'CDNSKEY'
RECORD_TYPES_CDS  = 'CDS'
RECORD_TYPES_CERT  = 'CERT'
RECORD_TYPES_CNAME  = 'CNAME'
RECORD_TYPES_CSYNC  = 'CSYNC'
RECORD_TYPES_DHCID  = 'DHCID'
RECORD_TYPES_DLV  = 'DLV'
RECORD_TYPES_DNAME  = 'DNAME'
RECORD_TYPES_DNSKEY  = 'DNSKEY'
RECORD_TYPES_DOA  = 'DOA'
RECORD_TYPES_DS  = 'DS'
RECORD_TYPES_EID  = 'EID'
RECORD_TYPES_EUI48  = 'EUI48'
RECORD_TYPES_EUI64  = 'EUI64'
RECORD_TYPES_GID  = 'GID'
RECORD_TYPES_GPOS  = 'GPOS'
RECORD_TYPES_HINFO  = 'HINFO'
RECORD_TYPES_HIP  = 'HIP'
RECORD_TYPES_HTTPS  = 'HTTPS'
RECORD_TYPES_IPSECKEY  = 'IPSECKEY'
RECORD_TYPES_ISDN  = 'ISDN'
RECORD_TYPES_IXFR  = 'IXFR'
RECORD_TYPES_KEY  = 'KEY'
RECORD_TYPES_KX  = 'KX'
RECORD_TYPES_L32  = 'L32'
RECORD_TYPES_L64  = 'L64'
RECORD_TYPES_LOC  = 'LOC'
RECORD_TYPES_LP  = 'LP'
RECORD_TYPES_MAILA  = 'MAILA'
RECORD_TYPES_MAILB  = 'MAILB'
RECORD_TYPES_MB  = 'MB'
RECORD_TYPES_MD  = 'MD'
RECORD_TYPES_MF  = 'MF'
RECORD_TYPES_MG  = 'MG'
RECORD_TYPES_MINFO  = 'MINFO'
RECORD_TYPES_MR  = 'MR'
RECORD_TYPES_MX  = 'MX'
RECORD_TYPES_NAPTR  = 'NAPTR'
RECORD_TYPES_NID  = 'NID'
RECORD_TYPES_NIMLOC  = 'NIMLOC'
RECORD_TYPES_NINFO  = 'NINFO'
RECORD_TYPES_NS  = 'NS'
RECORD_TYPES_NSAP  = 'NSAP'
RECORD_TYPES_NSAP_PTR  = 'NSAP_PTR'
RECORD_TYPES_NSEC  = 'NSEC'
RECORD_TYPES_NSEC3  = 'NSEC3'
RECORD_TYPES_NSEC3_PARAM  = 'NSEC3PARAM'
RECORD_TYPES_NULL  = 'NULL'
RECORD_TYPES_NXT  = 'NXT'
RECORD_TYPES_OPENPGPKEY  = 'OPENPGPKEY'
RECORD_TYPES_OPT  = 'OPT'
RECORD_TYPES_PTR  = 'PTR'
RECORD_TYPES_PX  = 'PX'
RECORD_TYPES_RKEY  = 'RKEY'
RECORD_TYPES_RP  = 'RP'
RECORD_TYPES_RRSIG  = 'RRSIG'
RECORD_TYPES_RT  = 'RT'
RECORD_TYPES_SIG  = 'SIG'
RECORD_TYPES_SINK  = 'SINK'
RECORD_TYPES_SMIMEA  = 'SMIMEA'
RECORD_TYPES_SOA  = 'SOA'
RECORD_TYPES_SPF  = 'SPF'
RECORD_TYPES_SRV  = 'SRV'
RECORD_TYPES_SSHFP  = 'SSHFP'
RECORD_TYPES_SVCB  = 'SVCB'
RECORD_TYPES_TA  = 'TA'
RECORD_TYPES_TALINK  = 'TALINK'
RECORD_TYPES_TKEY  = 'TKEY'
RECORD_TYPES_TLSA  = 'TLSA'
RECORD_TYPES_TSIG  = 'TSIG'
RECORD_TYPES_TXT  = 'TXT'
RECORD_TYPES_UID  = 'UID'
RECORD_TYPES_UINFO  = 'UINFO'
RECORD_TYPES_UNSPEC  = 'UNSPEC'
RECORD_TYPES_URI  = 'URI'
RECORD_TYPES_WKS  = 'WKS'
RECORD_TYPES_X25  = 'X25'
RECORD_TYPES_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
getHostname()  : string
Gets hostname
getModelName()  : string
The original name of the model.
getOmitFinalDnsDot()  : bool
Gets omit_final_dns_dot
getRecordTypes()  : array<string|int, string>
Gets record_types
getRecordTypesAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
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
setHostname()  : self
Sets hostname
setOmitFinalDnsDot()  : self
Sets omit_final_dns_dot
setRecordTypes()  : self
Sets record_types
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

RECORD_TYPES_NSEC3_PARAM

public mixed RECORD_TYPES_NSEC3_PARAM = 'NSEC3PARAM'

RECORD_TYPES_OPENPGPKEY

public mixed RECORD_TYPES_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 = ['hostname' => 'hostname', 'record_types' => 'recordTypes', 'omit_final_dns_dot' => 'omitFinalDNSDot']

$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 = ['hostname' => 'getHostname', 'record_types' => 'getRecordTypes', 'omit_final_dns_dot' => 'getOmitFinalDnsDot']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['hostname' => null, 'record_types' => null, 'omit_final_dns_dot' => 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 = 'DNSLookupOptions'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['hostname' => false, 'record_types' => false, 'omit_final_dns_dot' => 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 = ['hostname' => 'string', 'record_types' => 'string[]', 'omit_final_dns_dot' => 'bool']

$setters

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

protected static array<string|int, string> $setters = ['hostname' => 'setHostname', 'record_types' => 'setRecordTypes', 'omit_final_dns_dot' => 'setOmitFinalDnsDot']

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>

getHostname()

Gets hostname

public getHostname() : string
Return values
string

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getOmitFinalDnsDot()

Gets omit_final_dns_dot

public getOmitFinalDnsDot() : bool
Return values
bool

getRecordTypes()

Gets record_types

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

getRecordTypesAllowableValues()

Gets allowable values of the enum

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

setHostname()

Sets hostname

public setHostname(string $hostname) : self
Parameters
$hostname : string

List of record types you wish to query such as MX, DNS, TXT, NS, A etc.

Return values
self

setOmitFinalDnsDot()

Sets omit_final_dns_dot

public setOmitFinalDnsDot(bool $omit_final_dns_dot) : self
Parameters
$omit_final_dns_dot : bool

Optionally control whether to omit the final dot in full DNS name values.

Return values
self

setRecordTypes()

Sets record_types

public setRecordTypes(array<string|int, string> $record_types) : self
Parameters
$record_types : array<string|int, string>

List of record types you wish to query such as MX, DNS, TXT, NS, A etc.

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