com.softlayer.api.service.network.bandwidth.version1.Interface 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.bandwidth.version1;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.network.Component;
import com.softlayer.api.service.network.bandwidth.version1.Host;

/**
 * All bandwidth tracking is maintained through the switch that the bandwidth is used through.  All bandwidth is stored in a "pod" repository.  An interface links the hardware switch with the pod repository identification number. This is only relevant to bandwidth data.  It is not common to use this. 
 *
 * @see SoftLayer_Network_Bandwidth_Version1_Interface
 */
@ApiType("SoftLayer_Network_Bandwidth_Version1_Interface")
public class Interface extends Entity {

    /**
     * The host for an interface. This is not to be confused with a SoftLayer hardware
     */
    @ApiProperty
    protected Host host;

    public Host getHost() {
        return host;
    }

    public void setHost(Host host) {
        this.host = host;
    }

    /**
     * The switch for an interface.
     */
    @ApiProperty
    protected Component networkComponent;

    public Component getNetworkComponent() {
        return networkComponent;
    }

    public void setNetworkComponent(Component networkComponent) {
        this.networkComponent = networkComponent;
    }

    /**
     * A interface's host.  The host stores the pod number for the bandwidth data.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long hostId;

    public Long getHostId() {
        return hostId;
    }

    public void setHostId(Long hostId) {
        hostIdSpecified = true;
        this.hostId = hostId;
    }

    protected boolean hostIdSpecified;

    public boolean isHostIdSpecified() {
        return hostIdSpecified;
    }

    public void unsetHostId() {
        hostId = null;
        hostIdSpecified = false;
    }

    /**
     * The network component for this interface.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long networkComponentId;

    public Long getNetworkComponentId() {
        return networkComponentId;
    }

    public void setNetworkComponentId(Long networkComponentId) {
        networkComponentIdSpecified = true;
        this.networkComponentId = networkComponentId;
    }

    protected boolean networkComponentIdSpecified;

    public boolean isNetworkComponentIdSpecified() {
        return networkComponentIdSpecified;
    }

    public void unsetNetworkComponentId() {
        networkComponentId = null;
        networkComponentIdSpecified = false;
    }

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

        public Host.Mask host() {
            return withSubMask("host", Host.Mask.class);
        }

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

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

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

    }

}