com.softlayer.api.service.container.network.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
The newest version!
package com.softlayer.api.service.container.network.subnet;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.Hardware;

/**
 * SoftLayer_Container_Subnet_IPAddress models an IP v4 address as it exists as a member of it's subnet, letting the user know if it is a network identifier, gateway, broadcast, or useable address. Addresses that are neither the network identifier nor the gateway nor the broadcast addresses are usable by SoftLayer servers. 
 *
 * @see SoftLayer_Container_Network_Subnet_IpAddress
 */
@ApiType("SoftLayer_Container_Network_Subnet_IpAddress")
public class IpAddress extends Entity {

    /**
     * The hardware that an IP address is associated with.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Hardware hardware;

    public Hardware getHardware() {
        return hardware;
    }

    public void setHardware(Hardware hardware) {
        hardwareSpecified = true;
        this.hardware = hardware;
    }

    protected boolean hardwareSpecified;

    public boolean isHardwareSpecified() {
        return hardwareSpecified;
    }

    public void unsetHardware() {
        hardware = null;
        hardwareSpecified = false;
    }

    /**
     * An IP address expressed in dotted-quad notation.
     */
    @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;
    }

    /**
     * Whether an IP address is its subnet's broadcast address.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean isBroadcastAddress;

    public Boolean getIsBroadcastAddress() {
        return isBroadcastAddress;
    }

    public void setIsBroadcastAddress(Boolean isBroadcastAddress) {
        isBroadcastAddressSpecified = true;
        this.isBroadcastAddress = isBroadcastAddress;
    }

    protected boolean isBroadcastAddressSpecified;

    public boolean isIsBroadcastAddressSpecified() {
        return isBroadcastAddressSpecified;
    }

    public void unsetIsBroadcastAddress() {
        isBroadcastAddress = null;
        isBroadcastAddressSpecified = false;
    }

    /**
     * Whether an IP address is its subnet's gateway address. Gateway addresses exist on SoftLayer's routers and many not be assigned to servers.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean isGatewayAddress;

    public Boolean getIsGatewayAddress() {
        return isGatewayAddress;
    }

    public void setIsGatewayAddress(Boolean isGatewayAddress) {
        isGatewayAddressSpecified = true;
        this.isGatewayAddress = isGatewayAddress;
    }

    protected boolean isGatewayAddressSpecified;

    public boolean isIsGatewayAddressSpecified() {
        return isGatewayAddressSpecified;
    }

    public void unsetIsGatewayAddress() {
        isGatewayAddress = null;
        isGatewayAddressSpecified = false;
    }

    /**
     * Whether an IP address is its subnet's network identifier address.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean isNetworkAddress;

    public Boolean getIsNetworkAddress() {
        return isNetworkAddress;
    }

    public void setIsNetworkAddress(Boolean isNetworkAddress) {
        isNetworkAddressSpecified = true;
        this.isNetworkAddress = isNetworkAddress;
    }

    protected boolean isNetworkAddressSpecified;

    public boolean isIsNetworkAddressSpecified() {
        return isNetworkAddressSpecified;
    }

    public void unsetIsNetworkAddress() {
        isNetworkAddress = null;
        isNetworkAddressSpecified = false;
    }

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

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

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

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

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

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

    }

}