3.4.7.1 Message: GrowingObjectGetRange

Topic Version1Published10/31/2016
For StandardETP v1.1

Get all list items in a growing object within an index range. If the start or end index are null, it indicates using the minimum or maximum values respectively. If both are null, get all of the growing part.

Message Type ID: 4

Correlation Id Usage: n/a

Multi-part: False

Sent by: customer

Attribute

Description

Data Type

Min

Max

uri

A URI for the parent object.

string

1

1

startIndex

The starting index for the get range.

GrowingObjectIndex

1

1

endIndex

The ending index for the get range.

GrowingObjectIndex

1

1

uom

A UOM for depth values in the indexes. Defaults to whatever is stored natively in the store.

string

1

1

depthDatum

A depthDatum to be used if the index is an MD. As defined in depthDatum on the IndexMetadata record.

string

1

1

Avro Source

{

      "type": "record",

      "namespace": "Energistics.Protocol.GrowingObject",

      "name": "GrowingObjectGetRange",

      "messageType": "4",

      "protocol": "6",

      "senderRole": "customer",

      "protocolRoles": "store,customer",

      "fields":

     [

         { "name": "uri", "type": "string" },

         { "name": "startIndex", "type": "Energistics.Datatypes.Object.GrowingObjectIndex" },

         { "name": "endIndex", "type": "Energistics.Datatypes.Object.GrowingObjectIndex" },

         { "name": "uom", "type": "string" },

         { "name": "depthDatum", "type": "string" }

     ]

}