Class: blob
A placeholder for a binary blob
| Published in: | XenServer 5.0 (orlando) | A placeholder for a binary blob |
Fields
datetime
last_updated
[RO/constructor]
Time at which the data in the blob was last updated
| Published in: | XenServer 4.0 (rio) | Time at which the data in the blob was last updated |
string
mime_type
[RO/constructor]
The mime type associated with this object. Defaults to 'application/octet-stream' if the empty string is supplied
| Published in: | XenServer 4.0 (rio) | The mime type associated with this object. Defaults to 'application/octet-stream' if the empty string is supplied |
string
name_description
[RW]
a notes field containing human-readable description
| Default value: | "" | |
| Published in: | XenServer 4.0 (rio) | |
string
name_label
[RW]
a human-readable name
| Default value: | "" | |
| Published in: | XenServer 4.0 (rio) | |
bool
public
[RW]
True if the blob is publicly accessible
| Default value: | false | |
| Published in: | XenServer 6.1 (tampa) | True if the blob is publicly accessible |
int
size
[RO/runtime]
Size of the binary data, in bytes
| Published in: | XenServer 4.0 (rio) | Size of the binary data, in bytes |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
Messages
blob ref
create
(session ref, string, bool)
Create a placeholder for a binary blob
| Parameters: | session ref session_id | Reference to a valid session |
| string mime_type | The mime-type of the blob. Defaults to 'application/octet-stream' if the empty string is supplied | |
| bool public | True if the blob should be publicly available | |
| Minimum role: | pool-operator | |
| Result: | The reference of the created blob | |
| Published in: | XenServer 5.0 (orlando) | Create a placeholder for a binary blob |
void
destroy
(session ref, blob ref)
| Parameters: | session ref session_id | Reference to a valid session |
| blob ref self | The reference of the blob to destroy | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 5.0 (orlando) | |
blob ref set
get_all
(session ref)
Return a list of all the blobs known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only | |
| Result: | references to all objects | |
| Published in: | XenServer 5.0 (orlando) | A placeholder for a binary blob |
(blob ref → blob record) map
get_all_records
(session ref)
Return a map of blob references to blob records for all blobs known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only | |
| Result: | records of all objects | |
| Published in: | XenServer 5.0 (orlando) | A placeholder for a binary blob |
blob ref set
get_by_name_label
(session ref, string)
Get all the blob instances with the given label.
| Parameters: | session ref session_id | Reference to a valid session |
| string label | label of object to return | |
| Minimum role: | read-only | |
| Result: | references to objects with matching names | |
| Published in: | XenServer 5.0 (orlando) | A placeholder for a binary blob |
blob ref
get_by_uuid
(session ref, string)
Get a reference to the blob instance with the specified UUID.
| Parameters: | session ref session_id | Reference to a valid session |
| string uuid | UUID of object to return | |
| Minimum role: | read-only | |
| Result: | reference to the object | |
| Published in: | XenServer 5.0 (orlando) | A placeholder for a binary blob |
datetime
get_last_updated
(session ref, blob ref)
Get the last_updated field of the given blob.
| Parameters: | session ref session_id | Reference to a valid session |
| blob ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | Time at which the data in the blob was last updated |
string
get_mime_type
(session ref, blob ref)
Get the mime_type field of the given blob.
| Parameters: | session ref session_id | Reference to a valid session |
| blob ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | The mime type associated with this object. Defaults to 'application/octet-stream' if the empty string is supplied |
string
get_name_description
(session ref, blob ref)
Get the name/description field of the given blob.
| Parameters: | session ref session_id | Reference to a valid session |
| blob ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | |
string
get_name_label
(session ref, blob ref)
Get the name/label field of the given blob.
| Parameters: | session ref session_id | Reference to a valid session |
| blob ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | |
bool
get_public
(session ref, blob ref)
Get the public field of the given blob.
| Parameters: | session ref session_id | Reference to a valid session |
| blob ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 6.1 (tampa) | True if the blob is publicly accessible |
blob record
get_record
(session ref, blob ref)
Get a record containing the current state of the given blob.
| Parameters: | session ref session_id | Reference to a valid session |
| blob ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | all fields from the object | |
| Published in: | XenServer 5.0 (orlando) | A placeholder for a binary blob |
int
get_size
(session ref, blob ref)
Get the size field of the given blob.
| Parameters: | session ref session_id | Reference to a valid session |
| blob ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | Size of the binary data, in bytes |
string
get_uuid
(session ref, blob ref)
Get the uuid field of the given blob.
| Parameters: | session ref session_id | Reference to a valid session |
| blob ref self | reference to the object | |
| Minimum role: | read-only | |
| Result: | value of the field | |
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
void
set_name_description
(session ref, blob ref, string)
Set the name/description field of the given blob.
| Parameters: | session ref session_id | Reference to a valid session |
| blob ref self | reference to the object | |
| string value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | |
void
set_name_label
(session ref, blob ref, string)
Set the name/label field of the given blob.
| Parameters: | session ref session_id | Reference to a valid session |
| blob ref self | reference to the object | |
| string value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 4.0 (rio) | |
void
set_public
(session ref, blob ref, bool)
Set the public field of the given blob.
| Parameters: | session ref session_id | Reference to a valid session |
| blob ref self | reference to the object | |
| bool value | New value to set | |
| Minimum role: | pool-operator | |
| Published in: | XenServer 6.1 (tampa) | True if the blob is publicly accessible |