com.xensource.xenapi

Class USBGroup

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.USBGroup

public class USBGroup
extends XenAPIObject

A group of compatible USBs across the resource pool First published in XenServer 7.3.

Nested Class Summary

Nested Classes

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

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
void	addToOtherConfig(Connection c, java.lang.String key, java.lang.String value) Add the given key-value pair to the other_config field of the given USB_group.
static USBGroup	create(Connection c, java.lang.String nameLabel, java.lang.String nameDescription, java.util.Map<java.lang.String,java.lang.String> otherConfig) First published in XenServer 7.3.
static Task	createAsync(Connection c, java.lang.String nameLabel, java.lang.String nameDescription, java.util.Map<java.lang.String,java.lang.String> otherConfig) First published in XenServer 7.3.
void	destroy(Connection c) First published in XenServer 7.3.
Task	destroyAsync(Connection c) First published in XenServer 7.3.
boolean	equals(java.lang.Object obj) If obj is a USBGroup, compares XenAPI references for equality.
static java.util.Set<USBGroup>	getAll(Connection c) Return a list of all the USB_groups known to the system.
static java.util.Map<USBGroup,USBGroup.Record>	getAllRecords(Connection c) Return a map of USB_group references to USB_group records for all USB_groups known to the system.
static java.util.Set<USBGroup>	getByNameLabel(Connection c, java.lang.String label) Get all the USB_group instances with the given label.
static USBGroup	getByUuid(Connection c, java.lang.String uuid) Get a reference to the USB_group instance with the specified UUID.
java.lang.String	getNameDescription(Connection c) Get the name/description field of the given USB_group.
java.lang.String	getNameLabel(Connection c) Get the name/label field of the given USB_group.
java.util.Map<java.lang.String,java.lang.String>	getOtherConfig(Connection c) Get the other_config field of the given USB_group.
java.util.Set<PUSB>	getPUSBs(Connection c) Get the PUSBs field of the given USB_group.
USBGroup.Record	getRecord(Connection c) Get a record containing the current state of the given USB_group.
java.lang.String	getUuid(Connection c) Get the uuid field of the given USB_group.
java.util.Set<VUSB>	getVUSBs(Connection c) Get the VUSBs field of the given USB_group.
int	hashCode()
void	removeFromOtherConfig(Connection c, java.lang.String key) Remove the given key and its corresponding value from the other_config field of the given USB_group.
void	setNameDescription(Connection c, java.lang.String description) Set the name/description field of the given USB_group.
void	setNameLabel(Connection c, java.lang.String label) Set the name/label field of the given USB_group.
void	setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) Set the other_config field of the given USB_group.
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 USBGroup, 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 USBGroup.Record getRecord(Connection c)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given USB_group. First published in XenServer 7.3.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

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

Get a reference to the USB_group instance with the specified UUID. First published in XenServer 7.3.

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<USBGroup> getByNameLabel(Connection c,
                                     java.lang.String label)
                                              throws Types.BadServerResponse,
                                                     Types.XenAPIException,
                                                     org.apache.xmlrpc.XmlRpcException

Get all the USB_group instances with the given label. First published in XenServer 7.3.

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 USB_group. First published in XenServer 7.3.

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 USB_group. First published in XenServer 7.3.

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 USB_group. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPUSBs

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

Get the PUSBs field of the given USB_group. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVUSBs

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

Get the VUSBs field of the given USB_group. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getOtherConfig

public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c)
                                                                throws Types.BadServerResponse,
                                                                       Types.XenAPIException,
                                                                       org.apache.xmlrpc.XmlRpcException

Get the other_config field of the given USB_group. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameLabel

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

Set the name/label field of the given USB_group. First published in XenServer 7.3.

Parameters:

label - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setNameDescription

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

Set the name/description field of the given USB_group. First published in XenServer 7.3.

Parameters:

description - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setOtherConfig

public void setOtherConfig(Connection c,
                  java.util.Map<java.lang.String,java.lang.String> otherConfig)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Set the other_config field of the given USB_group. First published in XenServer 7.3.

Parameters:

otherConfig - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addToOtherConfig

public void addToOtherConfig(Connection c,
                    java.lang.String key,
                    java.lang.String value)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Add the given key-value pair to the other_config field of the given USB_group. First published in XenServer 7.3.

Parameters:

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeFromOtherConfig

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

Remove the given key and its corresponding value from the other_config field of the given USB_group. If the key is not in that Map, then do nothing. First published in XenServer 7.3.

Parameters:

key - Key to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               java.lang.String nameLabel,
               java.lang.String nameDescription,
               java.util.Map<java.lang.String,java.lang.String> otherConfig)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

First published in XenServer 7.3.

Parameters:

nameLabel -

nameDescription -

otherConfig -

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static USBGroup create(Connection c,
              java.lang.String nameLabel,
              java.lang.String nameDescription,
              java.util.Map<java.lang.String,java.lang.String> otherConfig)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException

First published in XenServer 7.3.

Parameters:

nameLabel -

nameDescription -

otherConfig -

Returns:

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroyAsync

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

First published in XenServer 7.3.

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

First published in XenServer 7.3.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

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

Return a list of all the USB_groups known to the system. First published in XenServer 7.3.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

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

Return a map of USB_group references to USB_group records for all USB_groups known to the system. First published in XenServer 7.3.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException