com.xensource.xenapi
Class VBD.Record

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

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

Represents all the fields in a VBD


Field Summary
 java.util.Set<Types.VbdOperations> allowedOperations
          list of the operations allowed in this state.
 java.lang.Boolean bootable
          true if this VBD is bootable
 java.lang.Boolean currentlyAttached
          is the device currently attached (erased on reboot)
 java.util.Map<java.lang.String,Types.VbdOperations> 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.String device
          device seen by the guest e.g.
 java.lang.Boolean empty
          if true this represents an empty drive
 VBDMetrics metrics
          metrics associated with this VBD
 Types.VbdMode mode
          the mode the VBD should be mounted with
 java.util.Map<java.lang.String,java.lang.String> otherConfig
          additional configuration
 java.util.Map<java.lang.String,java.lang.String> qosAlgorithmParams
          parameters for chosen QoS algorithm
 java.lang.String qosAlgorithmType
          QoS algorithm to use
 java.util.Set<java.lang.String> qosSupportedAlgorithms
          supported QoS algorithms for this VBD
 java.util.Map<java.lang.String,java.lang.String> runtimeProperties
          Device runtime properties
 java.lang.Long statusCode
          error/success code associated with last attach-operation (erased on reboot)
 java.lang.String statusDetail
          error/success information associated with last attach-operation status (erased on reboot)
 java.lang.Boolean storageLock
          true if a storage level lock was acquired
 Types.VbdType type
          how the VBD will appear to the guest (e.g.
 java.lang.Boolean unpluggable
          true if this VBD will support hot-unplug
 java.lang.String userdevice
          user-friendly device name e.g.
 java.lang.String uuid
          Unique identifier/object reference
 VDI VDI
          the virtual disk
 VM VM
          the virtual machine
 
Constructor Summary
VBD.Record()
           
 
Method Summary
 java.util.Map<java.lang.String,java.lang.Object> toMap()
          Convert a VBD.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


allowedOperations

public java.util.Set<Types.VbdOperations> 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.VbdOperations> currentOperations
links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.


VM

public VM VM
the virtual machine


VDI

public VDI VDI
the virtual disk


device

public java.lang.String device
device seen by the guest e.g. hda1


userdevice

public java.lang.String userdevice
user-friendly device name e.g. 0,1,2,etc.


bootable

public java.lang.Boolean bootable
true if this VBD is bootable


mode

public Types.VbdMode mode
the mode the VBD should be mounted with


type

public Types.VbdType type
how the VBD will appear to the guest (e.g. disk or CD)


unpluggable

public java.lang.Boolean unpluggable
true if this VBD will support hot-unplug


storageLock

public java.lang.Boolean storageLock
true if a storage level lock was acquired


empty

public java.lang.Boolean empty
if true this represents an empty drive


otherConfig

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


currentlyAttached

public java.lang.Boolean currentlyAttached
is the device currently attached (erased on reboot)


statusCode

public java.lang.Long statusCode
error/success code associated with last attach-operation (erased on reboot)


statusDetail

public java.lang.String statusDetail
error/success information associated with last attach-operation status (erased on reboot)


runtimeProperties

public java.util.Map<java.lang.String,java.lang.String> runtimeProperties
Device runtime properties


qosAlgorithmType

public java.lang.String qosAlgorithmType
QoS algorithm to use


qosAlgorithmParams

public java.util.Map<java.lang.String,java.lang.String> qosAlgorithmParams
parameters for chosen QoS algorithm


qosSupportedAlgorithms

public java.util.Set<java.lang.String> qosSupportedAlgorithms
supported QoS algorithms for this VBD


metrics

public VBDMetrics metrics
metrics associated with this VBD

Constructor Detail

VBD.Record

public VBD.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 VBD.Record to a Map

Specified by:
toMap in interface Types.Record