com.xensource.xenapi

Class Feature

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.Feature

public class Feature
extends XenAPIObject

A new piece of functionality First published in XenServer 7.2.

Nested Class Summary

Nested Classes

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

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
boolean	equals(java.lang.Object obj) If obj is a Feature, compares XenAPI references for equality.
static java.util.Set<Feature>	getAll(Connection c) Return a list of all the Features known to the system.
static java.util.Map<Feature,Feature.Record>	getAllRecords(Connection c) Return a map of Feature references to Feature records for all Features known to the system.
static java.util.Set<Feature>	getByNameLabel(Connection c, java.lang.String label) Get all the Feature instances with the given label.
static Feature	getByUuid(Connection c, java.lang.String uuid) Get a reference to the Feature instance with the specified UUID.
java.lang.Boolean	getEnabled(Connection c) Get the enabled field of the given Feature.
java.lang.Boolean	getExperimental(Connection c) Get the experimental field of the given Feature.
Host	getHost(Connection c) Get the host field of the given Feature.
java.lang.String	getNameDescription(Connection c) Get the name/description field of the given Feature.
java.lang.String	getNameLabel(Connection c) Get the name/label field of the given Feature.
Feature.Record	getRecord(Connection c) Get a record containing the current state of the given Feature.
java.lang.String	getUuid(Connection c) Get the uuid field of the given Feature.
java.lang.String	getVersion(Connection c) Get the version field of the given Feature.
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 Feature, 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 Feature.Record getRecord(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given Feature. First published in XenServer 7.2.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

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

Get a reference to the Feature instance with the specified UUID. First published in XenServer 7.2.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByNameLabel

public static java.util.Set<Feature> getByNameLabel(Connection c,
                                    java.lang.String label)
                                             throws Types.BadServerResponse,
                                                    Types.XenAPIException,
                                                    org.apache.xmlrpc.XmlRpcException

Get all the Feature instances with the given label. First published in XenServer 7.2.

Parameters:

label - label of object to return

Returns:

references to objects with matching names

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 Feature. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNameLabel

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

Get the name/label field of the given Feature. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNameDescription

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

Get the name/description field of the given Feature. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getEnabled

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

Get the enabled field of the given Feature. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getExperimental

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

Get the experimental field of the given Feature. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVersion

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

Get the version field of the given Feature. First published in XenServer 7.2.

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 Feature. First published in XenServer 7.2.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

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

Return a list of all the Features known to the system. First published in XenServer 7.2.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

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

Return a map of Feature references to Feature records for all Features known to the system. First published in XenServer 7.2.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException