com.arangodb.model.IndexOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arangodb-java-driver Show documentation

ArangoDB Java Driver

There is a newer version: 7.15.0

/*
 * DISCLAIMER
 *
 * Copyright 2019 ArangoDB GmbH, Cologne, Germany
 *
 * 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.
 *
 * Copyright holder is ArangoDB GmbH, Cologne, Germany
 */

package com.arangodb.model;

import com.arangodb.entity.IndexType;

/**
 * @author Heiko Kernbach
 *
 * This class is used for all index similarities
 */
public class IndexOptions {

	private Boolean inBackground;
	private String name;

	public IndexOptions() {
		super();
	}

	/**
	 * @param inBackground
	 *            create the the index in the background
	 *            this is a RocksDB only flag.
	 * @return options
	 */
	public IndexOptions inBackground(final Boolean inBackground) {
		this.inBackground = inBackground;
		return this;
	}

	public Boolean getInBackground() {
		return inBackground;
	}

	/**
	 * @param name
	 *            the name of the index
	 * @return options
	 */
	public IndexOptions name(final String name) {
		this.name = name;
		return this;
	}

	protected String getName() {
		return name;
	}
}