Package com.softlayer.api.service.dns.domain.resourcerecord

Interface SrvType.Service

All Superinterfaces:
Maskable, ResourceRecord.Service, ResultLimitable, Service
Enclosing class:
SrvType
@ApiService("SoftLayer_Dns_Domain_ResourceRecord_SrvType")
public static interface SrvType.Service
extends ResourceRecord.Service
The SoftLayer_Dns_Domain_ResourceRecord_SrvType service controls the creation, modification, and deletion of SRV records within a domain hosted on SoftLayer's DNS servers. It exists separately from the SoftLayer_Dns_Domain_ResourceRecord to provide control for SRV priority, port, protocol, service, and weight in addition to host, data, and time-to-live.
See Also:
SoftLayer_Dns_Domain_ResourceRecord_SrvType

  • Method Details

    • asAsync

      SrvType.ServiceAsync asAsync()
      Description copied from interface: Service
      Get an async version of this service
      Specified by:
      asAsync in interface ResourceRecord.Service
      Specified by:
      asAsync in interface Service

    • withNewMask

      SrvType.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
      Specified by:
      withNewMask in interface ResourceRecord.Service

    • withMask

      SrvType.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
      Specified by:
      withMask in interface ResourceRecord.Service

    • setMask

      void setMask​(SrvType.Mask mask)

    • createObject

      @ApiMethod SrvType createObject​(SrvType templateObject)
      createObject creates a new SRV 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 an SRV record updates the serial number of the domain the resource record is associated with.
      See Also:
      SoftLayer_Dns_Domain_ResourceRecord_SrvType::createObject

    • createObjectsForSrvType

      @ApiMethod("createObjects") List<ResourceRecord> createObjectsForSrvType​(List<ResourceRecord> templateObjects)
      Create multiple SRV records on a domain. This follows the same logic as ''createObject'. The serial number of the domain associated with this SRV record is updated upon creation.

      ''createObjects'' returns Boolean ''true'' on successful creation or ''false'' if it was unable to create a resource record.
      See Also:
      SoftLayer_Dns_Domain_ResourceRecord_SrvType::createObjects

    • deleteObjectForSrvType

      @ApiMethod(value="deleteObject", instanceRequired=true) Boolean deleteObjectForSrvType()
      Delete a domain's SRV 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_SrvType object. The serial number of the domain associated with this SRV record is updated upon deletion.

      ''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a resource record.
      See Also:
      SoftLayer_Dns_Domain_ResourceRecord_SrvType::deleteObject

    • deleteObjectsForSrvType

      @ApiMethod("deleteObjects") Boolean deleteObjectsForSrvType​(List<SrvType> templateObjects)
      Remove multiple SRV records from a domain. This follows the same logic as ''deleteObject'' and '''cannot be undone'''. The serial number of the domain associated with this SRV record is updated upon deletion.

      ''deleteObjects'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a resource record.
      See Also:
      SoftLayer_Dns_Domain_ResourceRecord_SrvType::deleteObjects

    • editObject

      @ApiMethod(instanceRequired=true) Boolean editObject​(SrvType templateObject)
      editObject edits an existing SRV 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 an SRV record updates the serial number of the domain the record is associated with.

      ''editObject'' returns Boolean ''true'' on a successful edit or ''false'' if it was unable to edit the resource record.
      See Also:
      SoftLayer_Dns_Domain_ResourceRecord_SrvType::editObject

    • editObjectsForSrvType

      @ApiMethod("editObjects") Boolean editObjectsForSrvType​(List<SrvType> templateObjects)
      Edit multiple SRV records on a domain. This follows the same logic as ''createObject'. The serial number of the domain associated with this SRV record is updated upon creation.

      ''createObjects'' returns Boolean ''true'' on successful creation or ''false'' if it was unable to create a resource record.
      See Also:
      SoftLayer_Dns_Domain_ResourceRecord_SrvType::editObjects

    • getObjectForSrvType

      @ApiMethod(value="getObject", instanceRequired=true) SrvType getObjectForSrvType()
      getObject retrieves the SoftLayer_Dns_Domain_ResourceRecord_SrvType object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_ResourceRecord_SrvType service. You can only retrieve resource records belonging to domains that are assigned to your SoftLayer account.
      See Also:
      SoftLayer_Dns_Domain_ResourceRecord_SrvType::getObject