com.arangodb.model.TtlIndexOptions 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 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
 * @see API Documentation
 */
public final class TtlIndexOptions extends IndexOptions {

    private final IndexType type = IndexType.ttl;
    private Iterable fields;
    private Integer expireAfter;

    public TtlIndexOptions() {
        super();
    }

    @Override
    TtlIndexOptions getThis() {
        return this;
    }

    public Iterable getFields() {
        return fields;
    }

    /**
     * @param fields A list of attribute paths
     * @return options
     */
    TtlIndexOptions fields(final Iterable fields) {
        this.fields = fields;
        return this;
    }

    public IndexType getType() {
        return type;
    }

    /**
     * @param expireAfter The time (in seconds) after a document’s creation after which the documents count as
     *                    “expired”.
     * @return options
     */
    public TtlIndexOptions expireAfter(final Integer expireAfter) {
        this.expireAfter = expireAfter;
        return this;
    }

    public Integer getExpireAfter() {
        return expireAfter;
    }

}