com.aerospike.client.policy.BatchWritePolicy Maven / Gradle / Ivy
Show all versions of aerospike-client-bc-jdk21 Show documentation
/*
* Copyright 2012-2024 Aerospike, Inc.
*
* Portions may be licensed to Aerospike, Inc. under one or more contributor
* license agreements WHICH ARE COMPATIBLE WITH THE APACHE LICENSE, VERSION 2.0.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.aerospike.client.policy;
import com.aerospike.client.exp.Expression;
/**
* Policy attributes used in batch write commands.
*/
public final class BatchWritePolicy {
/**
* Optional expression filter. If filterExp exists and evaluates to false, the specific batch key
* request is not performed and {@link com.aerospike.client.BatchRecord#resultCode} is set to
* {@link com.aerospike.client.ResultCode#FILTERED_OUT}.
*
* If exists, this filter overrides the batch parent filter {@link com.aerospike.client.policy.Policy#filterExp}
* for the specific key in batch commands that allow a different policy per key.
* Otherwise, this filter is ignored.
*
* Default: null
*/
public Expression filterExp;
/**
* Qualify how to handle writes where the record already exists.
*
* Default: RecordExistsAction.UPDATE
*/
public RecordExistsAction recordExistsAction = RecordExistsAction.UPDATE;
/**
* 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
*/
public CommitLevel commitLevel = CommitLevel.COMMIT_ALL;
/**
* 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
*/
public GenerationPolicy generationPolicy = GenerationPolicy.NONE;
/**
* 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 0. 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
*/
public int generation;
/**
* 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.
* - > 0: Actual ttl in seconds.
*
*
* Default: 0
*/
public int expiration;
/**
* 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 only.
*
* Default: false (do not tombstone deleted records).
*/
public boolean durableDelete;
/**
* Send user defined key in addition to hash digest.
* If true, the key will be stored with the record on the server.
*
* Default: false (do not send the user defined key)
*/
public boolean sendKey;
/**
* Copy constructor.
*/
public BatchWritePolicy(BatchWritePolicy other) {
this.filterExp = other.filterExp;
this.recordExistsAction = other.recordExistsAction;
this.commitLevel = other.commitLevel;
this.generationPolicy = other.generationPolicy;
this.generation = other.generation;
this.expiration = other.expiration;
this.durableDelete = other.durableDelete;
this.sendKey = other.sendKey;
}
/**
* Default constructor.
*/
public BatchWritePolicy() {
}
// Include setters to facilitate Spring's ConfigurationProperties.
public void setFilterExp(Expression filterExp) {
this.filterExp = filterExp;
}
public void setRecordExistsAction(RecordExistsAction recordExistsAction) {
this.recordExistsAction = recordExistsAction;
}
public void setCommitLevel(CommitLevel commitLevel) {
this.commitLevel = commitLevel;
}
public void setGenerationPolicy(GenerationPolicy generationPolicy) {
this.generationPolicy = generationPolicy;
}
public void setGeneration(int generation) {
this.generation = generation;
}
public void setExpiration(int expiration) {
this.expiration = expiration;
}
public void setDurableDelete(boolean durableDelete) {
this.durableDelete = durableDelete;
}
public void setSendKey(boolean sendKey) {
this.sendKey = sendKey;
}
}