BackgroundExecutePolicy Class

[Missing <summary> documentation for "T:Aerospike.Client.KVS.BackgroundExecutePolicy"]

Definition

Namespace: Aerospike.Client.KVS
Assembly: AerospikeClient (in AerospikeClient.dll) Version: 7.0.0
C#
public sealed class BackgroundExecutePolicy : IMessage<BackgroundExecutePolicy>, 
	IMessage, IEquatable<BackgroundExecutePolicy>, IDeepCloneable<BackgroundExecutePolicy>, 
	IBufferMessage
Inheritance
Object    BackgroundExecutePolicy
Implements
IBufferMessage, IDeepCloneableBackgroundExecutePolicy, IMessage, IMessageBackgroundExecutePolicy, IEquatableBackgroundExecutePolicy

Constructors

BackgroundExecutePolicyInitializes a new instance of the BackgroundExecutePolicy class
BackgroundExecutePolicy(BackgroundExecutePolicy)Initializes a new instance of the BackgroundExecutePolicy class

Properties

CommitLevel Desired consistency guarantee when committing a transaction on the server. The default (COMMIT_ALL) indicates that the server should wait for master and all replica commits to be successful before returning success to the client. Default: CommitLevel.COMMIT_ALL
Compress Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes. This option will increase cpu and memory usage (for extra compressed buffers),but decrease the size of data sent over the network.
Descriptor 
DurableDelete If the transaction results in a record deletion, leave a tombstone for the record. This prevents deleted records from reappearing after node failures. Valid for Aerospike Server Enterprise Edition 3.10+ only. Default: false (do not tombstone deleted records).
Expiration Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. Expiration values: - -2: Do not change ttl when record is updated. - -1: Never expire. - 0: Default to namespace configuration variable "default-ttl" on the server. - &gt; 0: Actual ttl in seconds.<br> Default: 0
Expression Optional expression filter. If filterExp exists and evaluates to false, the transaction is ignored.
Generation Expected generation. Generation is the number of times a record has been modified (including creation) on the server. If a write operation is creating a record, the expected generation would be <code>0</code>. This field is only relevant when generationPolicy is not NONE. The server does not support this field for UDF execute() calls. The read-modify-write usage model can still be enforced inside the UDF code itself. Default: 0
GenerationPolicy Qualify how to handle record writes based on record generation. The default (NONE) indicates that the generation is not used to restrict writes. The server does not support this field for UDF execute() calls. The read-modify-write usage model can still be enforced inside the UDF code itself. Default: GenerationPolicy.NONE
HasCommitLevelGets whether the "commitLevel" field is set
HasDurableDeleteGets whether the "durableDelete" field is set
HasExpirationGets whether the "expiration" field is set
HasExpressionGets whether the "expression" field is set
HasGenerationGets whether the "generation" field is set
HasGenerationPolicyGets whether the "generationPolicy" field is set
HasRecordExistsActionGets whether the "recordExistsAction" field is set
HasRespondAllOpsGets whether the "respondAllOps" field is set
HasSendKeyGets whether the "sendKey" field is set
HasTotalTimeoutGets whether the "totalTimeout" field is set
HasXdrGets whether the "xdr" field is set
Parser 
ReadModeAP Read policy for SC (strong consistency) namespaces.
ReadModeSC Replica algorithm used to determine the target node for a single record command. Scan and scan are not affected by replica algorithms.
RecordExistsAction Qualify how to handle writes where the record already exists. Default: RecordExistsAction.UPDATE
Replica Read policy for AP (availability) namespaces.
RespondAllOps For client operate(), return a result for every operation. Some operations do not return results by default (ListOperation.clear() for example). This can make it difficult to determine the desired result offset in the returned bin's result list. Setting respondAllOps to true makes it easier to identify the desired result offset (result offset equals bin's operate sequence). If there is a map operation in operate(), respondAllOps will be forced to true for that operate() call. Default: false
SendKey Send user defined key in addition to hash digest on both reads and writes. If the key is sent on a write, the key will be stored with the record on the server. <p> Default: false (do not send the user defined key)
TotalTimeout Total transaction timeout in milliseconds. Default for all other commands: 1000ms
Xdr Operate in XDR mode. Some external connectors may need to emulate an XDR client. If enabled, an XDR bit is set for writes in the wire protocol. Default: false.

Methods

CalculateSize 
ClearCommitLevelClears the value of the "commitLevel" field
ClearDurableDeleteClears the value of the "durableDelete" field
ClearExpirationClears the value of the "expiration" field
ClearExpressionClears the value of the "expression" field
ClearGenerationClears the value of the "generation" field
ClearGenerationPolicyClears the value of the "generationPolicy" field
ClearRecordExistsActionClears the value of the "recordExistsAction" field
ClearRespondAllOpsClears the value of the "respondAllOps" field
ClearSendKeyClears the value of the "sendKey" field
ClearTotalTimeoutClears the value of the "totalTimeout" field
ClearXdrClears the value of the "xdr" field
Clone 
Equals(BackgroundExecutePolicy) 
Equals(Object)
(Overrides ObjectEquals(Object))
GetHashCode
(Overrides ObjectGetHashCode)
MergeFrom(BackgroundExecutePolicy) 
MergeFrom(CodedInputStream) 
ToString
(Overrides ObjectToString)
WriteTo 

Fields

CommitLevelFieldNumberField number for the "commitLevel" field.
CompressFieldNumberField number for the "compress" field.
DurableDeleteFieldNumberField number for the "durableDelete" field.
ExpirationFieldNumberField number for the "expiration" field.
ExpressionFieldNumberField number for the "expression" field.
GenerationFieldNumberField number for the "generation" field.
GenerationPolicyFieldNumberField number for the "generationPolicy" field.
ReadModeAPFieldNumberField number for the "readModeAP" field.
ReadModeSCFieldNumberField number for the "readModeSC" field.
RecordExistsActionFieldNumberField number for the "recordExistsAction" field.
ReplicaFieldNumberField number for the "replica" field.
RespondAllOpsFieldNumberField number for the "respondAllOps" field.
SendKeyFieldNumberField number for the "sendKey" field.
TotalTimeoutFieldNumberField number for the "totalTimeout" field.
XdrFieldNumberField number for the "xdr" field.

See Also