com.aerospike.client.policy.BatchDeletePolicy Maven / Gradle / Ivy
/*
* Copyright 2012-2022 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 delete commands.
*/
public final class BatchDeletePolicy {
/**
* 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;
/**
* 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 deletes based on record generation. The default (NONE)
* indicates that the generation is not used to restrict deletes.
*
* 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. This field is only relevant when generationPolicy
* is not NONE.
*
* Default: 0
*/
public int generation;
/**
* 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 tombstone record on the server.
*
* Default: false (do not send the user defined key)
*/
public boolean sendKey;
/**
* Copy constructor.
*/
public BatchDeletePolicy(BatchDeletePolicy other) {
this.filterExp = other.filterExp;
this.commitLevel = other.commitLevel;
this.generationPolicy = other.generationPolicy;
this.generation = other.generation;
this.durableDelete = other.durableDelete;
this.sendKey = other.sendKey;
}
/**
* Default constructor.
*/
public BatchDeletePolicy() {
}
}