com.xensource.xenapi
Class VDI.Record

java.lang.Object
  extended by com.xensource.xenapi.VDI.Record
All Implemented Interfaces:
Types.Record
Enclosing class:
VDI

public static class VDI.Record
extends java.lang.Object
implements Types.Record

Represents all the fields in a VDI


Field Summary
 java.lang.Boolean allowCaching
          true if this VDI is to be cached in the local cache SR First published in XenServer 5.6 FP1.
 java.util.Set<Types.VdiOperations> allowedOperations
          list of the operations allowed in this state.
 java.util.Set<Crashdump> crashDumps
          list of crash dumps that refer to this disk
 java.util.Map<java.lang.String,Types.VdiOperations> currentOperations
          links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
 java.lang.Boolean isASnapshot
          true if this is a snapshot.
 java.lang.String location
          location information First published in XenServer 4.1.
 java.lang.Boolean managed
           
 java.lang.Boolean metadataLatest
          Whether this VDI contains the latest known accessible metadata for the pool First published in XenServer 6.0.
 Pool metadataOfPool
          The pool whose metadata is contained in this VDI First published in XenServer 6.0.
 java.lang.Boolean missing
          true if SR scan operation reported this VDI as not present on disk
 java.lang.String nameDescription
          a notes field containing human-readable description
 java.lang.String nameLabel
          a human-readable name
 Types.OnBoot onBoot
          The behaviour of this VDI on a VM boot First published in XenServer 5.6 FP1.
 java.util.Map<java.lang.String,java.lang.String> otherConfig
          additional configuration
 VDI parent
          References the parent disk, if this VDI is part of a chain
 java.lang.Long physicalUtilisation
          amount of physical space that the disk image is currently taking up on the storage repository (in bytes)
 java.lang.Boolean readOnly
          true if this disk may ONLY be mounted read-only
 java.lang.Boolean sharable
          true if this disk may be shared
 java.util.Map<java.lang.String,java.lang.String> smConfig
          SM dependent data First published in XenServer 4.1.
 VDI snapshotOf
          Ref pointing to the VDI this snapshot is of.
 java.util.Set<VDI> snapshots
          List pointing to all the VDIs snapshots.
 java.util.Date snapshotTime
          Date/time when this snapshot was created.
 SR SR
          storage repository in which the VDI resides
 java.lang.Boolean storageLock
          true if this disk is locked at the storage level
 java.util.Set<java.lang.String> tags
          user-specified tags for categorization purposes First published in XenServer 5.0.
 Types.VdiType type
          type of the VDI
 java.lang.String uuid
          Unique identifier/object reference
 java.util.Set<VBD> VBDs
          list of vbds that refer to this disk
 java.lang.Long virtualSize
          size of disk as presented to the guest (in bytes).
 java.util.Map<java.lang.String,java.lang.String> xenstoreData
          data to be inserted into the xenstore tree (/local/domain/0/backend/vbd///sm-data) after the VDI is attached.
 
Constructor Summary
VDI.Record()
           
 
Method Summary
 java.util.Map<java.lang.String,java.lang.Object> toMap()
          Convert a VDI.Record to a Map
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

uuid

public java.lang.String uuid
Unique identifier/object reference


nameLabel

public java.lang.String nameLabel
a human-readable name


nameDescription

public java.lang.String nameDescription
a notes field containing human-readable description


allowedOperations

public java.util.Set<Types.VdiOperations> allowedOperations
list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.


currentOperations

public java.util.Map<java.lang.String,Types.VdiOperations> currentOperations
links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.


SR

public SR SR
storage repository in which the VDI resides


VBDs

public java.util.Set<VBD> VBDs
list of vbds that refer to this disk


crashDumps

public java.util.Set<Crashdump> crashDumps
list of crash dumps that refer to this disk


virtualSize

public java.lang.Long virtualSize
size of disk as presented to the guest (in bytes). Note that, depending on storage backend type, requested size may not be respected exactly


physicalUtilisation

public java.lang.Long physicalUtilisation
amount of physical space that the disk image is currently taking up on the storage repository (in bytes)


type

public Types.VdiType type
type of the VDI


sharable

public java.lang.Boolean sharable
true if this disk may be shared


readOnly

public java.lang.Boolean readOnly
true if this disk may ONLY be mounted read-only


otherConfig

public java.util.Map<java.lang.String,java.lang.String> otherConfig
additional configuration


storageLock

public java.lang.Boolean storageLock
true if this disk is locked at the storage level


location

public java.lang.String location
location information First published in XenServer 4.1.


managed

public java.lang.Boolean managed

missing

public java.lang.Boolean missing
true if SR scan operation reported this VDI as not present on disk


parent

public VDI parent
References the parent disk, if this VDI is part of a chain


xenstoreData

public java.util.Map<java.lang.String,java.lang.String> xenstoreData
data to be inserted into the xenstore tree (/local/domain/0/backend/vbd///sm-data) after the VDI is attached. This is generally set by the SM backends on vdi_attach. First published in XenServer 4.1.


smConfig

public java.util.Map<java.lang.String,java.lang.String> smConfig
SM dependent data First published in XenServer 4.1.


isASnapshot

public java.lang.Boolean isASnapshot
true if this is a snapshot. First published in XenServer 5.0.


snapshotOf

public VDI snapshotOf
Ref pointing to the VDI this snapshot is of. First published in XenServer 5.0.


snapshots

public java.util.Set<VDI> snapshots
List pointing to all the VDIs snapshots. First published in XenServer 5.0.


snapshotTime

public java.util.Date snapshotTime
Date/time when this snapshot was created. First published in XenServer 5.0.


tags

public java.util.Set<java.lang.String> tags
user-specified tags for categorization purposes First published in XenServer 5.0.


allowCaching

public java.lang.Boolean allowCaching
true if this VDI is to be cached in the local cache SR First published in XenServer 5.6 FP1.


onBoot

public Types.OnBoot onBoot
The behaviour of this VDI on a VM boot First published in XenServer 5.6 FP1.


metadataOfPool

public Pool metadataOfPool
The pool whose metadata is contained in this VDI First published in XenServer 6.0.


metadataLatest

public java.lang.Boolean metadataLatest
Whether this VDI contains the latest known accessible metadata for the pool First published in XenServer 6.0.

Constructor Detail

VDI.Record

public VDI.Record()
Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()
Convert a VDI.Record to a Map

Specified by:
toMap in interface Types.Record