com.softlayer.api.service.container.bandwidth.Projection 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.container.bandwidth;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import java.util.GregorianCalendar;

/**
 * SoftLayer_Container_Bandwidth_Projection models projected bandwidth use over a time range.
 *
 * @see SoftLayer_Container_Bandwidth_Projection
 */
@ApiType("SoftLayer_Container_Bandwidth_Projection")
public class Projection extends Entity {

    /**
     * Bandwidth limit for this hardware.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String allowedUsage;

    public String getAllowedUsage() {
        return allowedUsage;
    }

    public void setAllowedUsage(String allowedUsage) {
        allowedUsageSpecified = true;
        this.allowedUsage = allowedUsage;
    }

    protected boolean allowedUsageSpecified;

    public boolean isAllowedUsageSpecified() {
        return allowedUsageSpecified;
    }

    public void unsetAllowedUsage() {
        allowedUsage = null;
        allowedUsageSpecified = false;
    }

    /**
     * Estimated bandwidth usage so far this billing cycle.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String estimatedUsage;

    public String getEstimatedUsage() {
        return estimatedUsage;
    }

    public void setEstimatedUsage(String estimatedUsage) {
        estimatedUsageSpecified = true;
        this.estimatedUsage = estimatedUsage;
    }

    protected boolean estimatedUsageSpecified;

    public boolean isEstimatedUsageSpecified() {
        return estimatedUsageSpecified;
    }

    public void unsetEstimatedUsage() {
        estimatedUsage = null;
        estimatedUsageSpecified = false;
    }

    /**
     * Hardware ID of server to monitor.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long hardwareId;

    public Long getHardwareId() {
        return hardwareId;
    }

    public void setHardwareId(Long hardwareId) {
        hardwareIdSpecified = true;
        this.hardwareId = hardwareId;
    }

    protected boolean hardwareIdSpecified;

    public boolean isHardwareIdSpecified() {
        return hardwareIdSpecified;
    }

    public void unsetHardwareId() {
        hardwareId = null;
        hardwareIdSpecified = false;
    }

    /**
     * Projected usage for this hardware based on previous usage this billing cycle.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String projectedUsage;

    public String getProjectedUsage() {
        return projectedUsage;
    }

    public void setProjectedUsage(String projectedUsage) {
        projectedUsageSpecified = true;
        this.projectedUsage = projectedUsage;
    }

    protected boolean projectedUsageSpecified;

    public boolean isProjectedUsageSpecified() {
        return projectedUsageSpecified;
    }

    public void unsetProjectedUsage() {
        projectedUsage = null;
        projectedUsageSpecified = false;
    }

    /**
     * the text name of the server being monitored.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serverName;

    public String getServerName() {
        return serverName;
    }

    public void setServerName(String serverName) {
        serverNameSpecified = true;
        this.serverName = serverName;
    }

    protected boolean serverNameSpecified;

    public boolean isServerNameSpecified() {
        return serverNameSpecified;
    }

    public void unsetServerName() {
        serverName = null;
        serverNameSpecified = false;
    }

    /**
     * The minimum date included in this list.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar startDate;

    public GregorianCalendar getStartDate() {
        return startDate;
    }

    public void setStartDate(GregorianCalendar startDate) {
        startDateSpecified = true;
        this.startDate = startDate;
    }

    protected boolean startDateSpecified;

    public boolean isStartDateSpecified() {
        return startDateSpecified;
    }

    public void unsetStartDate() {
        startDate = null;
        startDateSpecified = false;
    }

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

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

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

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

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

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

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

    }

}