com.solidfire.element.api.Volume Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of element-api Show documentation
Show all versions of element-api Show documentation
Library for interfacing with the Public and Incubating SolidFire Element API.
/*
* Copyright © 2015 SolidFire, Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* DO NOT EDIT THIS CODE BY HAND! It has been generated with jsvcgen.
*/
package com.solidfire.element.api;
import com.solidfire.javautil.Optional;
import com.solidfire.client.ApiException;
import com.solidfire.javautil.Optional;
import java.net.URL;
import java.util.Arrays;
import java.util.Objects;
import com.solidfire.annotation.Since;
import static com.solidfire.javautil.Optional.of;
/**
* Volumes Info is an object containing information about a volume.
**/
public class Volume {
private final Long volumeID;
private final String name;
private final Long accountID;
private final String createTime;
private final String status;
private final String access;
private final Boolean enable512e;
private final String iqn;
private final String scsiEUIDeviceID;
private final String scsiNAADeviceID;
private final QoSResult qos;
private final Long[] volumeAccessGroups;
private final VolumePair[] volumePairs;
private final Optional deleteTime;
private final Optional purgeTime;
private final Long sliceCount;
private final Long totalSize;
private final Long blockSize;
private final String virtualVolumeID;
private final java.util.Map attributes;
/**
* Volumes Info is an object containing information about a volume.
* The return objects only include "configured" information about the volume and not runtime or usage information.
* Information about paired volumes will also be returned.
* @param volumeID [required] Unique VolumeID for the volume.
* @param name [required] Name of the volume as provided at creation time.
* @param accountID [required] Unique AccountID for the account.
* @param createTime [required] UTC formatted time the volume was created.
* @param status [required] Current status of the volume
* @param access [required] Access allowed for the volume
* @param enable512e [required] If "true", the volume provides 512 byte sector emulation.
* @param iqn [required] Volume iSCSI Qualified Name.
* @param scsiEUIDeviceID [required] Globally unique SCSI device identifier for the volume in EUI-64 based 16-byte format.
* @param scsiNAADeviceID [required] Globally unique SCSI device identifier for the volume in NAA IEEE Registered Extended format.
* @param qos [required] Quality of service settings for this volume.
* @param volumeAccessGroups [required] List of volume access groups to which a volume belongs.
* @param volumePairs [required] Information about a paired volume.
* @param deleteTime (optional) The time this volume was deleted.
* @param purgeTime (optional) The time this volume will be purged from the system.
* @param sliceCount [required] The number of slices backing this volume.
* @param totalSize [required] Total size of this volume in bytes.
* @param virtualVolumeID [required] Virtual volume ID this volume backs.
* @param attributes [required] List of Name/Value pairs in JSON object format.
* @since 7.0
**/
@Since("7.0")
public Volume(Long volumeID, String name, Long accountID, String createTime, String status, String access, Boolean enable512e, String iqn, String scsiEUIDeviceID, String scsiNAADeviceID, QoSResult qos, Long[] volumeAccessGroups, VolumePair[] volumePairs, Optional deleteTime, Optional purgeTime, Long sliceCount, Long totalSize, String virtualVolumeID, java.util.Map attributes) {
this.name = name;
this.volumeAccessGroups = volumeAccessGroups;
this.createTime = createTime;
this.scsiNAADeviceID = scsiNAADeviceID;
this.totalSize = totalSize;
this.virtualVolumeID = virtualVolumeID;
this.enable512e = enable512e;
this.iqn = iqn;
this.blockSize = null;
this.attributes = attributes;
this.accountID = accountID;
this.volumePairs = volumePairs;
this.status = status;
this.purgeTime = purgeTime;
this.deleteTime = deleteTime;
this.volumeID = volumeID;
this.scsiEUIDeviceID = scsiEUIDeviceID;
this.qos = qos;
this.sliceCount = sliceCount;
this.access = access;
}
/**
* Volumes Info is an object containing information about a volume.
* The return objects only include "configured" information about the volume and not runtime or usage information.
* Information about paired volumes will also be returned.
* @param volumeID [required] Unique VolumeID for the volume.
* @param name [required] Name of the volume as provided at creation time.
* @param accountID [required] Unique AccountID for the account.
* @param createTime [required] UTC formatted time the volume was created.
* @param status [required] Current status of the volume
* @param access [required] Access allowed for the volume
* @param enable512e [required] If "true", the volume provides 512 byte sector emulation.
* @param iqn [required] Volume iSCSI Qualified Name.
* @param scsiEUIDeviceID [required] Globally unique SCSI device identifier for the volume in EUI-64 based 16-byte format.
* @param scsiNAADeviceID [required] Globally unique SCSI device identifier for the volume in NAA IEEE Registered Extended format.
* @param qos [required] Quality of service settings for this volume.
* @param volumeAccessGroups [required] List of volume access groups to which a volume belongs.
* @param volumePairs [required] Information about a paired volume.
* @param deleteTime (optional) The time this volume was deleted.
* @param purgeTime (optional) The time this volume will be purged from the system.
* @param sliceCount [required] The number of slices backing this volume.
* @param totalSize [required] Total size of this volume in bytes.
* @param blockSize [required] Size of the blocks on the volume.
* @param virtualVolumeID [required] Virtual volume ID this volume backs.
* @param attributes [required] List of Name/Value pairs in JSON object format.
* @since 8.0
**/
@Since("8.0")
public Volume(Long volumeID, String name, Long accountID, String createTime, String status, String access, Boolean enable512e, String iqn, String scsiEUIDeviceID, String scsiNAADeviceID, QoSResult qos, Long[] volumeAccessGroups, VolumePair[] volumePairs, Optional deleteTime, Optional purgeTime, Long sliceCount, Long totalSize, Long blockSize, String virtualVolumeID, java.util.Map attributes) {
this.name = name;
this.volumeAccessGroups = volumeAccessGroups;
this.createTime = createTime;
this.scsiNAADeviceID = scsiNAADeviceID;
this.totalSize = totalSize;
this.virtualVolumeID = virtualVolumeID;
this.enable512e = enable512e;
this.iqn = iqn;
this.blockSize = blockSize;
this.attributes = attributes;
this.accountID = accountID;
this.volumePairs = volumePairs;
this.status = status;
this.purgeTime = purgeTime;
this.deleteTime = deleteTime;
this.volumeID = volumeID;
this.scsiEUIDeviceID = scsiEUIDeviceID;
this.qos = qos;
this.sliceCount = sliceCount;
this.access = access;
}
/**
* Unique VolumeID for the volume.
**/
public Long getVolumeID() {
return this.volumeID;
}
/**
* Name of the volume as provided at creation time.
**/
public String getName() {
return this.name;
}
/**
* Unique AccountID for the account.
**/
public Long getAccountID() {
return this.accountID;
}
/**
* UTC formatted time the volume was created.
**/
public String getCreateTime() {
return this.createTime;
}
/**
* Current status of the volume
* init: A volume that is being initialized and is not ready for connections.
* active: An active volume ready for connections.
**/
public String getStatus() {
return this.status;
}
/**
* Access allowed for the volume
*
readOnly: Only read operations are allowed.
*
readWrite: Reads and writes are allowed.
*
locked: No reads or writes are allowed.
*
replicationTarget: Designated as a target volume in a replicated volume pair.
**/
public String getAccess() {
return this.access;
}
/**
* If "true", the volume provides 512 byte sector emulation.
**/
public Boolean getEnable512e() {
return this.enable512e;
}
/**
* Volume iSCSI Qualified Name.
**/
public String getIqn() {
return this.iqn;
}
/**
* Globally unique SCSI device identifier for the volume in EUI-64 based 16-byte format.
**/
public String getScsiEUIDeviceID() {
return this.scsiEUIDeviceID;
}
/**
* Globally unique SCSI device identifier for the volume in NAA IEEE Registered Extended format.
**/
public String getScsiNAADeviceID() {
return this.scsiNAADeviceID;
}
/**
* Quality of service settings for this volume.
**/
public QoSResult getQos() {
return this.qos;
}
/**
* List of volume access groups to which a volume belongs.
**/
public Long[] getVolumeAccessGroups() {
return this.volumeAccessGroups;
}
/**
* Information about a paired volume.
* Available only if a volume is paired.
* @see VolumePairs for return values.
**/
public VolumePair[] getVolumePairs() {
return this.volumePairs;
}
/**
* The time this volume was deleted.
* If this has no value, the volume has not yet been deleted.
**/
public Optional getDeleteTime() {
return this.deleteTime;
}
/**
* The time this volume will be purged from the system.
* If this has no value, the volume has not yet been deleted (and is not scheduled for purging).
**/
public Optional getPurgeTime() {
return this.purgeTime;
}
/**
* The number of slices backing this volume.
* In the current software, this value will always be 1.
**/
public Long getSliceCount() {
return this.sliceCount;
}
/**
* Total size of this volume in bytes.
**/
public Long getTotalSize() {
return this.totalSize;
}
/**
* Size of the blocks on the volume.
* @since 8.0
**/
@Since("8.0")
public Long getBlockSize() {
return this.blockSize;
}
/**
* Virtual volume ID this volume backs.
**/
public String getVirtualVolumeID() {
return this.virtualVolumeID;
}
/**
* List of Name/Value pairs in JSON object format.
**/
public java.util.Map getAttributes() {
return this.attributes;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Volume that = (Volume) o;
return Objects.equals( volumeID , that.volumeID )
&& Objects.equals( name , that.name )
&& Objects.equals( accountID , that.accountID )
&& Objects.equals( createTime , that.createTime )
&& Objects.equals( status , that.status )
&& Objects.equals( access , that.access )
&& Objects.equals( enable512e , that.enable512e )
&& Objects.equals( iqn , that.iqn )
&& Objects.equals( scsiEUIDeviceID , that.scsiEUIDeviceID )
&& Objects.equals( scsiNAADeviceID , that.scsiNAADeviceID )
&& Objects.equals( qos , that.qos )
&& Objects.deepEquals( volumeAccessGroups , that.volumeAccessGroups )
&& Objects.deepEquals( volumePairs , that.volumePairs )
&& Objects.equals( deleteTime , that.deleteTime )
&& Objects.equals( purgeTime , that.purgeTime )
&& Objects.equals( sliceCount , that.sliceCount )
&& Objects.equals( totalSize , that.totalSize )
&& Objects.equals( blockSize , that.blockSize )
&& Objects.equals( virtualVolumeID , that.virtualVolumeID )
&& Objects.equals( attributes , that.attributes );
}
@Override
public int hashCode() {
return Objects.hash( volumeID, name, accountID, createTime, status, access, enable512e, iqn, scsiEUIDeviceID, scsiNAADeviceID, qos, volumeAccessGroups, volumePairs, deleteTime, purgeTime, sliceCount, totalSize, blockSize, virtualVolumeID, attributes );
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder();
sb.append( "{ " );
sb.append(" volumeID : ").append(volumeID).append(",");
sb.append(" name : ").append(name).append(",");
sb.append(" accountID : ").append(accountID).append(",");
sb.append(" createTime : ").append(createTime).append(",");
sb.append(" status : ").append(status).append(",");
sb.append(" access : ").append(access).append(",");
sb.append(" enable512e : ").append(enable512e).append(",");
sb.append(" iqn : ").append(iqn).append(",");
sb.append(" scsiEUIDeviceID : ").append(scsiEUIDeviceID).append(",");
sb.append(" scsiNAADeviceID : ").append(scsiNAADeviceID).append(",");
sb.append(" qos : ").append(qos).append(",");
sb.append(" volumeAccessGroups : ").append(Arrays.toString(volumeAccessGroups)).append(",");
sb.append(" volumePairs : ").append(Arrays.toString(volumePairs)).append(",");
if(null != deleteTime && deleteTime.isPresent())
sb.append(" deleteTime : ").append(deleteTime.get()).append(",");
if(null != purgeTime && purgeTime.isPresent())
sb.append(" purgeTime : ").append(purgeTime.get()).append(",");
sb.append(" sliceCount : ").append(sliceCount).append(",");
sb.append(" totalSize : ").append(totalSize).append(",");
sb.append(" blockSize : ").append(blockSize).append(",");
sb.append(" virtualVolumeID : ").append(virtualVolumeID).append(",");
sb.append(" attributes : ").append(attributes);
sb.append( " }" );
if(sb.lastIndexOf(", }") != -1)
sb.deleteCharAt(sb.lastIndexOf(", }"));
return sb.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy