com.softlayer.api.service.network.customer.subnet.IpAddress 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
There is a newer version: 0.3.4
package com.softlayer.api.service.network.customer.subnet;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.network.customer.Subnet;
import com.softlayer.api.service.network.tunnel.module.context.address.Translation;
import java.util.ArrayList;
import java.util.List;

/**
 * The SoftLayer_Network_Customer_Subnet_IpAddress data type contains general information relating to a single Customer Subnet (Remote) IPv4 address. 
 *
 * @see SoftLayer_Network_Customer_Subnet_IpAddress
 */
@ApiType("SoftLayer_Network_Customer_Subnet_IpAddress")
public class IpAddress extends Entity {

    /**
     * The customer subnet (remote) that the ip address belongs to.
     */
    @ApiProperty
    protected Subnet subnet;

    public Subnet getSubnet() {
        return subnet;
    }

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

    /**
     * All the address translations that are tied to an IP address.
     */
    @ApiProperty
    protected List translations;

    public List getTranslations() {
        if (translations == null) {
            translations = new ArrayList();
        }
        return translations;
    }

    /**
     * Unique identifier for an ip address.
     */
    @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;
    }

    /**
     * An IP address expressed in dotted quad format.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String ipAddress;

    public String getIpAddress() {
        return ipAddress;
    }

    public void setIpAddress(String ipAddress) {
        ipAddressSpecified = true;
        this.ipAddress = ipAddress;
    }

    protected boolean ipAddressSpecified;

    public boolean isIpAddressSpecified() {
        return ipAddressSpecified;
    }

    public void unsetIpAddress() {
        ipAddress = null;
        ipAddressSpecified = false;
    }

    /**
     * An IP address' user defined note.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String notes;

    public String getNotes() {
        return notes;
    }

    public void setNotes(String notes) {
        notesSpecified = true;
        this.notes = notes;
    }

    protected boolean notesSpecified;

    public boolean isNotesSpecified() {
        return notesSpecified;
    }

    public void unsetNotes() {
        notes = null;
        notesSpecified = false;
    }

    /**
     * The unique identifier for the customer subnet (remote) the ip address belongs to.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long subnetId;

    public Long getSubnetId() {
        return subnetId;
    }

    public void setSubnetId(Long subnetId) {
        subnetIdSpecified = true;
        this.subnetId = subnetId;
    }

    protected boolean subnetIdSpecified;

    public boolean isSubnetIdSpecified() {
        return subnetIdSpecified;
    }

    public void unsetSubnetId() {
        subnetId = null;
        subnetIdSpecified = false;
    }

    /**
     * A count of all the address translations that are tied to an IP address.
     */
    @ApiProperty
    protected Long translationCount;

    public Long getTranslationCount() {
        return translationCount;
    }

    public void setTranslationCount(Long translationCount) {
        this.translationCount = translationCount;
    }

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

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

        public com.softlayer.api.service.network.tunnel.module.context.address.Translation.Mask translations() {
            return withSubMask("translations", com.softlayer.api.service.network.tunnel.module.context.address.Translation.Mask.class);
        }

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

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

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

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

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

    }

}