Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.xensource.xenapi
Class VBD.Record

    java.lang.Object
      com.xensource.xenapi.VBD.Record

All Implemented Interfaces:
  Types.Record

Enclosing class:
  VBD

    public static class VBD.Record

extends Object
implements Types.Record

Represents all the fields in a VBD

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

Constructor Summary
`VBD.Record()`

Method Summary
`Map<String,Object>` | `toMap()` Convert a VBD.Record to a Map
`String` | `toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### uuid

    public String uuid

  Unique identifier/object reference

### allowedOperations

    public 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 Map<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 String device

  device seen by the guest e.g. hda1

### userdevice

    public String userdevice

  user-friendly device name e.g. 0,1,2,etc.

### bootable

    public 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 Boolean unpluggable

  true if this VBD will support hot-unplug

### storageLock

    public Boolean storageLock

  true if a storage level lock was acquired

### empty

    public Boolean empty

  if true this represents an empty drive

### otherConfig

    public Map<String,String> otherConfig

  additional configuration

### currentlyAttached

    public Boolean currentlyAttached

  is the device currently attached (erased on reboot)

### statusCode

    public Long statusCode

  error/success code associated with last attach-operation (erased on reboot)

### statusDetail

    public String statusDetail

  error/success information associated with last attach-operation status (erased on reboot)

### runtimeProperties

    public Map<String,String> runtimeProperties

  Device runtime properties

### qosAlgorithmType

    public String qosAlgorithmType

  QoS algorithm to use

### qosAlgorithmParams

    public Map<String,String> qosAlgorithmParams

  parameters for chosen QoS algorithm

### qosSupportedAlgorithms

    public Set<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 String toString()

  Overrides:
    `toString` in class `Object`

### toMap

    public Map<String,Object> toMap()

  Convert a VBD.Record to a Map

  Specified by:
    `toMap` in interface `Types.Record`

Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD