com.softlayer.api.service.dns.domain.ResourceRecord

Direct Known Subclasses:: AaaaType, AType, CnameType, MxType, NsType, PtrType, SoaType, SrvType, TxtType

@ApiType("SoftLayer_Dns_Domain_ResourceRecord")
public class ResourceRecord
extends Entity

The SoftLayer_Dns_Domain_ResourceRecord data type represents a single resource record entry in a SoftLayer hosted domain. Each resource record contains a ''host'' and ''data'' property, defining a resource's name and it's target data. Domains contain multiple types of resource records. The ''type'' property separates out resource records by type. ''Type'' can take one of the following values:
* '''"a"''' for [[SoftLayer_Dns_Domain_ResourceRecord_AType|address]] records
* '''"aaaa"''' for [[SoftLayer_Dns_Domain_ResourceRecord_AaaaType|address]] records
* '''"cname"''' for [[SoftLayer_Dns_Domain_ResourceRecord_CnameType|canonical name]] records
* '''"mx"''' for [[SoftLayer_Dns_Domain_ResourceRecord_MxType|mail exchanger]] records
* '''"ns"''' for [[SoftLayer_Dns_Domain_ResourceRecord_NsType|name server]] records
* '''"ptr"''' for [[SoftLayer_Dns_Domain_ResourceRecord_PtrType|pointer]] records in reverse domains
* '''"soa"''' for a domain's [[SoftLayer_Dns_Domain_ResourceRecord_SoaType|start of authority]] record
* '''"spf"''' for [[SoftLayer_Dns_Domain_ResourceRecord_SpfType|sender policy framework]] records
* '''"srv"''' for [[SoftLayer_Dns_Domain_ResourceRecord_SrvType|service]] records
* '''"txt"''' for [[SoftLayer_Dns_Domain_ResourceRecord_TxtType|text]] records

As ''SoftLayer_Dns_Domain_ResourceRecord'' objects are created and loaded, the API verifies the ''type'' property and casts the object as the appropriate type.

See Also:: SoftLayer_Dns_Domain_ResourceRecord

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ResourceRecord.Mask`
`static interface`	`ResourceRecord.Service`	Every domain record hosted on the SoftLayer name servers is comprised of a series or resource records that control how the domain operates, translates host names, and translates service location.
`static interface`	`ResourceRecord.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`data`	The value of a domain's resource record.
`protected boolean`	`dataSpecified`
`protected Domain`	`domain`	The domain that a resource record belongs to.
`protected Long`	`domainId`	An identifier belonging to the domain that a resource record is associated with.
`protected boolean`	`domainIdSpecified`
`protected Long`	`expire`	The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative.
`protected boolean`	`expireSpecified`
`protected String`	`host`	The host defined by a resource record.
`protected boolean`	`hostSpecified`
`protected Long`	`id`	A domain resource record's internal identifier.
`protected boolean`	`idSpecified`
`protected Long`	`minimum`	The amount of time in seconds that a domain's resource records are valid.
`protected boolean`	`minimumSpecified`
`protected Long`	`mxPriority`	Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain.
`protected boolean`	`mxPrioritySpecified`
`protected Long`	`refresh`	The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server.
`protected boolean`	`refreshSpecified`
`protected String`	`responsiblePerson`	The email address of the person responsible for a domain, with the "@" replaced with a ".".
`protected boolean`	`responsiblePersonSpecified`
`protected Long`	`retry`	The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again.
`protected boolean`	`retrySpecified`
`protected Long`	`ttl`	The Time To Live value of a resource record, measured in seconds.
`protected boolean`	`ttlSpecified`
`protected String`	`type`	A domain resource record's type.
`protected boolean`	`typeSpecified`

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

ResourceRecord()

Method Summary

Modifier and Type	Method	Description
`ResourceRecord.Service`	`asService(ApiClient client)`
`String`	`getData()`
`Domain`	`getDomain()`
`Long`	`getDomainId()`
`Long`	`getExpire()`
`String`	`getHost()`
`Long`	`getId()`
`Long`	`getMinimum()`
`Long`	`getMxPriority()`
`Long`	`getRefresh()`
`String`	`getResponsiblePerson()`
`Long`	`getRetry()`
`Long`	`getTtl()`
`String`	`getType()`
`boolean`	`isDataSpecified()`
`boolean`	`isDomainIdSpecified()`
`boolean`	`isExpireSpecified()`
`boolean`	`isHostSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isMinimumSpecified()`
`boolean`	`isMxPrioritySpecified()`
`boolean`	`isRefreshSpecified()`
`boolean`	`isResponsiblePersonSpecified()`
`boolean`	`isRetrySpecified()`
`boolean`	`isTtlSpecified()`
`boolean`	`isTypeSpecified()`
`static ResourceRecord.Service`	`service(ApiClient client)`
`static ResourceRecord.Service`	`service(ApiClient client, Long id)`
`void`	`setData(String data)`
`void`	`setDomain(Domain domain)`
`void`	`setDomainId(Long domainId)`
`void`	`setExpire(Long expire)`
`void`	`setHost(String host)`
`void`	`setId(Long id)`
`void`	`setMinimum(Long minimum)`
`void`	`setMxPriority(Long mxPriority)`
`void`	`setRefresh(Long refresh)`
`void`	`setResponsiblePerson(String responsiblePerson)`
`void`	`setRetry(Long retry)`
`void`	`setTtl(Long ttl)`
`void`	`setType(String type)`
`void`	`unsetData()`
`void`	`unsetDomainId()`
`void`	`unsetExpire()`
`void`	`unsetHost()`
`void`	`unsetId()`
`void`	`unsetMinimum()`
`void`	`unsetMxPriority()`
`void`	`unsetRefresh()`
`void`	`unsetResponsiblePerson()`
`void`	`unsetRetry()`
`void`	`unsetTtl()`
`void`	`unsetType()`

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- domain
  
  @ApiProperty protected Domain domain
  
  The domain that a resource record belongs to.
- data
  
  @ApiProperty(canBeNullOrNotSet=true) protected String data
  
  The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character.
- dataSpecified
  
  protected boolean dataSpecified
- domainId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long domainId
  
  An identifier belonging to the domain that a resource record is associated with.
- domainIdSpecified
  
  protected boolean domainIdSpecified
- expire
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long expire
  
  The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative.
- expireSpecified
  
  protected boolean expireSpecified
- host
  
  @ApiProperty(canBeNullOrNotSet=true) protected String host
  
  The host defined by a resource record. A value of "@" denotes a wildcard.
- hostSpecified
  
  protected boolean hostSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  A domain resource record's internal identifier.
- idSpecified
  
  protected boolean idSpecified
- minimum
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long minimum
  
  The amount of time in seconds that a domain's resource records are valid. This is also known as a minimum TTL, and can be overridden by an individual resource record's TTL.
- minimumSpecified
  
  protected boolean minimumSpecified
- mxPriority
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long mxPriority
  
  Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation.
- mxPrioritySpecified
  
  protected boolean mxPrioritySpecified
- refresh
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long refresh
  
  The amount of time in seconds that a secondary name server should wait to check for a new copy of a DNS zone from the domain's primary name server. If a zone file has changed then the secondary DNS server will update it's copy of the zone to match the primary DNS server's zone.
- refreshSpecified
  
  protected boolean refreshSpecified
- responsiblePerson
  
  @ApiProperty(canBeNullOrNotSet=true) protected String responsiblePerson
  
  The email address of the person responsible for a domain, with the "@" replaced with a ".". For instance, if [email protected] is responsible for example.org, then example.org's SOA responsibility is "root.example.org.".
- responsiblePersonSpecified
  
  protected boolean responsiblePersonSpecified
- retry
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long retry
  
  The amount of time in seconds that a domain's primary name server (or servers) should wait if an attempt to refresh by a secondary name server failed before attempting to refresh a domain's zone with that secondary name server again.
- retrySpecified
  
  protected boolean retrySpecified
- ttl
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long ttl
  
  The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL.
- ttlSpecified
  
  protected boolean ttlSpecified
- type
  
  @ApiProperty(canBeNullOrNotSet=true) protected String type
  
  A domain resource record's type. A value of "a" denotes an A (address) record, "aaaa" denotes an AAAA (IPv6 address) record, "cname" denotes a CNAME (canonical name) record, "mx" denotes an MX (mail exchanger) record, "ns" denotes an NS (nameserver) record, "ptr" denotes a PTR (pointer/reverse) record, "soa" denotes the SOA (start of authority) record, "spf" denotes a SPF (sender policy framework) record, and "txt" denotes a TXT (text) record. A domain record's type also denotes which class in the SoftLayer API is a best match for extending a resource record.
- typeSpecified
  
  protected boolean typeSpecified
Constructor Details
- ResourceRecord
  
  public ResourceRecord()
Method Details
- getDomain
  
  public Domain getDomain()
- setDomain
  
  public void setDomain(Domain domain)
- getData
  
  public String getData()
- setData
  
  public void setData(String data)
- isDataSpecified
  
  public boolean isDataSpecified()
- unsetData
  
  public void unsetData()
- getDomainId
  
  public Long getDomainId()
- setDomainId
  
  public void setDomainId(Long domainId)
- isDomainIdSpecified
  
  public boolean isDomainIdSpecified()
- unsetDomainId
  
  public void unsetDomainId()
- getExpire
  
  public Long getExpire()
- setExpire
  
  public void setExpire(Long expire)
- isExpireSpecified
  
  public boolean isExpireSpecified()
- unsetExpire
  
  public void unsetExpire()
- getHost
  
  public String getHost()
- setHost
  
  public void setHost(String host)
- isHostSpecified
  
  public boolean isHostSpecified()
- unsetHost
  
  public void unsetHost()
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- isIdSpecified
  
  public boolean isIdSpecified()
- unsetId
  
  public void unsetId()
- getMinimum
  
  public Long getMinimum()
- setMinimum
  
  public void setMinimum(Long minimum)
- isMinimumSpecified
  
  public boolean isMinimumSpecified()
- unsetMinimum
  
  public void unsetMinimum()
- getMxPriority
  
  public Long getMxPriority()
- setMxPriority
  
  public void setMxPriority(Long mxPriority)
- isMxPrioritySpecified
  
  public boolean isMxPrioritySpecified()
- unsetMxPriority
  
  public void unsetMxPriority()
- getRefresh
  
  public Long getRefresh()
- setRefresh
  
  public void setRefresh(Long refresh)
- isRefreshSpecified
  
  public boolean isRefreshSpecified()
- unsetRefresh
  
  public void unsetRefresh()
- getResponsiblePerson
  
  public String getResponsiblePerson()
- setResponsiblePerson
  
  public void setResponsiblePerson(String responsiblePerson)
- isResponsiblePersonSpecified
  
  public boolean isResponsiblePersonSpecified()
- unsetResponsiblePerson
  
  public void unsetResponsiblePerson()
- getRetry
  
  public Long getRetry()
- setRetry
  
  public void setRetry(Long retry)
- isRetrySpecified
  
  public boolean isRetrySpecified()
- unsetRetry
  
  public void unsetRetry()
- getTtl
  
  public Long getTtl()
- setTtl
  
  public void setTtl(Long ttl)
- isTtlSpecified
  
  public boolean isTtlSpecified()
- unsetTtl
  
  public void unsetTtl()
- getType
  
  public String getType()
- setType
  
  public void setType(String type)
- isTypeSpecified
  
  public boolean isTypeSpecified()
- unsetType
  
  public void unsetType()
- asService
  
  public ResourceRecord.Service asService(ApiClient client)
- service
  
  public static ResourceRecord.Service service(ApiClient client)
- service
  
  public static ResourceRecord.Service service(ApiClient client, Long id)

Class ResourceRecord

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details