com.xensource.xenapi

Class PVSCacheStorage

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.PVSCacheStorage

public class PVSCacheStorage
extends XenAPIObject

Describes the storage that is available to a PVS site for caching purposes First published in XenServer 7.1.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PVSCacheStorage.Record Represents all the fields in a PVSCacheStorage

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	ref The XenAPI reference (OpaqueRef) to this object.

Method Summary

Methods

Modifier and Type	Method and Description
static PVSCacheStorage	create(Connection c, PVSCacheStorage.Record record) Create a new PVS_cache_storage instance, and return its handle.
static Task	createAsync(Connection c, PVSCacheStorage.Record record) Create a new PVS_cache_storage instance, and return its handle.
void	destroy(Connection c) Destroy the specified PVS_cache_storage instance.
Task	destroyAsync(Connection c) Destroy the specified PVS_cache_storage instance.
boolean	equals(java.lang.Object obj) If obj is a PVSCacheStorage, compares XenAPI references for equality.
static java.util.Set<PVSCacheStorage>	getAll(Connection c) Return a list of all the PVS_cache_storages known to the system.
static java.util.Map<PVSCacheStorage,PVSCacheStorage.Record>	getAllRecords(Connection c) Return a map of PVS_cache_storage references to PVS_cache_storage records for all PVS_cache_storages known to the system.
static PVSCacheStorage	getByUuid(Connection c, java.lang.String uuid) Get a reference to the PVS_cache_storage instance with the specified UUID.
Host	getHost(Connection c) Get the host field of the given PVS_cache_storage.
PVSCacheStorage.Record	getRecord(Connection c) Get a record containing the current state of the given PVS_cache_storage.
PVSSite	getSite(Connection c) Get the site field of the given PVS_cache_storage.
java.lang.Long	getSize(Connection c) Get the size field of the given PVS_cache_storage.
SR	getSR(Connection c) Get the SR field of the given PVS_cache_storage.
java.lang.String	getUuid(Connection c) Get the uuid field of the given PVS_cache_storage.
VDI	getVDI(Connection c) Get the VDI field of the given PVS_cache_storage.
int	hashCode()
java.lang.String	toWireString()

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ref

protected final java.lang.String ref

The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString

public java.lang.String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(java.lang.Object obj)

If obj is a PVSCacheStorage, compares XenAPI references for equality.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRecord

public PVSCacheStorage.Record getRecord(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given PVS_cache_storage. First published in XenServer 7.1.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

public static PVSCacheStorage getByUuid(Connection c,
                        java.lang.String uuid)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Get a reference to the PVS_cache_storage instance with the specified UUID. First published in XenServer 7.1.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               PVSCacheStorage.Record record)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Create a new PVS_cache_storage instance, and return its handle. First published in XenServer 7.1.

Parameters:

record - All constructor arguments

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static PVSCacheStorage create(Connection c,
                     PVSCacheStorage.Record record)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Create a new PVS_cache_storage instance, and return its handle. First published in XenServer 7.1.

Parameters:

record - All constructor arguments

Returns:

reference to the newly created object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Destroy the specified PVS_cache_storage instance. First published in XenServer 7.1.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Destroy the specified PVS_cache_storage instance. First published in XenServer 7.1.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getUuid

public java.lang.String getUuid(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get the uuid field of the given PVS_cache_storage. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getHost

public Host getHost(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Get the host field of the given PVS_cache_storage. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSR

public SR getSR(Connection c)
         throws Types.BadServerResponse,
                Types.XenAPIException,
                org.apache.xmlrpc.XmlRpcException

Get the SR field of the given PVS_cache_storage. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSite

public PVSSite getSite(Connection c)
                throws Types.BadServerResponse,
                       Types.XenAPIException,
                       org.apache.xmlrpc.XmlRpcException

Get the site field of the given PVS_cache_storage. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSize

public java.lang.Long getSize(Connection c)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

Get the size field of the given PVS_cache_storage. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVDI

public VDI getVDI(Connection c)
           throws Types.BadServerResponse,
                  Types.XenAPIException,
                  org.apache.xmlrpc.XmlRpcException

Get the VDI field of the given PVS_cache_storage. First published in XenServer 7.1.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.Set<PVSCacheStorage> getAll(Connection c)
                                             throws Types.BadServerResponse,
                                                    Types.XenAPIException,
                                                    org.apache.xmlrpc.XmlRpcException

Return a list of all the PVS_cache_storages known to the system. First published in XenServer 7.1.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.Map<PVSCacheStorage,PVSCacheStorage.Record> getAllRecords(Connection c)
                                                                           throws Types.BadServerResponse,
                                                                                  Types.XenAPIException,
                                                                                  org.apache.xmlrpc.XmlRpcException

Return a map of PVS_cache_storage references to PVS_cache_storage records for all PVS_cache_storages known to the system. First published in XenServer 7.1.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException