/*
* Copyright (c) 2008-2013 EMC Corporation
* All Rights Reserved
*/
package com.emc.storageos.model.block;
import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlRootElement;
import org.codehaus.jackson.annotate.JsonProperty;
import com.emc.storageos.model.RelatedResourceRep;
import com.emc.storageos.model.VirtualArrayRelatedResourceRep;
@XmlAccessorType(XmlAccessType.PROPERTY)
@XmlRootElement(name = "volume")
public class VolumeRestRep extends BlockObjectRestRep {
private RelatedResourceRep project;
private RelatedResourceRep tenant;
private String provisionedCapacity;
private String allocatedCapacity;
private String capacity;
private String preAllocationSize;
private boolean isComposite;
private RelatedResourceRep vpool;
private Boolean thinlyProvisioned;
private RelatedResourceRep autoTierPolicyUri;
private List<RelatedResourceRep> haVolumes;
private ProtectionRestRep protection;
private String accessState;
private String linkStatus;
private Boolean hasXIO3XVolumes;
private RelatedResourceRep pool;
private List<RelatedResourceRep> volumeGroups;
private Boolean supportsSnapshotSessions;
private String systemType;
// Compression ratio of the volume if it is compressed
private String compressionRatio;
// Fields in a Volume that are specific to RecoverPoint
public static class RecoverPointRestRep {
private List<VirtualArrayRelatedResourceRep> rpTargets;
private RelatedResourceRep protectionSet;
private RelatedResourceRep protectionSystem;
private String internalSiteName;
private String copyName;
private String rsetName;
private String personality;
/**
* This volume's RecoverPoint (RP) target copies
*
*/
@XmlElementWrapper(name = "targets")
/**
* A RecoverPoint (RP) target copy
*
*/
@XmlElement(name = "target")
public List<VirtualArrayRelatedResourceRep> getRpTargets() {
if (rpTargets == null) {
rpTargets = new ArrayList<VirtualArrayRelatedResourceRep>();
}
return rpTargets;
}
public void setRpTargets(List<VirtualArrayRelatedResourceRep> rpTargets) {
this.rpTargets = rpTargets;
}
/**
* This volume's RecoverPoint (RP) consistency group
*
*/
@XmlElement(name = "protection_set")
public RelatedResourceRep getProtectionSet() {
return protectionSet;
}
public void setProtectionSet(RelatedResourceRep protectionSet) {
this.protectionSet = protectionSet;
}
/**
* This volume's RecoverPoint appliance (RPA)
*
*/
@XmlElement(name = "protection_system")
public RelatedResourceRep getProtectionSystem() {
return protectionSystem;
}
public void setProtectionSystem(RelatedResourceRep protectionSystem) {
this.protectionSystem = protectionSystem;
}
/**
* A label that can be used to denote the physical location of the volume
*
*/
@XmlElement(name = "site_name")
public String getInternalSiteName() {
return internalSiteName;
}
public void setInternalSiteName(String internalSiteName) {
this.internalSiteName = internalSiteName;
}
/**
* The volume's RecoverPoint (RP) copy name. In this context, a
* production volume is a copy that is used as a source for
* replication.
*
*/
@XmlElement(name = "copy_name")
public String getCopyName() {
return copyName;
}
public void setCopyName(String copyName) {
this.copyName = copyName;
}
/**
* The name of this volume's RecoverPoint (RP) replication set. A
* replication set consists of a production volume and that volume's
* target copies.
*
*/
@XmlElement(name = "replicationset_name")
public String getRsetName() {
return rsetName;
}
public void setRsetName(String rsetName) {
this.rsetName = rsetName;
}
/**
* How this volume is used with respect to replication
* Valid values:
* SOURCE = A production volume
* TARGET = A copy of a production volume
* METADATA = A volume that stores meta-data for replication. Example: A RecoverPoint journal volume
*/
@XmlElement(name = "personality")
public String getPersonality() {
return personality;
}
public void setPersonality(String personality) {
this.personality = personality;
}
}
// Fields in a volume that are specific to native mirrors
public static class MirrorRestRep {
private List<VirtualArrayRelatedResourceRep> mirrors;
@XmlElementWrapper(name = "native_mirrors")
/**
* List of mirrors - VMAX BCVs or VNX SnapView Clones.
*/
@XmlElement(name = "native_mirror")
public List<VirtualArrayRelatedResourceRep> getMirrors() {
if (mirrors == null) {
mirrors = new ArrayList<VirtualArrayRelatedResourceRep>();
}
return mirrors;
}
public void setMirrors(List<VirtualArrayRelatedResourceRep> mirrors) {
this.mirrors = mirrors;
}
}
// Fields in a volume that are specific to full copies of another volume
public static class FullCopyRestRep {
private RelatedResourceRep associatedSourceVolume;
private List<VirtualArrayRelatedResourceRep> fullCopyVolumes;
private Boolean isSyncActive;
private Integer percentSynced;
private String replicaState;
private String fullCopySetName;
@XmlElement(name = "associated_source_volume")
public RelatedResourceRep getAssociatedSourceVolume() {
return associatedSourceVolume;
}
public void setAssociatedSourceVolume(RelatedResourceRep associatedSourceVolume) {
this.associatedSourceVolume = associatedSourceVolume;
}
@XmlElementWrapper(name = "volumes")
@XmlElement(name = "volume")
public List<VirtualArrayRelatedResourceRep> getFullCopyVolumes() {
if (fullCopyVolumes == null) {
fullCopyVolumes = new ArrayList<VirtualArrayRelatedResourceRep>();
}
return fullCopyVolumes;
}
public void setFullCopyVolumes(List<VirtualArrayRelatedResourceRep> fullCopyVolumes) {
this.fullCopyVolumes = fullCopyVolumes;
}
@XmlElement(name = "is_sync_active")
public Boolean getSyncActive() {
return isSyncActive;
}
public void setSyncActive(Boolean syncActive) {
isSyncActive = syncActive;
}
@XmlElement(name = "percent_synced")
public Integer getPercentSynced() {
return percentSynced;
}
public void setPercentSynced(Integer percentSynced) {
this.percentSynced = percentSynced;
}
@XmlElement(name = "replicaState")
public String getReplicaState() {
return replicaState;
}
public void setReplicaState(String state) {
replicaState = state;
}
/**
* the name to identify full copies created as a Set
*
* @return the full copy set name
*/
@XmlElement(name = "full_copy_set_name")
public String getFullCopySetName() {
return fullCopySetName;
}
public void setFullCopySetName(String setName) {
fullCopySetName = setName;
}
}
// Fields in a volume that are specific to SRDF Copies
public static class SRDFRestRep {
private RelatedResourceRep associatedSourceVolume;
private List<VirtualArrayRelatedResourceRep> targetVolumes;
private String personality;
private URI srdfGroup;
private String srdfCopyMode;
@XmlElement(name = "associated_source_volume")
public RelatedResourceRep getAssociatedSourceVolume() {
return associatedSourceVolume;
}
public void setAssociatedSourceVolume(RelatedResourceRep associatedSourceVolume) {
this.associatedSourceVolume = associatedSourceVolume;
}
@XmlElementWrapper(name = "volumes")
@XmlElement(name = "volume")
public List<VirtualArrayRelatedResourceRep> getSRDFTargetVolumes() {
if (targetVolumes == null) {
targetVolumes = new ArrayList<VirtualArrayRelatedResourceRep>();
}
return targetVolumes;
}
public void setSRDFTargetVolumes(List<VirtualArrayRelatedResourceRep> targetVolumes) {
this.targetVolumes = targetVolumes;
}
/**
* How this volume is used with respect to replication
* Valid values:
* SOURCE = A production volume
* TARGET = A copy of a production volume
* METADATA = A volume that stores meta-data for replication. Example = Recoverpoint journal volume
*/
@XmlElement(name = "personality")
public String getPersonality() {
return personality;
}
public void setPersonality(String personality) {
this.personality = personality;
}
@XmlElement(name = "srdf_group_uri")
public URI getSrdfGroup() {
return srdfGroup;
}
public void setSrdfGroup(URI srdfGroup) {
this.srdfGroup = srdfGroup;
}
@XmlElement(name = "srdf_copy_mode")
public String getSrdfCopyMode() {
return srdfCopyMode;
}
public void setSrdfCopyMode(String srdfCopyMode) {
this.srdfCopyMode = srdfCopyMode;
}
}
// Fields specific to protection characteristics of the Volume
public static class ProtectionRestRep {
private MirrorRestRep mirrorRep;
private RecoverPointRestRep rpRep;
private FullCopyRestRep fullCopyRep;
private SRDFRestRep srdfRep;
/**
* Information related to native mirroring
*
*/
@XmlElement(name = "mirrors")
public MirrorRestRep getMirrorRep() {
return mirrorRep;
}
public void setMirrorRep(MirrorRestRep mirrorRep) {
this.mirrorRep = mirrorRep;
}
/**
* Information related to RecoverPoint (RP) replication
*
*/
@XmlElement(name = "recoverpoint")
public RecoverPointRestRep getRpRep() {
return rpRep;
}
public void setRpRep(RecoverPointRestRep rpRep) {
this.rpRep = rpRep;
}
/**
* Information related to clone replication
*
*/
@XmlElement(name = "full_copies")
public FullCopyRestRep getFullCopyRep() {
return fullCopyRep;
}
public void setFullCopyRep(FullCopyRestRep fullCopyRestRep) {
this.fullCopyRep = fullCopyRestRep;
}
/**
* Information related to SRDF replication
*
*/
@XmlElement(name = "srdf")
public SRDFRestRep getSrdfRep() {
return srdfRep;
}
public void setSrdfRep(SRDFRestRep srdfRep) {
this.srdfRep = srdfRep;
}
}
/**
* The total amount of space allocated from the volume's storage pool (GB)
*
*/
@XmlElement(name = "allocated_capacity_gb")
public String getAllocatedCapacity() {
return allocatedCapacity;
}
public void setAllocatedCapacity(String allocatedCapacity) {
this.allocatedCapacity = allocatedCapacity;
}
/**
* The amount of space that was initially allocated when the volume was created (GB)
*
*/
@XmlElement(name = "pre_allocation_size_gb")
public String getPreAllocationSize() {
return preAllocationSize;
}
public void setPreAllocationSize(String preAllocationSize) {
this.preAllocationSize = preAllocationSize;
}
/**
* The policy used to distribute data across the disks of
* the volume's storage pool
*
*/
@XmlElement(name = "auto_tier_policy")
public RelatedResourceRep getAutoTierPolicyUri() {
return autoTierPolicyUri;
}
public void setAutoTierPolicyUri(RelatedResourceRep autoTierPolicy) {
this.autoTierPolicyUri = autoTierPolicy;
}
/**
* This volume's total capacity in Gb (Gigabytes).
*
*/
@XmlElement(name = "requested_capacity_gb")
public String getCapacity() {
return capacity;
}
public void setCapacity(String capacity) {
this.capacity = capacity;
}
/**
* This volume's virtual pool
*
*/
@XmlElement(name = "vpool")
@JsonProperty("vpool")
public RelatedResourceRep getVirtualPool() {
return vpool;
}
public void setVirtualPool(RelatedResourceRep vpool) {
this.vpool = vpool;
}
/**
* Specifies whether this is a composite (meta) volume.
*
*/
@XmlElement(name = "is_composite")
public Boolean getIsComposite() {
return isComposite;
}
public void setIsComposite(Boolean isComposite) {
this.isComposite = isComposite;
}
/**
* This volume's project
*
*/
@XmlElement
public RelatedResourceRep getProject() {
return project;
}
public void setProject(RelatedResourceRep project) {
this.project = project;
}
/**
* This volume's logical capacity in Gb (Gigabytes).
*
*/
@XmlElement(name = "provisioned_capacity_gb")
public String getProvisionedCapacity() {
return provisionedCapacity;
}
public void setProvisionedCapacity(String provisionedCapacity) {
this.provisionedCapacity = provisionedCapacity;
}
/**
* This volume's tenant
*
*/
@XmlElement
public RelatedResourceRep getTenant() {
return tenant;
}
public void setTenant(RelatedResourceRep tenant) {
this.tenant = tenant;
}
/**
* Whether or not this volume is thinly provisioned. A thin
* volume initially allocates a portion of its assigned
* capacity when it is created and then grows as needed.
*
*/
@XmlElement(name = "thinly_provisioned")
public Boolean getThinlyProvisioned() {
return thinlyProvisioned;
}
public void setThinlyProvisioned(Boolean thinlyProvisioned) {
this.thinlyProvisioned = thinlyProvisioned;
}
@XmlElementWrapper(name = "high_availability_backing_volumes")
/**
* List of volumes acting as backing volumes in case of fail-over.
*/
@XmlElement(name = "high_availability_backing_volume")
public List<RelatedResourceRep> getHaVolumes() {
if (haVolumes == null) {
haVolumes = new ArrayList<RelatedResourceRep>();
}
return haVolumes;
}
public void setHaVolumes(List<RelatedResourceRep> haVolumes) {
this.haVolumes = haVolumes;
}
/**
* Information on how this volume is protected
*
*/
public ProtectionRestRep getProtection() {
return protection;
}
public void setProtection(ProtectionRestRep protection) {
this.protection = protection;
}
/**
* The volume's access state
*
*/
@XmlElement(name = "access_state")
public String getAccessState() {
return accessState;
}
public void setAccessState(String accessState) {
this.accessState = accessState;
}
/**
* The volume's link status
*
*/
@XmlElement(name = "link_status")
public String getLinkStatus() {
return linkStatus;
}
public void setLinkStatus(String linkStatus) {
this.linkStatus = linkStatus;
}
/**
* Specifies whether this is Xtremio 3.x volume or not.
*
* @return
*/
@XmlElement(name = "has_xio_3x_backend_volumes")
public Boolean getHasXIO3XVolumes() {
return hasXIO3XVolumes;
}
public void setHasXIO3XVolumes(Boolean hasXIO3XVolumes) {
this.hasXIO3XVolumes = hasXIO3XVolumes;
}
/**
* URI for the storage pool containing storage allocated for the volume.
*
*/
@XmlElement(name = "storage_pool")
public RelatedResourceRep getPool() {
return pool;
}
public void setPool(RelatedResourceRep pool) {
this.pool = pool;
}
@XmlElementWrapper(name = "volume_groups")
/**
* List of applications that the volume assigned to.
* @valid none
*/
@XmlElement(name = "volume_group")
public List<RelatedResourceRep> getVolumeGroups() {
if (volumeGroups == null) {
volumeGroups = new ArrayList<RelatedResourceRep>();
}
return volumeGroups;
}
public void setVolumeGroups(List<RelatedResourceRep> volumeGroups) {
this.volumeGroups = volumeGroups;
}
/**
* Specifies whether this is volume supports Snapshot Sessions.
*
* @return true if volume supports Snapshot Sessions, false otherwise
*/
@XmlElement(name = "supports_snapshot_sessions")
public Boolean getSupportsSnapshotSessions() {
return supportsSnapshotSessions;
}
public void setSupportsSnapshotSessions(Boolean supportsSnapshotSessions) {
this.supportsSnapshotSessions = supportsSnapshotSessions;
}
/**
* Storage system's type
*
* @return the systemType
*/
@XmlElement(name = "system_type")
public String getSystemType() {
return systemType;
}
/**
* @param systemType the systemType to set
*/
public void setSystemType(String systemType) {
this.systemType = systemType;
}
@XmlElement(name = "compression_ratio")
public String getCompressionRatio() {
return compressionRatio;
}
public void setCompressionRatio(String compressionRatio) {
this.compressionRatio = compressionRatio;
}
}