com.softlayer.api.service.billing.item.Hardware 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.billing.item;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.billing.Item;
import com.softlayer.api.service.billing.item.network.Storage;
import com.softlayer.api.service.hardware.Server;
import com.softlayer.api.service.network.bandwidth.Usage;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;

/**
 * The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware. 
 *
 * @see SoftLayer_Billing_Item_Hardware
 */
@ApiType("SoftLayer_Billing_Item_Hardware")
public class Hardware extends Item {

    /**
     * The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
     */
    @ApiProperty
    protected List billingCycleBandwidthUsage;

    public List getBillingCycleBandwidthUsage() {
        if (billingCycleBandwidthUsage == null) {
            billingCycleBandwidthUsage = new ArrayList();
        }
        return billingCycleBandwidthUsage;
    }

    /**
     * The raw private bandwidth usage data for the current billing cycle.
     */
    @ApiProperty
    protected List billingCyclePrivateBandwidthUsage;

    public List getBillingCyclePrivateBandwidthUsage() {
        if (billingCyclePrivateBandwidthUsage == null) {
            billingCyclePrivateBandwidthUsage = new ArrayList();
        }
        return billingCyclePrivateBandwidthUsage;
    }

    /**
     * The total private inbound bandwidth for this hardware for the current billing cycle.
     */
    @ApiProperty
    protected BigDecimal billingCyclePrivateUsageIn;

    public BigDecimal getBillingCyclePrivateUsageIn() {
        return billingCyclePrivateUsageIn;
    }

    public void setBillingCyclePrivateUsageIn(BigDecimal billingCyclePrivateUsageIn) {
        this.billingCyclePrivateUsageIn = billingCyclePrivateUsageIn;
    }

    /**
     * The total private outbound bandwidth for this hardware for the current billing cycle.
     */
    @ApiProperty
    protected BigDecimal billingCyclePrivateUsageOut;

    public BigDecimal getBillingCyclePrivateUsageOut() {
        return billingCyclePrivateUsageOut;
    }

    public void setBillingCyclePrivateUsageOut(BigDecimal billingCyclePrivateUsageOut) {
        this.billingCyclePrivateUsageOut = billingCyclePrivateUsageOut;
    }

    /**
     * The total private bandwidth for this hardware for the current billing cycle.
     */
    @ApiProperty
    protected Long billingCyclePrivateUsageTotal;

    public Long getBillingCyclePrivateUsageTotal() {
        return billingCyclePrivateUsageTotal;
    }

    public void setBillingCyclePrivateUsageTotal(Long billingCyclePrivateUsageTotal) {
        this.billingCyclePrivateUsageTotal = billingCyclePrivateUsageTotal;
    }

    /**
     * The raw public bandwidth usage data for the current billing cycle.
     */
    @ApiProperty
    protected List billingCyclePublicBandwidthUsage;

    public List getBillingCyclePublicBandwidthUsage() {
        if (billingCyclePublicBandwidthUsage == null) {
            billingCyclePublicBandwidthUsage = new ArrayList();
        }
        return billingCyclePublicBandwidthUsage;
    }

    /**
     * The total public inbound bandwidth for this hardware for the current billing cycle.
     */
    @ApiProperty
    protected BigDecimal billingCyclePublicUsageIn;

    public BigDecimal getBillingCyclePublicUsageIn() {
        return billingCyclePublicUsageIn;
    }

    public void setBillingCyclePublicUsageIn(BigDecimal billingCyclePublicUsageIn) {
        this.billingCyclePublicUsageIn = billingCyclePublicUsageIn;
    }

    /**
     * The total public outbound bandwidth for this hardware for the current billing cycle.
     */
    @ApiProperty
    protected BigDecimal billingCyclePublicUsageOut;

    public BigDecimal getBillingCyclePublicUsageOut() {
        return billingCyclePublicUsageOut;
    }

    public void setBillingCyclePublicUsageOut(BigDecimal billingCyclePublicUsageOut) {
        this.billingCyclePublicUsageOut = billingCyclePublicUsageOut;
    }

    /**
     * The total public bandwidth for this hardware for the current billing cycle.
     */
    @ApiProperty
    protected Long billingCyclePublicUsageTotal;

    public Long getBillingCyclePublicUsageTotal() {
        return billingCyclePublicUsageTotal;
    }

    public void setBillingCyclePublicUsageTotal(Long billingCyclePublicUsageTotal) {
        this.billingCyclePublicUsageTotal = billingCyclePublicUsageTotal;
    }

    /**
     * A lockbox account associated with a server.
     */
    @ApiProperty
    protected Storage lockboxNetworkStorage;

    public Storage getLockboxNetworkStorage() {
        return lockboxNetworkStorage;
    }

    public void setLockboxNetworkStorage(Storage lockboxNetworkStorage) {
        this.lockboxNetworkStorage = lockboxNetworkStorage;
    }

    @ApiProperty
    protected List monitoringBillingItems;

    public List getMonitoringBillingItems() {
        if (monitoringBillingItems == null) {
            monitoringBillingItems = new ArrayList();
        }
        return monitoringBillingItems;
    }

    /**
     * The resource for a server billing item.
     */
    @ApiProperty
    protected Server resource;

    public Server getResource() {
        return resource;
    }

    public void setResource(Server resource) {
        this.resource = resource;
    }

    /**
     * The resource (unique identifier) for a server billing item.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long resourceTableId;

    public Long getResourceTableId() {
        return resourceTableId;
    }

    public void setResourceTableId(Long resourceTableId) {
        resourceTableIdSpecified = true;
        this.resourceTableId = resourceTableId;
    }

    protected boolean resourceTableIdSpecified;

    public boolean isResourceTableIdSpecified() {
        return resourceTableIdSpecified;
    }

    public void unsetResourceTableId() {
        resourceTableId = null;
        resourceTableIdSpecified = false;
    }

    /**
     * A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
     */
    @ApiProperty
    protected Long billingCycleBandwidthUsageCount;

    public Long getBillingCycleBandwidthUsageCount() {
        return billingCycleBandwidthUsageCount;
    }

    public void setBillingCycleBandwidthUsageCount(Long billingCycleBandwidthUsageCount) {
        this.billingCycleBandwidthUsageCount = billingCycleBandwidthUsageCount;
    }

    /**
     * A count of the raw private bandwidth usage data for the current billing cycle.
     */
    @ApiProperty
    protected Long billingCyclePrivateBandwidthUsageCount;

    public Long getBillingCyclePrivateBandwidthUsageCount() {
        return billingCyclePrivateBandwidthUsageCount;
    }

    public void setBillingCyclePrivateBandwidthUsageCount(Long billingCyclePrivateBandwidthUsageCount) {
        this.billingCyclePrivateBandwidthUsageCount = billingCyclePrivateBandwidthUsageCount;
    }

    /**
     * A count of the raw public bandwidth usage data for the current billing cycle.
     */
    @ApiProperty
    protected Long billingCyclePublicBandwidthUsageCount;

    public Long getBillingCyclePublicBandwidthUsageCount() {
        return billingCyclePublicBandwidthUsageCount;
    }

    public void setBillingCyclePublicBandwidthUsageCount(Long billingCyclePublicBandwidthUsageCount) {
        this.billingCyclePublicBandwidthUsageCount = billingCyclePublicBandwidthUsageCount;
    }

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

    public Long getMonitoringBillingItemCount() {
        return monitoringBillingItemCount;
    }

    public void setMonitoringBillingItemCount(Long monitoringBillingItemCount) {
        this.monitoringBillingItemCount = monitoringBillingItemCount;
    }

    public static class Mask extends com.softlayer.api.service.billing.Item.Mask {

        public com.softlayer.api.service.network.bandwidth.Usage.Mask billingCycleBandwidthUsage() {
            return withSubMask("billingCycleBandwidthUsage", com.softlayer.api.service.network.bandwidth.Usage.Mask.class);
        }

        public com.softlayer.api.service.network.bandwidth.Usage.Mask billingCyclePrivateBandwidthUsage() {
            return withSubMask("billingCyclePrivateBandwidthUsage", com.softlayer.api.service.network.bandwidth.Usage.Mask.class);
        }

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

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

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

        public com.softlayer.api.service.network.bandwidth.Usage.Mask billingCyclePublicBandwidthUsage() {
            return withSubMask("billingCyclePublicBandwidthUsage", com.softlayer.api.service.network.bandwidth.Usage.Mask.class);
        }

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

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

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

        public com.softlayer.api.service.billing.item.network.Storage.Mask lockboxNetworkStorage() {
            return withSubMask("lockboxNetworkStorage", com.softlayer.api.service.billing.item.network.Storage.Mask.class);
        }

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

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

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

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

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

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

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

    }

}