com.arangodb.model.arangosearch.ArangoSearchPropertiesOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Core module for ArangoDB Java Driver
There is a newer version: 7.16.0
/*
 * DISCLAIMER
 *
 * Copyright 2018 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.arangosearch;

import com.arangodb.entity.arangosearch.CollectionLink;
import com.arangodb.entity.arangosearch.ConsolidationPolicy;
import com.arangodb.entity.arangosearch.PrimarySort;
import com.arangodb.internal.serde.InternalSerializers;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

import java.util.Arrays;
import java.util.Collection;

/**
 * @author Mark Vollmary
 */
public final class ArangoSearchPropertiesOptions {

    private Long consolidationIntervalMsec;
    private Long cleanupIntervalStep;
    private ConsolidationPolicy consolidationPolicy;
    private Collection links;
    private Collection primarySorts;

    /**
     * @param consolidationIntervalMsec Wait at least this many milliseconds between committing index data changes
     *                                  and making them visible to
     *                                  queries (default: 60000, to disable use: 0). For the case where there are a
     *                                  lot of inserts/updates, a
     *                                  lower value, until commit, will cause the index not to account for them and
     *                                  memory usage would
     *                                  continue to grow. For the case where there are a few inserts/updates, a
     *                                  higher value will impact
     *                                  performance and waste disk space for each commit call without any added
     *                                  benefits.
     * @return options
     */
    public ArangoSearchPropertiesOptions consolidationIntervalMsec(final Long consolidationIntervalMsec) {
        this.consolidationIntervalMsec = consolidationIntervalMsec;
        return this;
    }

    /**
     * @param cleanupIntervalStep Wait at least this many commits between removing unused files in data directory
     *                            (default: 10, to
     *                            disable use: 0). For the case where the consolidation policies merge segments often
     *                            (i.e. a lot of
     *                            commit+consolidate), a lower value will cause a lot of disk space to be wasted. For
     *                            the case where the
     *                            consolidation policies rarely merge segments (i.e. few inserts/deletes), a higher
     *                            value will impact
     *                            performance without any added benefits.
     * @return options
     */
    public ArangoSearchPropertiesOptions cleanupIntervalStep(final Long cleanupIntervalStep) {
        this.cleanupIntervalStep = cleanupIntervalStep;
        return this;
    }

    /**
     * @param consolidationPolicy
     * @return options
     */
    public ArangoSearchPropertiesOptions consolidationPolicy(final ConsolidationPolicy consolidationPolicy) {
        this.consolidationPolicy = consolidationPolicy;
        return this;
    }

    /**
     * @param links A list of linked collections
     * @return options
     */
    public ArangoSearchPropertiesOptions link(final CollectionLink... links) {
        this.links = Arrays.asList(links);
        return this;
    }

    /**
     * @param primarySorts A list of primarySort objects
     * @return options
     */
    public ArangoSearchPropertiesOptions primarySort(final PrimarySort... primarySorts) {
        this.primarySorts = Arrays.asList(primarySorts);
        return this;
    }

    public Long getConsolidationIntervalMsec() {
        return consolidationIntervalMsec;
    }

    public Long getCleanupIntervalStep() {
        return cleanupIntervalStep;
    }

    public ConsolidationPolicy getConsolidationPolicy() {
        return consolidationPolicy;
    }

    @JsonSerialize(using = InternalSerializers.CollectionLinksSerializer.class)
    public Collection getLinks() {
        return links;
    }

    public Collection getPrimarySorts() {
        return primarySorts;
    }
}