All Superinterfaces:: Maskable, ResultLimitable, Service

Enclosing class:: Registration

@ApiService("SoftLayer_Network_Subnet_Registration")
public static interface Registration.Service
extends Service

Subnet registration objects are used to request and track registration of the subnet with the appropriate Regional Internet Registry (RIR). Registration for public subnets can be requested any time after assignment of the subnet.

Subnet Registration objects can be updated any time after they are created. This will result in the information being submitted to the RIR and the records on their end being refreshed.

See Also:: SoftLayer_Network_Subnet_Registration

Method Summary

Modifier and Type	Method	Description
`Registration.ServiceAsync`	`asAsync()`	Get an async version of this service
`Boolean`	`clearRegistration()`	This method will initiate the removal of a subnet registration.
`Registration`	`createObject(Registration templateObject)`	Create registration with a global registrar to associate an assigned subnet with the provided contact details.
`List<Registration>`	`createObjects(List<Registration> templateObjects)`	Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details.
`Boolean`	`editObject(Registration templateObject)`	This method will edit an existing SoftLayer_Network_Subnet_Registration object.
`Boolean`	`editRegistrationAttachedDetails(Details personObjectSkeleton, Details networkObjectSkeleton)`	This method modifies a single registration by modifying the current [[SoftLayer_Network_Subnet_Registration_Details]] objects that are linked to that registration.
`Account`	`getAccount()`	The account that this registration belongs to.
`List<Details>`	`getDetailReferences()`	The cross-reference records that tie the [[SoftLayer_Account_Regional_Registry_Detail]] objects to the registration object.
`List<Event>`	`getEvents()`	The related registration events.
`Detail`	`getNetworkDetail()`	The "network" detail object.
`Registration`	`getObject()`
`Detail`	`getPersonDetail()`	The "person" detail object.
`Registry`	`getRegionalInternetRegistry()`	The related Regional Internet Registry.
`Handle`	`getRegionalInternetRegistryHandle()`	The RIR handle that this registration object belongs to.
`Status`	`getStatus()`	The status of this registration.
`Subnet`	`getSubnet()`	The subnet that this registration pertains to.
`void`	`setMask(Registration.Mask mask)`
`Registration.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Registration.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
  
  Registration.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Registration.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
  
  Registration.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(Registration.Mask mask)
- clearRegistration
  
  @ApiMethod(instanceRequired=true) Boolean clearRegistration()
  
  This method will initiate the removal of a subnet registration.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::clearRegistration
- createObject
  
  @ApiMethod Registration createObject(Registration templateObject)
  
  Create registration with a global registrar to associate an assigned subnet with the provided contact details.
  
  Contact information is provided in the form of a [[SoftLayer_Account_Regional_Registry_Detail|person detail record]], which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the ``OPEN`` status. To specify a person detail when creating a registration, the ``detailReferences`` property should be populated with a list item providing a ``detailId`` value referencing the [[SoftLayer_Account_Regional_Registry_Detail|person detail record]].
  
  The same applies to [[SoftLayer_Account_Regional_Registry_Detail|network detail records]], though these references need not be provided. The system will create a reference to the network described by the registration's subnet in the absence of a provided network detail reference. However, if a specific detail is referenced, it must describe the same subnet as the registration.
  
  A template containing the following properties will create a subnet registration:
  
  * networkIdentifier
  * cidr
  * detailReferences
  
  ``networkIdentifier`` is the base address of the public, SoftLayer owned subnet which is being registered. ``cidr`` must be an integer representing the CIDR of the subnet to be registered. The ``networkIdentifier``/``cidr`` must represent an assigned subnet. ``detailReferences`` tie the registration to SoftLayer_Account_Regional_Registry_Detail objects.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::createObject
- createObjects
  
  @ApiMethod List<Registration> createObjects(List<Registration> templateObjects)
  
  Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::createObjects
- editObject
  
  @ApiMethod(instanceRequired=true) Boolean editObject(Registration templateObject)
  
  This method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [[SoftLayer_Network_Subnet_Registration::createObject|createObject]].
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::editObject
- editRegistrationAttachedDetails
  
  @ApiMethod Boolean editRegistrationAttachedDetails(Details personObjectSkeleton, Details networkObjectSkeleton)
  
  This method modifies a single registration by modifying the current [[SoftLayer_Network_Subnet_Registration_Details]] objects that are linked to that registration.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::editRegistrationAttachedDetails
- getObject
  
  @ApiMethod(instanceRequired=true) Registration getObject()
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::getObject
- getAccount
  
  @ApiMethod(instanceRequired=true) Account getAccount()
  
  The account that this registration belongs to.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::getAccount
- getDetailReferences
  
  @ApiMethod(instanceRequired=true) List<Details> getDetailReferences()
  
  The cross-reference records that tie the [[SoftLayer_Account_Regional_Registry_Detail]] objects to the registration object.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::getDetailReferences
- getEvents
  
  @ApiMethod(instanceRequired=true) List<Event> getEvents()
  
  The related registration events.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::getEvents
- getNetworkDetail
  
  @ApiMethod(instanceRequired=true) Detail getNetworkDetail()
  
  The "network" detail object.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::getNetworkDetail
- getPersonDetail
  
  @ApiMethod(instanceRequired=true) Detail getPersonDetail()
  
  The "person" detail object.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::getPersonDetail
- getRegionalInternetRegistry
  
  @ApiMethod(instanceRequired=true) Registry getRegionalInternetRegistry()
  
  The related Regional Internet Registry.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::getRegionalInternetRegistry
- getRegionalInternetRegistryHandle
  
  @ApiMethod(instanceRequired=true) Handle getRegionalInternetRegistryHandle()
  
  The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::getRegionalInternetRegistryHandle
- getStatus
  
  @ApiMethod(instanceRequired=true) Status getStatus()
  
  The status of this registration.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::getStatus
- getSubnet
  
  @ApiMethod(instanceRequired=true) Subnet getSubnet()
  
  The subnet that this registration pertains to.
  
  See Also:
  
  SoftLayer_Network_Subnet_Registration::getSubnet

Interface Registration.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details