com.github.ydespreaux.spring.data.elasticsearch.annotations.Index Maven / Gradle / Ivy

/*
 * Copyright (C) 2018 Yoann Despréaux
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; see the file COPYING . If not, write to the
 * Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * Please send bugreports with examples or suggestions to [email protected]
 */

package com.github.ydespreaux.spring.data.elasticsearch.annotations;

import com.github.ydespreaux.spring.data.elasticsearch.core.IndexTimeBasedSupport;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author Yoann Despréaux
 * @since 1.0.0
 */
@Target({})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Index {

    /**
     * Création de l'index si ce dernier n'existe pas.
     * La création de l'index se base sur le template correspondant pour la configuration, le mapping etc...
     */
    boolean createIndex() default true;

    String name() default "";

    String settingsAndMappingPath() default "";

    /**
     * Type du document à indexer
     *
     * @return the type name
     */
    String type() default "_doc";

    /**
     * @return
     */
    String indexPattern() default "";

    /**
     * La classe IndexTimeBasedSupport permet de générer le nom de l'index pour l'indexation de documents
     * en fonction de la date courante ainsi que le document à indexer.
     *
     * @return the index time based support
     */
    Class indexTimeBasedSupport() default IndexTimeBasedSupport.class;

}