com.softlayer.api.service.network.Subnet 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;

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.Hardware;
import com.softlayer.api.service.billing.Item;
import com.softlayer.api.service.dns.Domain;
import com.softlayer.api.service.dns.domain.Reverse;
import com.softlayer.api.service.location.Datacenter;
import com.softlayer.api.service.network.Storage;
import com.softlayer.api.service.network.Vlan;
import com.softlayer.api.service.network.component.Firewall;
import com.softlayer.api.service.network.protection.Address;
import com.softlayer.api.service.network.regional.internet.Registry;
import com.softlayer.api.service.network.storage.allowed.Host;
import com.softlayer.api.service.network.subnet.IpAddress;
import com.softlayer.api.service.network.subnet.Registration;
import com.softlayer.api.service.network.subnet.ipaddress.Global;
import com.softlayer.api.service.network.subnet.swip.Transaction;
import com.softlayer.api.service.network.tunnel.module.Context;
import com.softlayer.api.service.tag.Reference;
import com.softlayer.api.service.virtual.Guest;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * The SoftLayer_Network_Subnet data type contains general information relating to a single SoftLayer subnet. Personal information in this type such as names, addresses, and phone numbers are assigned to the account only and not to users belonging to the account. 
 *
 * @see SoftLayer_Network_Subnet
 */
@ApiType("SoftLayer_Network_Subnet")
public class Subnet extends Entity {

    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

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

    /**
     * If present, the active registration for this subnet.
     */
    @ApiProperty
    protected Registration activeRegistration;

    public Registration getActiveRegistration() {
        return activeRegistration;
    }

    public void setActiveRegistration(Registration activeRegistration) {
        this.activeRegistration = activeRegistration;
    }

    /**
     * DEPRECATED
     */
    @ApiProperty
    protected Transaction activeSwipTransaction;

    public Transaction getActiveSwipTransaction() {
        return activeSwipTransaction;
    }

    public void setActiveSwipTransaction(Transaction activeSwipTransaction) {
        this.activeSwipTransaction = activeSwipTransaction;
    }

    /**
     * DEPRECATED
     */
    @ApiProperty
    protected com.softlayer.api.service.provisioning.version1.Transaction activeTransaction;

    public com.softlayer.api.service.provisioning.version1.Transaction getActiveTransaction() {
        return activeTransaction;
    }

    public void setActiveTransaction(com.softlayer.api.service.provisioning.version1.Transaction activeTransaction) {
        this.activeTransaction = activeTransaction;
    }

    /**
     * Identifier which distinguishes what classification of addresses the subnet represents.
     */
    @ApiProperty
    protected String addressSpace;

    public String getAddressSpace() {
        return addressSpace;
    }

    public void setAddressSpace(String addressSpace) {
        this.addressSpace = addressSpace;
    }

    /**
     * The SoftLayer_Network_Storage_Allowed_Host information to connect this Subnet to Network Storage supporting access control lists.
     */
    @ApiProperty
    protected Host allowedHost;

    public Host getAllowedHost() {
        return allowedHost;
    }

    public void setAllowedHost(Host allowedHost) {
        this.allowedHost = allowedHost;
    }

    /**
     * The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
     */
    @ApiProperty
    protected List allowedNetworkStorage;

    public List getAllowedNetworkStorage() {
        if (allowedNetworkStorage == null) {
            allowedNetworkStorage = new ArrayList();
        }
        return allowedNetworkStorage;
    }

    /**
     * The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
     */
    @ApiProperty
    protected List allowedNetworkStorageReplicas;

    public List getAllowedNetworkStorageReplicas() {
        if (allowedNetworkStorageReplicas == null) {
            allowedNetworkStorageReplicas = new ArrayList();
        }
        return allowedNetworkStorageReplicas;
    }

    /**
     * The billing item for a subnet.
     */
    @ApiProperty
    protected Item billingItem;

    public Item getBillingItem() {
        return billingItem;
    }

    public void setBillingItem(Item billingItem) {
        this.billingItem = billingItem;
    }

    @ApiProperty
    protected List boundDescendants;

    public List getBoundDescendants() {
        if (boundDescendants == null) {
            boundDescendants = new ArrayList();
        }
        return boundDescendants;
    }

    /**
     * Whether or not this subnet is associated with a router. Subnets that are not associated with a router cannot be routed.
     */
    @ApiProperty
    protected Boolean boundRouterFlag;

    public Boolean getBoundRouterFlag() {
        return boundRouterFlag;
    }

    public void setBoundRouterFlag(Boolean boundRouterFlag) {
        this.boundRouterFlag = boundRouterFlag;
    }

    @ApiProperty
    protected List boundRouters;

    public List getBoundRouters() {
        if (boundRouters == null) {
            boundRouters = new ArrayList();
        }
        return boundRouters;
    }

    @ApiProperty
    protected List children;

    public List getChildren() {
        if (children == null) {
            children = new ArrayList();
        }
        return children;
    }

    /**
     * The data center this subnet may be routed within.
     */
    @ApiProperty
    protected Datacenter datacenter;

    public Datacenter getDatacenter() {
        return datacenter;
    }

    public void setDatacenter(Datacenter datacenter) {
        this.datacenter = datacenter;
    }

    @ApiProperty
    protected List descendants;

    public List getDescendants() {
        if (descendants == null) {
            descendants = new ArrayList();
        }
        return descendants;
    }

    @ApiProperty
    protected String displayLabel;

    public String getDisplayLabel() {
        return displayLabel;
    }

    public void setDisplayLabel(String displayLabel) {
        this.displayLabel = displayLabel;
    }

    /**
     * A static routed ip address
     */
    @ApiProperty
    protected IpAddress endPointIpAddress;

    public IpAddress getEndPointIpAddress() {
        return endPointIpAddress;
    }

    public void setEndPointIpAddress(IpAddress endPointIpAddress) {
        this.endPointIpAddress = endPointIpAddress;
    }

    @ApiProperty
    protected Global globalIpRecord;

    public Global getGlobalIpRecord() {
        return globalIpRecord;
    }

    public void setGlobalIpRecord(Global globalIpRecord) {
        this.globalIpRecord = globalIpRecord;
    }

    /**
     * The hardware using IP addresses on this subnet.
     */
    @ApiProperty
    protected List hardware;

    public List getHardware() {
        if (hardware == null) {
            hardware = new ArrayList();
        }
        return hardware;
    }

