package protocol.sdk.kv.lookup_in

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: LookupInSpecResult

• oneof result

  • bool value = 1

  • shared.Exception exception = 2

Used in: LookupInSpec

• string path = 1

• optional bool xattr = 2

Used in: LookupInSpec

• string path = 1

• optional bool xattr = 2

Used in: LookupInSpec

• string path = 1

• optional bool xattr = 2

Used in: CollectionLevelCommand

• optional shared.DocLocation location = 1

  Use for collection and ID - Should be used over the collection level command collection

• repeated LookupInSpec spec = 2

• optional LookupInOptions options = 3

A Scan will result in the performer sending back a stream of (in the golden path): (1) A stream.Created result with type STREAM_LOOKUP_IN_ALL_REPLICAS, followed by (2) Zero or more LookupInAllReplicasResult results (and/or streams.Error), followed by (3) A stream.Complete result.

Used in: CollectionLevelCommand

• optional shared.DocLocation location = 1

• repeated LookupInSpec spec = 2

• optional LookupInAllReplicasOptions options = 3

• optional streams.Config stream_config = 4

  Not sent on to the SDK - instead specifies how the performer should handle the streaming.

Used in: LookupInAllReplicas

• optional uint32 timeout_millis = 1

• optional string parent_span_id = 3

• optional shared.ReadPreference read_preference = 5

  Will only be sent if support is declared for SDK_ZONE_AWARE_READ_FROM_REPLICA

Used in: Result

• optional LookupInReplicaResult lookup_in_replica_result = 1

• string stream_id = 2

  Not part of the SDK response - identifies what stream this is from.

Used in: CollectionLevelCommand

• optional shared.DocLocation location = 1

• repeated LookupInSpec spec = 2

• optional LookupInAnyReplicaOptions options = 3

Used in: LookupInAnyReplica

• optional uint32 timeout_millis = 1

• optional string parent_span_id = 3

• optional shared.ReadPreference read_preference = 5

  Will only be sent if support is declared for SDK_ZONE_AWARE_READ_FROM_REPLICA

Used in: LookupIn

• optional uint32 timeout_millis = 1

• optional bool access_deleted = 3

• optional string parent_span_id = 4

Used in: Result, LookupInAllReplicasResult

• repeated LookupInSpecResult results = 1

  For each LookupInSpec we should return a LookupInSpecResult within the total LookupInAnyReplicasResult

• bool is_replica = 2

  Returns true if the read was from a replica node

• int64 cas = 3

Used in: Result

• repeated LookupInSpecResult results = 1

  For each LookupInSpec we should return a LookupInSpecResult within the total LookupInResult

• int64 cas = 2

Used in: LookupIn, LookupInAllReplicas, LookupInAnyReplica

• oneof operation

  • ExistsOperation exists = 1

  • GetOperation get = 2

  • CountOperation count = 3

• optional shared.ContentAs content_as = 4

Used in: LookupInReplicaResult, LookupInResult

• optional shared.ContentOrError content_as_result = 1

  If from an exists lookup: Either an error propagated from exists_result or the value of exists_result converted to the requested content type Otherwise: Returns an exception or the value of the result in the requested content type

• optional BooleanOrError exists_result = 2

  True if a result was found, false if the path was not found. Otherwise will be an exception