com.aerospike.client.operation.HLLWriteFlags Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aerospike-client-jdk8 Show documentation

Aerospike Java client interface to Aerospike database server

The newest version!

/*
 * Copyright 2012-2023 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.operation;

/**
 * HyperLogLog operation policy write bit flags. Use BITWISE OR to combine flags. Example:
 * 
 * {@code 
 * int flags = HLLWriteFlags.CREATE_ONLY | HLLWriteFlags.NO_FAIL;
 * }
 */
public final class HLLWriteFlags {
	/**
	 * Default.  Allow create or update.
	 */
	public static final int DEFAULT = 0;

	/**
	 * If the bin already exists, the operation will be denied.
	 * If the bin does not exist, a new bin will be created.
	 */
	public static final int CREATE_ONLY = 1;

	/**
	 * If the bin already exists, the bin will be overwritten.
	 * If the bin does not exist, the operation will be denied.
	 */
	public static final int UPDATE_ONLY = 2;

	/**
	 * Do not raise error if operation is denied.
	 */
	public static final int NO_FAIL = 4;

	/**
	 * Allow the resulting set to be the minimum of provided index bits.
	 * Also, allow the usage of less precise HLL algorithms when minHash bits
	 * of all participating sets do not match.
	 */
	public static final int ALLOW_FOLD = 8;
}