3.3.17.4 Record: DataObject
| Topic Version | 1 | Published | 10/31/2016 | |
| For Standard | ETP v1.1 | |||
Record structure to carry a single data object. This record encapsulates a Resource record, which contains most of the metadata, and carries the object data as a byte array.
|
Avro Schema |
|---|
|
{ "type": "record", "namespace": "Energistics.Datatypes.Object", "name": "DataObject", "fields": [ { "name": "resource", "type": "Energistics.Datatypes.Object.Resource" }, { "name": "contentEncoding", "type": "string" }, { "name": "data", "type": "bytes" } ] } |
|
Attribute |
Description |
Data Type |
Min |
Max |
|---|---|---|---|---|
|
resource |
Contains high-level metadata about the data object being transferred, in the form of a Resource struct. If you have used the Discovery protocol to find a Resource, then the result of the GetObject message should be to return the same resource information in this field. |
Resource |
1 |
1 |
|
contentEncoding |
Indicates if compression is used. Currently, it MUST be either an empty string or the string "gzip". |
string |
1 |
1 |
|
data |
A byte array containing the encoded object, either as a utf-8 string or its gzipped form. Note, for StoreNotification messages, if includeObjectData is false in the NotificationRequest, this field has zero bytes. For all 1.x Energistics schema data objects that use the plural root, the XML document MUST contain only a single object. |
bytes |
1 |
1 |