com.xensource.xenapi
public class VMSS extends XenAPIObject
Modifier and Type | Class and Description |
---|---|
static class |
VMSS.Record
Represents all the fields in a VMSS
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
ref
The XenAPI reference (OpaqueRef) to this object.
|
Modifier and Type | Method and Description |
---|---|
void |
addToSchedule(Connection c,
java.lang.String key,
java.lang.String value)
First published in .
|
static VMSS |
create(Connection c,
VMSS.Record record)
Create a new VMSS instance, and return its handle.
|
static Task |
createAsync(Connection c,
VMSS.Record record)
Create a new VMSS instance, and return its handle.
|
void |
destroy(Connection c)
Destroy the specified VMSS instance.
|
Task |
destroyAsync(Connection c)
Destroy the specified VMSS instance.
|
boolean |
equals(java.lang.Object obj)
If obj is a VMSS, compares XenAPI references for equality.
|
static java.util.Set<VMSS> |
getAll(Connection c)
Return a list of all the VMSSs known to the system.
|
static java.util.Map<VMSS,VMSS.Record> |
getAllRecords(Connection c)
Return a map of VMSS references to VMSS records for all VMSSs known to the system.
|
static java.util.Set<VMSS> |
getByNameLabel(Connection c,
java.lang.String label)
Get all the VMSS instances with the given label.
|
static VMSS |
getByUuid(Connection c,
java.lang.String uuid)
Get a reference to the VMSS instance with the specified UUID.
|
java.lang.Boolean |
getEnabled(Connection c)
Get the enabled field of the given VMSS.
|
Types.VmssFrequency |
getFrequency(Connection c)
Get the frequency field of the given VMSS.
|
java.util.Date |
getLastRunTime(Connection c)
Get the last_run_time field of the given VMSS.
|
java.lang.String |
getNameDescription(Connection c)
Get the name/description field of the given VMSS.
|
java.lang.String |
getNameLabel(Connection c)
Get the name/label field of the given VMSS.
|
VMSS.Record |
getRecord(Connection c)
Get a record containing the current state of the given VMSS.
|
java.lang.Long |
getRetainedSnapshots(Connection c)
Get the retained_snapshots field of the given VMSS.
|
java.util.Map<java.lang.String,java.lang.String> |
getSchedule(Connection c)
Get the schedule field of the given VMSS.
|
Types.VmssType |
getType(Connection c)
Get the type field of the given VMSS.
|
java.lang.String |
getUuid(Connection c)
Get the uuid field of the given VMSS.
|
java.util.Set<VM> |
getVMs(Connection c)
Get the VMs field of the given VMSS.
|
int |
hashCode() |
void |
removeFromSchedule(Connection c,
java.lang.String key)
First published in .
|
void |
setEnabled(Connection c,
java.lang.Boolean enabled)
Set the enabled field of the given VMSS.
|
void |
setFrequency(Connection c,
Types.VmssFrequency value)
Set the value of the frequency field
First published in .
|
void |
setLastRunTime(Connection c,
java.util.Date value)
First published in .
|
void |
setNameDescription(Connection c,
java.lang.String description)
Set the name/description field of the given VMSS.
|
void |
setNameLabel(Connection c,
java.lang.String label)
Set the name/label field of the given VMSS.
|
void |
setRetainedSnapshots(Connection c,
java.lang.Long value)
First published in .
|
void |
setSchedule(Connection c,
java.util.Map<java.lang.String,java.lang.String> value)
First published in .
|
void |
setType(Connection c,
Types.VmssType value)
First published in .
|
java.lang.String |
snapshotNow(Connection c)
This call executes the snapshot schedule immediately
First published in .
|
java.lang.String |
toWireString() |
isNull
protected final java.lang.String ref
public java.lang.String toWireString()
toWireString
in class XenAPIObject
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public VMSS.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static VMSS getByUuid(Connection c, java.lang.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, VMSS.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor argumentsTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static VMSS create(Connection c, VMSS.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 static java.util.Set<VMSS> getByNameLabel(Connection c, java.lang.String label) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
label
- label of object to returnTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.Boolean getEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Types.VmssType getType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.Long getRetainedSnapshots(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Types.VmssFrequency getFrequency(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Map<java.lang.String,java.lang.String> getSchedule(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Date getLastRunTime(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Set<VM> getVMs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setNameLabel(Connection c, java.lang.String label) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
label
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setNameDescription(Connection c, java.lang.String description) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
description
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setEnabled(Connection c, java.lang.Boolean enabled) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
enabled
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String snapshotNow(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setRetainedSnapshots(Connection c, java.lang.Long value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setFrequency(Connection c, Types.VmssFrequency value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the snapshot schedule frequencyTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setSchedule(Connection c, java.util.Map<java.lang.String,java.lang.String> value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToSchedule(Connection c, java.lang.String key, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- the key to addvalue
- the value to addTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromSchedule(Connection c, java.lang.String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- the key to removeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setLastRunTime(Connection c, java.util.Date value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setType(Connection c, Types.VmssType value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the snapshot schedule typeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static java.util.Set<VMSS> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static java.util.Map<VMSS,VMSS.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException