com.softlayer.api.service.network.subnet.Registration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
The newest version!
package com.softlayer.api.service.network.subnet;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.account.regional.registry.Detail;
import com.softlayer.api.service.account.rwhois.Handle;
import com.softlayer.api.service.network.Subnet;
import com.softlayer.api.service.network.regional.internet.Registry;
import com.softlayer.api.service.network.subnet.registration.Details;
import com.softlayer.api.service.network.subnet.registration.Event;
import com.softlayer.api.service.network.subnet.registration.Status;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The subnet registration data type contains general information relating to a single subnet registration instance. These registration instances can be updated to reflect changes, and will record the changes in the [[SoftLayer_Network_Subnet_Registration_Event|events]]. 
 *
 * @see SoftLayer_Network_Subnet_Registration
 */
@ApiType("SoftLayer_Network_Subnet_Registration")
public class Registration extends Entity {

    /**
     * The account that this registration belongs to.
     */
    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

    public void setAccount(Account account) {
        this.account = account;
    }

    /**
     * The cross-reference records that tie the [[SoftLayer_Account_Regional_Registry_Detail]] objects to the registration object.
     */
    @ApiProperty
    protected List detailReferences;

    public List getDetailReferences() {
        if (detailReferences == null) {
            detailReferences = new ArrayList();
        }
        return detailReferences;
    }

    /**
     * The related registration events.
     */
    @ApiProperty
    protected List events;

    public List getEvents() {
        if (events == null) {
            events = new ArrayList();
        }
        return events;
    }

    /**
     * The "network" detail object.
     */
    @ApiProperty
    protected Detail networkDetail;

    public Detail getNetworkDetail() {
        return networkDetail;
    }

    public void setNetworkDetail(Detail networkDetail) {
        this.networkDetail = networkDetail;
    }

    /**
     * The "person" detail object.
     */
    @ApiProperty
    protected Detail personDetail;

    public Detail getPersonDetail() {
        return personDetail;
    }

    public void setPersonDetail(Detail personDetail) {
        this.personDetail = personDetail;
    }

    /**
     * The related Regional Internet Registry.
     */
    @ApiProperty
    protected Registry regionalInternetRegistry;

    public Registry getRegionalInternetRegistry() {
        return regionalInternetRegistry;
    }

    public void setRegionalInternetRegistry(Registry regionalInternetRegistry) {
        this.regionalInternetRegistry = regionalInternetRegistry;
    }

    /**
     * The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete.
     */
    @ApiProperty
    protected Handle regionalInternetRegistryHandle;

    public Handle getRegionalInternetRegistryHandle() {
        return regionalInternetRegistryHandle;
    }

    public void setRegionalInternetRegistryHandle(Handle regionalInternetRegistryHandle) {
        this.regionalInternetRegistryHandle = regionalInternetRegistryHandle;
    }

    /**
     * The status of this registration.
     */
    @ApiProperty
    protected Status status;

    public Status getStatus() {
        return status;
    }

    public void setStatus(Status status) {
        this.status = status;
    }

    /**
     * The subnet that this registration pertains to.
     */
    @ApiProperty
    protected Subnet subnet;

    public Subnet getSubnet() {
        return subnet;
    }

    public void setSubnet(Subnet subnet) {
        this.subnet = subnet;
    }

