package protocol.sdk.kv

Get desktop application:
View/edit binary Protocol Buffers messages

Performer will return a MutationResult

Used in: BinaryCollectionLevelCommand

• optional shared.DocLocation location = 1

• bytes content = 2

• optional AppendOptions options = 3

Used in: Append

• optional int32 timeout_msecs = 1

• optional int64 cas = 2

• optional shared.DurabilityType durability = 5

• optional string parent_span_id = 6

Used in: Result

• int64 cas = 1

• optional shared.MutationToken mutation_token = 2

• int64 content = 3

Performer will return a CounterResult

Used in: BinaryCollectionLevelCommand

• optional shared.DocLocation location = 1

• optional DecrementOptions options = 3

Used in: Decrement

• optional int32 timeout_msecs = 1

• optional shared.Expiry expiry = 2

• optional int64 delta = 3

• optional int64 initial = 4

• optional shared.DurabilityType durability = 5

• optional string parent_span_id = 6

Performer will return an ExistsResult

Used in: CollectionLevelCommand

• optional shared.DocLocation location = 1

• optional ExistsOptions options = 2

Used in: Exists

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Used in: Result

• int64 cas = 1

• bool exists = 2

Performer will return a GetResult

Used in: Command

• optional shared.DocLocation location = 1

• optional GetOptions options = 2

• optional shared.ContentAs content_as = 3

Performer will return a GetReplicaResult

Used in: CollectionLevelCommand

• optional shared.DocLocation location = 1

• optional GetAllReplicasOptions options = 2

• optional streams.Config stream_config = 3

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

• optional shared.ContentAs content_as = 4

Used in: GetAllReplicas

• optional int32 timeout_msecs = 1

• optional shared.Transcoder transcoder = 2

• optional shared.ReadPreference read_preference = 3

  Will only be sent if support is declared for SDK_ZONE_AWARE_READ_FROM_REPLICA

• optional string parent_span_id = 4

Performer will return a GetResult

Used in: CollectionLevelCommand

• optional shared.DocLocation location = 1

• optional google.protobuf.Duration duration = 2

• optional GetAndLockOptions options = 3

• optional shared.ContentAs content_as = 4

Used in: GetAndLock

• optional int32 timeout_msecs = 1

• optional shared.Transcoder transcoder = 2

• optional string parent_span_id = 3

Performer will return a GetResult

Used in: CollectionLevelCommand

• optional shared.DocLocation location = 1

• optional shared.Expiry expiry = 2

• optional GetAndTouchOptions options = 3

• optional shared.ContentAs content_as = 4

Used in: GetAndTouch

• optional int32 timeout_msecs = 1

• optional shared.Transcoder transcoder = 2

• optional string parent_span_id = 3

Performer will return a GetReplicaResult

Used in: CollectionLevelCommand

• optional shared.DocLocation location = 1

• optional GetAnyReplicaOptions options = 2

• optional shared.ContentAs content_as = 3

Used in: GetAnyReplica

• optional int32 timeout_msecs = 1

• optional shared.Transcoder transcoder = 2

• optional shared.ReadPreference read_preference = 3

  Will only be sent if support is declared for SDK_ZONE_AWARE_READ_FROM_REPLICA

• optional string parent_span_id = 4

Used in: Get, GetOrNull

• optional int32 timeout_msecs = 1

• optional bool with_expiry = 2

• repeated string projection = 3

  It's not possible to have 'optional repeated' in GRPC. If this is empty, don't set the projected option.

• optional shared.Transcoder transcoder = 4

• optional string parent_span_id = 5

Performer will return a GetResult or a Result.null_result=true

Used in: Command

• optional shared.DocLocation location = 1

• optional GetOptions options = 2

  This must be a GetOrNullOptions block in the SDK in case they ever diverge, but in FIT where future breakage is more easily patched, we can be lazy and DRY.

• optional shared.ContentAs content_as = 3

Used in: Result

• int64 cas = 1

• optional shared.ContentTypes content = 2

• bool is_replica = 3

• optional int64 expiry_time = 4

  Represented as the number of seconds since January 1, 1970 (e.g. what the server returns)

• optional string stream_id = 5

  Not part of the SDK response - identifies what stream this is from. This is only needed when returning the result of collection.getAllReplicas()

Used in: Result

• int64 cas = 1

• optional shared.ContentTypes content = 2

• optional int64 expiry_time = 3

  Represented as the number of seconds since January 1, 1970 (e.g. what the server returns)

Performer will return a CounterResult

Used in: BinaryCollectionLevelCommand

• optional shared.DocLocation location = 1

• optional IncrementOptions options = 3

Used in: Increment

• optional int32 timeout_msecs = 1

• optional shared.Expiry expiry = 2

• optional int64 delta = 3

• optional int64 initial = 4

• optional shared.DurabilityType durability = 5

• optional string parent_span_id = 6

Performer will return a MutationResult

Used in: Command

• optional shared.DocLocation location = 1

• optional shared.Content content = 2

• optional InsertOptions options = 3

Used in: Insert

• optional int32 timeout_msecs = 1

• optional shared.DurabilityType durability = 2

• optional shared.Expiry expiry = 3

• optional shared.Transcoder transcoder = 4

• optional string parent_span_id = 5

Used in: Result

• int64 cas = 1

• optional shared.MutationToken mutation_token = 2

Performer will return a MutationResult

Used in: BinaryCollectionLevelCommand

• optional shared.DocLocation location = 1

• bytes content = 2

• optional PrependOptions options = 3

Used in: Prepend

• optional int32 timeout_msecs = 1

• optional int64 cas = 2

• optional shared.DurabilityType durability = 5

• optional string parent_span_id = 6

Performer will return a MutationResult

Used in: Command

• optional shared.DocLocation location = 1

• optional RemoveOptions options = 2

Used in: Remove

• optional int32 timeout_msecs = 1

• optional shared.DurabilityType durability = 2

• optional int64 cas = 3

• optional string parent_span_id = 4

Performer will return a MutationResult

Used in: Command

• optional shared.DocLocation location = 1

• optional shared.Content content = 2

• optional ReplaceOptions options = 3

Used in: Replace

• optional int32 timeout_msecs = 1

• optional shared.DurabilityType durability = 2

• optional shared.Expiry expiry = 3

• optional bool preserve_expiry = 4

• optional int64 cas = 5

• optional shared.Transcoder transcoder = 6

• optional string parent_span_id = 7

Performer will return a MutationResult

Used in: CollectionLevelCommand

• optional shared.DocLocation location = 1

• optional shared.Expiry expiry = 2

• optional TouchOptions options = 3

Used in: Touch

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Performer will return an empty result with success set

Used in: CollectionLevelCommand

• optional shared.DocLocation location = 1

• int64 cas = 2

• optional UnlockOptions options = 3

Used in: Unlock

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 3

Performer will return a MutationResult

Used in: Command

• optional shared.DocLocation location = 1

• optional shared.Content content = 2

• optional UpsertOptions options = 3

Used in: Upsert

• optional int32 timeout_msecs = 1

• optional shared.DurabilityType durability = 2

• optional shared.Expiry expiry = 3

• optional bool preserve_expiry = 4

• optional shared.Transcoder transcoder = 5

• optional string parent_span_id = 6