Package com.xensource.xenapi
Class Blob
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.Blob
A placeholder for a binary blob
First published in XenServer 5.0.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic Blob
create
(Connection c, String mimeType) Create a placeholder for a binary blob Minimum allowed role: pool-operator First published in XenServer 5.0.static Blob
create
(Connection c, String mimeType, Boolean _public) Create a placeholder for a binary blob Minimum allowed role: pool-operator First published in XenServer 5.0.void
Minimum allowed role: pool-operator First published in XenServer 5.0.boolean
If obj is a Blob, compares XenAPI references for equality.getAll
(Connection c) Return a list of all the blobs known to the system.static Map<Blob,
Blob.Record> Return a map of blob references to blob records for all blobs known to the system.getByNameLabel
(Connection c, String label) Get all the blob instances with the given label.static Blob
getByUuid
(Connection c, String uuid) Get a reference to the blob instance with the specified UUID.Get the last_updated field of the given blob.Get the mime_type field of the given blob.Get the name/description field of the given blob.Get the name/label field of the given blob.Get the public field of the given blob.Get a record containing the current state of the given blob.Get the size field of the given blob.Get the uuid field of the given blob.int
hashCode()
void
setNameDescription
(Connection c, String description) Set the name/description field of the given blob.void
setNameLabel
(Connection c, String label) Set the name/label field of the given blob.void
setPublic
(Connection c, Boolean _public) Set the public field of the given blob.Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a Blob, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public Blob.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a record containing the current state of the given blob. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- all fields from the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getByUuid
public static Blob getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a reference to the blob instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onuuid
- UUID of object to return- Returns:
- reference to the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getByNameLabel
public static Set<Blob> getByNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, IOException Get all the blob instances with the given label. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onlabel
- label of object to return- Returns:
- references to objects with matching names
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the uuid field of the given blob. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNameLabel
public String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the name/label field of the given blob. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNameDescription
public String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the name/description field of the given blob. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSize
public Long getSize(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the size field of the given blob. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPublic
public Boolean getPublic(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the public field of the given blob. Minimum allowed role: read-only First published in XenServer 6.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getLastUpdated
public Date getLastUpdated(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the last_updated field of the given blob. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMimeType
public String getMimeType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the mime_type field of the given blob. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setNameLabel
public void setNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the name/label field of the given blob. Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onlabel
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setNameDescription
public void setNameDescription(Connection c, String description) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the name/description field of the given blob. Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made ondescription
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setPublic
public void setPublic(Connection c, Boolean _public) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the public field of the given blob. Minimum allowed role: pool-operator First published in XenServer 6.1.- Parameters:
c
- The connection the call is made on_public
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
create
public static Blob create(Connection c, String mimeType) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a placeholder for a binary blob Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onmimeType
- The mime-type of the blob. Defaults to 'application/octet-stream' if the empty string is supplied- Returns:
- The reference of the created blob
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
create
public static Blob create(Connection c, String mimeType, Boolean _public) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a placeholder for a binary blob Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onmimeType
- The mime-type of the blob. Defaults to 'application/octet-stream' if the empty string is supplied_public
- True if the blob should be publicly available First published in XenServer 6.1.- Returns:
- The reference of the created blob
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
destroy
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAll
public static Set<Blob> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a list of all the blobs known to the system. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- references to all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllRecords
public static Map<Blob,Blob.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of blob references to blob records for all blobs known to the system. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- records of all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-