All Superinterfaces:: Maskable, ResultLimitable, Service

Enclosing class:: Secondary

@ApiService("SoftLayer_Dns_Secondary")
public static interface Secondary.Service
extends Service

SoftLayer's secondary DNS service allows you to use SoftLayer's name servers as a secondary server to your domain's name servers. This is accomplished through the use of zone transfers. Each record created within the secondary DNS service defines which zone is transferred, what server it is transferred from, and the frequency that zone transfers occur at. Zone transfers are performed automatically based on the transfer frequency set on the secondary DNS record. Domains created via zone transfer may not be modified by the SoftLayer portal or API.

The secondary DNS service also provides the ability to manually initiate a zone transfer through the [[SoftLayer_Dns_Secondary::transferNow]] method. The daemon that performs zone transfers runs once a minute, therefore it could take a full minute for the zone transfer to be completed.

Secondary DNS transfers may periodically generate notification or error messages. Please use the [[SoftLayer_Dns_Message]] service to retrieve these notifications.

See Also:: SoftLayer_Dns_Secondary

Method Summary

Modifier and Type	Method	Description
`Secondary.ServiceAsync`	`asAsync()`	Get an async version of this service
`Boolean`	`convertToPrimary()`	A secondary DNS record may be converted to a primary DNS record.
`Secondary`	`createObject(Secondary templateObject)`	Create a secondary DNS record.
`List<Secondary>`	`createObjects(List<Secondary> templateObjects)`	Create multiple secondary DNS records.
`Boolean`	`deleteObject()`	Delete a secondary DNS Record.
`Boolean`	`editObject(Secondary templateObject)`	Edit the properties of a secondary DNS record by passing in a modified instance of a SoftLayer_Dns_Secondary object.
`Account`	`getAccount()`	The SoftLayer account that owns a secondary DNS record.
`List<Secondary>`	`getByDomainName(String name)`	Search for [[SoftLayer_Dns_Secondary]] records by domain name.
`Domain`	`getDomain()`	The domain record created by zone transfer from a secondary DNS record.
`List<Message>`	`getErrorMessages()`	The error messages created during secondary DNS record transfer.
`Secondary`	`getObject()`	getObject retrieves the SoftLayer_Dns_Secondary object whose ID number corresponds to the ID number of the init paramater passed to the SoftLayer_Dns_Secondary service.
`Status`	`getStatus()`	The current status of the secondary DNS zone.
`void`	`setMask(Secondary.Mask mask)`
`Boolean`	`transferNow()`	Force a secondary DNS zone transfer by setting it's status "Transfer Now".
`Secondary.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Secondary.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details
- asAsync
  
  Secondary.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Secondary.Mask withNewMask()
  
  Description copied from interface: Maskable
  
  Overwrite the existing mask on this service with a new one and return it
  
  Specified by:
  
  withNewMask in interface Maskable
- withMask
  
  Secondary.Mask withMask()
  
  Description copied from interface: Maskable
  
  Use the existing mask on this service or create it if not present
  
  Specified by:
  
  withMask in interface Maskable
- setMask
  
  void setMask(Secondary.Mask mask)
- convertToPrimary
  
  @ApiMethod(instanceRequired=true) Boolean convertToPrimary()
  
  A secondary DNS record may be converted to a primary DNS record. By converting a secondary DNS record, the SoftLayer name servers will be the authoritative nameserver for this domain and will be directly editable in the SoftLayer API and Portal.
  
  Primary DNS record conversion performs the following steps:
  * The SOA record is updated with SoftLayer's primary name server.
  * All NS records are removed and replaced with SoftLayer's NS records.
  * The secondary DNS record is removed.
  
  After the DNS records are converted, the following restrictions will apply to the new domain record:
  * You will need to manage the zone record using the [[SoftLayer_Dns_Domain]] service.
  * You may not edit the SOA or NS records.
  * You may only edit the following resource records: A, AAAA, CNAME, MX, TX, SRV.
  
  This change can not be undone, and the record can not be converted back into a secondary DNS record once the conversion is complete.
  
  See Also:
  
  SoftLayer_Dns_Secondary::convertToPrimary
- createObject
  
  @ApiMethod Secondary createObject(Secondary templateObject)
  
  Create a secondary DNS record. The ''zoneName'', ''masterIpAddress'', and ''transferFrequency'' properties in the templateObject parameter are required parameters to create a secondary DNS record.
  
  See Also:
  
  SoftLayer_Dns_Secondary::createObject
- createObjects
  
  @ApiMethod List<Secondary> createObjects(List<Secondary> templateObjects)
  
  Create multiple secondary DNS records. Each record passed to ''createObjects'' follows the logic in the SoftLayer_Dns_Secondary [[SoftLayer_Dns_Secondary::createObject|createObject]] method.
  
  See Also:
  
  SoftLayer_Dns_Secondary::createObjects
- deleteObject
  
  @ApiMethod(instanceRequired=true) Boolean deleteObject()
  
  Delete a secondary DNS Record. This will also remove any associated domain records and resource records on the SoftLayer nameservers that were created as a result of the zone transfers. This action cannot be undone.
  
  See Also:
  
  SoftLayer_Dns_Secondary::deleteObject
- editObject
  
  @ApiMethod(instanceRequired=true) Boolean editObject(Secondary templateObject)
  
  Edit the properties of a secondary DNS record by passing in a modified instance of a SoftLayer_Dns_Secondary object. You may only edit the ''masterIpAddress'' and ''transferFrequency'' properties of your secondary DNS record. ''ZoneName'' may not be altered after a secondary DNS record has been created. Please remove and re-create the record if you need to make changes to your zone name.
  
  See Also:
  
  SoftLayer_Dns_Secondary::editObject
- getByDomainName
  
  @ApiMethod List<Secondary> getByDomainName(String name)
  
  Search for [[SoftLayer_Dns_Secondary]] records by domain name. getByDomainName() performs an inclusive search for secondary domain records, returning multiple records based on partial name matches. Use this method to locate secondary domain records if you don't have access to their id numbers.
  
  See Also:
  
  SoftLayer_Dns_Secondary::getByDomainName
- getObject
  
  @ApiMethod(instanceRequired=true) Secondary getObject()
  
  getObject retrieves the SoftLayer_Dns_Secondary object whose ID number corresponds to the ID number of the init paramater passed to the SoftLayer_Dns_Secondary service. You can only retrieve a secondary DNS record that is assigned to your SoftLayer customer account.
  
  See Also:
  
  SoftLayer_Dns_Secondary::getObject
- transferNow
  
  @ApiMethod(instanceRequired=true) Boolean transferNow()
  
  Force a secondary DNS zone transfer by setting it's status "Transfer Now". A zone transfer will be initiated within a minute of receiving this API call.
  
  See Also:
  
  SoftLayer_Dns_Secondary::transferNow
- getAccount
  
  @ApiMethod(instanceRequired=true) Account getAccount()
  
  The SoftLayer account that owns a secondary DNS record.
  
  See Also:
  
  SoftLayer_Dns_Secondary::getAccount
- getDomain
  
  @ApiMethod(instanceRequired=true) Domain getDomain()
  
  The domain record created by zone transfer from a secondary DNS record.
  
  See Also:
  
  SoftLayer_Dns_Secondary::getDomain
- getErrorMessages
  
  @ApiMethod(instanceRequired=true) List<Message> getErrorMessages()
  
  The error messages created during secondary DNS record transfer.
  
  See Also:
  
  SoftLayer_Dns_Secondary::getErrorMessages
- getStatus
  
  @ApiMethod(instanceRequired=true) Status getStatus()
  
  The current status of the secondary DNS zone.
  
  See Also:
  
  SoftLayer_Dns_Secondary::getStatus

Interface Secondary.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details