com.softlayer.api.service.network.bandwidth.version1.Allocation 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.billing.item.Hardware;
import com.softlayer.api.service.network.bandwidth.version1.allotment.Detail;
import java.math.BigDecimal;

/**
 * The SoftLayer_Network_Bandwidth_Version1_Allocation data type contains general information relating to a single bandwidth allocation record. 
 *
 * @see SoftLayer_Network_Bandwidth_Version1_Allocation
 */
@ApiType("SoftLayer_Network_Bandwidth_Version1_Allocation")
public class Allocation extends Entity {

    /**
     * A bandwidth allotment detail.
     */
    @ApiProperty
    protected Detail allotmentDetail;

    public Detail getAllotmentDetail() {
        return allotmentDetail;
    }

    public void setAllotmentDetail(Detail allotmentDetail) {
        this.allotmentDetail = allotmentDetail;
    }

    /**
     * Billing item associated with this hardware allocation.
     */
    @ApiProperty
    protected Hardware billingItem;

    public Hardware getBillingItem() {
        return billingItem;
    }

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

    /**
     * The amount of bandwidth allocated.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal amount;

    public BigDecimal getAmount() {
        return amount;
    }

    public void setAmount(BigDecimal amount) {
        amountSpecified = true;
        this.amount = amount;
    }

    protected boolean amountSpecified;

    public boolean isAmountSpecified() {
        return amountSpecified;
    }

    public void unsetAmount() {
        amount = null;
        amountSpecified = false;
    }

    /**
     * Internal ID associated with this allocation.
     */
    @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;
    }

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

        public com.softlayer.api.service.network.bandwidth.version1.allotment.Detail.Mask allotmentDetail() {
            return withSubMask("allotmentDetail", com.softlayer.api.service.network.bandwidth.version1.allotment.Detail.Mask.class);
        }

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

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

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

    }

}