com.softlayer.api.service.network.bandwidth.version1.Allotment 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
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.bandwidth.version1;
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.container.Graph;
import com.softlayer.api.service.container.bandwidth.GraphOutputs;
import com.softlayer.api.service.container.network.bandwidth.version1.Usage;
import com.softlayer.api.service.location.Group;
import com.softlayer.api.service.metric.tracking.object.Data;
import com.softlayer.api.service.metric.tracking.object.VirtualDedicatedRack;
import com.softlayer.api.service.metric.tracking.object.bandwidth.Summary;
import com.softlayer.api.service.network.application.delivery.Controller;
import com.softlayer.api.service.network.bandwidth.version1.allotment.Type;
import com.softlayer.api.service.network.bandwidth.version1.usage.Detail;
import com.softlayer.api.service.service.Provider;
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_Bandwidth_Version1_Allotment class provides methods and data structures necessary to work with an array of hardware objects associated with a single Bandwidth Pooling.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment
*/
@ApiType("SoftLayer_Network_Bandwidth_Version1_Allotment")
public class Allotment extends Entity {
/**
* The account associated with this virtual rack.
*/
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
/**
* The bandwidth allotment detail records associated with this virtual rack.
*/
@ApiProperty
protected List activeDetails;
public List getActiveDetails() {
if (activeDetails == null) {
activeDetails = new ArrayList();
}
return activeDetails;
}
/**
* The Application Delivery Controller contained within a virtual rack.
*/
@ApiProperty
protected List applicationDeliveryControllers;
public List getApplicationDeliveryControllers() {
if (applicationDeliveryControllers == null) {
applicationDeliveryControllers = new ArrayList();
}
return applicationDeliveryControllers;
}
/**
* The average daily public bandwidth usage for the current billing cycle.
*/
@ApiProperty
protected BigDecimal averageDailyPublicBandwidthUsage;
public BigDecimal getAverageDailyPublicBandwidthUsage() {
return averageDailyPublicBandwidthUsage;
}
public void setAverageDailyPublicBandwidthUsage(BigDecimal averageDailyPublicBandwidthUsage) {
this.averageDailyPublicBandwidthUsage = averageDailyPublicBandwidthUsage;
}
/**
* The bandwidth allotment type of this virtual rack.
*/
@ApiProperty
protected Type bandwidthAllotmentType;
public Type getBandwidthAllotmentType() {
return bandwidthAllotmentType;
}
public void setBandwidthAllotmentType(Type bandwidthAllotmentType) {
this.bandwidthAllotmentType = bandwidthAllotmentType;
}
/**
* The bare metal server instances contained within a virtual rack.
*/
@ApiProperty
protected List bareMetalInstances;
public List getBareMetalInstances() {
if (bareMetalInstances == null) {
bareMetalInstances = new ArrayList();
}
return bareMetalInstances;
}
/**
* A virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to.
*/
@ApiProperty
protected List billingCycleBandwidthUsage;
public List getBillingCycleBandwidthUsage() {
if (billingCycleBandwidthUsage == null) {
billingCycleBandwidthUsage = new ArrayList();
}
return billingCycleBandwidthUsage;
}
/**
* A virtual rack's raw private network bandwidth usage data for an account's current billing cycle.
*/
@ApiProperty
protected com.softlayer.api.service.network.bandwidth.Usage billingCyclePrivateBandwidthUsage;
public com.softlayer.api.service.network.bandwidth.Usage getBillingCyclePrivateBandwidthUsage() {
return billingCyclePrivateBandwidthUsage;
}
public void setBillingCyclePrivateBandwidthUsage(com.softlayer.api.service.network.bandwidth.Usage billingCyclePrivateBandwidthUsage) {
this.billingCyclePrivateBandwidthUsage = billingCyclePrivateBandwidthUsage;
}
/**
* A virtual rack's raw public network bandwidth usage data for an account's current billing cycle.
*/
@ApiProperty
protected com.softlayer.api.service.network.bandwidth.Usage billingCyclePublicBandwidthUsage;
public com.softlayer.api.service.network.bandwidth.Usage getBillingCyclePublicBandwidthUsage() {
return billingCyclePublicBandwidthUsage;
}
public void setBillingCyclePublicBandwidthUsage(com.softlayer.api.service.network.bandwidth.Usage billingCyclePublicBandwidthUsage) {
this.billingCyclePublicBandwidthUsage = billingCyclePublicBandwidthUsage;
}
/**
* The total public bandwidth used in this virtual rack for an account's current billing cycle.
*/
@ApiProperty
protected Long billingCyclePublicUsageTotal;
public Long getBillingCyclePublicUsageTotal() {
return billingCyclePublicUsageTotal;
}
public void setBillingCyclePublicUsageTotal(Long billingCyclePublicUsageTotal) {
this.billingCyclePublicUsageTotal = billingCyclePublicUsageTotal;
}
/**
* A virtual rack's billing item.
*/
@ApiProperty
protected Item billingItem;
public Item getBillingItem() {
return billingItem;
}
public void setBillingItem(Item billingItem) {
this.billingItem = billingItem;
}
/**
* An object that provides commonly used bandwidth summary components for the current billing cycle.
*/
@ApiProperty
protected Summary currentBandwidthSummary;
public Summary getCurrentBandwidthSummary() {
return currentBandwidthSummary;
}
public void setCurrentBandwidthSummary(Summary currentBandwidthSummary) {
this.currentBandwidthSummary = currentBandwidthSummary;
}
/**
* The bandwidth allotment detail records associated with this virtual rack.
*/
@ApiProperty
protected List details;
public List getDetails() {
if (details == null) {
details = new ArrayList();
}
return details;
}
/**
* The hardware contained within a virtual rack.
*/
@ApiProperty
protected List hardware;
public List getHardware() {
if (hardware == null) {
hardware = new ArrayList();
}
return hardware;
}
/**
* The total public inbound bandwidth used in this virtual rack for an account's current billing cycle.
*/
@ApiProperty
protected BigDecimal inboundPublicBandwidthUsage;
public BigDecimal getInboundPublicBandwidthUsage() {
return inboundPublicBandwidthUsage;
}
public void setInboundPublicBandwidthUsage(BigDecimal inboundPublicBandwidthUsage) {
this.inboundPublicBandwidthUsage = inboundPublicBandwidthUsage;
}
/**
* The location group associated with this virtual rack.
*/
@ApiProperty
protected Group locationGroup;
public Group getLocationGroup() {
return locationGroup;
}
public void setLocationGroup(Group locationGroup) {
this.locationGroup = locationGroup;
}
/**
* The managed bare metal server instances contained within a virtual rack.
*/
@ApiProperty
protected List managedBareMetalInstances;
public List getManagedBareMetalInstances() {
if (managedBareMetalInstances == null) {
managedBareMetalInstances = new ArrayList();
}
return managedBareMetalInstances;
}
/**
* The managed hardware contained within a virtual rack.
*/
@ApiProperty
protected List managedHardware;
public List getManagedHardware() {
if (managedHardware == null) {
managedHardware = new ArrayList();
}
return managedHardware;
}
/**
* The managed Virtual Server contained within a virtual rack.
*/
@ApiProperty
protected List managedVirtualGuests;
public List getManagedVirtualGuests() {
if (managedVirtualGuests == null) {
managedVirtualGuests = new ArrayList();
}
return managedVirtualGuests;
}
/**
* A virtual rack's metric tracking object. This object records all periodic polled data available to this rack.
*/
@ApiProperty
protected VirtualDedicatedRack metricTrackingObject;
public VirtualDedicatedRack getMetricTrackingObject() {
return metricTrackingObject;
}
public void setMetricTrackingObject(VirtualDedicatedRack metricTrackingObject) {
this.metricTrackingObject = metricTrackingObject;
}
/**
* The metric tracking object id for this allotment.
*/
@ApiProperty
protected Long metricTrackingObjectId;
public Long getMetricTrackingObjectId() {
return metricTrackingObjectId;
}
public void setMetricTrackingObjectId(Long metricTrackingObjectId) {
this.metricTrackingObjectId = metricTrackingObjectId;
}
/**
* The total public outbound bandwidth used in this virtual rack for an account's current billing cycle.
*/
@ApiProperty
protected BigDecimal outboundPublicBandwidthUsage;
public BigDecimal getOutboundPublicBandwidthUsage() {
return outboundPublicBandwidthUsage;
}
public void setOutboundPublicBandwidthUsage(BigDecimal outboundPublicBandwidthUsage) {
this.outboundPublicBandwidthUsage = outboundPublicBandwidthUsage;
}
/**
* Whether the bandwidth usage for this bandwidth pool for the current billing cycle exceeds the allocation.
*/
@ApiProperty
protected Long overBandwidthAllocationFlag;
public Long getOverBandwidthAllocationFlag() {
return overBandwidthAllocationFlag;
}
public void setOverBandwidthAllocationFlag(Long overBandwidthAllocationFlag) {
this.overBandwidthAllocationFlag = overBandwidthAllocationFlag;
}
/**
* The private network only hardware contained within a virtual rack.
*/
@ApiProperty
protected List privateNetworkOnlyHardware;
public List getPrivateNetworkOnlyHardware() {
if (privateNetworkOnlyHardware == null) {
privateNetworkOnlyHardware = new ArrayList();
}
return privateNetworkOnlyHardware;
}
/**
* Whether the bandwidth usage for this bandwidth pool for the current billing cycle is projected to exceed the allocation.
*/
@ApiProperty
protected Long projectedOverBandwidthAllocationFlag;
public Long getProjectedOverBandwidthAllocationFlag() {
return projectedOverBandwidthAllocationFlag;
}
public void setProjectedOverBandwidthAllocationFlag(Long projectedOverBandwidthAllocationFlag) {
this.projectedOverBandwidthAllocationFlag = projectedOverBandwidthAllocationFlag;
}
/**
* The projected public outbound bandwidth for this virtual server for the current billing cycle.
*/
@ApiProperty
protected BigDecimal projectedPublicBandwidthUsage;
public BigDecimal getProjectedPublicBandwidthUsage() {
return projectedPublicBandwidthUsage;
}
public void setProjectedPublicBandwidthUsage(BigDecimal projectedPublicBandwidthUsage) {
this.projectedPublicBandwidthUsage = projectedPublicBandwidthUsage;
}
@ApiProperty
protected Provider serviceProvider;
public Provider getServiceProvider() {
return serviceProvider;
}
public void setServiceProvider(Provider serviceProvider) {
this.serviceProvider = serviceProvider;
}
/**
* The combined allocated bandwidth for all servers in a virtual rack.
*/
@ApiProperty
protected Long totalBandwidthAllocated;
public Long getTotalBandwidthAllocated() {
return totalBandwidthAllocated;
}
public void setTotalBandwidthAllocated(Long totalBandwidthAllocated) {
this.totalBandwidthAllocated = totalBandwidthAllocated;
}
/**
* The Virtual Server contained within a virtual rack.
*/
@ApiProperty
protected List virtualGuests;
public List getVirtualGuests() {
if (virtualGuests == null) {
virtualGuests = new ArrayList();
}
return virtualGuests;
}
/**
* The user account identifier associated with this allotment.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long accountId;
public Long getAccountId() {
return accountId;
}
public void setAccountId(Long accountId) {
accountIdSpecified = true;
this.accountId = accountId;
}
protected boolean accountIdSpecified;
public boolean isAccountIdSpecified() {
return accountIdSpecified;
}
public void unsetAccountId() {
accountId = null;
accountIdSpecified = false;
}
/**
* An identifier marking this allotment as a virtual private rack (1) or a bandwidth pooling(2).
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long bandwidthAllotmentTypeId;
public Long getBandwidthAllotmentTypeId() {
return bandwidthAllotmentTypeId;
}
public void setBandwidthAllotmentTypeId(Long bandwidthAllotmentTypeId) {
bandwidthAllotmentTypeIdSpecified = true;
this.bandwidthAllotmentTypeId = bandwidthAllotmentTypeId;
}
protected boolean bandwidthAllotmentTypeIdSpecified;
public boolean isBandwidthAllotmentTypeIdSpecified() {
return bandwidthAllotmentTypeIdSpecified;
}
public void unsetBandwidthAllotmentTypeId() {
bandwidthAllotmentTypeId = null;
bandwidthAllotmentTypeIdSpecified = false;
}
/**
* Creation date for an allotment.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar createDate;
public GregorianCalendar getCreateDate() {
return createDate;
}
public void setCreateDate(GregorianCalendar createDate) {
createDateSpecified = true;
this.createDate = createDate;
}
protected boolean createDateSpecified;
public boolean isCreateDateSpecified() {
return createDateSpecified;
}
public void unsetCreateDate() {
createDate = null;
createDateSpecified = false;
}
/**
* End date for an allotment.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar endDate;
public GregorianCalendar getEndDate() {
return endDate;
}
public void setEndDate(GregorianCalendar endDate) {
endDateSpecified = true;
this.endDate = endDate;
}
protected boolean endDateSpecified;
public boolean isEndDateSpecified() {
return endDateSpecified;
}
public void unsetEndDate() {
endDate = null;
endDateSpecified = false;
}
/**
* A virtual rack'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;
}
/**
* Location Group Id for an allotment
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long locationGroupId;
public Long getLocationGroupId() {
return locationGroupId;
}
public void setLocationGroupId(Long locationGroupId) {
locationGroupIdSpecified = true;
this.locationGroupId = locationGroupId;
}
protected boolean locationGroupIdSpecified;
public boolean isLocationGroupIdSpecified() {
return locationGroupIdSpecified;
}
public void unsetLocationGroupId() {
locationGroupId = null;
locationGroupIdSpecified = false;
}
/**
* Text A virtual rack's name.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String name;
public String getName() {
return name;
}
public void setName(String name) {
nameSpecified = true;
this.name = name;
}
protected boolean nameSpecified;
public boolean isNameSpecified() {
return nameSpecified;
}
public void unsetName() {
name = null;
nameSpecified = false;
}
/**
* Service Provider Id for an allotment
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long serviceProviderId;
public Long getServiceProviderId() {
return serviceProviderId;
}
public void setServiceProviderId(Long serviceProviderId) {
serviceProviderIdSpecified = true;
this.serviceProviderId = serviceProviderId;
}
protected boolean serviceProviderIdSpecified;
public boolean isServiceProviderIdSpecified() {
return serviceProviderIdSpecified;
}
public void unsetServiceProviderId() {
serviceProviderId = null;
serviceProviderIdSpecified = false;
}
/**
* A count of the bandwidth allotment detail records associated with this virtual rack.
*/
@ApiProperty
protected Long activeDetailCount;
public Long getActiveDetailCount() {
return activeDetailCount;
}
public void setActiveDetailCount(Long activeDetailCount) {
this.activeDetailCount = activeDetailCount;
}
/**
* A count of the Application Delivery Controller contained within a virtual rack.
*/
@ApiProperty
protected Long applicationDeliveryControllerCount;
public Long getApplicationDeliveryControllerCount() {
return applicationDeliveryControllerCount;
}
public void setApplicationDeliveryControllerCount(Long applicationDeliveryControllerCount) {
this.applicationDeliveryControllerCount = applicationDeliveryControllerCount;
}
/**
* A count of the bare metal server instances contained within a virtual rack.
*/
@ApiProperty
protected Long bareMetalInstanceCount;
public Long getBareMetalInstanceCount() {
return bareMetalInstanceCount;
}
public void setBareMetalInstanceCount(Long bareMetalInstanceCount) {
this.bareMetalInstanceCount = bareMetalInstanceCount;
}
/**
* A count of a virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is 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 bandwidth allotment detail records associated with this virtual rack.
*/
@ApiProperty
protected Long detailCount;
public Long getDetailCount() {
return detailCount;
}
public void setDetailCount(Long detailCount) {
this.detailCount = detailCount;
}
/**
* A count of the hardware contained within a virtual rack.
*/
@ApiProperty
protected Long hardwareCount;
public Long getHardwareCount() {
return hardwareCount;
}
public void setHardwareCount(Long hardwareCount) {
this.hardwareCount = hardwareCount;
}
/**
* A count of the managed bare metal server instances contained within a virtual rack.
*/
@ApiProperty
protected Long managedBareMetalInstanceCount;
public Long getManagedBareMetalInstanceCount() {
return managedBareMetalInstanceCount;
}
public void setManagedBareMetalInstanceCount(Long managedBareMetalInstanceCount) {
this.managedBareMetalInstanceCount = managedBareMetalInstanceCount;
}
/**
* A count of the managed hardware contained within a virtual rack.
*/
@ApiProperty
protected Long managedHardwareCount;
public Long getManagedHardwareCount() {
return managedHardwareCount;
}
public void setManagedHardwareCount(Long managedHardwareCount) {
this.managedHardwareCount = managedHardwareCount;
}
/**
* A count of the managed Virtual Server contained within a virtual rack.
*/
@ApiProperty
protected Long managedVirtualGuestCount;
public Long getManagedVirtualGuestCount() {
return managedVirtualGuestCount;
}
public void setManagedVirtualGuestCount(Long managedVirtualGuestCount) {
this.managedVirtualGuestCount = managedVirtualGuestCount;
}
/**
* A count of the private network only hardware contained within a virtual rack.
*/
@ApiProperty
protected Long privateNetworkOnlyHardwareCount;
public Long getPrivateNetworkOnlyHardwareCount() {
return privateNetworkOnlyHardwareCount;
}
public void setPrivateNetworkOnlyHardwareCount(Long privateNetworkOnlyHardwareCount) {
this.privateNetworkOnlyHardwareCount = privateNetworkOnlyHardwareCount;
}
/**
* A count of the Virtual Server contained within a virtual rack.
*/
@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 Bandwidth Pooling, Virtual Datacenter, Virtual Private Rack(VPR) is defined in the SoftLayer_Network_Bandwidth_Version1_Allotment service as an allotment. SoftLayer allotments are a collection of servers that share all of the servers allocated bandwidth together.
*
* Virtual Private Rack Each server is by default a part of your Virtual Private Rack. Bandwidth overages are billed individually per server for all hardware in your Virtual Private Rack. If any one server uses more bandwidth than it is allocated, an overage charge will result.
*
* Bandwidth Pooling Bandwidth Pooling allow you to optimize your bandwidth usage by "pooling" all of the bandwidth together for servers in a Bandwidth Pooling. Bandwidth overages for servers in a Bandwidth Pooling are summed up as a whole and overages are calculated only if the total bandwidth of all servers exceeds the total allocated bandwidth for all servers.
*
* For example, if you had 5 servers, each with 2000 GB of bandwidth, and one server used 3000 GB of bandwidth while the other used only 1500 GB of bandwidth, you would not be billed for an overage because your total usage would be 9000 GB and your total allocated would be 10000 GB.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Network_Bandwidth_Version1_Allotment")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Create a allotment for servers to pool bandwidth and avoid overages in billing if they use more than there allocated bandwidth.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::createObject
*/
@ApiMethod
public Allotment createObject(Allotment templateObject);
/**
* Edit a bandwidth allotment's local properties. Currently you may only change an allotment's name. Use the [[SoftLayer_Network_Bandwidth_Version1_Allotment::reassignServers|reassignServers()]] and [[SoftLayer_Network_Bandwidth_Version1_Allotment::unassignServers|unassignServers()]] methods to move servers in and out of your allotments.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::editObject
*/
@ApiMethod(instanceRequired = true)
public Boolean editObject(Allotment templateObject);
/**
* [DEPRECATED] This method recurses through all servers on a Bandwidth Pool for 24 hour time span starting at a given date/time. To get the private data set for all servers on a Bandwidth Pool from midnight Feb 1st, 2008 to 23:59 on Feb 1st, you would pass a parameter of '02/01/2008 0:00'. The ending date / time is calculated for you to prevent requesting data from the server for periods larger than 24 hours as this method requires processing a lot of data records and can get slow at times.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getBackendBandwidthByHour
*/
@Deprecated
@ApiMethod(instanceRequired = true)
public List getBackendBandwidthByHour(GregorianCalendar date);
/**
* This method recurses through all servers on a Bandwidth Pool between the given start and end dates to retrieve public bandwidth data.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getBackendBandwidthUse
*/
@ApiMethod(instanceRequired = true)
public List getBackendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getBandwidthForDateRange
*/
@ApiMethod(instanceRequired = true)
public List getBandwidthForDateRange(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* This method recurses through all servers on a Bandwidth Pool for a given snapshot range, gathers the necessary parameters, and then calls the bandwidth graphing server. The return result is a container that includes the min and max dates for all servers to be used in the query, as well as an image in PNG format. This method uses the new and improved drawing routines which should return in a reasonable time frame now that the new backend data warehouse is used.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getBandwidthImage
*/
@ApiMethod(instanceRequired = true)
public GraphOutputs getBandwidthImage(String networkType, String snapshotRange, Boolean draw, GregorianCalendar dateSpecified, GregorianCalendar dateSpecifiedEnd);
/**
* Retrieve bandwidth graph by date.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getCustomBandwidthDataByDate
*/
@ApiMethod(instanceRequired = true)
public Graph getCustomBandwidthDataByDate(Graph graphData);
/**
* [DEPRECATED] This method recurses through all servers on a Bandwidth Pool for 24 hour time span starting at a given date/time. To get the public data set for all servers on a Bandwidth Pool from midnight Feb 1st, 2008 to 23:59 on Feb 1st, you would pass a parameter of '02/01/2008 0:00'. The ending date / time is calculated for you to prevent requesting data from the server for periods larger than 24 hours as this method requires processing a lot of data records and can get slow at times.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getFrontendBandwidthByHour
*/
@Deprecated
@ApiMethod(instanceRequired = true)
public List getFrontendBandwidthByHour(GregorianCalendar date);
/**
* This method recurses through all servers on a Bandwidth Pool between the given start and end dates to retrieve private bandwidth data.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getFrontendBandwidthUse
*/
@ApiMethod(instanceRequired = true)
public List getFrontendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* getObject retrieves the SoftLayer_Network_Bandwidth_Version1_Allotment object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve an allotment associated with the account that your portal user is assigned to.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getObject
*/
@ApiMethod(instanceRequired = true)
public Allotment getObject();
/**
* Gets the monthly recurring fee of a pooled server.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getVdrMemberRecurringFee
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getVdrMemberRecurringFee();
/**
* This method will reassign a collection of SoftLayer hardware to a bandwidth allotment Bandwidth Pool.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::reassignServers
*/
@ApiMethod
public Boolean reassignServers(List templateObjects, Long newAllotmentId);
/**
* This will remove a bandwidth pooling from a customer's allotments by cancelling the billing item. All servers in that allotment will get moved to the account's vpr.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::requestVdrCancellation
*/
@ApiMethod(instanceRequired = true)
public Boolean requestVdrCancellation();
/**
* This will move servers into a bandwidth pool, removing them from their previous bandwidth pool and optionally remove the bandwidth pool on completion.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::requestVdrContentUpdates
*/
@ApiMethod(instanceRequired = true)
public Boolean requestVdrContentUpdates(List hardwareToAdd, List hardwareToRemove, List cloudsToAdd, List cloudsToRemove, Long optionalAllotmentId, List adcToAdd, List adcToRemove);
/**
* This will update the bandwidth pool to the servers provided. Servers currently in the bandwidth pool not provided on update will be removed. Servers provided on update not currently in the bandwidth pool will be added. If all servers are removed, this removes the bandwidth pool on completion.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::setVdrContent
*/
@ApiMethod(instanceRequired = true)
public Boolean setVdrContent(List hardware, List bareMetalServers, List virtualServerInstance, List adc, Long optionalAllotmentId);
/**
* This method will reassign a collection of SoftLayer hardware to the virtual private rack
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::unassignServers
*/
@ApiMethod
public Boolean unassignServers(List templateObjects);
/**
* This method will void a pending server removal from this bandwidth pooling. Pass in the id of the hardware object or virtual guest you wish to update. Assuming that object is currently pending removal from the bandwidth pool at the start of the next billing cycle, the bandwidth pool member status will be restored and the pending cancellation removed.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::voidPendingServerMove
*/
@ApiMethod(instanceRequired = true)
public Boolean voidPendingServerMove(Long id, String type);
/**
* This method will void a pending cancellation on a bandwidth pool. Note however any servers that belonged to the rack will have to be restored individually using the method voidPendingServerMove($id, $type).
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::voidPendingVdrCancellation
*/
@ApiMethod(instanceRequired = true)
public Boolean voidPendingVdrCancellation();
/**
* The account associated with this virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getAccount
*/
@ApiMethod(instanceRequired = true)
public Account getAccount();
/**
* The bandwidth allotment detail records associated with this virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getActiveDetails
*/
@ApiMethod(instanceRequired = true)
public List getActiveDetails();
/**
* The Application Delivery Controller contained within a virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getApplicationDeliveryControllers
*/
@ApiMethod(instanceRequired = true)
public List getApplicationDeliveryControllers();
/**
* The average daily public bandwidth usage for the current billing cycle.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getAverageDailyPublicBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getAverageDailyPublicBandwidthUsage();
/**
* The bandwidth allotment type of this virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getBandwidthAllotmentType
*/
@ApiMethod(instanceRequired = true)
public Type getBandwidthAllotmentType();
/**
* The bare metal server instances contained within a virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getBareMetalInstances
*/
@ApiMethod(instanceRequired = true)
public List getBareMetalInstances();
/**
* A virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getBillingCycleBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public List getBillingCycleBandwidthUsage();
/**
* A virtual rack's raw private network bandwidth usage data for an account's current billing cycle.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getBillingCyclePrivateBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.network.bandwidth.Usage getBillingCyclePrivateBandwidthUsage();
/**
* A virtual rack's raw public network bandwidth usage data for an account's current billing cycle.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getBillingCyclePublicBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.network.bandwidth.Usage getBillingCyclePublicBandwidthUsage();
/**
* The total public bandwidth used in this virtual rack for an account's current billing cycle.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getBillingCyclePublicUsageTotal
*/
@ApiMethod(instanceRequired = true)
public Long getBillingCyclePublicUsageTotal();
/**
* A virtual rack's billing item.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getBillingItem
*/
@ApiMethod(instanceRequired = true)
public Item getBillingItem();
/**
* An object that provides commonly used bandwidth summary components for the current billing cycle.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getCurrentBandwidthSummary
*/
@ApiMethod(instanceRequired = true)
public Summary getCurrentBandwidthSummary();
/**
* The bandwidth allotment detail records associated with this virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getDetails
*/
@ApiMethod(instanceRequired = true)
public List getDetails();
/**
* The hardware contained within a virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getHardware
*/
@ApiMethod(instanceRequired = true)
public List getHardware();
/**
* The total public inbound bandwidth used in this virtual rack for an account's current billing cycle.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getInboundPublicBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getInboundPublicBandwidthUsage();
/**
* The location group associated with this virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getLocationGroup
*/
@ApiMethod(instanceRequired = true)
public Group getLocationGroup();
/**
* The managed bare metal server instances contained within a virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getManagedBareMetalInstances
*/
@ApiMethod(instanceRequired = true)
public List getManagedBareMetalInstances();
/**
* The managed hardware contained within a virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getManagedHardware
*/
@ApiMethod(instanceRequired = true)
public List getManagedHardware();
/**
* The managed Virtual Server contained within a virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getManagedVirtualGuests
*/
@ApiMethod(instanceRequired = true)
public List getManagedVirtualGuests();
/**
* A virtual rack's metric tracking object. This object records all periodic polled data available to this rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getMetricTrackingObject
*/
@ApiMethod(instanceRequired = true)
public VirtualDedicatedRack getMetricTrackingObject();
/**
* The metric tracking object id for this allotment.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getMetricTrackingObjectId
*/
@ApiMethod(instanceRequired = true)
public Long getMetricTrackingObjectId();
/**
* The total public outbound bandwidth used in this virtual rack for an account's current billing cycle.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getOutboundPublicBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOutboundPublicBandwidthUsage();
/**
* Whether the bandwidth usage for this bandwidth pool for the current billing cycle exceeds the allocation.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getOverBandwidthAllocationFlag
*/
@ApiMethod(instanceRequired = true)
public Long getOverBandwidthAllocationFlag();
/**
* The private network only hardware contained within a virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getPrivateNetworkOnlyHardware
*/
@ApiMethod(instanceRequired = true)
public List getPrivateNetworkOnlyHardware();
/**
* Whether the bandwidth usage for this bandwidth pool for the current billing cycle is projected to exceed the allocation.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getProjectedOverBandwidthAllocationFlag
*/
@ApiMethod(instanceRequired = true)
public Long getProjectedOverBandwidthAllocationFlag();
/**
* The projected public outbound bandwidth for this virtual server for the current billing cycle.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getProjectedPublicBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getProjectedPublicBandwidthUsage();
/**
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getServiceProvider
*/
@ApiMethod(instanceRequired = true)
public Provider getServiceProvider();
/**
* The combined allocated bandwidth for all servers in a virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::getTotalBandwidthAllocated
*/
@ApiMethod(instanceRequired = true)
public Long getTotalBandwidthAllocated();
/**
* The Virtual Server contained within a virtual rack.
*
* @see SoftLayer_Network_Bandwidth_Version1_Allotment::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#createObject}
*/
public Future createObject(Allotment templateObject);
public Future> createObject(Allotment templateObject, ResponseHandler callback);
/**
* Async version of {@link Service#editObject}
*/
public Future editObject(Allotment templateObject);
public Future> editObject(Allotment templateObject, ResponseHandler callback);
/**
* Async version of {@link Service#getBackendBandwidthByHour}
*/
@Deprecated
public Future> getBackendBandwidthByHour(GregorianCalendar date);
@Deprecated
public Future> getBackendBandwidthByHour(GregorianCalendar date, ResponseHandler> callback);
/**
* Async version of {@link Service#getBackendBandwidthUse}
*/
public Future> getBackendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate);
public Future> getBackendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate, ResponseHandler> callback);
/**
* Async version of {@link Service#getBandwidthForDateRange}
*/
public Future> getBandwidthForDateRange(GregorianCalendar startDate, GregorianCalendar endDate);
public Future> getBandwidthForDateRange(GregorianCalendar startDate, GregorianCalendar endDate, ResponseHandler> callback);
/**
* Async version of {@link Service#getBandwidthImage}
*/
public Future getBandwidthImage(String networkType, String snapshotRange, Boolean draw, GregorianCalendar dateSpecified, GregorianCalendar dateSpecifiedEnd);
public Future> getBandwidthImage(String networkType, String snapshotRange, Boolean draw, GregorianCalendar dateSpecified, GregorianCalendar dateSpecifiedEnd, ResponseHandler callback);
/**
* Async version of {@link Service#getCustomBandwidthDataByDate}
*/
public Future getCustomBandwidthDataByDate(Graph graphData);
public Future> getCustomBandwidthDataByDate(Graph graphData, ResponseHandler callback);
/**
* Async version of {@link Service#getFrontendBandwidthByHour}
*/
@Deprecated
public Future> getFrontendBandwidthByHour(GregorianCalendar date);
@Deprecated
public Future> getFrontendBandwidthByHour(GregorianCalendar date, ResponseHandler> callback);
/**
* Async version of {@link Service#getFrontendBandwidthUse}
*/
public Future> getFrontendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate);
public Future> getFrontendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate, ResponseHandler> callback);
/**
* Async version of {@link Service#getObject}
*/
public Future getObject();
public Future> getObject(ResponseHandler callback);
/**
* Async version of {@link Service#getVdrMemberRecurringFee}
*/
public Future getVdrMemberRecurringFee();
public Future> getVdrMemberRecurringFee(ResponseHandler callback);
/**
* Async version of {@link Service#reassignServers}
*/
public Future reassignServers(List templateObjects, Long newAllotmentId);
public Future> reassignServers(List templateObjects, Long newAllotmentId, ResponseHandler callback);
/**
* Async version of {@link Service#requestVdrCancellation}
*/
public Future requestVdrCancellation();
public Future> requestVdrCancellation(ResponseHandler callback);
/**
* Async version of {@link Service#requestVdrContentUpdates}
*/
public Future requestVdrContentUpdates(List hardwareToAdd, List hardwareToRemove, List cloudsToAdd, List cloudsToRemove, Long optionalAllotmentId, List adcToAdd, List adcToRemove);
public Future> requestVdrContentUpdates(List hardwareToAdd, List hardwareToRemove, List cloudsToAdd, List cloudsToRemove, Long optionalAllotmentId, List adcToAdd, List adcToRemove, ResponseHandler callback);
/**
* Async version of {@link Service#setVdrContent}
*/
public Future setVdrContent(List hardware, List bareMetalServers, List virtualServerInstance, List adc, Long optionalAllotmentId);
public Future> setVdrContent(List hardware, List bareMetalServers, List virtualServerInstance, List adc, Long optionalAllotmentId, ResponseHandler callback);
/**
* Async version of {@link Service#unassignServers}
*/
public Future unassignServers(List templateObjects);
public Future> unassignServers(List templateObjects, ResponseHandler callback);
/**
* Async version of {@link Service#voidPendingServerMove}
*/
public Future voidPendingServerMove(Long id, String type);
public Future> voidPendingServerMove(Long id, String type, ResponseHandler callback);
/**
* Async version of {@link Service#voidPendingVdrCancellation}
*/
public Future voidPendingVdrCancellation();
public Future> voidPendingVdrCancellation(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#getActiveDetails}
*/
public Future> getActiveDetails();
/**
* Async callback version of {@link Service#getActiveDetails}
*/
public Future> getActiveDetails(ResponseHandler> callback);
/**
* Async version of {@link Service#getApplicationDeliveryControllers}
*/
public Future> getApplicationDeliveryControllers();
/**
* Async callback version of {@link Service#getApplicationDeliveryControllers}
*/
public Future> getApplicationDeliveryControllers(ResponseHandler> callback);
/**
* Async version of {@link Service#getAverageDailyPublicBandwidthUsage}
*/
public Future getAverageDailyPublicBandwidthUsage();
/**
* Async callback version of {@link Service#getAverageDailyPublicBandwidthUsage}
*/
public Future> getAverageDailyPublicBandwidthUsage(ResponseHandler callback);
/**
* Async version of {@link Service#getBandwidthAllotmentType}
*/
public Future getBandwidthAllotmentType();
/**
* Async callback version of {@link Service#getBandwidthAllotmentType}
*/
public Future> getBandwidthAllotmentType(ResponseHandler callback);
/**
* Async version of {@link Service#getBareMetalInstances}
*/
public Future> getBareMetalInstances();
/**
* Async callback version of {@link Service#getBareMetalInstances}
*/
public Future> getBareMetalInstances(ResponseHandler> callback);
/**
* Async version of {@link Service#getBillingCycleBandwidthUsage}
*/
public Future> getBillingCycleBandwidthUsage();
/**
* Async callback version of {@link Service#getBillingCycleBandwidthUsage}
*/
public Future> getBillingCycleBandwidthUsage(ResponseHandler> callback);
/**
* Async version of {@link Service#getBillingCyclePrivateBandwidthUsage}
*/
public Future getBillingCyclePrivateBandwidthUsage();
/**
* Async callback version of {@link Service#getBillingCyclePrivateBandwidthUsage}
*/
public Future> getBillingCyclePrivateBandwidthUsage(ResponseHandler callback);
/**
* Async version of {@link Service#getBillingCyclePublicBandwidthUsage}
*/
public Future getBillingCyclePublicBandwidthUsage();
/**
* Async callback version of {@link Service#getBillingCyclePublicBandwidthUsage}
*/
public Future> getBillingCyclePublicBandwidthUsage(ResponseHandler callback);
/**
* Async version of {@link Service#getBillingCyclePublicUsageTotal}
*/
public Future getBillingCyclePublicUsageTotal();
/**
* Async callback version of {@link Service#getBillingCyclePublicUsageTotal}
*/
public Future> getBillingCyclePublicUsageTotal(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#getCurrentBandwidthSummary}
*/
public Future
getCurrentBandwidthSummary();
/**
* Async callback version of {@link Service#getCurrentBandwidthSummary}
*/
public Future> getCurrentBandwidthSummary(ResponseHandler callback);
/**
* Async version of {@link Service#getDetails}
*/
public Future> getDetails();
/**
* Async callback version of {@link Service#getDetails}
*/
public Future> getDetails(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#getInboundPublicBandwidthUsage}
*/
public Future getInboundPublicBandwidthUsage();
/**
* Async callback version of {@link Service#getInboundPublicBandwidthUsage}
*/
public Future> getInboundPublicBandwidthUsage(ResponseHandler callback);
/**
* Async version of {@link Service#getLocationGroup}
*/
public Future getLocationGroup();
/**
* Async callback version of {@link Service#getLocationGroup}
*/
public Future> getLocationGroup(ResponseHandler callback);
/**
* Async version of {@link Service#getManagedBareMetalInstances}
*/
public Future> getManagedBareMetalInstances();
/**
* Async callback version of {@link Service#getManagedBareMetalInstances}
*/
public Future> getManagedBareMetalInstances(ResponseHandler> callback);
/**
* Async version of {@link Service#getManagedHardware}
*/
public Future> getManagedHardware();
/**
* Async callback version of {@link Service#getManagedHardware}
*/
public Future> getManagedHardware(ResponseHandler> callback);
/**
* Async version of {@link Service#getManagedVirtualGuests}
*/
public Future> getManagedVirtualGuests();
/**
* Async callback version of {@link Service#getManagedVirtualGuests}
*/
public Future> getManagedVirtualGuests(ResponseHandler> callback);
/**
* Async version of {@link Service#getMetricTrackingObject}
*/
public Future getMetricTrackingObject();
/**
* Async callback version of {@link Service#getMetricTrackingObject}
*/
public Future> getMetricTrackingObject(ResponseHandler callback);
/**
* Async version of {@link Service#getMetricTrackingObjectId}
*/
public Future getMetricTrackingObjectId();
/**
* Async callback version of {@link Service#getMetricTrackingObjectId}
*/
public Future> getMetricTrackingObjectId(ResponseHandler callback);
/**
* Async version of {@link Service#getOutboundPublicBandwidthUsage}
*/
public Future getOutboundPublicBandwidthUsage();
/**
* Async callback version of {@link Service#getOutboundPublicBandwidthUsage}
*/
public Future> getOutboundPublicBandwidthUsage(ResponseHandler callback);
/**
* Async version of {@link Service#getOverBandwidthAllocationFlag}
*/
public Future getOverBandwidthAllocationFlag();
/**
* Async callback version of {@link Service#getOverBandwidthAllocationFlag}
*/
public Future> getOverBandwidthAllocationFlag(ResponseHandler callback);
/**
* Async version of {@link Service#getPrivateNetworkOnlyHardware}
*/
public Future> getPrivateNetworkOnlyHardware();
/**
* Async callback version of {@link Service#getPrivateNetworkOnlyHardware}
*/
public Future> getPrivateNetworkOnlyHardware(ResponseHandler> callback);
/**
* Async version of {@link Service#getProjectedOverBandwidthAllocationFlag}
*/
public Future getProjectedOverBandwidthAllocationFlag();
/**
* Async callback version of {@link Service#getProjectedOverBandwidthAllocationFlag}
*/
public Future> getProjectedOverBandwidthAllocationFlag(ResponseHandler callback);
/**
* Async version of {@link Service#getProjectedPublicBandwidthUsage}
*/
public Future getProjectedPublicBandwidthUsage();
/**
* Async callback version of {@link Service#getProjectedPublicBandwidthUsage}
*/
public Future> getProjectedPublicBandwidthUsage(ResponseHandler callback);
/**
* Async version of {@link Service#getServiceProvider}
*/
public Future getServiceProvider();
/**
* Async callback version of {@link Service#getServiceProvider}
*/
public Future> getServiceProvider(ResponseHandler callback);
/**
* Async version of {@link Service#getTotalBandwidthAllocated}
*/
public Future getTotalBandwidthAllocated();
/**
* Async callback version of {@link Service#getTotalBandwidthAllocated}
*/
public Future> getTotalBandwidthAllocated(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.bandwidth.version1.allotment.Detail.Mask activeDetails() {
return withSubMask("activeDetails", com.softlayer.api.service.network.bandwidth.version1.allotment.Detail.Mask.class);
}
public com.softlayer.api.service.network.application.delivery.Controller.Mask applicationDeliveryControllers() {
return withSubMask("applicationDeliveryControllers", com.softlayer.api.service.network.application.delivery.Controller.Mask.class);
}
public Mask averageDailyPublicBandwidthUsage() {
withLocalProperty("averageDailyPublicBandwidthUsage");
return this;
}
public com.softlayer.api.service.network.bandwidth.version1.allotment.Type.Mask bandwidthAllotmentType() {
return withSubMask("bandwidthAllotmentType", com.softlayer.api.service.network.bandwidth.version1.allotment.Type.Mask.class);
}
public com.softlayer.api.service.Hardware.Mask bareMetalInstances() {
return withSubMask("bareMetalInstances", com.softlayer.api.service.Hardware.Mask.class);
}
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 com.softlayer.api.service.network.bandwidth.Usage.Mask billingCyclePublicBandwidthUsage() {
return withSubMask("billingCyclePublicBandwidthUsage", com.softlayer.api.service.network.bandwidth.Usage.Mask.class);
}
public Mask billingCyclePublicUsageTotal() {
withLocalProperty("billingCyclePublicUsageTotal");
return this;
}
public com.softlayer.api.service.billing.Item.Mask billingItem() {
return withSubMask("billingItem", com.softlayer.api.service.billing.Item.Mask.class);
}
public com.softlayer.api.service.metric.tracking.object.bandwidth.Summary.Mask currentBandwidthSummary() {
return withSubMask("currentBandwidthSummary", com.softlayer.api.service.metric.tracking.object.bandwidth.Summary.Mask.class);
}
public com.softlayer.api.service.network.bandwidth.version1.allotment.Detail.Mask details() {
return withSubMask("details", com.softlayer.api.service.network.bandwidth.version1.allotment.Detail.Mask.class);
}
public com.softlayer.api.service.Hardware.Mask hardware() {
return withSubMask("hardware", com.softlayer.api.service.Hardware.Mask.class);
}
public Mask inboundPublicBandwidthUsage() {
withLocalProperty("inboundPublicBandwidthUsage");
return this;
}
public com.softlayer.api.service.location.Group.Mask locationGroup() {
return withSubMask("locationGroup", com.softlayer.api.service.location.Group.Mask.class);
}
public com.softlayer.api.service.Hardware.Mask managedBareMetalInstances() {
return withSubMask("managedBareMetalInstances", com.softlayer.api.service.Hardware.Mask.class);
}
public com.softlayer.api.service.Hardware.Mask managedHardware() {
return withSubMask("managedHardware", com.softlayer.api.service.Hardware.Mask.class);
}
public com.softlayer.api.service.virtual.Guest.Mask managedVirtualGuests() {
return withSubMask("managedVirtualGuests", com.softlayer.api.service.virtual.Guest.Mask.class);
}
public com.softlayer.api.service.metric.tracking.object.VirtualDedicatedRack.Mask metricTrackingObject() {
return withSubMask("metricTrackingObject", com.softlayer.api.service.metric.tracking.object.VirtualDedicatedRack.Mask.class);
}
public Mask metricTrackingObjectId() {
withLocalProperty("metricTrackingObjectId");
return this;
}
public Mask outboundPublicBandwidthUsage() {
withLocalProperty("outboundPublicBandwidthUsage");
return this;
}
public Mask overBandwidthAllocationFlag() {
withLocalProperty("overBandwidthAllocationFlag");
return this;
}
public com.softlayer.api.service.Hardware.Mask privateNetworkOnlyHardware() {
return withSubMask("privateNetworkOnlyHardware", com.softlayer.api.service.Hardware.Mask.class);
}
public Mask projectedOverBandwidthAllocationFlag() {
withLocalProperty("projectedOverBandwidthAllocationFlag");
return this;
}
public Mask projectedPublicBandwidthUsage() {
withLocalProperty("projectedPublicBandwidthUsage");
return this;
}
public com.softlayer.api.service.service.Provider.Mask serviceProvider() {
return withSubMask("serviceProvider", com.softlayer.api.service.service.Provider.Mask.class);
}
public Mask totalBandwidthAllocated() {
withLocalProperty("totalBandwidthAllocated");
return this;
}
public com.softlayer.api.service.virtual.Guest.Mask virtualGuests() {
return withSubMask("virtualGuests", com.softlayer.api.service.virtual.Guest.Mask.class);
}
public Mask accountId() {
withLocalProperty("accountId");
return this;
}
public Mask bandwidthAllotmentTypeId() {
withLocalProperty("bandwidthAllotmentTypeId");
return this;
}
public Mask createDate() {
withLocalProperty("createDate");
return this;
}
public Mask endDate() {
withLocalProperty("endDate");
return this;
}
public Mask id() {
withLocalProperty("id");
return this;
}
public Mask locationGroupId() {
withLocalProperty("locationGroupId");
return this;
}
public Mask name() {
withLocalProperty("name");
return this;
}
public Mask serviceProviderId() {
withLocalProperty("serviceProviderId");
return this;
}
public Mask activeDetailCount() {
withLocalProperty("activeDetailCount");
return this;
}
public Mask applicationDeliveryControllerCount() {
withLocalProperty("applicationDeliveryControllerCount");
return this;
}
public Mask bareMetalInstanceCount() {
withLocalProperty("bareMetalInstanceCount");
return this;
}
public Mask billingCycleBandwidthUsageCount() {
withLocalProperty("billingCycleBandwidthUsageCount");
return this;
}
public Mask detailCount() {
withLocalProperty("detailCount");
return this;
}
public Mask hardwareCount() {
withLocalProperty("hardwareCount");
return this;
}
public Mask managedBareMetalInstanceCount() {
withLocalProperty("managedBareMetalInstanceCount");
return this;
}
public Mask managedHardwareCount() {
withLocalProperty("managedHardwareCount");
return this;
}
public Mask managedVirtualGuestCount() {
withLocalProperty("managedVirtualGuestCount");
return this;
}
public Mask privateNetworkOnlyHardwareCount() {
withLocalProperty("privateNetworkOnlyHardwareCount");
return this;
}
public Mask virtualGuestCount() {
withLocalProperty("virtualGuestCount");
return this;
}
}
}