Interface ResourceRecord.Service
-
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- All Known Subinterfaces:
MxType.Service
,SrvType.Service
- Enclosing class:
- ResourceRecord
@ApiService("SoftLayer_Dns_Domain_ResourceRecord") public static interface ResourceRecord.Service extends 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. Each of those resource records is controlled by the SoftLayer_Dns_Domain_ResourceRecord service. SoftLayer domains have the following resource records:
* A single SOA record
* A records
* AAAA records
* Optional CNAME records
* At least one MX record
* NS records for ns1.softlayer.com and ns2.softlayer.com
* Optional TXT records
* Optional SPF records
The SoftLayer_Dns_Domain_ResourceRecords service also controls the records contained in reverse DNS records. SoftLayer_Dns_Domain_Reverse records contain multiple PTR type resource records.
As with domain changes, resource record changes happen immediately, but may take up to 72 hours to propagate to the rest of the Internet's name servers. The SoftLayer_Dns_Domain_ResourceRecord service only applies to domains hosted on the SoftLayer name servers.- See Also:
- SoftLayer_Dns_Domain_ResourceRecord
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ResourceRecord.ServiceAsync
asAsync()
Get an async version of this serviceResourceRecord
createObject(ResourceRecord templateObject)
createObject creates a new domain resource record.List<ResourceRecord>
createObjects(List<ResourceRecord> templateObjects)
Create multiple resource records on a domain.Boolean
deleteObject()
Delete a domain's resource record.Boolean
deleteObjects(List<ResourceRecord> templateObjects)
Remove multiple resource records from a domain.Boolean
editObject(ResourceRecord templateObject)
editObject edits an existing domain resource record.Boolean
editObjects(List<ResourceRecord> templateObjects)
Edit multiple resource records on a domain.Domain
getDomain()
The domain that a resource record belongs to.ResourceRecord
getObject()
getObject retrieves the SoftLayer_Dns_Domain_ResourceRecord object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_ResourceRecord service.void
setMask(ResourceRecord.Mask mask)
ResourceRecord.Mask
withMask()
Use the existing mask on this service or create it if not presentResourceRecord.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return it-
Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
-
-
-
Method Detail
-
asAsync
ResourceRecord.ServiceAsync asAsync()
Description copied from interface:Service
Get an async version of this service
-
withNewMask
ResourceRecord.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 interfaceMaskable
-
withMask
ResourceRecord.Mask withMask()
Description copied from interface:Maskable
Use the existing mask on this service or create it if not present
-
setMask
void setMask(ResourceRecord.Mask mask)
-
createObject
@ApiMethod ResourceRecord createObject(ResourceRecord templateObject)
createObject creates a new domain resource record. The ''host'' property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for "@", "_", ".", "*", and "-". The ''data'' property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for "." and "-". Creating a resource record updates the serial number of the domain the resource record is associated with.
''createObject'' returns Boolean ''true'' on successful create or ''false'' if it was unable to create a resource record.
-
createObjects
@ApiMethod List<ResourceRecord> createObjects(List<ResourceRecord> templateObjects)
Create multiple resource records on a domain. This follows the same logic as ''createObject'. The serial number of the domain associated with this resource record is updated upon creation.
''createObjects'' returns Boolean ''true'' on successful creation or ''false'' if it was unable to create a resource record.
-
deleteObject
@ApiMethod(instanceRequired=true) Boolean deleteObject()
Delete a domain's resource record. '''This cannot be undone.''' Be wary of running this method. If you remove a resource record in error you will need to re-create it by creating a new SoftLayer_Dns_Domain_ResourceRecord object. The serial number of the domain associated with this resource record is updated upon deletion. You may not delete SOA, NS, or PTR resource records.
''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a resource record.
-
deleteObjects
@ApiMethod Boolean deleteObjects(List<ResourceRecord> templateObjects)
Remove multiple resource records from a domain. This follows the same logic as ''deleteObject'' and '''cannot be undone'''. The serial number of the domain associated with this resource record is updated upon deletion. You may not delete SOA records, PTR records, or NS resource records that point to ns1.softlayer.com or ns2.softlayer.com.
''deleteObjects'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a resource record.
-
editObject
@ApiMethod(instanceRequired=true) Boolean editObject(ResourceRecord templateObject)
editObject edits an existing domain resource record. The ''host'' property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for "@", "_", ".", "*", and "-". The ''data'' property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for "." and "-". Editing a resource record updates the serial number of the domain the resource record is associated with.
''editObject'' returns Boolean ''true'' on a successful edit or ''false'' if it was unable to edit the resource record.
-
editObjects
@ApiMethod Boolean editObjects(List<ResourceRecord> templateObjects)
Edit multiple resource records on a domain. This follows the same logic as ''createObject'. The serial number of the domain associated with this resource record is updated upon creation.
''createObjects'' returns Boolean ''true'' on successful creation or ''false'' if it was unable to create a resource record.
-
getObject
@ApiMethod(instanceRequired=true) ResourceRecord getObject()
getObject retrieves the SoftLayer_Dns_Domain_ResourceRecord object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_ResourceRecord service. You can only retrieve resource records belonging to domains that are assigned to your SoftLayer account.
-
getDomain
@ApiMethod(instanceRequired=true) Domain getDomain()
The domain that a resource record belongs to.
-
-