    /**
     * All the ip addresses associated with a subnet.
     */
    @ApiProperty
    protected List ipAddresses;

    public List getIpAddresses() {
        if (ipAddresses == null) {
            ipAddresses = new ArrayList();
        }
        return ipAddresses;
    }

    /**
     * The upstream network component firewall.
     */
    @ApiProperty
    protected Firewall networkComponentFirewall;

    public Firewall getNetworkComponentFirewall() {
        return networkComponentFirewall;
    }

    public void setNetworkComponentFirewall(Firewall networkComponentFirewall) {
        this.networkComponentFirewall = networkComponentFirewall;
    }

    @ApiProperty
    protected List networkProtectionAddresses;

    public List getNetworkProtectionAddresses() {
        if (networkProtectionAddresses == null) {
            networkProtectionAddresses = new ArrayList();
        }
        return networkProtectionAddresses;
    }

    /**
     * IPSec network tunnels that have access to a private subnet.
     */
    @ApiProperty
    protected List networkTunnelContexts;

    public List getNetworkTunnelContexts() {
        if (networkTunnelContexts == null) {
            networkTunnelContexts = new ArrayList();
        }
        return networkTunnelContexts;
    }

    /**
     * The VLAN object that a subnet is associated with.
     */
    @ApiProperty
    protected Vlan networkVlan;

    public Vlan getNetworkVlan() {
        return networkVlan;
    }

    public void setNetworkVlan(Vlan networkVlan) {
        this.networkVlan = networkVlan;
    }

    /**
     * The pod in which this subnet resides.
     */
    @ApiProperty
    protected String podName;

    public String getPodName() {
        return podName;
    }

    public void setPodName(String podName) {
        this.podName = podName;
    }

    @ApiProperty
    protected List protectedIpAddresses;

    public List getProtectedIpAddresses() {
        if (protectedIpAddresses == null) {
            protectedIpAddresses = new ArrayList();
        }
        return protectedIpAddresses;
    }

    @ApiProperty
    protected Registry regionalInternetRegistry;

    public Registry getRegionalInternetRegistry() {
        return regionalInternetRegistry;
    }

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

    /**
     * All registrations that have been created for this subnet.
     */
    @ApiProperty
    protected List registrations;

    public List getRegistrations() {
        if (registrations == null) {
            registrations = new ArrayList();
        }
        return registrations;
    }

    /**
     * The reverse DNS domain associated with this subnet.
     */
    @ApiProperty
    protected Domain reverseDomain;

    public Domain getReverseDomain() {
        return reverseDomain;
    }

    public void setReverseDomain(Domain reverseDomain) {
        this.reverseDomain = reverseDomain;
    }

    /**
     * An identifier of the role the subnet is within. Roles dictate how a subnet may be used.
     */
    @ApiProperty
    protected String roleKeyName;

    public String getRoleKeyName() {
        return roleKeyName;
    }

    public void setRoleKeyName(String roleKeyName) {
        this.roleKeyName = roleKeyName;
    }

    /**
     * The name of the role the subnet is within. Roles dictate how a subnet may be used.
     */
    @ApiProperty
    protected String roleName;

    public String getRoleName() {
        return roleName;
    }

    public void setRoleName(String roleName) {
        this.roleName = roleName;
    }

    /**
     * The identifier for the type of route then subnet is currently configured for.
     */
    @ApiProperty
    protected String routingTypeKeyName;

    public String getRoutingTypeKeyName() {
        return routingTypeKeyName;
    }

    public void setRoutingTypeKeyName(String routingTypeKeyName) {
        this.routingTypeKeyName = routingTypeKeyName;
    }

    /**
     * The name for the type of route then subnet is currently configured for.
     */
    @ApiProperty
    protected String routingTypeName;

    public String getRoutingTypeName() {
        return routingTypeName;
    }

    public void setRoutingTypeName(String routingTypeName) {
        this.routingTypeName = routingTypeName;
    }

    /**
     * DEPRECATED
     */
    @ApiProperty
    protected List swipTransaction;

    public List getSwipTransaction() {
        if (swipTransaction == null) {
            swipTransaction = new ArrayList();
        }
        return swipTransaction;
    }

    /**
     * References to all tags for this subnet.
     */
    @ApiProperty
    protected List tagReferences;

    public List getTagReferences() {
        if (tagReferences == null) {
            tagReferences = new ArrayList();
        }
        return tagReferences;
    }

    @ApiProperty
    protected List unboundDescendants;

    public List getUnboundDescendants() {
        if (unboundDescendants == null) {
            unboundDescendants = new ArrayList();
        }
        return unboundDescendants;
    }

    /**
     * Provides the total number of utilized IP addresses on this subnet. The primary consumer of IP addresses are compute resources, which can consume more than one address. This value is only supported for primary subnet types.
     */
    @ApiProperty
    protected Long utilizedIpAddressCount;

    public Long getUtilizedIpAddressCount() {
        return utilizedIpAddressCount;
    }

    public void setUtilizedIpAddressCount(Long utilizedIpAddressCount) {
        this.utilizedIpAddressCount = utilizedIpAddressCount;
    }

    /**
     * The Virtual Servers using IP addresses on this subnet.
     */
    @ApiProperty
    protected List virtualGuests;

    public List getVirtualGuests() {
        if (virtualGuests == null) {
            virtualGuests = new ArrayList();
        }
        return virtualGuests;
    }

