Develop for XenServer

Class: blob

June 19, 2024

Contributed by:

X X

A placeholder for a binary blob

Fields for class: blob

Field	Type	Qualifier	Description
`last_updated`	`datetime`	RO/constructor	Time at which the data in the blob was last updated
`mime_type`	`string`	RO/constructor	The mime type associated with this object. Defaults to ‘application/octet-stream’ if the empty string is supplied
`name_description`	`string`	RW	a notes field containing human-readable description
`name_label`	`string`	RW	a human-readable name
`public`	`bool`	RW	True if the blob is publicly accessible
`size`	`int`	RO/runtime	Size of the binary data, in bytes
`uuid`	`string`	RO/runtime	Unique identifier/object reference

RPCs associated with class: blob

RPC name: create

Overview:

Create a placeholder for a binary blob

Signature:

blob ref create (session ref session_ref, string mime_type, bool public)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	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

Return Type: blob ref

The reference of the created blob

RPC name: destroy

Overview:

Signature:

void destroy (session ref session_ref, blob ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`blob ref`	`self`	The reference of the blob to destroy

Minimum Role: pool-operator

Return Type: void

RPC name: get_all

Overview:

Return a list of all the blobs known to the system.

Signature:

blob ref set get_all (session ref session_ref)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session

Minimum Role: read-only

Return Type: blob ref set

references to all objects

RPC name: get_all_records

Overview:

Return a map of blob references to blob records for all blobs known to the system.

Signature:

(blob ref -> blob record) map get_all_records (session ref session_ref)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session

Minimum Role: read-only

Return Type: (blob ref -> blob record) map

records of all objects

RPC name: get_by_name_label

Overview:

Get all the blob instances with the given label.

Signature:

blob ref set get_by_name_label (session ref session_ref, string label)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`string`	`label`	label of object to return

Minimum Role: read-only

Return Type: blob ref set

references to objects with matching names

RPC name: get_by_uuid

Overview:

Get a reference to the blob instance with the specified UUID.

Signature:

blob ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`string`	`uuid`	UUID of object to return

Minimum Role: read-only

Return Type: blob ref

reference to the object

RPC name: get_last_updated

Overview:

Get the last_updated field of the given blob.

Signature:

datetime get_last_updated (session ref session_ref, blob ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`blob ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: datetime

value of the field

RPC name: get_mime_type

Overview:

Get the mime_type field of the given blob.

Signature:

string get_mime_type (session ref session_ref, blob ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`blob ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_name_description

Overview:

Get the name/description field of the given blob.

Signature:

string get_name_description (session ref session_ref, blob ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`blob ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_name_label

Overview:

Get the name/label field of the given blob.

Signature:

string get_name_label (session ref session_ref, blob ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`blob ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_public

Overview:

Get the public field of the given blob.

Signature:

bool get_public (session ref session_ref, blob ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`blob ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_record

Overview:

Get a record containing the current state of the given blob.

Signature:

blob record get_record (session ref session_ref, blob ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`blob ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: blob record

all fields from the object

RPC name: get_size

Overview:

Get the size field of the given blob.

Signature:

int get_size (session ref session_ref, blob ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`blob ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: int

value of the field

RPC name: get_uuid

Overview:

Get the uuid field of the given blob.

Signature:

string get_uuid (session ref session_ref, blob ref self)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`blob ref`	`self`	reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: set_name_description

Overview:

Set the name/description field of the given blob.

Signature:

void set_name_description (session ref session_ref, blob ref self, string value)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`blob ref`	`self`	reference to the object
`string`	`value`	New value to set

Minimum Role: pool-operator

Return Type: void

RPC name: set_name_label

Overview:

Set the name/label field of the given blob.

Signature:

void set_name_label (session ref session_ref, blob ref self, string value)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`blob ref`	`self`	reference to the object
`string`	`value`	New value to set

Minimum Role: pool-operator

Return Type: void

RPC name: set_public

Overview:

Set the public field of the given blob.

Signature:

void set_public (session ref session_ref, blob ref self, bool value)
<!--NeedCopy-->

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`blob ref`	`self`	reference to the object
`bool`	`value`	New value to set

Minimum Role: pool-operator

Return Type: void

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Class: blob

June 19, 2024

Contributed by:

X X

June 19, 2024

Contributed by:

X X

Class: blob

Fields for class: blob

RPCs associated with class: blob

RPC name: create

RPC name: destroy

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_name_label

RPC name: get_by_uuid

RPC name: get_last_updated

RPC name: get_mime_type

RPC name: get_name_description

RPC name: get_name_label

RPC name: get_public

RPC name: get_record

RPC name: get_size

RPC name: get_uuid

RPC name: set_name_description

RPC name: set_name_label

RPC name: set_public

In this article