    /**
     * The registration object's associated [[SoftLayer_Account|account]] id 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long accountId;

    public Long getAccountId() {
        return accountId;
    }

    public void setAccountId(Long accountId) {
        accountIdSpecified = true;
        this.accountId = accountId;
    }

    protected boolean accountIdSpecified;

    public boolean isAccountIdSpecified() {
        return accountIdSpecified;
    }

    public void unsetAccountId() {
        accountId = null;
        accountIdSpecified = false;
    }

    /**
     * The CIDR prefix for the registered subnet 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long cidr;

    public Long getCidr() {
        return cidr;
    }

    public void setCidr(Long cidr) {
        cidrSpecified = true;
        this.cidr = cidr;
    }

    protected boolean cidrSpecified;

    public boolean isCidrSpecified() {
        return cidrSpecified;
    }

    public void unsetCidr() {
        cidr = null;
        cidrSpecified = false;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar createDate;

    public GregorianCalendar getCreateDate() {
        return createDate;
    }

    public void setCreateDate(GregorianCalendar createDate) {
        createDateSpecified = true;
        this.createDate = createDate;
    }

    protected boolean createDateSpecified;

    public boolean isCreateDateSpecified() {
        return createDateSpecified;
    }

    public void unsetCreateDate() {
        createDate = null;
        createDateSpecified = false;
    }

    /**
     * Unique ID of the registration object 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar modifyDate;

    public GregorianCalendar getModifyDate() {
        return modifyDate;
    }

    public void setModifyDate(GregorianCalendar modifyDate) {
        modifyDateSpecified = true;
        this.modifyDate = modifyDate;
    }

    protected boolean modifyDateSpecified;

    public boolean isModifyDateSpecified() {
        return modifyDateSpecified;
    }

    public void unsetModifyDate() {
        modifyDate = null;
        modifyDateSpecified = false;
    }

    /**
     * The RIR-specific handle or name of the registered subnet. This field is read-only. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String networkHandle;

    public String getNetworkHandle() {
        return networkHandle;
    }

    public void setNetworkHandle(String networkHandle) {
        networkHandleSpecified = true;
        this.networkHandle = networkHandle;
    }

    protected boolean networkHandleSpecified;

    public boolean isNetworkHandleSpecified() {
        return networkHandleSpecified;
    }

    public void unsetNetworkHandle() {
        networkHandle = null;
        networkHandleSpecified = false;
    }

    /**
     * The base IP address of the registered subnet 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String networkIdentifier;

    public String getNetworkIdentifier() {
        return networkIdentifier;
    }

    public void setNetworkIdentifier(String networkIdentifier) {
        networkIdentifierSpecified = true;
        this.networkIdentifier = networkIdentifier;
    }

    protected boolean networkIdentifierSpecified;

    public boolean isNetworkIdentifierSpecified() {
        return networkIdentifierSpecified;
    }

    public void unsetNetworkIdentifier() {
        networkIdentifier = null;
        networkIdentifierSpecified = false;
    }

    /**
     * The registration object's associated [[SoftLayer_Account_Rwhois_Handle|RIR handle]] id 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long regionalInternetRegistryHandleId;

    public Long getRegionalInternetRegistryHandleId() {
        return regionalInternetRegistryHandleId;
    }

    public void setRegionalInternetRegistryHandleId(Long regionalInternetRegistryHandleId) {
        regionalInternetRegistryHandleIdSpecified = true;
        this.regionalInternetRegistryHandleId = regionalInternetRegistryHandleId;
    }

    protected boolean regionalInternetRegistryHandleIdSpecified;

    public boolean isRegionalInternetRegistryHandleIdSpecified() {
        return regionalInternetRegistryHandleIdSpecified;
    }

    public void unsetRegionalInternetRegistryHandleId() {
        regionalInternetRegistryHandleId = null;
        regionalInternetRegistryHandleIdSpecified = false;
    }

    /**
     * The registration object's associated [[SoftLayer_Network_Regional_Internet_Registry|RIR]] id 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long regionalInternetRegistryId;

    public Long getRegionalInternetRegistryId() {
        return regionalInternetRegistryId;
    }

    public void setRegionalInternetRegistryId(Long regionalInternetRegistryId) {
        regionalInternetRegistryIdSpecified = true;
        this.regionalInternetRegistryId = regionalInternetRegistryId;
    }

    protected boolean regionalInternetRegistryIdSpecified;

    public boolean isRegionalInternetRegistryIdSpecified() {
        return regionalInternetRegistryIdSpecified;
    }

    public void unsetRegionalInternetRegistryId() {
        regionalInternetRegistryId = null;
        regionalInternetRegistryIdSpecified = false;
    }

    /**
     * The registration object's associated [[SoftLayer_Network_Subnet_Registration_Status|status]] id 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long statusId;

    public Long getStatusId() {
        return statusId;
    }

    public void setStatusId(Long statusId) {
        statusIdSpecified = true;
        this.statusId = statusId;
    }

    protected boolean statusIdSpecified;

    public boolean isStatusIdSpecified() {
        return statusIdSpecified;
    }

    public void unsetStatusId() {
        statusId = null;
        statusIdSpecified = false;
    }

    /**
     * A count of the cross-reference records that tie the [[SoftLayer_Account_Regional_Registry_Detail]] objects to the registration object.
     */
    @ApiProperty
    protected Long detailReferenceCount;

    public Long getDetailReferenceCount() {
        return detailReferenceCount;
    }

    public void setDetailReferenceCount(Long detailReferenceCount) {
        this.detailReferenceCount = detailReferenceCount;
    }

    /**
     * A count of the related registration events.
     */
    @ApiProperty
    protected Long eventCount;

    public Long getEventCount() {
        return eventCount;
    }

    public void setEventCount(Long eventCount) {
        this.eventCount = eventCount;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    /**
     * 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 SoftLayer_Network_Subnet_Registration
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Network_Subnet_Registration")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * This method will initiate the removal of a subnet registration. 
         *
         * @see SoftLayer_Network_Subnet_Registration::clearRegistration
         */
        @ApiMethod(instanceRequired = true)
        public Boolean clearRegistration();

        /**
         * 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 SoftLayer_Network_Subnet_Registration::createObject
         */
        @ApiMethod
        public Registration createObject(Registration templateObject);

        /**
         * Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details. 
         *
         * @see SoftLayer_Network_Subnet_Registration::createObjects
         */
        @ApiMethod
        public List createObjects(List templateObjects);

        /**
         * This method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [[SoftLayer_Network_Subnet_Registration::createObject|createObject]]. 
         *
         * @see SoftLayer_Network_Subnet_Registration::editObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean editObject(Registration templateObject);

        /**
         * This method modifies a single registration by modifying the current [[SoftLayer_Network_Subnet_Registration_Details]] objects that are linked to that registration. 
         *
         * @see SoftLayer_Network_Subnet_Registration::editRegistrationAttachedDetails
         */
        @ApiMethod
        public Boolean editRegistrationAttachedDetails(Details personObjectSkeleton, Details networkObjectSkeleton);

        /**
         * @see SoftLayer_Network_Subnet_Registration::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Registration getObject();

        /**
         * The account that this registration belongs to.
         *
         * @see SoftLayer_Network_Subnet_Registration::getAccount
         */
        @ApiMethod(instanceRequired = true)
        public Account getAccount();

        /**
         * The cross-reference records that tie the [[SoftLayer_Account_Regional_Registry_Detail]] objects to the registration object.
         *
         * @see SoftLayer_Network_Subnet_Registration::getDetailReferences
         */
        @ApiMethod(instanceRequired = true)
        public List getDetailReferences();

        /**
         * The related registration events.
         *
         * @see SoftLayer_Network_Subnet_Registration::getEvents
         */
        @ApiMethod(instanceRequired = true)
        public List getEvents();

        /**
         * The "network" detail object.
         *
         * @see SoftLayer_Network_Subnet_Registration::getNetworkDetail
         */
        @ApiMethod(instanceRequired = true)
        public Detail getNetworkDetail();

        /**
         * The "person" detail object.
         *
         * @see SoftLayer_Network_Subnet_Registration::getPersonDetail
         */
        @ApiMethod(instanceRequired = true)
        public Detail getPersonDetail();

        /**
         * The related Regional Internet Registry.
         *
         * @see SoftLayer_Network_Subnet_Registration::getRegionalInternetRegistry
         */
        @ApiMethod(instanceRequired = true)
        public Registry getRegionalInternetRegistry();

        /**
         * The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete.
         *
         * @see SoftLayer_Network_Subnet_Registration::getRegionalInternetRegistryHandle
         */
        @ApiMethod(instanceRequired = true)
        public Handle getRegionalInternetRegistryHandle();

        /**
         * The status of this registration.
         *
         * @see SoftLayer_Network_Subnet_Registration::getStatus
         */
        @ApiMethod(instanceRequired = true)
        public Status getStatus();

        /**
         * The subnet that this registration pertains to.
         *
         * @see SoftLayer_Network_Subnet_Registration::getSubnet
         */
        @ApiMethod(instanceRequired = true)
        public Subnet getSubnet();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Async version of {@link Service#clearRegistration}
         */
        public Future clearRegistration();

        public Future clearRegistration(ResponseHandler callback);

        /**
         * Async version of {@link Service#createObject}
         */
        public Future createObject(Registration templateObject);

        public Future createObject(Registration templateObject, ResponseHandler callback);

        /**
         * Async version of {@link Service#createObjects}
         */
        public Future> createObjects(List templateObjects);

        public Future createObjects(List templateObjects, ResponseHandler> callback);

        /**
         * Async version of {@link Service#editObject}
         */
        public Future editObject(Registration templateObject);

        public Future editObject(Registration templateObject, ResponseHandler callback);

        /**
         * Async version of {@link Service#editRegistrationAttachedDetails}
         */
        public Future editRegistrationAttachedDetails(Details personObjectSkeleton, Details networkObjectSkeleton);

        public Future editRegistrationAttachedDetails(Details personObjectSkeleton, Details networkObjectSkeleton, ResponseHandler callback);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

        /**
         * Async version of {@link Service#getAccount}
         */
        public Future getAccount();

        /**
         * Async callback version of {@link Service#getAccount}
         */
        public Future getAccount(ResponseHandler callback);

        /**
         * Async version of {@link Service#getDetailReferences}
         */
        public Future> getDetailReferences();

        /**
         * Async callback version of {@link Service#getDetailReferences}
         */
        public Future getDetailReferences(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getEvents}
         */
        public Future> getEvents();

        /**
         * Async callback version of {@link Service#getEvents}
         */
        public Future getEvents(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getNetworkDetail}
         */
        public Future getNetworkDetail();

        /**
         * Async callback version of {@link Service#getNetworkDetail}
         */
        public Future getNetworkDetail(ResponseHandler callback);

        /**
         * Async version of {@link Service#getPersonDetail}
         */
        public Future getPersonDetail();

        /**
         * Async callback version of {@link Service#getPersonDetail}
         */
        public Future getPersonDetail(ResponseHandler callback);

        /**
         * Async version of {@link Service#getRegionalInternetRegistry}
         */
        public Future getRegionalInternetRegistry();

        /**
         * Async callback version of {@link Service#getRegionalInternetRegistry}
         */
        public Future getRegionalInternetRegistry(ResponseHandler callback);

        /**
         * Async version of {@link Service#getRegionalInternetRegistryHandle}
         */
        public Future getRegionalInternetRegistryHandle();

        /**
         * Async callback version of {@link Service#getRegionalInternetRegistryHandle}
         */
        public Future getRegionalInternetRegistryHandle(ResponseHandler callback);

        /**
         * Async version of {@link Service#getStatus}
         */
        public Future getStatus();

        /**
         * Async callback version of {@link Service#getStatus}
         */
        public Future getStatus(ResponseHandler callback);

        /**
         * Async version of {@link Service#getSubnet}
         */
        public Future getSubnet();

        /**
         * Async callback version of {@link Service#getSubnet}
         */
        public Future getSubnet(ResponseHandler callback);

    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public com.softlayer.api.service.Account.Mask account() {
            return withSubMask("account", com.softlayer.api.service.Account.Mask.class);
        }

        public com.softlayer.api.service.network.subnet.registration.Details.Mask detailReferences() {
            return withSubMask("detailReferences", com.softlayer.api.service.network.subnet.registration.Details.Mask.class);
        }

        public com.softlayer.api.service.network.subnet.registration.Event.Mask events() {
            return withSubMask("events", com.softlayer.api.service.network.subnet.registration.Event.Mask.class);
        }

        public com.softlayer.api.service.account.regional.registry.Detail.Mask networkDetail() {
            return withSubMask("networkDetail", com.softlayer.api.service.account.regional.registry.Detail.Mask.class);
        }

        public com.softlayer.api.service.account.regional.registry.Detail.Mask personDetail() {
            return withSubMask("personDetail", com.softlayer.api.service.account.regional.registry.Detail.Mask.class);
        }

        public com.softlayer.api.service.network.regional.internet.Registry.Mask regionalInternetRegistry() {
            return withSubMask("regionalInternetRegistry", com.softlayer.api.service.network.regional.internet.Registry.Mask.class);
        }

        public com.softlayer.api.service.account.rwhois.Handle.Mask regionalInternetRegistryHandle() {
            return withSubMask("regionalInternetRegistryHandle", com.softlayer.api.service.account.rwhois.Handle.Mask.class);
        }

        public com.softlayer.api.service.network.subnet.registration.Status.Mask status() {
            return withSubMask("status", com.softlayer.api.service.network.subnet.registration.Status.Mask.class);
        }

        public com.softlayer.api.service.network.Subnet.Mask subnet() {
            return withSubMask("subnet", com.softlayer.api.service.network.Subnet.Mask.class);
        }

        public Mask accountId() {
            withLocalProperty("accountId");
            return this;
        }

        public Mask cidr() {
            withLocalProperty("cidr");
            return this;
        }

        public Mask createDate() {
            withLocalProperty("createDate");
            return this;
        }

        public Mask id() {
            withLocalProperty("id");
            return this;
        }

        public Mask modifyDate() {
            withLocalProperty("modifyDate");
            return this;
        }

        public Mask networkHandle() {
            withLocalProperty("networkHandle");
            return this;
        }

        public Mask networkIdentifier() {
            withLocalProperty("networkIdentifier");
            return this;
        }

        public Mask regionalInternetRegistryHandleId() {
            withLocalProperty("regionalInternetRegistryHandleId");
            return this;
        }

        public Mask regionalInternetRegistryId() {
            withLocalProperty("regionalInternetRegistryId");
            return this;
        }

        public Mask statusId() {
            withLocalProperty("statusId");
            return this;
        }

        public Mask detailReferenceCount() {
            withLocalProperty("detailReferenceCount");
            return this;
        }

        public Mask eventCount() {
            withLocalProperty("eventCount");
            return this;
        }

    }

}