com.softlayer.api.service.network.Storage 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
package com.softlayer.api.service.network;
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.Hardware;
import com.softlayer.api.service.Location;
import com.softlayer.api.service.Notification;
import com.softlayer.api.service.account.Password;
import com.softlayer.api.service.billing.Item;
import com.softlayer.api.service.container.bandwidth.GraphOutputs;
import com.softlayer.api.service.container.network.service.resource.objectstorage.ConnectionInformation;
import com.softlayer.api.service.container.network.storage.Host;
import com.softlayer.api.service.container.network.storage.NetworkConnectionInformation;
import com.softlayer.api.service.container.network.storage.VolumeDuplicateParameters;
import com.softlayer.api.service.container.network.storage.hub.objectstorage.ContentDeliveryUrl;
import com.softlayer.api.service.container.network.storage.hub.objectstorage.Folder;
import com.softlayer.api.service.container.utility.file.Entity;
import com.softlayer.api.service.metric.tracking.Object;
import com.softlayer.api.service.network.Subnet;
import com.softlayer.api.service.network.service.Resource;
import com.softlayer.api.service.network.storage.Credential;
import com.softlayer.api.service.network.storage.Event;
import com.softlayer.api.service.network.storage.Group;
import com.softlayer.api.service.network.storage.History;
import com.softlayer.api.service.network.storage.Partnership;
import com.softlayer.api.service.network.storage.Property;
import com.softlayer.api.service.network.storage.Schedule;
import com.softlayer.api.service.network.storage.Type;
import com.softlayer.api.service.network.subnet.IpAddress;
import com.softlayer.api.service.notification.user.Subscriber;
import com.softlayer.api.service.product.item.Category;
import com.softlayer.api.service.provisioning.version1.Transaction;
import com.softlayer.api.service.virtual.Guest;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;
/**
* The SoftLayer_Network_Storage data type contains general information regarding a Storage product such as account id, access username and password, the Storage product type, and the server the Storage service is associated with. Currently, only EVault backup storage has an associated server.
*
* @see SoftLayer_Network_Storage
*/
@ApiType("SoftLayer_Network_Storage")
public class Storage extends com.softlayer.api.service.Entity {
/**
* The account that a Storage services belongs to.
*/
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
/**
* Other usernames and passwords associated with a Storage volume.
*/
@ApiProperty
protected Password accountPassword;
public Password getAccountPassword() {
return accountPassword;
}
public void setAccountPassword(Password accountPassword) {
this.accountPassword = accountPassword;
}
/**
* The currently active transactions on a network storage volume.
*/
@ApiProperty
protected List activeTransactions;
public List getActiveTransactions() {
if (activeTransactions == null) {
activeTransactions = new ArrayList();
}
return activeTransactions;
}
/**
* The SoftLayer_Hardware objects which are allowed access to this storage volume.
*/
@ApiProperty
protected List allowedHardware;
public List getAllowedHardware() {
if (allowedHardware == null) {
allowedHardware = new ArrayList();
}
return allowedHardware;
}
/**
* The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.
*/
@ApiProperty
protected List allowedIpAddresses;
public List getAllowedIpAddresses() {
if (allowedIpAddresses == null) {
allowedIpAddresses = new ArrayList();
}
return allowedIpAddresses;
}
/**
* The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
*/
@ApiProperty
protected List allowedReplicationHardware;
public List getAllowedReplicationHardware() {
if (allowedReplicationHardware == null) {
allowedReplicationHardware = new ArrayList();
}
return allowedReplicationHardware;
}
/**
* The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.
*/
@ApiProperty
protected List allowedReplicationIpAddresses;
public List getAllowedReplicationIpAddresses() {
if (allowedReplicationIpAddresses == null) {
allowedReplicationIpAddresses = new ArrayList();
}
return allowedReplicationIpAddresses;
}
/**
* The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.
*/
@ApiProperty
protected List allowedReplicationSubnets;
public List getAllowedReplicationSubnets() {
if (allowedReplicationSubnets == null) {
allowedReplicationSubnets = new ArrayList();
}
return allowedReplicationSubnets;
}
/**
* The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
*/
@ApiProperty
protected List allowedReplicationVirtualGuests;
public List getAllowedReplicationVirtualGuests() {
if (allowedReplicationVirtualGuests == null) {
allowedReplicationVirtualGuests = new ArrayList();
}
return allowedReplicationVirtualGuests;
}
/**
* The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.
*/
@ApiProperty
protected List allowedSubnets;
public List getAllowedSubnets() {
if (allowedSubnets == null) {
allowedSubnets = new ArrayList();
}
return allowedSubnets;
}
/**
* The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.
*/
@ApiProperty
protected List allowedVirtualGuests;
public List getAllowedVirtualGuests() {
if (allowedVirtualGuests == null) {
allowedVirtualGuests = new ArrayList();
}
return allowedVirtualGuests;
}
/**
* The current billing item for a Storage volume.
*/
@ApiProperty
protected Item billingItem;
public Item getBillingItem() {
return billingItem;
}
public void setBillingItem(Item billingItem) {
this.billingItem = billingItem;
}
@ApiProperty
protected Category billingItemCategory;
public Category getBillingItemCategory() {
return billingItemCategory;
}
public void setBillingItemCategory(Category billingItemCategory) {
this.billingItemCategory = billingItemCategory;
}
/**
* The amount of space used by the volume, in bytes.
*/
@ApiProperty
protected String bytesUsed;
public String getBytesUsed() {
return bytesUsed;
}
public void setBytesUsed(String bytesUsed) {
this.bytesUsed = bytesUsed;
}
/**
* The schedule id which was executed to create a snapshot.
*/
@ApiProperty
protected String creationScheduleId;
public String getCreationScheduleId() {
return creationScheduleId;
}
public void setCreationScheduleId(String creationScheduleId) {
this.creationScheduleId = creationScheduleId;
}
@ApiProperty
protected List credentials;
public List getCredentials() {
if (credentials == null) {
credentials = new ArrayList();
}
return credentials;
}
/**
* The Daily Schedule which is associated with this network storage volume.
*/
@ApiProperty
protected Schedule dailySchedule;
public Schedule getDailySchedule() {
return dailySchedule;
}
public void setDailySchedule(Schedule dailySchedule) {
this.dailySchedule = dailySchedule;
}
/**
* The events which have taken place on a network storage volume.
*/
@ApiProperty
protected List events;
public List getEvents() {
if (events == null) {
events = new ArrayList();
}
return events;
}
/**
* Retrieves the NFS Network Mount Address Name for a given File Storage Volume.
*/
@ApiProperty
protected String fileNetworkMountAddress;
public String getFileNetworkMountAddress() {
return fileNetworkMountAddress;
}
public void setFileNetworkMountAddress(String fileNetworkMountAddress) {
this.fileNetworkMountAddress = fileNetworkMountAddress;
}
/**
* When applicable, the hardware associated with a Storage service.
*/
@ApiProperty
protected Hardware hardware;
public Hardware getHardware() {
return hardware;
}
public void setHardware(Hardware hardware) {
this.hardware = hardware;
}
@ApiProperty
protected Boolean hasEncryptionAtRest;
public Boolean getHasEncryptionAtRest() {
return hasEncryptionAtRest;
}
public void setHasEncryptionAtRest(Boolean hasEncryptionAtRest) {
this.hasEncryptionAtRest = hasEncryptionAtRest;
}
/**
* The Hourly Schedule which is associated with this network storage volume.
*/
@ApiProperty
protected Schedule hourlySchedule;
public Schedule getHourlySchedule() {
return hourlySchedule;
}
public void setHourlySchedule(Schedule hourlySchedule) {
this.hourlySchedule = hourlySchedule;
}
/**
* The Interval Schedule which is associated with this network storage volume.
*/
@ApiProperty
protected Schedule intervalSchedule;
public Schedule getIntervalSchedule() {
return intervalSchedule;
}
public void setIntervalSchedule(Schedule intervalSchedule) {
this.intervalSchedule = intervalSchedule;
}
/**
* The maximum number of IOPs selected for this volume.
*/
@ApiProperty
protected String iops;
public String getIops() {
return iops;
}
public void setIops(String iops) {
this.iops = iops;
}
/**
* Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot.
*/
@ApiProperty
protected Boolean isReadyForSnapshot;
public Boolean getIsReadyForSnapshot() {
return isReadyForSnapshot;
}
public void setIsReadyForSnapshot(Boolean isReadyForSnapshot) {
this.isReadyForSnapshot = isReadyForSnapshot;
}
/**
* Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details.
*/
@ApiProperty
protected Boolean isReadyToMount;
public Boolean getIsReadyToMount() {
return isReadyToMount;
}
public void setIsReadyToMount(Boolean isReadyToMount) {
this.isReadyToMount = isReadyToMount;
}
/**
* Relationship between a container volume and iSCSI LUNs.
*/
@ApiProperty
protected List iscsiLuns;
public List getIscsiLuns() {
if (iscsiLuns == null) {
iscsiLuns = new ArrayList();
}
return iscsiLuns;
}
/**
* Returns the target IP addresses of an iSCSI volume.
*/
@ApiProperty
protected List iscsiTargetIpAddresses;
public List getIscsiTargetIpAddresses() {
if (iscsiTargetIpAddresses == null) {
iscsiTargetIpAddresses = new ArrayList();
}
return iscsiTargetIpAddresses;
}
/**
* The ID of the LUN volume.
*/
@ApiProperty
protected String lunId;
public String getLunId() {
return lunId;
}
public void setLunId(String lunId) {
this.lunId = lunId;
}
/**
* The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset.
*/
@ApiProperty
protected List manualSnapshots;
public List getManualSnapshots() {
if (manualSnapshots == null) {
manualSnapshots = new ArrayList();
}
return manualSnapshots;
}
/**
* A network storage volume's metric tracking object. This object records all periodic polled data available to this volume.
*/
@ApiProperty
protected Object metricTrackingObject;
public Object getMetricTrackingObject() {
return metricTrackingObject;
}
public void setMetricTrackingObject(Object metricTrackingObject) {
this.metricTrackingObject = metricTrackingObject;
}
/**
* Whether or not a network storage volume may be mounted.
*/
@ApiProperty
protected String mountableFlag;
public String getMountableFlag() {
return mountableFlag;
}
public void setMountableFlag(String mountableFlag) {
this.mountableFlag = mountableFlag;
}
/**
* The current status of split or move operation as a part of volume duplication.
*/
@ApiProperty
protected String moveAndSplitStatus;
public String getMoveAndSplitStatus() {
return moveAndSplitStatus;
}
public void setMoveAndSplitStatus(String moveAndSplitStatus) {
this.moveAndSplitStatus = moveAndSplitStatus;
}
/**
* The subscribers that will be notified for usage amount warnings and overages.
*/
@ApiProperty
protected List notificationSubscribers;
public List getNotificationSubscribers() {
if (notificationSubscribers == null) {
notificationSubscribers = new ArrayList();
}
return notificationSubscribers;
}
/**
* The name of the snapshot that this volume was duplicated from.
*/
@ApiProperty
protected String originalSnapshotName;
public String getOriginalSnapshotName() {
return originalSnapshotName;
}
public void setOriginalSnapshotName(String originalSnapshotName) {
this.originalSnapshotName = originalSnapshotName;
}
/**
* The name of the volume that this volume was duplicated from.
*/
@ApiProperty
protected String originalVolumeName;
public String getOriginalVolumeName() {
return originalVolumeName;
}
public void setOriginalVolumeName(String originalVolumeName) {
this.originalVolumeName = originalVolumeName;
}
/**
* The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created.
*/
@ApiProperty
protected String originalVolumeSize;
public String getOriginalVolumeSize() {
return originalVolumeSize;
}
public void setOriginalVolumeSize(String originalVolumeSize) {
this.originalVolumeSize = originalVolumeSize;
}
/**
* A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.
*/
@ApiProperty
protected com.softlayer.api.service.network.storage.iscsi.os.Type osType;
public com.softlayer.api.service.network.storage.iscsi.os.Type getOsType() {
return osType;
}
public void setOsType(com.softlayer.api.service.network.storage.iscsi.os.Type osType) {
this.osType = osType;
}
/**
* A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.
*/
@ApiProperty
protected String osTypeId;
public String getOsTypeId() {
return osTypeId;
}
public void setOsTypeId(String osTypeId) {
this.osTypeId = osTypeId;
}
/**
* The volumes or snapshots partnered with a network storage volume in a parental role.
*/
@ApiProperty
protected List parentPartnerships;
public List getParentPartnerships() {
if (parentPartnerships == null) {
parentPartnerships = new ArrayList();
}
return parentPartnerships;
}
/**
* The parent volume of a volume in a complex storage relationship.
*/
@ApiProperty
protected Storage parentVolume;
public Storage getParentVolume() {
return parentVolume;
}
public void setParentVolume(Storage parentVolume) {
this.parentVolume = parentVolume;
}
/**
* The volumes or snapshots partnered with a network storage volume.
*/
@ApiProperty
protected List partnerships;
public List getPartnerships() {
if (partnerships == null) {
partnerships = new ArrayList();
}
return partnerships;
}
/**
* All permissions group(s) this volume is in.
*/
@ApiProperty
protected List permissionsGroups;
public List getPermissionsGroups() {
if (permissionsGroups == null) {
permissionsGroups = new ArrayList();
}
return permissionsGroups;
}
/**
* The properties used to provide additional details about a network storage volume.
*/
@ApiProperty
protected List properties;
public List getProperties() {
if (properties == null) {
properties = new ArrayList();
}
return properties;
}
/**
* The number of IOPs provisioned for this volume.
*/
@ApiProperty
protected String provisionedIops;
public String getProvisionedIops() {
return provisionedIops;
}
public void setProvisionedIops(String provisionedIops) {
this.provisionedIops = provisionedIops;
}
/**
* The iSCSI LUN volumes being replicated by this network storage volume.
*/
@ApiProperty
protected List replicatingLuns;
public List getReplicatingLuns() {
if (replicatingLuns == null) {
replicatingLuns = new ArrayList();
}
return replicatingLuns;
}
/**
* The network storage volume being replicated by a volume.
*/
@ApiProperty
protected Storage replicatingVolume;
public Storage getReplicatingVolume() {
return replicatingVolume;
}
public void setReplicatingVolume(Storage replicatingVolume) {
this.replicatingVolume = replicatingVolume;
}
/**
* The volume replication events.
*/
@ApiProperty
protected List replicationEvents;
public List getReplicationEvents() {
if (replicationEvents == null) {
replicationEvents = new ArrayList();
}
return replicationEvents;
}
/**
* The network storage volumes configured to be replicants of a volume.
*/
@ApiProperty
protected List replicationPartners;
public List getReplicationPartners() {
if (replicationPartners == null) {
replicationPartners = new ArrayList();
}
return replicationPartners;
}
/**
* The Replication Schedule associated with a network storage volume.
*/
@ApiProperty
protected Schedule replicationSchedule;
public Schedule getReplicationSchedule() {
return replicationSchedule;
}
public void setReplicationSchedule(Schedule replicationSchedule) {
this.replicationSchedule = replicationSchedule;
}
/**
* The current replication status of a network storage volume. Indicates Failover or Failback status.
*/
@ApiProperty
protected String replicationStatus;
public String getReplicationStatus() {
return replicationStatus;
}
public void setReplicationStatus(String replicationStatus) {
this.replicationStatus = replicationStatus;
}
/**
* The schedules which are associated with a network storage volume.
*/
@ApiProperty
protected List schedules;
public List getSchedules() {
if (schedules == null) {
schedules = new ArrayList();
}
return schedules;
}
/**
* The network resource a Storage service is connected to.
*/
@ApiProperty
protected Resource serviceResource;
public Resource getServiceResource() {
return serviceResource;
}
public void setServiceResource(Resource serviceResource) {
this.serviceResource = serviceResource;
}
/**
* The IP address of a Storage resource.
*/
@ApiProperty
protected String serviceResourceBackendIpAddress;
public String getServiceResourceBackendIpAddress() {
return serviceResourceBackendIpAddress;
}
public void setServiceResourceBackendIpAddress(String serviceResourceBackendIpAddress) {
this.serviceResourceBackendIpAddress = serviceResourceBackendIpAddress;
}
/**
* The name of a Storage's network resource.
*/
@ApiProperty
protected String serviceResourceName;
public String getServiceResourceName() {
return serviceResourceName;
}
public void setServiceResourceName(String serviceResourceName) {
this.serviceResourceName = serviceResourceName;
}
/**
* A volume's configured snapshot space size.
*/
@ApiProperty
protected String snapshotCapacityGb;
public String getSnapshotCapacityGb() {
return snapshotCapacityGb;
}
public void setSnapshotCapacityGb(String snapshotCapacityGb) {
this.snapshotCapacityGb = snapshotCapacityGb;
}
/**
* The creation timestamp of the snapshot on the storage platform.
*/
@ApiProperty
protected String snapshotCreationTimestamp;
public String getSnapshotCreationTimestamp() {
return snapshotCreationTimestamp;
}
public void setSnapshotCreationTimestamp(String snapshotCreationTimestamp) {
this.snapshotCreationTimestamp = snapshotCreationTimestamp;
}
/**
* The percentage of used snapshot space after which to delete automated snapshots.
*/
@ApiProperty
protected String snapshotDeletionThresholdPercentage;
public String getSnapshotDeletionThresholdPercentage() {
return snapshotDeletionThresholdPercentage;
}
public void setSnapshotDeletionThresholdPercentage(String snapshotDeletionThresholdPercentage) {
this.snapshotDeletionThresholdPercentage = snapshotDeletionThresholdPercentage;
}
/**
* The snapshot size in bytes.
*/
@ApiProperty
protected String snapshotSizeBytes;
public String getSnapshotSizeBytes() {
return snapshotSizeBytes;
}
public void setSnapshotSizeBytes(String snapshotSizeBytes) {
this.snapshotSizeBytes = snapshotSizeBytes;
}
/**
* A volume's available snapshot reservation space.
*/
@ApiProperty
protected String snapshotSpaceAvailable;
public String getSnapshotSpaceAvailable() {
return snapshotSpaceAvailable;
}
public void setSnapshotSpaceAvailable(String snapshotSpaceAvailable) {
this.snapshotSpaceAvailable = snapshotSpaceAvailable;
}
/**
* The snapshots associated with this SoftLayer_Network_Storage volume.
*/
@ApiProperty
protected List snapshots;
public List getSnapshots() {
if (snapshots == null) {
snapshots = new ArrayList();
}
return snapshots;
}
@ApiProperty
protected String staasVersion;
public String getStaasVersion() {
return staasVersion;
}
public void setStaasVersion(String staasVersion) {
this.staasVersion = staasVersion;
}
/**
* The network storage groups this volume is attached to.
*/
@ApiProperty
protected List storageGroups;
public List getStorageGroups() {
if (storageGroups == null) {
storageGroups = new ArrayList();
}
return storageGroups;
}
@ApiProperty
protected String storageTierLevel;
public String getStorageTierLevel() {
return storageTierLevel;
}
public void setStorageTierLevel(String storageTierLevel) {
this.storageTierLevel = storageTierLevel;
}
/**
* A description of the Storage object.
*/
@ApiProperty
protected Type storageType;
public Type getStorageType() {
return storageType;
}
public void setStorageType(Type storageType) {
this.storageType = storageType;
}
/**
* The amount of space used by the volume.
*/
@ApiProperty
protected String totalBytesUsed;
public String getTotalBytesUsed() {
return totalBytesUsed;
}
public void setTotalBytesUsed(String totalBytesUsed) {
this.totalBytesUsed = totalBytesUsed;
}
/**
* The total snapshot retention count of all schedules on this network storage volume.
*/
@ApiProperty
protected Long totalScheduleSnapshotRetentionCount;
public Long getTotalScheduleSnapshotRetentionCount() {
return totalScheduleSnapshotRetentionCount;
}
public void setTotalScheduleSnapshotRetentionCount(Long totalScheduleSnapshotRetentionCount) {
this.totalScheduleSnapshotRetentionCount = totalScheduleSnapshotRetentionCount;
}
/**
* The usage notification for SL Storage services.
*/
@ApiProperty
protected Notification usageNotification;
public Notification getUsageNotification() {
return usageNotification;
}
public void setUsageNotification(Notification usageNotification) {
this.usageNotification = usageNotification;
}
/**
* The type of network storage service.
*/
@ApiProperty
protected String vendorName;
public String getVendorName() {
return vendorName;
}
public void setVendorName(String vendorName) {
this.vendorName = vendorName;
}
/**
* When applicable, the virtual guest associated with a Storage service.
*/
@ApiProperty
protected Guest virtualGuest;
public Guest getVirtualGuest() {
return virtualGuest;
}
public void setVirtualGuest(Guest virtualGuest) {
this.virtualGuest = virtualGuest;
}
/**
* The username and password history for a Storage service.
*/
@ApiProperty
protected List volumeHistory;
public List getVolumeHistory() {
if (volumeHistory == null) {
volumeHistory = new ArrayList();
}
return volumeHistory;
}
/**
* The current status of a network storage volume.
*/
@ApiProperty
protected String volumeStatus;
public String getVolumeStatus() {
return volumeStatus;
}
public void setVolumeStatus(String volumeStatus) {
this.volumeStatus = volumeStatus;
}
/**
* The account username and password for the EVault webCC interface.
*/
@ApiProperty
protected Password webccAccount;
public Password getWebccAccount() {
return webccAccount;
}
public void setWebccAccount(Password webccAccount) {
this.webccAccount = webccAccount;
}
/**
* The Weekly Schedule which is associated with this network storage volume.
*/
@ApiProperty
protected Schedule weeklySchedule;
public Schedule getWeeklySchedule() {
return weeklySchedule;
}
public void setWeeklySchedule(Schedule weeklySchedule) {
this.weeklySchedule = weeklySchedule;
}
/**
* The internal identifier of the SoftLayer customer account that a Storage account belongs to.
*/
@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;
}
/**
* A Storage account's capacity, measured in gigabytes.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long capacityGb;
public Long getCapacityGb() {
return capacityGb;
}
public void setCapacityGb(Long capacityGb) {
capacityGbSpecified = true;
this.capacityGb = capacityGb;
}
protected boolean capacityGbSpecified;
public boolean isCapacityGbSpecified() {
return capacityGbSpecified;
}
public void unsetCapacityGb() {
capacityGb = null;
capacityGbSpecified = false;
}
/**
* The date a network storage volume was created.
*/
@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;
}
/**
* The unique identification number of the guest associated with a Storage volume.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long guestId;
public Long getGuestId() {
return guestId;
}
public void setGuestId(Long guestId) {
guestIdSpecified = true;
this.guestId = guestId;
}
protected boolean guestIdSpecified;
public boolean isGuestIdSpecified() {
return guestIdSpecified;
}
public void unsetGuestId() {
guestId = null;
guestIdSpecified = false;
}
/**
* The server that is associated with a Storage service.
*/
@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;
}
/**
* The unique identification number of the host associated with a Storage volume.
*/
@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;
}
/**
* A Storage account's unique 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;
}
/**
* A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB".
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String nasType;
public String getNasType() {
return nasType;
}
public void setNasType(String nasType) {
nasTypeSpecified = true;
this.nasType = nasType;
}
protected boolean nasTypeSpecified;
public boolean isNasTypeSpecified() {
return nasTypeSpecified;
}
public void unsetNasType() {
nasType = null;
nasTypeSpecified = false;
}
/**
* Public notes related to a Storage volume.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String notes;
public String getNotes() {
return notes;
}
public void setNotes(String notes) {
notesSpecified = true;
this.notes = notes;
}
protected boolean notesSpecified;
public boolean isNotesSpecified() {
return notesSpecified;
}
public void unsetNotes() {
notes = null;
notesSpecified = false;
}
/**
* The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String password;
public String getPassword() {
return password;
}
public void setPassword(String password) {
passwordSpecified = true;
this.password = password;
}
protected boolean passwordSpecified;
public boolean isPasswordSpecified() {
return passwordSpecified;
}
public void unsetPassword() {
password = null;
passwordSpecified = false;
}
/**
* Service Provider ID
*/
@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 storage object's type.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String storageTypeId;
public String getStorageTypeId() {
return storageTypeId;
}
public void setStorageTypeId(String storageTypeId) {
storageTypeIdSpecified = true;
this.storageTypeId = storageTypeId;
}
protected boolean storageTypeIdSpecified;
public boolean isStorageTypeIdSpecified() {
return storageTypeIdSpecified;
}
public void unsetStorageTypeId() {
storageTypeId = null;
storageTypeIdSpecified = false;
}
/**
* This flag indicates whether this storage type is upgradable or not.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Boolean upgradableFlag;
public Boolean getUpgradableFlag() {
return upgradableFlag;
}
public void setUpgradableFlag(Boolean upgradableFlag) {
upgradableFlagSpecified = true;
this.upgradableFlag = upgradableFlag;
}
protected boolean upgradableFlagSpecified;
public boolean isUpgradableFlagSpecified() {
return upgradableFlagSpecified;
}
public void unsetUpgradableFlag() {
upgradableFlag = null;
upgradableFlagSpecified = false;
}
/**
* The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String username;
public String getUsername() {
return username;
}
public void setUsername(String username) {
usernameSpecified = true;
this.username = username;
}
protected boolean usernameSpecified;
public boolean isUsernameSpecified() {
return usernameSpecified;
}
public void unsetUsername() {
username = null;
usernameSpecified = false;
}
/**
* A count of the currently active transactions on a network storage volume.
*/
@ApiProperty
protected Long activeTransactionCount;
public Long getActiveTransactionCount() {
return activeTransactionCount;
}
public void setActiveTransactionCount(Long activeTransactionCount) {
this.activeTransactionCount = activeTransactionCount;
}
/**
* A count of the SoftLayer_Hardware objects which are allowed access to this storage volume.
*/
@ApiProperty
protected Long allowedHardwareCount;
public Long getAllowedHardwareCount() {
return allowedHardwareCount;
}
public void setAllowedHardwareCount(Long allowedHardwareCount) {
this.allowedHardwareCount = allowedHardwareCount;
}
/**
* A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.
*/
@ApiProperty
protected Long allowedIpAddressCount;
public Long getAllowedIpAddressCount() {
return allowedIpAddressCount;
}
public void setAllowedIpAddressCount(Long allowedIpAddressCount) {
this.allowedIpAddressCount = allowedIpAddressCount;
}
/**
* A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
*/
@ApiProperty
protected Long allowedReplicationHardwareCount;
public Long getAllowedReplicationHardwareCount() {
return allowedReplicationHardwareCount;
}
public void setAllowedReplicationHardwareCount(Long allowedReplicationHardwareCount) {
this.allowedReplicationHardwareCount = allowedReplicationHardwareCount;
}
/**
* A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.
*/
@ApiProperty
protected Long allowedReplicationIpAddressCount;
public Long getAllowedReplicationIpAddressCount() {
return allowedReplicationIpAddressCount;
}
public void setAllowedReplicationIpAddressCount(Long allowedReplicationIpAddressCount) {
this.allowedReplicationIpAddressCount = allowedReplicationIpAddressCount;
}
/**
* A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.
*/
@ApiProperty
protected Long allowedReplicationSubnetCount;
public Long getAllowedReplicationSubnetCount() {
return allowedReplicationSubnetCount;
}
public void setAllowedReplicationSubnetCount(Long allowedReplicationSubnetCount) {
this.allowedReplicationSubnetCount = allowedReplicationSubnetCount;
}
/**
* A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
*/
@ApiProperty
protected Long allowedReplicationVirtualGuestCount;
public Long getAllowedReplicationVirtualGuestCount() {
return allowedReplicationVirtualGuestCount;
}
public void setAllowedReplicationVirtualGuestCount(Long allowedReplicationVirtualGuestCount) {
this.allowedReplicationVirtualGuestCount = allowedReplicationVirtualGuestCount;
}
/**
* A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume.
*/
@ApiProperty
protected Long allowedSubnetCount;
public Long getAllowedSubnetCount() {
return allowedSubnetCount;
}
public void setAllowedSubnetCount(Long allowedSubnetCount) {
this.allowedSubnetCount = allowedSubnetCount;
}
/**
* A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.
*/
@ApiProperty
protected Long allowedVirtualGuestCount;
public Long getAllowedVirtualGuestCount() {
return allowedVirtualGuestCount;
}
public void setAllowedVirtualGuestCount(Long allowedVirtualGuestCount) {
this.allowedVirtualGuestCount = allowedVirtualGuestCount;
}
/**
* A count of
*/
@ApiProperty
protected Long credentialCount;
public Long getCredentialCount() {
return credentialCount;
}
public void setCredentialCount(Long credentialCount) {
this.credentialCount = credentialCount;
}
/**
* A count of the events which have taken place on a network storage volume.
*/
@ApiProperty
protected Long eventCount;
public Long getEventCount() {
return eventCount;
}
public void setEventCount(Long eventCount) {
this.eventCount = eventCount;
}
/**
* A count of relationship between a container volume and iSCSI LUNs.
*/
@ApiProperty
protected Long iscsiLunCount;
public Long getIscsiLunCount() {
return iscsiLunCount;
}
public void setIscsiLunCount(Long iscsiLunCount) {
this.iscsiLunCount = iscsiLunCount;
}
/**
* A count of returns the target IP addresses of an iSCSI volume.
*/
@ApiProperty
protected Long iscsiTargetIpAddressCount;
public Long getIscsiTargetIpAddressCount() {
return iscsiTargetIpAddressCount;
}
public void setIscsiTargetIpAddressCount(Long iscsiTargetIpAddressCount) {
this.iscsiTargetIpAddressCount = iscsiTargetIpAddressCount;
}
/**
* A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset.
*/
@ApiProperty
protected Long manualSnapshotCount;
public Long getManualSnapshotCount() {
return manualSnapshotCount;
}
public void setManualSnapshotCount(Long manualSnapshotCount) {
this.manualSnapshotCount = manualSnapshotCount;
}
/**
* A count of the subscribers that will be notified for usage amount warnings and overages.
*/
@ApiProperty
protected Long notificationSubscriberCount;
public Long getNotificationSubscriberCount() {
return notificationSubscriberCount;
}
public void setNotificationSubscriberCount(Long notificationSubscriberCount) {
this.notificationSubscriberCount = notificationSubscriberCount;
}
/**
* A count of the volumes or snapshots partnered with a network storage volume in a parental role.
*/
@ApiProperty
protected Long parentPartnershipCount;
public Long getParentPartnershipCount() {
return parentPartnershipCount;
}
public void setParentPartnershipCount(Long parentPartnershipCount) {
this.parentPartnershipCount = parentPartnershipCount;
}
/**
* A count of the volumes or snapshots partnered with a network storage volume.
*/
@ApiProperty
protected Long partnershipCount;
public Long getPartnershipCount() {
return partnershipCount;
}
public void setPartnershipCount(Long partnershipCount) {
this.partnershipCount = partnershipCount;
}
/**
* A count of all permissions group(s) this volume is in.
*/
@ApiProperty
protected Long permissionsGroupCount;
public Long getPermissionsGroupCount() {
return permissionsGroupCount;
}
public void setPermissionsGroupCount(Long permissionsGroupCount) {
this.permissionsGroupCount = permissionsGroupCount;
}
/**
* A count of the properties used to provide additional details about a network storage volume.
*/
@ApiProperty
protected Long propertyCount;
public Long getPropertyCount() {
return propertyCount;
}
public void setPropertyCount(Long propertyCount) {
this.propertyCount = propertyCount;
}
/**
* A count of the iSCSI LUN volumes being replicated by this network storage volume.
*/
@ApiProperty
protected Long replicatingLunCount;
public Long getReplicatingLunCount() {
return replicatingLunCount;
}
public void setReplicatingLunCount(Long replicatingLunCount) {
this.replicatingLunCount = replicatingLunCount;
}
/**
* A count of the volume replication events.
*/
@ApiProperty
protected Long replicationEventCount;
public Long getReplicationEventCount() {
return replicationEventCount;
}
public void setReplicationEventCount(Long replicationEventCount) {
this.replicationEventCount = replicationEventCount;
}
/**
* A count of the network storage volumes configured to be replicants of a volume.
*/
@ApiProperty
protected Long replicationPartnerCount;
public Long getReplicationPartnerCount() {
return replicationPartnerCount;
}
public void setReplicationPartnerCount(Long replicationPartnerCount) {
this.replicationPartnerCount = replicationPartnerCount;
}
/**
* A count of the schedules which are associated with a network storage volume.
*/
@ApiProperty
protected Long scheduleCount;
public Long getScheduleCount() {
return scheduleCount;
}
public void setScheduleCount(Long scheduleCount) {
this.scheduleCount = scheduleCount;
}
/**
* A count of the snapshots associated with this SoftLayer_Network_Storage volume.
*/
@ApiProperty
protected Long snapshotCount;
public Long getSnapshotCount() {
return snapshotCount;
}
public void setSnapshotCount(Long snapshotCount) {
this.snapshotCount = snapshotCount;
}
/**
* A count of the network storage groups this volume is attached to.
*/
@ApiProperty
protected Long storageGroupCount;
public Long getStorageGroupCount() {
return storageGroupCount;
}
public void setStorageGroupCount(Long storageGroupCount) {
this.storageGroupCount = storageGroupCount;
}
/**
* A count of the username and password history for a Storage service.
*/
@ApiProperty
protected Long volumeHistoryCount;
public Long getVolumeHistoryCount() {
return volumeHistoryCount;
}
public void setVolumeHistoryCount(Long volumeHistoryCount) {
this.volumeHistoryCount = volumeHistoryCount;
}
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());
}
/**
* SoftLayer customers may have a Storage volume associated with their account. Storage types include NAS, Lockbox, iSCSI, EVault backup, and Hub cloud storage. Information such as the account the Storage volume is associated to, username and password to access the Storage volume, related server (EVault only) and the capacity used are some of the details that may be retrieved using this service. Information regarding the Storage's resource that is useful in reconfiguring and mounting a StorageLayer volume may also be retrieved from this service.
*
* For the EVault Storage services, the username and passwords in the SoftLayer_Network_Storage services are used to register the EVault server agent with the vault. Please see the [[SoftLayer_Account_Password]] service to edit the passwords and notes for the EVault Webcc tool.
*
* @see SoftLayer_Network_Storage
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Network_Storage")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.
*
* @see SoftLayer_Network_Storage::allowAccessFromHardware
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessFromHardware(Hardware hardwareObjectTemplate);
/**
* @see SoftLayer_Network_Storage::allowAccessFromHardwareList
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessFromHardwareList(List hardwareObjectTemplates);
/**
* This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.
*
* @see SoftLayer_Network_Storage::allowAccessFromHost
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.network.storage.allowed.Host allowAccessFromHost(String typeClassName, Long hostId);
/**
* This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage volume will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.
*
* @see SoftLayer_Network_Storage::allowAccessFromHostList
*/
@ApiMethod(instanceRequired = true)
public List allowAccessFromHostList(List hostObjectTemplates);
/**
* This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume.
*
* @see SoftLayer_Network_Storage::allowAccessFromIpAddress
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessFromIpAddress(IpAddress ipAddressObjectTemplate);
/**
* @see SoftLayer_Network_Storage::allowAccessFromIpAddressList
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessFromIpAddressList(List ipAddressObjectTemplates);
/**
* This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.
*
* @see SoftLayer_Network_Storage::allowAccessFromSubnet
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessFromSubnet(Subnet subnetObjectTemplate);
/**
* @see SoftLayer_Network_Storage::allowAccessFromSubnetList
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessFromSubnetList(List subnetObjectTemplates);
/**
* This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.
*
* @see SoftLayer_Network_Storage::allowAccessFromVirtualGuest
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessFromVirtualGuest(Guest virtualGuestObjectTemplate);
/**
* This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.
*
* @see SoftLayer_Network_Storage::allowAccessFromVirtualGuestList
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessFromVirtualGuestList(List virtualGuestObjectTemplates);
/**
* This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.
*
* @see SoftLayer_Network_Storage::allowAccessToReplicantFromHardware
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessToReplicantFromHardware(Hardware hardwareObjectTemplate);
/**
* This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume.
*
* @see SoftLayer_Network_Storage::allowAccessToReplicantFromHardwareList
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessToReplicantFromHardwareList(List hardwareObjectTemplates);
/**
* @see SoftLayer_Network_Storage::allowAccessToReplicantFromIpAddress
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessToReplicantFromIpAddress(IpAddress ipAddressObjectTemplate);
/**
* This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume.
*
* @see SoftLayer_Network_Storage::allowAccessToReplicantFromIpAddressList
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessToReplicantFromIpAddressList(List ipAddressObjectTemplates);
/**
* This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.
*
* @see SoftLayer_Network_Storage::allowAccessToReplicantFromSubnet
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessToReplicantFromSubnet(Subnet subnetObjectTemplate);
/**
* This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume.
*
* @see SoftLayer_Network_Storage::allowAccessToReplicantFromSubnetList
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessToReplicantFromSubnetList(List subnetObjectTemplates);
/**
* This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replicant volume.
*
* @see SoftLayer_Network_Storage::allowAccessToReplicantFromVirtualGuest
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessToReplicantFromVirtualGuest(Guest virtualGuestObjectTemplate);
/**
* This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume.
*
* @see SoftLayer_Network_Storage::allowAccessToReplicantFromVirtualGuestList
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessToReplicantFromVirtualGuestList(List virtualGuestObjectTemplates);
/**
* This method will assign an existing credential to the current volume. The credential must have been created using the 'addNewCredential' method. The volume type must support an additional credential.
*
* @see SoftLayer_Network_Storage::assignCredential
*/
@ApiMethod(instanceRequired = true)
public Boolean assignCredential(String username);
/**
* This method will set up a new credential for the remote storage volume. The storage volume must support an additional credential. Once created, the credential will be automatically assigned to the current volume. If there are no volumes assigned to the credential it will be automatically deleted.
*
* @see SoftLayer_Network_Storage::assignNewCredential
*/
@ApiMethod(instanceRequired = true)
public Credential assignNewCredential(String type);
/**
* The method will change the password for the given Storage/Virtual Server Storage account.
*
* @see SoftLayer_Network_Storage::changePassword
*/
@ApiMethod
public Boolean changePassword(String username, String currentPassword, String newPassword);
/**
* {{CloudLayerOnlyMethod}}
*
* collectBandwidth() Retrieve the bandwidth usage for the current billing cycle.
*
* @see SoftLayer_Network_Storage::collectBandwidth
*/
@ApiMethod(instanceRequired = true)
public Long collectBandwidth(String type, GregorianCalendar startDate, GregorianCalendar endDate);
/**
* {{CloudLayerOnlyMethod}}
*
* collectBytesUsed() retrieves the number of bytes capacity currently in use on a Storage account.
*
* @see SoftLayer_Network_Storage::collectBytesUsed
*/
@ApiMethod(instanceRequired = true)
public Long collectBytesUsed();
/**
* @see SoftLayer_Network_Storage::createFolder
*/
@ApiMethod(instanceRequired = true)
public Boolean createFolder(String folder);
/**
* The LUN ID only takes effect during the Host Authorization process. It is required to de-authorize all hosts before using this method.
*
* @see SoftLayer_Network_Storage::createOrUpdateLunId
*/
@ApiMethod(instanceRequired = true)
public Property createOrUpdateLunId(Long lunId);
/**
* @see SoftLayer_Network_Storage::createSnapshot
*/
@ApiMethod(instanceRequired = true)
public Storage createSnapshot(String notes);
/**
* {{CloudLayerOnlyMethod}} Delete all files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin.
*
* Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted.
*
* Please note, files can not be restored once they are permanently deleted.
*
* @see SoftLayer_Network_Storage::deleteAllFiles
*/
@ApiMethod(instanceRequired = true)
public Boolean deleteAllFiles();
/**
* {{CloudLayerOnlyMethod}} Delete an individual file within a Storage account. Depending on the type of Storage account, Deleting a file either deletes the file permanently or sends the file to your account's recycle bin.
*
* Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the file is in the account's recycle bin. If the file exist in the recycle bin, then it is permanently deleted.
*
* Please note, a file can not be restored once it is permanently deleted.
*
* @see SoftLayer_Network_Storage::deleteFile
*/
@ApiMethod(instanceRequired = true)
public Boolean deleteFile(String fileId);
/**
* {{CloudLayerOnlyMethod}} Delete multiple files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin.
*
* Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted.
*
* Please note, files can not be restored once they are permanently deleted.
*
* @see SoftLayer_Network_Storage::deleteFiles
*/
@ApiMethod(instanceRequired = true)
public Boolean deleteFiles(List fileIds);
/**
* @see SoftLayer_Network_Storage::deleteFolder
*/
@ApiMethod(instanceRequired = true)
public Boolean deleteFolder(String folder);
/**
* Delete a network storage volume. '''This cannot be undone.''' At this time only network storage snapshots may be deleted with this method.
*
* ''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a volume;
*
* @see SoftLayer_Network_Storage::deleteObject
*/
@ApiMethod(instanceRequired = true)
public Boolean deleteObject();
/**
* This method is not valid for Legacy iSCSI Storage Volumes.
*
* Disable scheduled snapshots of this storage volume. Scheduling options include 'INTERVAL', HOURLY, DAILY and WEEKLY schedules.
*
* @see SoftLayer_Network_Storage::disableSnapshots
*/
@ApiMethod(instanceRequired = true)
public Boolean disableSnapshots(String scheduleType);
/**
* {{CloudLayerOnlyMethod}} Download a file from a Storage account. This method returns a file's details including the file's raw content.
*
* @see SoftLayer_Network_Storage::downloadFile
*/
@ApiMethod(instanceRequired = true)
public Entity downloadFile(String fileId);
/**
* This method will change the password of a credential created using the 'addNewCredential' method. If the credential exists on multiple storage volumes it will change for those volumes as well.
*
* @see SoftLayer_Network_Storage::editCredential
*/
@ApiMethod(instanceRequired = true)
public Boolean editCredential(String username, String newPassword);
/**
* The password and/or notes may be modified for the Storage service except evault passwords and notes.
*
* @see SoftLayer_Network_Storage::editObject
*/
@ApiMethod(instanceRequired = true)
public Boolean editObject(Storage templateObject);
/**
* This method is not valid for Legacy iSCSI Storage Volumes.
*
* Enable scheduled snapshots of this storage volume. Scheduling options include HOURLY, DAILY and WEEKLY schedules. For HOURLY schedules, provide relevant data for $scheduleType, $retentionCount and $minute. For DAILY schedules, provide relevant data for $scheduleType, $retentionCount, $minute, and $hour. For WEEKLY schedules, provide relevant data for all parameters of this method.
*
* @see SoftLayer_Network_Storage::enableSnapshots
*/
@ApiMethod(instanceRequired = true)
public Boolean enableSnapshots(String scheduleType, Long retentionCount, Long minute, Long hour, String dayOfWeek);
/**
* Failback from a volume replicant. In order to failback the volume must have already been failed over to a replicant.
*
* @see SoftLayer_Network_Storage::failbackFromReplicant
*/
@ApiMethod(instanceRequired = true)
public Boolean failbackFromReplicant();
/**
* Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available.
*
* @see SoftLayer_Network_Storage::failoverToReplicant
*/
@ApiMethod(instanceRequired = true)
public Boolean failoverToReplicant(Long replicantId);
/**
* {{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files in a Storage account's root directory. This does not download file content.
*
* @see SoftLayer_Network_Storage::getAllFiles
*/
@ApiMethod(instanceRequired = true)
public List getAllFiles();
/**
* {{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files matching the filter's criteria in a Storage account's root directory. This does not download file content.
*
* @see SoftLayer_Network_Storage::getAllFilesByFilter
*/
@ApiMethod(instanceRequired = true)
public List getAllFilesByFilter(Entity filter);
/**
* This method retrieves a list of SoftLayer_Hardware that can be authorized to this SoftLayer_Network_Storage.
*
* @see SoftLayer_Network_Storage::getAllowableHardware
*/
@ApiMethod(instanceRequired = true)
public List getAllowableHardware(String filterHostname);
/**
* This method retrieves a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this SoftLayer_Network_Storage.
*
* @see SoftLayer_Network_Storage::getAllowableIpAddresses
*/
@ApiMethod(instanceRequired = true)
public List getAllowableIpAddresses(Long subnetId, String filterIpAddress);
/**
* This method retrieves a list of SoftLayer_Network_Subnet that can be authorized to this SoftLayer_Network_Storage.
*
* @see SoftLayer_Network_Storage::getAllowableSubnets
*/
@ApiMethod(instanceRequired = true)
public List getAllowableSubnets(String filterNetworkIdentifier);
/**
* This method retrieves a list of SoftLayer_Virtual_Guest that can be authorized to this SoftLayer_Network_Storage.
*
* @see SoftLayer_Network_Storage::getAllowableVirtualGuests
*/
@ApiMethod(instanceRequired = true)
public List getAllowableVirtualGuests(String filterHostname);
/**
* Retrieves the total number of allowed hosts limit per volume.
*
* @see SoftLayer_Network_Storage::getAllowedHostsLimit
*/
@ApiMethod(instanceRequired = true)
public Long getAllowedHostsLimit();
/**
* Retrieve network storage accounts by username and storage account type. Use this method if you wish to retrieve a storage record by username rather than by id. The ''type'' parameter must correspond to one of the available ''nasType'' values in the SoftLayer_Network_Storage data type.
*
* @see SoftLayer_Network_Storage::getByUsername
*/
@ApiMethod
public List getByUsername(String username, String type);
/**
* @see SoftLayer_Network_Storage::getCdnUrls
*/
@ApiMethod(instanceRequired = true)
public List getCdnUrls();
/**
* @see SoftLayer_Network_Storage::getClusterResource
*/
@ApiMethod(instanceRequired = true)
public Resource getClusterResource();
/**
*
*
*
*
* @see SoftLayer_Network_Storage::getFileBlockEncryptedLocations
*/
@ApiMethod
public List getFileBlockEncryptedLocations();
/**
* {{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date of a file within a Storage account. This does not download file content.
*
* @see SoftLayer_Network_Storage::getFileByIdentifier
*/
@ApiMethod(instanceRequired = true)
public Entity getFileByIdentifier(String identifier);
/**
* {{CloudLayerOnlyMethod}} Retrieve the file number of files in a Virtual Server Storage account's root directory. This does not include the files stored in the recycle bin.
*
* @see SoftLayer_Network_Storage::getFileCount
*/
@ApiMethod(instanceRequired = true)
public Long getFileCount();
/**
* @see SoftLayer_Network_Storage::getFileList
*/
@ApiMethod(instanceRequired = true)
public List getFileList(String folder, String path);
/**
* {{CloudLayerOnlyMethod}} Retrieve the number of files pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted.
*
* @see SoftLayer_Network_Storage::getFilePendingDeleteCount
*/
@ApiMethod(instanceRequired = true)
public Long getFilePendingDeleteCount();
/**
* {{CloudLayerOnlyMethod}} Retrieve a list of files that are pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted. This method does not download file content.
*
* @see SoftLayer_Network_Storage::getFilesPendingDelete
*/
@ApiMethod(instanceRequired = true)
public List getFilesPendingDelete();
/**
* @see SoftLayer_Network_Storage::getFolderList
*/
@ApiMethod(instanceRequired = true)
public List getFolderList();
/**
* {{CloudLayerOnlyMethod}}
*
* getGraph() retrieves a Storage account's usage and returns a PNG graph image, title, and the minimum and maximum dates included in the graphed date range. Virtual Server storage accounts can also graph upload and download bandwidth usage.
*
* @see SoftLayer_Network_Storage::getGraph
*/
@ApiMethod(instanceRequired = true)
public GraphOutputs getGraph(GregorianCalendar startDate, GregorianCalendar endDate, String type);
/**
* @see SoftLayer_Network_Storage::getMaximumExpansionSize
*/
@ApiMethod(instanceRequired = true)
public Long getMaximumExpansionSize();
/**
* @see SoftLayer_Network_Storage::getNetworkConnectionDetails
*/
@ApiMethod(instanceRequired = true)
public NetworkConnectionInformation getNetworkConnectionDetails();
/**
* @see SoftLayer_Network_Storage::getNetworkMountAddress
*/
@ApiMethod(instanceRequired = true)
public String getNetworkMountAddress();
/**
* getObject retrieves the SoftLayer_Network_Storage object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Storage service.
*
* Please use the associated methods in the [[SoftLayer_Network_Storage]] service to retrieve a Storage account's id.
*
* @see SoftLayer_Network_Storage::getObject
*/
@ApiMethod(instanceRequired = true)
public Storage getObject();
/**
* @see SoftLayer_Network_Storage::getObjectStorageConnectionInformation
*/
@ApiMethod
public List getObjectStorageConnectionInformation();
/**
* Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. Use this method if you wish to retrieve a storage record by a credential rather than by id.
*
* @see SoftLayer_Network_Storage::getObjectsByCredential
*/
@ApiMethod
public List getObjectsByCredential(Credential credentialObject);
/**
* {{CloudLayerOnlyMethod}} Retrieve the details of a file that is pending deletion in a Storage account's a recycle bin.
*
* @see SoftLayer_Network_Storage::getRecycleBinFileByIdentifier
*/
@ApiMethod(instanceRequired = true)
public Entity getRecycleBinFileByIdentifier(String fileId);
/**
* Retrieves the remaining number of allowed hosts per volume.
*
* @see SoftLayer_Network_Storage::getRemainingAllowedHosts
*/
@ApiMethod(instanceRequired = true)
public Long getRemainingAllowedHosts();
/**
* Retrieves the remaining number of allowed hosts for a volume's replicant.
*
* @see SoftLayer_Network_Storage::getRemainingAllowedHostsForReplicant
*/
@ApiMethod(instanceRequired = true)
public Long getRemainingAllowedHostsForReplicant();
/**
* Retrieves a list of snapshots for this SoftLayer_Network_Storage volume. This method works with the result limits and offset to support pagination.
*
* @see SoftLayer_Network_Storage::getSnapshotsForVolume
*/
@ApiMethod(instanceRequired = true)
public List getSnapshotsForVolume();
/**
* @see SoftLayer_Network_Storage::getStorageGroupsNetworkConnectionDetails
*/
@ApiMethod(instanceRequired = true)
public List getStorageGroupsNetworkConnectionDetails();
/**
* @see SoftLayer_Network_Storage::getTargetIpAddresses
*/
@ApiMethod(instanceRequired = true)
public List getTargetIpAddresses();
/**
* @see SoftLayer_Network_Storage::getValidReplicationTargetDatacenterLocations
*/
@ApiMethod(instanceRequired = true)
public List getValidReplicationTargetDatacenterLocations();
/**
* This method returns the parameters for cloning a volume
*
* @see SoftLayer_Network_Storage::getVolumeDuplicateParameters
*/
@ApiMethod(instanceRequired = true)
public VolumeDuplicateParameters getVolumeDuplicateParameters();
/**
* Immediate Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available.
*
* @see SoftLayer_Network_Storage::immediateFailoverToReplicant
*/
@ApiMethod(instanceRequired = true)
public Boolean immediateFailoverToReplicant(Long replicantId);
/**
* @see SoftLayer_Network_Storage::isBlockingOperationInProgress
*/
@ApiMethod(instanceRequired = true)
public Boolean isBlockingOperationInProgress(List exemptStatusKeyNames);
/**
* This method returns a boolean indicating whether the clone volume is ready for snapshot.
*
* @see SoftLayer_Network_Storage::isDuplicateReadyForSnapshot
*/
@ApiMethod(instanceRequired = true)
public Boolean isDuplicateReadyForSnapshot();
/**
* This method returns a boolean indicating whether the clone volume is ready to mount.
*
* @see SoftLayer_Network_Storage::isDuplicateReadyToMount
*/
@ApiMethod(instanceRequired = true)
public Boolean isDuplicateReadyToMount();
/**
* @see SoftLayer_Network_Storage::isVolumeActive
*/
@ApiMethod(instanceRequired = true)
public Boolean isVolumeActive();
/**
* This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.
*
* @see SoftLayer_Network_Storage::removeAccessFromHardware
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessFromHardware(Hardware hardwareObjectTemplate);
/**
* This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.
*
* @see SoftLayer_Network_Storage::removeAccessFromHardwareList
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessFromHardwareList(List hardwareObjectTemplates);
/**
* This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.
*
* @see SoftLayer_Network_Storage::removeAccessFromHost
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.network.storage.allowed.Host removeAccessFromHost(String typeClassName, Long hostId);
/**
* This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.
*
* @see SoftLayer_Network_Storage::removeAccessFromHostList
*/
@ApiMethod(instanceRequired = true)
public List removeAccessFromHostList(List hostObjectTemplates);
/**
* This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume.
*
* @see SoftLayer_Network_Storage::removeAccessFromIpAddress
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessFromIpAddress(IpAddress ipAddressObjectTemplate);
/**
* @see SoftLayer_Network_Storage::removeAccessFromIpAddressList
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessFromIpAddressList(List ipAddressObjectTemplates);
/**
* @see SoftLayer_Network_Storage::removeAccessFromSubnet
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessFromSubnet(Subnet subnetObjectTemplate);
/**
* @see SoftLayer_Network_Storage::removeAccessFromSubnetList
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessFromSubnetList(List subnetObjectTemplates);
/**
* This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.
*
* @see SoftLayer_Network_Storage::removeAccessFromVirtualGuest
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessFromVirtualGuest(Guest virtualGuestObjectTemplate);
/**
* This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.
*
* @see SoftLayer_Network_Storage::removeAccessFromVirtualGuestList
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessFromVirtualGuestList(List virtualGuestObjectTemplates);
/**
* This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume.
*
* @see SoftLayer_Network_Storage::removeAccessToReplicantFromHardwareList
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessToReplicantFromHardwareList(List hardwareObjectTemplates);
/**
* This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume.
*
* @see SoftLayer_Network_Storage::removeAccessToReplicantFromIpAddressList
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessToReplicantFromIpAddressList(List ipAddressObjectTemplates);
/**
* @see SoftLayer_Network_Storage::removeAccessToReplicantFromSubnet
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessToReplicantFromSubnet(Subnet subnetObjectTemplate);
/**
* This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume.
*
* @see SoftLayer_Network_Storage::removeAccessToReplicantFromSubnetList
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessToReplicantFromSubnetList(List subnetObjectTemplates);
/**
* This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume.
*
* @see SoftLayer_Network_Storage::removeAccessToReplicantFromVirtualGuestList
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessToReplicantFromVirtualGuestList(List virtualGuestObjectTemplates);
/**
* This method will remove a credential from the current volume. The credential must have been created using the 'addNewCredential' method.
*
* @see SoftLayer_Network_Storage::removeCredential
*/
@ApiMethod(instanceRequired = true)
public Boolean removeCredential(String username);
/**
* {{CloudLayerOnlyMethod}} Restore an individual file so that it may be used as it was before it was deleted.
*
* If a file is deleted from a Virtual Server Storage account, the file is placed into the account's recycle bin and not permanently deleted. Therefore, restoreFile can be used to place the file back into your Virtual Server account's root directory.
*
* @see SoftLayer_Network_Storage::restoreFile
*/
@ApiMethod(instanceRequired = true)
public Entity restoreFile(String fileId);
/**
* Restore the volume from a snapshot that was previously taken.
*
* @see SoftLayer_Network_Storage::restoreFromSnapshot
*/
@ApiMethod(instanceRequired = true)
public Boolean restoreFromSnapshot(Long snapshotId);
/**
* The method will retrieve the password for the StorageLayer or Virtual Server Storage Account and email the password. The Storage Account passwords will be emailed to the master user. For Virtual Server Storage, the password will be sent to the email address used as the username.
*
* @see SoftLayer_Network_Storage::sendPasswordReminderEmail
*/
@ApiMethod
public Boolean sendPasswordReminderEmail(String username);
/**
* Enable or disable the mounting of a Storage volume. When mounting is enabled the Storage volume will be mountable or available for use.
*
* For Virtual Server volumes, disabling mounting will deny access to the Virtual Server Account, remove published material and deny all file interaction including uploads and downloads.
*
* Enabling or disabling mounting for Storage volumes is not possible if mounting has been disabled by SoftLayer or a parent account.
*
* @see SoftLayer_Network_Storage::setMountable
*/
@ApiMethod(instanceRequired = true)
public Boolean setMountable(Boolean mountable);
/**
* @see SoftLayer_Network_Storage::setSnapshotAllocation
*/
@ApiMethod(instanceRequired = true)
public Void setSnapshotAllocation(Long capacityGb);
/**
* Upgrade the Storage volume to one of the upgradable packages (for example from 10 Gigs of EVault storage to 100 Gigs of EVault storage).
*
* @see SoftLayer_Network_Storage::upgradeVolumeCapacity
*/
@ApiMethod(instanceRequired = true)
public Boolean upgradeVolumeCapacity(Long itemId);
/**
* {{CloudLayerOnlyMethod}} Upload a file to a Storage account's root directory. Once uploaded, this method returns new file entity identifier for the upload file.
*
* The following properties are required in the ''file'' parameter.
* *'''name''': The name of the file you wish to upload
* *'''content''': The raw contents of the file you wish to upload.
* *'''contentType''': The MIME-type of content that you wish to upload.
*
* @see SoftLayer_Network_Storage::uploadFile
*/
@ApiMethod(instanceRequired = true)
public Entity uploadFile(Entity file);
/**
* The account that a Storage services belongs to.
*
* @see SoftLayer_Network_Storage::getAccount
*/
@ApiMethod(instanceRequired = true)
public Account getAccount();
/**
* Other usernames and passwords associated with a Storage volume.
*
* @see SoftLayer_Network_Storage::getAccountPassword
*/
@ApiMethod(instanceRequired = true)
public Password getAccountPassword();
/**
* The currently active transactions on a network storage volume.
*
* @see SoftLayer_Network_Storage::getActiveTransactions
*/
@ApiMethod(instanceRequired = true)
public List getActiveTransactions();
/**
* The SoftLayer_Hardware objects which are allowed access to this storage volume.
*
* @see SoftLayer_Network_Storage::getAllowedHardware
*/
@ApiMethod(instanceRequired = true)
public List getAllowedHardware();
/**
* The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.
*
* @see SoftLayer_Network_Storage::getAllowedIpAddresses
*/
@ApiMethod(instanceRequired = true)
public List getAllowedIpAddresses();
/**
* The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
*
* @see SoftLayer_Network_Storage::getAllowedReplicationHardware
*/
@ApiMethod(instanceRequired = true)
public List getAllowedReplicationHardware();
/**
* The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.
*
* @see SoftLayer_Network_Storage::getAllowedReplicationIpAddresses
*/
@ApiMethod(instanceRequired = true)
public List getAllowedReplicationIpAddresses();
/**
* The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.
*
* @see SoftLayer_Network_Storage::getAllowedReplicationSubnets
*/
@ApiMethod(instanceRequired = true)
public List getAllowedReplicationSubnets();
/**
* The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
*
* @see SoftLayer_Network_Storage::getAllowedReplicationVirtualGuests
*/
@ApiMethod(instanceRequired = true)
public List getAllowedReplicationVirtualGuests();
/**
* The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.
*
* @see SoftLayer_Network_Storage::getAllowedSubnets
*/
@ApiMethod(instanceRequired = true)
public List getAllowedSubnets();
/**
* The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.
*
* @see SoftLayer_Network_Storage::getAllowedVirtualGuests
*/
@ApiMethod(instanceRequired = true)
public List getAllowedVirtualGuests();
/**
* The current billing item for a Storage volume.
*
* @see SoftLayer_Network_Storage::getBillingItem
*/
@ApiMethod(instanceRequired = true)
public Item getBillingItem();
/**
* @see SoftLayer_Network_Storage::getBillingItemCategory
*/
@ApiMethod(instanceRequired = true)
public Category getBillingItemCategory();
/**
* The amount of space used by the volume, in bytes.
*
* @see SoftLayer_Network_Storage::getBytesUsed
*/
@ApiMethod(instanceRequired = true)
public String getBytesUsed();
/**
* The schedule id which was executed to create a snapshot.
*
* @see SoftLayer_Network_Storage::getCreationScheduleId
*/
@ApiMethod(instanceRequired = true)
public String getCreationScheduleId();
/**
* @see SoftLayer_Network_Storage::getCredentials
*/
@ApiMethod(instanceRequired = true)
public List getCredentials();
/**
* The Daily Schedule which is associated with this network storage volume.
*
* @see SoftLayer_Network_Storage::getDailySchedule
*/
@ApiMethod(instanceRequired = true)
public Schedule getDailySchedule();
/**
* The events which have taken place on a network storage volume.
*
* @see SoftLayer_Network_Storage::getEvents
*/
@ApiMethod(instanceRequired = true)
public List getEvents();
/**
* Retrieves the NFS Network Mount Address Name for a given File Storage Volume.
*
* @see SoftLayer_Network_Storage::getFileNetworkMountAddress
*/
@ApiMethod(instanceRequired = true)
public String getFileNetworkMountAddress();
/**
* When applicable, the hardware associated with a Storage service.
*
* @see SoftLayer_Network_Storage::getHardware
*/
@ApiMethod(instanceRequired = true)
public Hardware getHardware();
/**
* @see SoftLayer_Network_Storage::getHasEncryptionAtRest
*/
@ApiMethod(instanceRequired = true)
public Boolean getHasEncryptionAtRest();
/**
* The Hourly Schedule which is associated with this network storage volume.
*
* @see SoftLayer_Network_Storage::getHourlySchedule
*/
@ApiMethod(instanceRequired = true)
public Schedule getHourlySchedule();
/**
* The Interval Schedule which is associated with this network storage volume.
*
* @see SoftLayer_Network_Storage::getIntervalSchedule
*/
@ApiMethod(instanceRequired = true)
public Schedule getIntervalSchedule();
/**
* The maximum number of IOPs selected for this volume.
*
* @see SoftLayer_Network_Storage::getIops
*/
@ApiMethod(instanceRequired = true)
public String getIops();
/**
* Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot.
*
* @see SoftLayer_Network_Storage::getIsReadyForSnapshot
*/
@ApiMethod(instanceRequired = true)
public Boolean getIsReadyForSnapshot();
/**
* Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details.
*
* @see SoftLayer_Network_Storage::getIsReadyToMount
*/
@ApiMethod(instanceRequired = true)
public Boolean getIsReadyToMount();
/**
* Relationship between a container volume and iSCSI LUNs.
*
* @see SoftLayer_Network_Storage::getIscsiLuns
*/
@ApiMethod(instanceRequired = true)
public List getIscsiLuns();
/**
* Returns the target IP addresses of an iSCSI volume.
*
* @see SoftLayer_Network_Storage::getIscsiTargetIpAddresses
*/
@ApiMethod(instanceRequired = true)
public List getIscsiTargetIpAddresses();
/**
* The ID of the LUN volume.
*
* @see SoftLayer_Network_Storage::getLunId
*/
@ApiMethod(instanceRequired = true)
public String getLunId();
/**
* The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset.
*
* @see SoftLayer_Network_Storage::getManualSnapshots
*/
@ApiMethod(instanceRequired = true)
public List getManualSnapshots();
/**
* A network storage volume's metric tracking object. This object records all periodic polled data available to this volume.
*
* @see SoftLayer_Network_Storage::getMetricTrackingObject
*/
@ApiMethod(instanceRequired = true)
public Object getMetricTrackingObject();
/**
* Whether or not a network storage volume may be mounted.
*
* @see SoftLayer_Network_Storage::getMountableFlag
*/
@ApiMethod(instanceRequired = true)
public String getMountableFlag();
/**
* The current status of split or move operation as a part of volume duplication.
*
* @see SoftLayer_Network_Storage::getMoveAndSplitStatus
*/
@ApiMethod(instanceRequired = true)
public String getMoveAndSplitStatus();
/**
* The subscribers that will be notified for usage amount warnings and overages.
*
* @see SoftLayer_Network_Storage::getNotificationSubscribers
*/
@ApiMethod(instanceRequired = true)
public List getNotificationSubscribers();
/**
* The name of the snapshot that this volume was duplicated from.
*
* @see SoftLayer_Network_Storage::getOriginalSnapshotName
*/
@ApiMethod(instanceRequired = true)
public String getOriginalSnapshotName();
/**
* The name of the volume that this volume was duplicated from.
*
* @see SoftLayer_Network_Storage::getOriginalVolumeName
*/
@ApiMethod(instanceRequired = true)
public String getOriginalVolumeName();
/**
* The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created.
*
* @see SoftLayer_Network_Storage::getOriginalVolumeSize
*/
@ApiMethod(instanceRequired = true)
public String getOriginalVolumeSize();
/**
* A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.
*
* @see SoftLayer_Network_Storage::getOsType
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.network.storage.iscsi.os.Type getOsType();
/**
* A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.
*
* @see SoftLayer_Network_Storage::getOsTypeId
*/
@ApiMethod(instanceRequired = true)
public String getOsTypeId();
/**
* The volumes or snapshots partnered with a network storage volume in a parental role.
*
* @see SoftLayer_Network_Storage::getParentPartnerships
*/
@ApiMethod(instanceRequired = true)
public List getParentPartnerships();
/**
* The parent volume of a volume in a complex storage relationship.
*
* @see SoftLayer_Network_Storage::getParentVolume
*/
@ApiMethod(instanceRequired = true)
public Storage getParentVolume();
/**
* The volumes or snapshots partnered with a network storage volume.
*
* @see SoftLayer_Network_Storage::getPartnerships
*/
@ApiMethod(instanceRequired = true)
public List getPartnerships();
/**
* All permissions group(s) this volume is in.
*
* @see SoftLayer_Network_Storage::getPermissionsGroups
*/
@ApiMethod(instanceRequired = true)
public List getPermissionsGroups();
/**
* The properties used to provide additional details about a network storage volume.
*
* @see SoftLayer_Network_Storage::getProperties
*/
@ApiMethod(instanceRequired = true)
public List getProperties();
/**
* The number of IOPs provisioned for this volume.
*
* @see SoftLayer_Network_Storage::getProvisionedIops
*/
@ApiMethod(instanceRequired = true)
public String getProvisionedIops();
/**
* The iSCSI LUN volumes being replicated by this network storage volume.
*
* @see SoftLayer_Network_Storage::getReplicatingLuns
*/
@ApiMethod(instanceRequired = true)
public List getReplicatingLuns();
/**
* The network storage volume being replicated by a volume.
*
* @see SoftLayer_Network_Storage::getReplicatingVolume
*/
@ApiMethod(instanceRequired = true)
public Storage getReplicatingVolume();
/**
* The volume replication events.
*
* @see SoftLayer_Network_Storage::getReplicationEvents
*/
@ApiMethod(instanceRequired = true)
public List getReplicationEvents();
/**
* The network storage volumes configured to be replicants of a volume.
*
* @see SoftLayer_Network_Storage::getReplicationPartners
*/
@ApiMethod(instanceRequired = true)
public List getReplicationPartners();
/**
* The Replication Schedule associated with a network storage volume.
*
* @see SoftLayer_Network_Storage::getReplicationSchedule
*/
@ApiMethod(instanceRequired = true)
public Schedule getReplicationSchedule();
/**
* The current replication status of a network storage volume. Indicates Failover or Failback status.
*
* @see SoftLayer_Network_Storage::getReplicationStatus
*/
@ApiMethod(instanceRequired = true)
public String getReplicationStatus();
/**
* The schedules which are associated with a network storage volume.
*
* @see SoftLayer_Network_Storage::getSchedules
*/
@ApiMethod(instanceRequired = true)
public List getSchedules();
/**
* The network resource a Storage service is connected to.
*
* @see SoftLayer_Network_Storage::getServiceResource
*/
@ApiMethod(instanceRequired = true)
public Resource getServiceResource();
/**
* The IP address of a Storage resource.
*
* @see SoftLayer_Network_Storage::getServiceResourceBackendIpAddress
*/
@ApiMethod(instanceRequired = true)
public String getServiceResourceBackendIpAddress();
/**
* The name of a Storage's network resource.
*
* @see SoftLayer_Network_Storage::getServiceResourceName
*/
@ApiMethod(instanceRequired = true)
public String getServiceResourceName();
/**
* A volume's configured snapshot space size.
*
* @see SoftLayer_Network_Storage::getSnapshotCapacityGb
*/
@ApiMethod(instanceRequired = true)
public String getSnapshotCapacityGb();
/**
* The creation timestamp of the snapshot on the storage platform.
*
* @see SoftLayer_Network_Storage::getSnapshotCreationTimestamp
*/
@ApiMethod(instanceRequired = true)
public String getSnapshotCreationTimestamp();
/**
* The percentage of used snapshot space after which to delete automated snapshots.
*
* @see SoftLayer_Network_Storage::getSnapshotDeletionThresholdPercentage
*/
@ApiMethod(instanceRequired = true)
public String getSnapshotDeletionThresholdPercentage();
/**
* The snapshot size in bytes.
*
* @see SoftLayer_Network_Storage::getSnapshotSizeBytes
*/
@ApiMethod(instanceRequired = true)
public String getSnapshotSizeBytes();
/**
* A volume's available snapshot reservation space.
*
* @see SoftLayer_Network_Storage::getSnapshotSpaceAvailable
*/
@ApiMethod(instanceRequired = true)
public String getSnapshotSpaceAvailable();
/**
* The snapshots associated with this SoftLayer_Network_Storage volume.
*
* @see SoftLayer_Network_Storage::getSnapshots
*/
@ApiMethod(instanceRequired = true)
public List getSnapshots();
/**
* @see SoftLayer_Network_Storage::getStaasVersion
*/
@ApiMethod(instanceRequired = true)
public String getStaasVersion();
/**
* The network storage groups this volume is attached to.
*
* @see SoftLayer_Network_Storage::getStorageGroups
*/
@ApiMethod(instanceRequired = true)
public List getStorageGroups();
/**
* @see SoftLayer_Network_Storage::getStorageTierLevel
*/
@ApiMethod(instanceRequired = true)
public String getStorageTierLevel();
/**
* A description of the Storage object.
*
* @see SoftLayer_Network_Storage::getStorageType
*/
@ApiMethod(instanceRequired = true)
public Type getStorageType();
/**
* The amount of space used by the volume.
*
* @see SoftLayer_Network_Storage::getTotalBytesUsed
*/
@ApiMethod(instanceRequired = true)
public String getTotalBytesUsed();
/**
* The total snapshot retention count of all schedules on this network storage volume.
*
* @see SoftLayer_Network_Storage::getTotalScheduleSnapshotRetentionCount
*/
@ApiMethod(instanceRequired = true)
public Long getTotalScheduleSnapshotRetentionCount();
/**
* The usage notification for SL Storage services.
*
* @see SoftLayer_Network_Storage::getUsageNotification
*/
@ApiMethod(instanceRequired = true)
public Notification getUsageNotification();
/**
* The type of network storage service.
*
* @see SoftLayer_Network_Storage::getVendorName
*/
@ApiMethod(instanceRequired = true)
public String getVendorName();
/**
* When applicable, the virtual guest associated with a Storage service.
*
* @see SoftLayer_Network_Storage::getVirtualGuest
*/
@ApiMethod(instanceRequired = true)
public Guest getVirtualGuest();
/**
* The username and password history for a Storage service.
*
* @see SoftLayer_Network_Storage::getVolumeHistory
*/
@ApiMethod(instanceRequired = true)
public List getVolumeHistory();
/**
* The current status of a network storage volume.
*
* @see SoftLayer_Network_Storage::getVolumeStatus
*/
@ApiMethod(instanceRequired = true)
public String getVolumeStatus();
/**
* The account username and password for the EVault webCC interface.
*
* @see SoftLayer_Network_Storage::getWebccAccount
*/
@ApiMethod(instanceRequired = true)
public Password getWebccAccount();
/**
* The Weekly Schedule which is associated with this network storage volume.
*
* @see SoftLayer_Network_Storage::getWeeklySchedule
*/
@ApiMethod(instanceRequired = true)
public Schedule getWeeklySchedule();
}
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#allowAccessFromHardware}
*/
public Future allowAccessFromHardware(Hardware hardwareObjectTemplate);
public Future> allowAccessFromHardware(Hardware hardwareObjectTemplate, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessFromHardwareList}
*/
public Future allowAccessFromHardwareList(List hardwareObjectTemplates);
public Future> allowAccessFromHardwareList(List hardwareObjectTemplates, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessFromHost}
*/
public Future allowAccessFromHost(String typeClassName, Long hostId);
public Future> allowAccessFromHost(String typeClassName, Long hostId, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessFromHostList}
*/
public Future> allowAccessFromHostList(List hostObjectTemplates);
public Future> allowAccessFromHostList(List hostObjectTemplates, ResponseHandler> callback);
/**
* Async version of {@link Service#allowAccessFromIpAddress}
*/
public Future allowAccessFromIpAddress(IpAddress ipAddressObjectTemplate);
public Future> allowAccessFromIpAddress(IpAddress ipAddressObjectTemplate, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessFromIpAddressList}
*/
public Future allowAccessFromIpAddressList(List ipAddressObjectTemplates);
public Future> allowAccessFromIpAddressList(List ipAddressObjectTemplates, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessFromSubnet}
*/
public Future allowAccessFromSubnet(Subnet subnetObjectTemplate);
public Future> allowAccessFromSubnet(Subnet subnetObjectTemplate, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessFromSubnetList}
*/
public Future allowAccessFromSubnetList(List subnetObjectTemplates);
public Future> allowAccessFromSubnetList(List subnetObjectTemplates, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessFromVirtualGuest}
*/
public Future allowAccessFromVirtualGuest(Guest virtualGuestObjectTemplate);
public Future> allowAccessFromVirtualGuest(Guest virtualGuestObjectTemplate, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessFromVirtualGuestList}
*/
public Future allowAccessFromVirtualGuestList(List virtualGuestObjectTemplates);
public Future> allowAccessFromVirtualGuestList(List virtualGuestObjectTemplates, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessToReplicantFromHardware}
*/
public Future allowAccessToReplicantFromHardware(Hardware hardwareObjectTemplate);
public Future> allowAccessToReplicantFromHardware(Hardware hardwareObjectTemplate, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessToReplicantFromHardwareList}
*/
public Future allowAccessToReplicantFromHardwareList(List hardwareObjectTemplates);
public Future> allowAccessToReplicantFromHardwareList(List hardwareObjectTemplates, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessToReplicantFromIpAddress}
*/
public Future allowAccessToReplicantFromIpAddress(IpAddress ipAddressObjectTemplate);
public Future> allowAccessToReplicantFromIpAddress(IpAddress ipAddressObjectTemplate, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessToReplicantFromIpAddressList}
*/
public Future allowAccessToReplicantFromIpAddressList(List ipAddressObjectTemplates);
public Future> allowAccessToReplicantFromIpAddressList(List ipAddressObjectTemplates, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessToReplicantFromSubnet}
*/
public Future allowAccessToReplicantFromSubnet(Subnet subnetObjectTemplate);
public Future> allowAccessToReplicantFromSubnet(Subnet subnetObjectTemplate, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessToReplicantFromSubnetList}
*/
public Future allowAccessToReplicantFromSubnetList(List subnetObjectTemplates);
public Future> allowAccessToReplicantFromSubnetList(List subnetObjectTemplates, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessToReplicantFromVirtualGuest}
*/
public Future allowAccessToReplicantFromVirtualGuest(Guest virtualGuestObjectTemplate);
public Future> allowAccessToReplicantFromVirtualGuest(Guest virtualGuestObjectTemplate, ResponseHandler callback);
/**
* Async version of {@link Service#allowAccessToReplicantFromVirtualGuestList}
*/
public Future allowAccessToReplicantFromVirtualGuestList(List virtualGuestObjectTemplates);
public Future> allowAccessToReplicantFromVirtualGuestList(List virtualGuestObjectTemplates, ResponseHandler callback);
/**
* Async version of {@link Service#assignCredential}
*/
public Future assignCredential(String username);
public Future> assignCredential(String username, ResponseHandler callback);
/**
* Async version of {@link Service#assignNewCredential}
*/
public Future assignNewCredential(String type);
public Future> assignNewCredential(String type, ResponseHandler callback);
/**
* Async version of {@link Service#changePassword}
*/
public Future changePassword(String username, String currentPassword, String newPassword);
public Future> changePassword(String username, String currentPassword, String newPassword, ResponseHandler callback);
/**
* Async version of {@link Service#collectBandwidth}
*/
public Future collectBandwidth(String type, GregorianCalendar startDate, GregorianCalendar endDate);
public Future> collectBandwidth(String type, GregorianCalendar startDate, GregorianCalendar endDate, ResponseHandler callback);
/**
* Async version of {@link Service#collectBytesUsed}
*/
public Future collectBytesUsed();
public Future> collectBytesUsed(ResponseHandler callback);
/**
* Async version of {@link Service#createFolder}
*/
public Future createFolder(String folder);
public Future> createFolder(String folder, ResponseHandler callback);
/**
* Async version of {@link Service#createOrUpdateLunId}
*/
public Future createOrUpdateLunId(Long lunId);
public Future> createOrUpdateLunId(Long lunId, ResponseHandler callback);
/**
* Async version of {@link Service#createSnapshot}
*/
public Future createSnapshot(String notes);
public Future> createSnapshot(String notes, ResponseHandler callback);
/**
* Async version of {@link Service#deleteAllFiles}
*/
public Future deleteAllFiles();
public Future> deleteAllFiles(ResponseHandler callback);
/**
* Async version of {@link Service#deleteFile}
*/
public Future deleteFile(String fileId);
public Future> deleteFile(String fileId, ResponseHandler callback);
/**
* Async version of {@link Service#deleteFiles}
*/
public Future deleteFiles(List fileIds);
public Future> deleteFiles(List fileIds, ResponseHandler callback);
/**
* Async version of {@link Service#deleteFolder}
*/
public Future deleteFolder(String folder);
public Future> deleteFolder(String folder, ResponseHandler callback);
/**
* Async version of {@link Service#deleteObject}
*/
public Future deleteObject();
public Future> deleteObject(ResponseHandler callback);
/**
* Async version of {@link Service#disableSnapshots}
*/
public Future disableSnapshots(String scheduleType);
public Future> disableSnapshots(String scheduleType, ResponseHandler callback);
/**
* Async version of {@link Service#downloadFile}
*/
public Future downloadFile(String fileId);
public Future> downloadFile(String fileId, ResponseHandler callback);
/**
* Async version of {@link Service#editCredential}
*/
public Future editCredential(String username, String newPassword);
public Future> editCredential(String username, String newPassword, ResponseHandler callback);
/**
* Async version of {@link Service#editObject}
*/
public Future editObject(Storage templateObject);
public Future> editObject(Storage templateObject, ResponseHandler callback);
/**
* Async version of {@link Service#enableSnapshots}
*/
public Future enableSnapshots(String scheduleType, Long retentionCount, Long minute, Long hour, String dayOfWeek);
public Future> enableSnapshots(String scheduleType, Long retentionCount, Long minute, Long hour, String dayOfWeek, ResponseHandler callback);
/**
* Async version of {@link Service#failbackFromReplicant}
*/
public Future failbackFromReplicant();
public Future> failbackFromReplicant(ResponseHandler callback);
/**
* Async version of {@link Service#failoverToReplicant}
*/
public Future failoverToReplicant(Long replicantId);
public Future> failoverToReplicant(Long replicantId, ResponseHandler callback);
/**
* Async version of {@link Service#getAllFiles}
*/
public Future> getAllFiles();
public Future> getAllFiles(ResponseHandler> callback);
/**
* Async version of {@link Service#getAllFilesByFilter}
*/
public Future> getAllFilesByFilter(Entity filter);
public Future> getAllFilesByFilter(Entity filter, ResponseHandler> callback);
/**
* Async version of {@link Service#getAllowableHardware}
*/
public Future> getAllowableHardware(String filterHostname);
public Future> getAllowableHardware(String filterHostname, ResponseHandler> callback);
/**
* Async version of {@link Service#getAllowableIpAddresses}
*/
public Future> getAllowableIpAddresses(Long subnetId, String filterIpAddress);
public Future> getAllowableIpAddresses(Long subnetId, String filterIpAddress, ResponseHandler> callback);
/**
* Async version of {@link Service#getAllowableSubnets}
*/
public Future> getAllowableSubnets(String filterNetworkIdentifier);
public Future> getAllowableSubnets(String filterNetworkIdentifier, ResponseHandler> callback);
/**
* Async version of {@link Service#getAllowableVirtualGuests}
*/
public Future> getAllowableVirtualGuests(String filterHostname);
public Future> getAllowableVirtualGuests(String filterHostname, ResponseHandler