    /**
     * The last IP address in a subnet is the subnet's broadcast address. This is an IP address that will broadcast network requests to the entire subnet and may not be assigned to a network interface. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String broadcastAddress;

    public String getBroadcastAddress() {
        return broadcastAddress;
    }

    public void setBroadcastAddress(String broadcastAddress) {
        broadcastAddressSpecified = true;
        this.broadcastAddress = broadcastAddress;
    }

    protected boolean broadcastAddressSpecified;

    public boolean isBroadcastAddressSpecified() {
        return broadcastAddressSpecified;
    }

    public void unsetBroadcastAddress() {
        broadcastAddress = null;
        broadcastAddressSpecified = false;
    }

    /**
     * A subnet's Classless Inter-Domain Routing prefix. This is a number between 0 and 32 signifying the number of bits in a subnet's netmask. These bits separate a subnet's network address from it's host addresses. It performs the same function as the ''netmask'' property, but is represented as an integer. 
     */
    @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;
    }

    /**
     * A subnet's gateway address. This is an IP address that belongs to the router on the subnet and may not be assigned to a network interface. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String gateway;

    public String getGateway() {
        return gateway;
    }

    public void setGateway(String gateway) {
        gatewaySpecified = true;
        this.gateway = gateway;
    }

    protected boolean gatewaySpecified;

    public boolean isGatewaySpecified() {
        return gatewaySpecified;
    }

    public void unsetGateway() {
        gateway = null;
        gatewaySpecified = false;
    }

    /**
     * A subnet's internal identifier.
     */
    @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 Boolean isCustomerOwned;

    public Boolean getIsCustomerOwned() {
        return isCustomerOwned;
    }

    public void setIsCustomerOwned(Boolean isCustomerOwned) {
        isCustomerOwnedSpecified = true;
        this.isCustomerOwned = isCustomerOwned;
    }

    protected boolean isCustomerOwnedSpecified;

    public boolean isIsCustomerOwnedSpecified() {
        return isCustomerOwnedSpecified;
    }

    public void unsetIsCustomerOwned() {
        isCustomerOwned = null;
        isCustomerOwnedSpecified = false;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean isCustomerRoutable;

    public Boolean getIsCustomerRoutable() {
        return isCustomerRoutable;
    }

    public void setIsCustomerRoutable(Boolean isCustomerRoutable) {
        isCustomerRoutableSpecified = true;
        this.isCustomerRoutable = isCustomerRoutable;
    }

    protected boolean isCustomerRoutableSpecified;

    public boolean isIsCustomerRoutableSpecified() {
        return isCustomerRoutableSpecified;
    }

    public void unsetIsCustomerRoutable() {
        isCustomerRoutable = null;
        isCustomerRoutableSpecified = false;
    }

    /**
     * The last time this subnet was last modified
     */
    @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;
    }

    /**
     * A bitmask in dotted-quad format that is used to separate a subnet's network address from it's host addresses. This performs the same function as the ''cidr'' property, but is expressed in a string format. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String netmask;

    public String getNetmask() {
        return netmask;
    }

    public void setNetmask(String netmask) {
        netmaskSpecified = true;
        this.netmask = netmask;
    }

    protected boolean netmaskSpecified;

    public boolean isNetmaskSpecified() {
        return netmaskSpecified;
    }

    public void unsetNetmask() {
        netmask = null;
        netmaskSpecified = false;
    }

    /**
     * A subnet's network identifier. This is the first IP address of a subnet and may not be assigned to a network interface. 
     */
    @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;
    }

    /**
     * A subnet's associated VLAN's internal identifier.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long networkVlanId;

    public Long getNetworkVlanId() {
        return networkVlanId;
    }

    public void setNetworkVlanId(Long networkVlanId) {
        networkVlanIdSpecified = true;
        this.networkVlanId = networkVlanId;
    }

    protected boolean networkVlanIdSpecified;

    public boolean isNetworkVlanIdSpecified() {
        return networkVlanIdSpecified;
    }

    public void unsetNetworkVlanId() {
        networkVlanId = null;
        networkVlanIdSpecified = false;
    }

    /**
     * This is the note field. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String note;

    public String getNote() {
        return note;
    }

    public void setNote(String note) {
        noteSpecified = true;
        this.note = note;
    }

    protected boolean noteSpecified;

    public boolean isNoteSpecified() {
        return noteSpecified;
    }

    public void unsetNote() {
        note = null;
        noteSpecified = false;
    }

    /**
     * Used to sort subnets and group subnets of similar type together for use on customer facing portals. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String sortOrder;

    public String getSortOrder() {
        return sortOrder;
    }

    public void setSortOrder(String sortOrder) {
        sortOrderSpecified = true;
        this.sortOrder = sortOrder;
    }

    protected boolean sortOrderSpecified;

    public boolean isSortOrderSpecified() {
        return sortOrderSpecified;
    }

    public void unsetSortOrder() {
        sortOrder = null;
        sortOrderSpecified = false;
    }

    /**
     * A subnet type can be any of the following: 

     * * PRIMARY

     * * ADDITIONAL_PRIMARY

     * * SECONDARY_ON_VLAN

     * * STATIC_IP_ROUTED

     * * PRIMARY_6

     * * SUBNET_ON_VLAN

     * * STATIC_IP_ROUTED_6

     * * GLOBAL_IP

     * A "PRIMARY" subnet is the primary network bound to a VLAN within the softlayer network. An "ADDITIONAL_PRIMARY" subnet is bound to a network VLAN to augment the pool of available primary IP addresses that may be assigned to a server. A "SECONDARY_ON_VLAN" subnet is a secondary portable subnet whose IP addresses are managed by the end user. "STATIC_IP_ROUTED" subnets are subnets that are statically routed to a single endpoint IP address. A "PRIMARY_6" subnet is the primary IPv6 network bound to a VLAN. A "SUBNET_ON_VLAN" subnet is the secondary portable IPv6 subnet whose IP addresses are managed by the end user. A "STATIC_IP_ROUTED_6" subnet is statically routed to a single IPv6 endpoint IP address. A "GLOBAL_IP" subnet is a subnet that is routable to a single endpoint IP address. The "GLOBAL_IP" type is used for both IPv4 and IPv6 subnets. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String subnetType;

    public String getSubnetType() {
        return subnetType;
    }

    public void setSubnetType(String subnetType) {
        subnetTypeSpecified = true;
        this.subnetType = subnetType;
    }

    protected boolean subnetTypeSpecified;

    public boolean isSubnetTypeSpecified() {
        return subnetTypeSpecified;
    }

    public void unsetSubnetType() {
        subnetType = null;
        subnetTypeSpecified = false;
    }

    /**
     * The number of IP addresses contained within this subnet.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal totalIpAddresses;

    public BigDecimal getTotalIpAddresses() {
        return totalIpAddresses;
    }

    public void setTotalIpAddresses(BigDecimal totalIpAddresses) {
        totalIpAddressesSpecified = true;
        this.totalIpAddresses = totalIpAddresses;
    }

    protected boolean totalIpAddressesSpecified;

    public boolean isTotalIpAddressesSpecified() {
        return totalIpAddressesSpecified;
    }

    public void unsetTotalIpAddresses() {
        totalIpAddresses = null;
        totalIpAddressesSpecified = false;
    }

    /**
     * The number of IP addresses that can be addressed within this subnet. For IPv4 subnets with a CIDR value of at most 30, a discount of 3 is taken from the total number of IP addresses for the subnet's unusable network, gateway and broadcast IP addresses. For IPv6 subnets with a CIDR value of at most 126, a discount of 2 is taken for the subnet's network and gateway IP addresses. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal usableIpAddressCount;

    public BigDecimal getUsableIpAddressCount() {
        return usableIpAddressCount;
    }

    public void setUsableIpAddressCount(BigDecimal usableIpAddressCount) {
        usableIpAddressCountSpecified = true;
        this.usableIpAddressCount = usableIpAddressCount;
    }

    protected boolean usableIpAddressCountSpecified;

    public boolean isUsableIpAddressCountSpecified() {
        return usableIpAddressCountSpecified;
    }

    public void unsetUsableIpAddressCount() {
        usableIpAddressCount = null;
        usableIpAddressCountSpecified = false;
    }

    /**
     * This is the Internet Protocol version. Current values may be either 4 or 6. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long version;

    public Long getVersion() {
        return version;
    }

    public void setVersion(Long version) {
        versionSpecified = true;
        this.version = version;
    }

    protected boolean versionSpecified;

    public boolean isVersionSpecified() {
        return versionSpecified;
    }

    public void unsetVersion() {
        version = null;
        versionSpecified = false;
    }

    /**
     * A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
     */
    @ApiProperty
    protected Long allowedNetworkStorageCount;

    public Long getAllowedNetworkStorageCount() {
        return allowedNetworkStorageCount;
    }

    public void setAllowedNetworkStorageCount(Long allowedNetworkStorageCount) {
        this.allowedNetworkStorageCount = allowedNetworkStorageCount;
    }

    /**
     * A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
     */
    @ApiProperty
    protected Long allowedNetworkStorageReplicaCount;

    public Long getAllowedNetworkStorageReplicaCount() {
        return allowedNetworkStorageReplicaCount;
    }

    public void setAllowedNetworkStorageReplicaCount(Long allowedNetworkStorageReplicaCount) {
        this.allowedNetworkStorageReplicaCount = allowedNetworkStorageReplicaCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long boundDescendantCount;

    public Long getBoundDescendantCount() {
        return boundDescendantCount;
    }

    public void setBoundDescendantCount(Long boundDescendantCount) {
        this.boundDescendantCount = boundDescendantCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long boundRouterCount;

    public Long getBoundRouterCount() {
        return boundRouterCount;
    }

    public void setBoundRouterCount(Long boundRouterCount) {
        this.boundRouterCount = boundRouterCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long childrenCount;

    public Long getChildrenCount() {
        return childrenCount;
    }

    public void setChildrenCount(Long childrenCount) {
        this.childrenCount = childrenCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long descendantCount;

    public Long getDescendantCount() {
        return descendantCount;
    }

    public void setDescendantCount(Long descendantCount) {
        this.descendantCount = descendantCount;
    }

    /**
     * A count of the hardware using IP addresses on this subnet.
     */
    @ApiProperty
    protected Long hardwareCount;

    public Long getHardwareCount() {
        return hardwareCount;
    }

    public void setHardwareCount(Long hardwareCount) {
        this.hardwareCount = hardwareCount;
    }

    /**
     * A count of all the ip addresses associated with a subnet.
     */
    @ApiProperty
    protected Long ipAddressCount;

    public Long getIpAddressCount() {
        return ipAddressCount;
    }

    public void setIpAddressCount(Long ipAddressCount) {
        this.ipAddressCount = ipAddressCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long networkProtectionAddressCount;

    public Long getNetworkProtectionAddressCount() {
        return networkProtectionAddressCount;
    }

    public void setNetworkProtectionAddressCount(Long networkProtectionAddressCount) {
        this.networkProtectionAddressCount = networkProtectionAddressCount;
    }

    /**
     * A count of iPSec network tunnels that have access to a private subnet.
     */
    @ApiProperty
    protected Long networkTunnelContextCount;

    public Long getNetworkTunnelContextCount() {
        return networkTunnelContextCount;
    }

    public void setNetworkTunnelContextCount(Long networkTunnelContextCount) {
        this.networkTunnelContextCount = networkTunnelContextCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long protectedIpAddressCount;

    public Long getProtectedIpAddressCount() {
        return protectedIpAddressCount;
    }

    public void setProtectedIpAddressCount(Long protectedIpAddressCount) {
        this.protectedIpAddressCount = protectedIpAddressCount;
    }

    /**
     * A count of all registrations that have been created for this subnet.
     */
    @ApiProperty
    protected Long registrationCount;

    public Long getRegistrationCount() {
        return registrationCount;
    }

    public void setRegistrationCount(Long registrationCount) {
        this.registrationCount = registrationCount;
    }

    /**
     * A count of dEPRECATED
     */
    @ApiProperty
    protected Long swipTransactionCount;

    public Long getSwipTransactionCount() {
        return swipTransactionCount;
    }

    public void setSwipTransactionCount(Long swipTransactionCount) {
        this.swipTransactionCount = swipTransactionCount;
    }

    /**
     * A count of references to all tags for this subnet.
     */
    @ApiProperty
    protected Long tagReferenceCount;

    public Long getTagReferenceCount() {
        return tagReferenceCount;
    }

    public void setTagReferenceCount(Long tagReferenceCount) {
        this.tagReferenceCount = tagReferenceCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long unboundDescendantCount;

    public Long getUnboundDescendantCount() {
        return unboundDescendantCount;
    }

    public void setUnboundDescendantCount(Long unboundDescendantCount) {
        this.unboundDescendantCount = unboundDescendantCount;
    }

    /**
     * A count of the Virtual Servers using IP addresses on this subnet.
     */
    @ApiProperty
    protected Long virtualGuestCount;

    public Long getVirtualGuestCount() {
        return virtualGuestCount;
    }

    public void setVirtualGuestCount(Long virtualGuestCount) {
        this.virtualGuestCount = virtualGuestCount;
    }

    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());
    }

    /**
     * Every SoftLayer ip address is associated with a subnet which is defined in the SoftLayer_Network_Subnet service. SoftLayer subnets define a group of ip addresses and are assigned to a SoftLayer_Network_Vlan.  The SoftLayer_Network_Subnet service gives you information about your subnet such as your network address, broadcast address, the subnet gateway address, and the total number of IP addresses within the subnet. Use the data returned by these methods with other API services to get more detailed information about your services. 

     * 

     * Along with VLANs, subnets are an integral part of the SoftLayer network. Each server ordered by SoftLayer comes with at least one public and one private subnet, with more available for order in the customer portal. Subnets exist in the SoftLayer network as either interfaces on a VLAN or as route destination from an IP address or VLAN. 

     * 

     * SoftLayer customers can order and manage subnets through the customer portal. If you need to cancel a subnet please open a sales ticket in our customer portal and our account management staff will assist you. 
     *
     * @see SoftLayer_Network_Subnet
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Network_Subnet")
    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 is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control. 
         *
         * @see SoftLayer_Network_Subnet::allowAccessToNetworkStorage
         */
        @ApiMethod(instanceRequired = true)
        public Boolean allowAccessToNetworkStorage(Storage networkStorageTemplateObject);

        /**
         * This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. 
         *
         * @see SoftLayer_Network_Subnet::allowAccessToNetworkStorageList
         */
        @ApiMethod(instanceRequired = true)
        public Boolean allowAccessToNetworkStorageList(List networkStorageTemplateObjects);

        /**
         * This interface allows you to remove the route of your Account Owned subnets. The result will be a subnet that is no longer routed on the network. Remove the route of subnets you are not actively using, as it will make it easier to identify available subnets later. 

         * 

         * '''Important:''' When removing the route of ''Portable'' subnets, know that any subnet depending on an IP address provided by the Portable subnet will also have their routes removed! 

         * 

         * To review what subnets are routed to IP addresses provided by a ''Portable'' subnet, you can utilize the following object mask: 'mask[ipAddresses[endpointSubnets]]'. Any subnet present in conjunction with ''endpointSubnets'' is a subnet which depends on the respective IP address. 

         * 

         * The behavior of this interface is such that either true or false is returned. A result of false can be interpreted as the clear route request having already been completed. In contrast, a result of true means the subnet is currently routed and will be transitioned. This route change is asynchronous to the request. A response of true does not mean the subnet's route has changed, but simply that it will change. In order to monitor for the completion of the change, you may either attempt a clear route again until the result is false, or monitor one or more SoftLayer_Network_Subnet properties: subnetType, networkVlanId, and or endPointIpAddress to determine if routing of the subnet has been removed. 
         *
         * @see SoftLayer_Network_Subnet::clearRoute
         */
        @ApiMethod(instanceRequired = true)
        public Boolean clearRoute();

        /**
         * Create the default PTR records for this subnet 
         *
         * @see SoftLayer_Network_Subnet::createReverseDomainRecords
         */
        @ApiMethod(instanceRequired = true)
        public Reverse createReverseDomainRecords();

        /**
         * 

         * ***DEPRECATED***

         * This endpoint is deprecated in favor of the more expressive and capable SoftLayer_Network_Subnet::route, to which this endpoint now proxies. Refer to it for more information. 

         * 

         * Similarly, unroute requests are proxied to SoftLayer_Network_Subnet::clearRoute. 
         *
         * @see SoftLayer_Network_Subnet::createSubnetRouteUpdateTransaction
         */
        @ApiMethod(instanceRequired = true)
        public Boolean createSubnetRouteUpdateTransaction(String newEndPointIpAddress);

        /**
         * 

         * ***DEPRECATED***

         * This function is used to create a new SoftLayer SWIP transaction to register your RWHOIS data with ARIN. SWIP transactions can only be initiated on subnets that contain more than 8 IP addresses. 
         *
         * @see SoftLayer_Network_Subnet::createSwipTransaction
         */
        @ApiMethod(instanceRequired = true)
        public Boolean createSwipTransaction();

        /**
         * Edit the note for this subnet.
         *
         * @see SoftLayer_Network_Subnet::editNote
         */
        @ApiMethod(instanceRequired = true)
        public Boolean editNote(String note);

        /**
         * 

         * ***DEPRECATED***

         * Retrieve a list of a SoftLayer customer's subnets along with their SWIP transaction statuses. This is a shortcut method that combines the SoftLayer_Network_Subnet retrieval methods along with [[object masks]] to retrieve their subnets' associated SWIP transactions as well. 

         * 

         * This is a special function built for SoftLayer's use on the SWIP section of the customer portal, but may also be useful for API users looking for the same data. 
         *
         * @see SoftLayer_Network_Subnet::findAllSubnetsAndActiveSwipTransactionStatus
         */
        @ApiMethod
        public List findAllSubnetsAndActiveSwipTransactionStatus();

        /**
         * This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Network_Subnet. 
         *
         * @see SoftLayer_Network_Subnet::getAttachedNetworkStorages
         */
        @ApiMethod(instanceRequired = true)
        public List getAttachedNetworkStorages(String nasType);

        /**
         * This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Network_Subnet. 
         *
         * @see SoftLayer_Network_Subnet::getAvailableNetworkStorages
         */
        @ApiMethod(instanceRequired = true)
        public List getAvailableNetworkStorages(String nasType);

        /**
         * getObject retrieves the SoftLayer_Network_Subnet object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet service. You can only retrieve the subnet whose vlan is associated with the account that you portal user is assigned to. 
         *
         * @see SoftLayer_Network_Subnet::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Subnet getObject();

        /**
         * Retrieve all reverse DNS records associated with a subnet. 
         *
         * @see SoftLayer_Network_Subnet::getReverseDomainRecords
         */
        @ApiMethod(instanceRequired = true)
        public List getReverseDomainRecords();

        /**
         * Returns IP addresses which may be used as routing endpoints for a given subnet. IP address which are currently the network, gateway, or broadcast address of a Secondary Portable subnet, are an address in a Secondary Static subnet, or if the address is not assigned to a resource when part of a Primary Subnet will not be available as a routing endpoint. 
         *
         * @see SoftLayer_Network_Subnet::getRoutableEndpointIpAddresses
         */
        @ApiMethod(instanceRequired = true)
        public List getRoutableEndpointIpAddresses();

        /**
         * Retrieve the subnet associated with an IP address. You may only retrieve subnets assigned to your SoftLayer customer account. 
         *
         * @see SoftLayer_Network_Subnet::getSubnetForIpAddress
         */
        @ApiMethod
        public Subnet getSubnetForIpAddress(String ipAddress);

        /**
         * This method is used to remove access to multiple SoftLayer_Network_Storage volumes 
         *
         * @see SoftLayer_Network_Subnet::removeAccessToNetworkStorageList
         */
        @ApiMethod(instanceRequired = true)
        public Boolean removeAccessToNetworkStorageList(List networkStorageTemplateObjects);

        /**
         * This interface allows you to change the route of your Account Owned subnets. It accommodates a number of ways to identify your desired routing destination through the use of a 'type' and 'identifier'. Subnets may be routed as either Static or Portable, and that designation is dictated by the routing destination specified. 

         * 

         * Static subnets have an ultimate routing destination of a single IP address but may not be routed to an existing subnet's IP address whose subnet is routed as a Static. Portable subnets have an ultimate routing destination of a VLAN. 

         * 

         * A subnet can be routed to any resource within the same "routing region" as the subnet itself. A subnet's routing region can be diverse but is usually limited to a single data center. 

         * 

         * The following identifier 'type' values will result in Static routing:  SoftLayer_Network_Subnet_IpAddress
 SoftLayer_Hardware_Server
 SoftLayer_Virtual_Guest
 
 

         * 

         * The following identifier 'type' values will result in Portable routing:  SoftLayer_Network_Vlan
 
 

         * 

         * For each identifier type, one or more 'identifier' formats are possible. 

         * 

         * ''SoftLayer_Network_Subnet_IpAddress'' will accept the following identifier formats:  An entirely numeric value will be treated as a SoftLayer_Network_Subnet_IpAddress.id value of the desired IP address object.
 A dotted-quad IPv4 address.
 A full or compressed IPv6 address.
 
 

         * 

         * ''SoftLayer_Network_Vlan'' will accept the following identifier formats:  An entirely numeric value will be treated as a SoftLayer_Network_Vlan.id value of the desired VLAN object.
 A semantic VLAN identifier of the form .., eg. dal13.fcr01.1234 - the router name may optionally contain the 'a' or 'b' redundancy qualifier (which has no meaning in this context).
 
 

         * 

         * ''SoftLayer_Hardware_Server'' will accept the following identifier formats:  An entirely numeric value will be treated as a SoftLayer_Hardware_Server.id value of the desired server.
 A UUID corresponding to a server's SoftLayer_Hardware_Server.globalIdentifier.
 A value corresponding to a unique SoftLayer_Hardware_Server.hostname.
 A value corresponding to a unique fully-qualified domain name in the format 'hostname<domain>' where < and > are literal, hostname refers to SoftLayer_Hardware_Server.hostname and domain to SoftLayer_Hardware_Server.domain, respectively.
 
 

         * 

         * ''SoftLayer_Virtual_Guest'' will accept the following identifier formats:  An entirely numeric value will be treated as a SoftLayer_Virtual_Guest.id value of the desired server.
 A UUID corresponding to a server's SoftLayer_Virtual_Guest.globalIdentifier.
 A value corresponding to a unique SoftLayer_Virtual_Guest.hostname.
 A value corresponding to a unique fully-qualified domain name in the format 'hostname<domain>' where < and > are literal, hostname refers to SoftLayer_Virtual_Guest.hostname and domain to SoftLayer_Virtual_Guest.domain, respectively.
 
 

         * 

         * The routing destination result of specifying a SoftLayer_Hardware_Server or SoftLayer_Virtual_Guest type will be the primary IP address of the server for the same network segment the subnet is on. Thus, a public subnet will be routed to the server's public, primary IP address. Additionally, this IP address resolution will match the subnet's IP version; routing a IPv6 subnet to a server will result in selection of the primary IPv6 address of the respective network segment, if available. 

         * 

         * Subnets may only be routed to the IP version they themselves represent. That means an IPv4 subnet can only be routed to IPv4 addresses. Any type/identifier combination that resolves to an IP address must be able to locate an IP address of the same version as the subnet being routed. 

         * 

         * When routing to an IP address on a Primary subnet, only those addresses actively assigned to resources may be targeted. Additionally, the network, gateway, or broadcast address of any Portable subnet may not be a routing destination. For some VLANs utilizing the HSRP redundancy strategy, there are additional addresses which cannot be a route destination. 

         * 

         * When routing a subnet that is already routed, note that the subnet first has its route removed; this procedure is the same as what will occur when using SoftLayer_Network_Subnet::clearRoute. Special consideration should be made for subnets routed as Portable. Please refer to the documentation for SoftLayer_Network_Subnet::clearRoute for details. 

         * 

         * The behavior of this interface is such that either true or false is returned. A response of false indicates the route request would not result in the route of the subnet changing; attempts to route the subnet to the same destination, even if identified by differing means, will result in no changes. A result of false can be interpreted as the route request having already been completed. In contrast, a result of true means the requested destination is different from the current destination and the subnet's routing will be transitioned. This route change is asynchronous to the request. A response of true does not mean the subnet's route has changed, but simply that it will change. In order to monitor for the completion of the change, you may either attempt a route change again until the result is false, or monitor one or more SoftLayer_Network_Subnet properties: subnetType, networkVlanId, and or endPointIpAddress to determine if routing of the subnet has become the desired route destination. 

         * 

         * Use of this operation is limited to a single active request per subnet. If a previous route request is not yet complete, a "not ready" message will be returned upon subsequent requests. 
         *
         * @see SoftLayer_Network_Subnet::route
         */
        @ApiMethod(instanceRequired = true)
        public Boolean route(String type, String identifier);

        /**
         * Tag a subnet by passing in one or more tags separated by a comma. Any existing tags you wish to keep should be included in the set of tags, as any missing tags will be removed. To remove all tags from the subnet, send an empty string. 
         *
         * @see SoftLayer_Network_Subnet::setTags
         */
        @ApiMethod(instanceRequired = true)
        public Boolean setTags(String tags);

        /**
         * @see SoftLayer_Network_Subnet::getAccount
         */
        @ApiMethod(instanceRequired = true)
        public Account getAccount();

        /**
         * If present, the active registration for this subnet.
         *
         * @see SoftLayer_Network_Subnet::getActiveRegistration
         */
        @ApiMethod(instanceRequired = true)
        public Registration getActiveRegistration();

        /**
         * DEPRECATED
         *
         * @see SoftLayer_Network_Subnet::getActiveSwipTransaction
         */
        @ApiMethod(instanceRequired = true)
        public Transaction getActiveSwipTransaction();

        /**
         * DEPRECATED
         *
         * @see SoftLayer_Network_Subnet::getActiveTransaction
         */
        @ApiMethod(instanceRequired = true)
        public com.softlayer.api.service.provisioning.version1.Transaction getActiveTransaction();

        /**
         * Identifier which distinguishes what classification of addresses the subnet represents.
         *
         * @see SoftLayer_Network_Subnet::getAddressSpace
         */
        @ApiMethod(instanceRequired = true)
        public String getAddressSpace();

        /**
         * The SoftLayer_Network_Storage_Allowed_Host information to connect this Subnet to Network Storage supporting access control lists.
         *
         * @see SoftLayer_Network_Subnet::getAllowedHost
         */
        @ApiMethod(instanceRequired = true)
        public Host getAllowedHost();

        /**
         * The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
         *
         * @see SoftLayer_Network_Subnet::getAllowedNetworkStorage
         */
        @ApiMethod(instanceRequired = true)
        public List getAllowedNetworkStorage();

        /**
         * The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
         *
         * @see SoftLayer_Network_Subnet::getAllowedNetworkStorageReplicas
         */
        @ApiMethod(instanceRequired = true)
        public List getAllowedNetworkStorageReplicas();

        /**
         * The billing item for a subnet.
         *
         * @see SoftLayer_Network_Subnet::getBillingItem
         */
        @ApiMethod(instanceRequired = true)
        public Item getBillingItem();

        /**
         * @see SoftLayer_Network_Subnet::getBoundDescendants
         */
        @ApiMethod(instanceRequired = true)
        public List getBoundDescendants();

        /**
         * Whether or not this subnet is associated with a router. Subnets that are not associated with a router cannot be routed.
         *
         * @see SoftLayer_Network_Subnet::getBoundRouterFlag
         */
        @ApiMethod(instanceRequired = true)
        public Boolean getBoundRouterFlag();

        /**
         * @see SoftLayer_Network_Subnet::getBoundRouters
         */
        @ApiMethod(instanceRequired = true)
        public List getBoundRouters();

        /**
         * @see SoftLayer_Network_Subnet::getChildren
         */
        @ApiMethod(instanceRequired = true)
        public List getChildren();

        /**
         * The data center this subnet may be routed within.
         *
         * @see SoftLayer_Network_Subnet::getDatacenter
         */
        @ApiMethod(instanceRequired = true)
        public Datacenter getDatacenter();

        /**
         * @see SoftLayer_Network_Subnet::getDescendants
         */
        @ApiMethod(instanceRequired = true)
        public List getDescendants();

        /**
         * @see SoftLayer_Network_Subnet::getDisplayLabel
         */
        @ApiMethod(instanceRequired = true)
        public String getDisplayLabel();

        /**
         * A static routed ip address
         *
         * @see SoftLayer_Network_Subnet::getEndPointIpAddress
         */
        @ApiMethod(instanceRequired = true)
        public IpAddress getEndPointIpAddress();

        /**
         * @see SoftLayer_Network_Subnet::getGlobalIpRecord
         */
        @ApiMethod(instanceRequired = true)
        public Global getGlobalIpRecord();

        /**
         * The hardware using IP addresses on this subnet.
         *
         * @see SoftLayer_Network_Subnet::getHardware
         */
        @ApiMethod(instanceRequired = true)
        public List getHardware();

        /**
         * All the ip addresses associated with a subnet.
         *
         * @see SoftLayer_Network_Subnet::getIpAddresses
         */
        @ApiMethod(instanceRequired = true)
        public List getIpAddresses();

        /**
         * The upstream network component firewall.
         *
         * @see SoftLayer_Network_Subnet::getNetworkComponentFirewall
         */
        @ApiMethod(instanceRequired = true)
        public Firewall getNetworkComponentFirewall();

        /**
         * @see SoftLayer_Network_Subnet::getNetworkProtectionAddresses
         */
        @ApiMethod(instanceRequired = true)
        public List getNetworkProtectionAddresses();

        /**
         * IPSec network tunnels that have access to a private subnet.
         *
         * @see SoftLayer_Network_Subnet::getNetworkTunnelContexts
         */
        @ApiMethod(instanceRequired = true)
        public List getNetworkTunnelContexts();

        /**
         * The VLAN object that a subnet is associated with.
         *
         * @see SoftLayer_Network_Subnet::getNetworkVlan
         */
        @ApiMethod(instanceRequired = true)
        public Vlan getNetworkVlan();

        /**
         * The pod in which this subnet resides.
         *
         * @see SoftLayer_Network_Subnet::getPodName
         */
        @ApiMethod(instanceRequired = true)
        public String getPodName();

        /**
         * @see SoftLayer_Network_Subnet::getProtectedIpAddresses
         */
        @ApiMethod(instanceRequired = true)
        public List getProtectedIpAddresses();

        /**
         * @see SoftLayer_Network_Subnet::getRegionalInternetRegistry
         */
        @ApiMethod(instanceRequired = true)
        public Registry getRegionalInternetRegistry();

        /**
         * All registrations that have been created for this subnet.
         *
         * @see SoftLayer_Network_Subnet::getRegistrations
         */
        @ApiMethod(instanceRequired = true)
        public List getRegistrations();

        /**
         * The reverse DNS domain associated with this subnet.
         *
         * @see SoftLayer_Network_Subnet::getReverseDomain
         */
        @ApiMethod(instanceRequired = true)
        public Domain getReverseDomain();

        /**
         * An identifier of the role the subnet is within. Roles dictate how a subnet may be used.
         *
         * @see SoftLayer_Network_Subnet::getRoleKeyName
         */
        @ApiMethod(instanceRequired = true)
        public String getRoleKeyName();

        /**
         * The name of the role the subnet is within. Roles dictate how a subnet may be used.
         *
         * @see SoftLayer_Network_Subnet::getRoleName
         */
        @ApiMethod(instanceRequired = true)
        public String getRoleName();

        /**
         * The identifier for the type of route then subnet is currently configured for.
         *
         * @see SoftLayer_Network_Subnet::getRoutingTypeKeyName
         */
        @ApiMethod(instanceRequired = true)
        public String getRoutingTypeKeyName();

        /**
         * The name for the type of route then subnet is currently configured for.
         *
         * @see SoftLayer_Network_Subnet::getRoutingTypeName
         */
        @ApiMethod(instanceRequired = true)
        public String getRoutingTypeName();

        /**
         * DEPRECATED
         *
         * @see SoftLayer_Network_Subnet::getSwipTransaction
         */
        @ApiMethod(instanceRequired = true)
        public List getSwipTransaction();

        /**
         * References to all tags for this subnet.
         *
         * @see SoftLayer_Network_Subnet::getTagReferences
         */
        @ApiMethod(instanceRequired = true)
        public List getTagReferences();

        /**
         * @see SoftLayer_Network_Subnet::getUnboundDescendants
         */
        @ApiMethod(instanceRequired = true)
        public List getUnboundDescendants();

        /**
         * Provides the total number of utilized IP addresses on this subnet. The primary consumer of IP addresses are compute resources, which can consume more than one address. This value is only supported for primary subnet types.
         *
         * @see SoftLayer_Network_Subnet::getUtilizedIpAddressCount
         */
        @ApiMethod(instanceRequired = true)
        public Long getUtilizedIpAddressCount();

        /**
         * The Virtual Servers using IP addresses on this subnet.
         *
         * @see SoftLayer_Network_Subnet::getVirtualGuests
         */
        @ApiMethod(instanceRequired = true)
        public List getVirtualGuests();

    }

    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#allowAccessToNetworkStorage}
         */
        public Future allowAccessToNetworkStorage(Storage networkStorageTemplateObject);

        public Future allowAccessToNetworkStorage(Storage networkStorageTemplateObject, ResponseHandler callback);

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

        public Future allowAccessToNetworkStorageList(List networkStorageTemplateObjects, ResponseHandler callback);

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

        public Future clearRoute(ResponseHandler callback);

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

        public Future createReverseDomainRecords(ResponseHandler callback);

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

        public Future createSubnetRouteUpdateTransaction(String newEndPointIpAddress, ResponseHandler callback);

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

        public Future createSwipTransaction(ResponseHandler callback);

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

        public Future editNote(String note, ResponseHandler callback);

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

        public Future findAllSubnetsAndActiveSwipTransactionStatus(ResponseHandler> callback);

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

        public Future getAttachedNetworkStorages(String nasType, ResponseHandler> callback);

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

        public Future getAvailableNetworkStorages(String nasType, ResponseHandler> callback);

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

        public Future getObject(ResponseHandler callback);

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

        public Future getReverseDomainRecords(ResponseHandler> callback);

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

        public Future getRoutableEndpointIpAddresses(ResponseHandler> callback);

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

        public Future getSubnetForIpAddress(String ipAddress, ResponseHandler callback);

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

        public Future removeAccessToNetworkStorageList(List networkStorageTemplateObjects, ResponseHandler callback);

        /**
         * Async version of {@link Service#route}
         */
        public Future route(String type, String identifier);

        public Future route(String type, String identifier, ResponseHandler callback);

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

        public Future setTags(String tags, 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#getActiveRegistration}
         */
        public Future getActiveRegistration();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        /**
         * Async callback version of {@link Service#getProtectedIpAddresses}
         */
        public Future getProtectedIpAddresses(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#getRegistrations}
         */
        public Future> getRegistrations();

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        /**
         * Async callback version of {@link Service#getVirtualGuests}
         */
        public Future getVirtualGuests(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.Mask activeRegistration() {
            return withSubMask("activeRegistration", com.softlayer.api.service.network.subnet.Registration.Mask.class);
        }

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

        public com.softlayer.api.service.provisioning.version1.Transaction.Mask activeTransaction() {
            return withSubMask("activeTransaction", com.softlayer.api.service.provisioning.version1.Transaction.Mask.class);
        }

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

        public com.softlayer.api.service.network.storage.allowed.Host.Mask allowedHost() {
            return withSubMask("allowedHost", com.softlayer.api.service.network.storage.allowed.Host.Mask.class);
        }

        public Storage.Mask allowedNetworkStorage() {
            return withSubMask("allowedNetworkStorage", Storage.Mask.class);
        }

        public Storage.Mask allowedNetworkStorageReplicas() {
            return withSubMask("allowedNetworkStorageReplicas", Storage.Mask.class);
        }

        public com.softlayer.api.service.billing.Item.Mask billingItem() {
            return withSubMask("billingItem", com.softlayer.api.service.billing.Item.Mask.class);
        }

        public Subnet.Mask boundDescendants() {
            return withSubMask("boundDescendants", Subnet.Mask.class);
        }

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

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

        public Subnet.Mask children() {
            return withSubMask("children", Subnet.Mask.class);
        }

        public com.softlayer.api.service.location.Datacenter.Mask datacenter() {
            return withSubMask("datacenter", com.softlayer.api.service.location.Datacenter.Mask.class);
        }

        public Subnet.Mask descendants() {
            return withSubMask("descendants", Subnet.Mask.class);
        }

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

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

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

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

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

        public com.softlayer.api.service.network.component.Firewall.Mask networkComponentFirewall() {
            return withSubMask("networkComponentFirewall", com.softlayer.api.service.network.component.Firewall.Mask.class);
        }

        public com.softlayer.api.service.network.protection.Address.Mask networkProtectionAddresses() {
            return withSubMask("networkProtectionAddresses", com.softlayer.api.service.network.protection.Address.Mask.class);
        }

        public com.softlayer.api.service.network.tunnel.module.Context.Mask networkTunnelContexts() {
            return withSubMask("networkTunnelContexts", com.softlayer.api.service.network.tunnel.module.Context.Mask.class);
        }

        public Vlan.Mask networkVlan() {
            return withSubMask("networkVlan", Vlan.Mask.class);
        }

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

        public com.softlayer.api.service.network.subnet.IpAddress.Mask protectedIpAddresses() {
            return withSubMask("protectedIpAddresses", com.softlayer.api.service.network.subnet.IpAddress.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.network.subnet.Registration.Mask registrations() {
            return withSubMask("registrations", com.softlayer.api.service.network.subnet.Registration.Mask.class);
        }

        public com.softlayer.api.service.dns.Domain.Mask reverseDomain() {
            return withSubMask("reverseDomain", com.softlayer.api.service.dns.Domain.Mask.class);
        }

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

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

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

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

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

        public com.softlayer.api.service.tag.Reference.Mask tagReferences() {
            return withSubMask("tagReferences", com.softlayer.api.service.tag.Reference.Mask.class);
        }

        public Subnet.Mask unboundDescendants() {
            return withSubMask("unboundDescendants", Subnet.Mask.class);
        }

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

        public com.softlayer.api.service.virtual.Guest.Mask virtualGuests() {
            return withSubMask("virtualGuests", com.softlayer.api.service.virtual.Guest.Mask.class);
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    }

}