3.4.7.5 Message: GrowingObjectDeleteRange
Topic Version | 1 | Published | 10/31/2016 | |
For Standard | ETP v1.1 |
Delete all list items in a range of index values. Range is inclusive of the limits (i.e., points >= to start and <= end will be deleted). For lists of sub-objects with ranges of their own (e.g., wellbore geometry sections, mud log intervals) the delete is for any elements that overlap the input range in any way.
Message Type ID: 2
Correlation Id Usage: n/a
Multi-part: False
Sent by: customer
Attribute |
Description |
Data Type |
Min |
Max |
---|---|---|---|---|
uri |
A URI for the parent object. The URI MUST resolve to a single data object; if it does not, send EINVALID_URI. |
string |
1 |
1 |
startIndex |
The starting index for the delete range. |
GrowingObjectIndex |
1 |
1 |
endIndex |
The ending index for the delete range. MUST be >= startIndex or EINVALID_ARGUMENT. |
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 the depthDatum on the IndexMetadata record. |
string |
1 |
1 |
Avro Source |
---|
{ "type": "record", "namespace": "Energistics.Protocol.GrowingObject", "name": "GrowingObjectDeleteRange", "messageType": "2", "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" } ] } |