public class Console extends XenAPIObject
Modifier and Type | Class and Description |
---|---|
static class |
Console.Record
Represents all the fields in a Console
|
Modifier and Type | Field and Description |
---|---|
protected String |
ref
The XenAPI reference to this object.
|
Modifier and Type | Method and Description |
---|---|
void |
addToOtherConfig(Connection c,
String key,
String value)
Add the given key-value pair to the other_config field of the given console.
|
static Console |
create(Connection c,
Console.Record record)
Create a new console instance, and return its handle.
|
static Task |
createAsync(Connection c,
Console.Record record)
Create a new console instance, and return its handle.
|
void |
destroy(Connection c)
Destroy the specified console instance.
|
Task |
destroyAsync(Connection c)
Destroy the specified console instance.
|
boolean |
equals(Object obj)
If obj is a Console, compares XenAPI references for equality.
|
static Set<Console> |
getAll(Connection c)
Return a list of all the consoles known to the system.
|
static Map<Console,Console.Record> |
getAllRecords(Connection c)
Return a map of console references to console records for all consoles known to the system.
|
static Console |
getByUuid(Connection c,
String uuid)
Get a reference to the console instance with the specified UUID.
|
String |
getLocation(Connection c)
Get the location field of the given console.
|
Map<String,String> |
getOtherConfig(Connection c)
Get the other_config field of the given console.
|
Types.ConsoleProtocol |
getProtocol(Connection c)
Get the protocol field of the given console.
|
Console.Record |
getRecord(Connection c)
Get a record containing the current state of the given console.
|
String |
getUuid(Connection c)
Get the uuid field of the given console.
|
VM |
getVM(Connection c)
Get the VM field of the given console.
|
int |
hashCode() |
void |
removeFromOtherConfig(Connection c,
String key)
Remove the given key and its corresponding value from the other_config field of the given console.
|
void |
setOtherConfig(Connection c,
Map<String,String> otherConfig)
Set the other_config field of the given console.
|
String |
toWireString() |
protected final String ref
public String toWireString()
toWireString
in class XenAPIObject
public boolean equals(Object obj)
public Console.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Console getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
uuid
- UUID of object to returnTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Task createAsync(Connection c, Console.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor argumentsTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Console create(Connection c, Console.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor argumentsTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Types.ConsoleProtocol getProtocol(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public String getLocation(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public VM getVM(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setOtherConfig(Connection c, Map<String,String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
otherConfig
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToOtherConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to addvalue
- Value to addTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromOtherConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to removeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Set<Console> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Map<Console,Console.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException