org.elasticsearch.xpack.esql.expression.function.Example Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of x-pack-esql Show documentation

The plugin that powers ESQL for Elasticsearch

There is a newer version: 8.16.1

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */

package org.elasticsearch.xpack.esql.expression.function;

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

/**
 * An example of using a function that is rendered in the docs.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.CONSTRUCTOR)
public @interface Example {

    /**
     * The description that will appear before the example
     */
    String description() default "";

    /**
     * The test file that contains the example.
     */
    String file();

    /**
     * The tag that fences this example.
     */
    String tag();

    /**
     * The explanation that will appear after the example.
     */
    String explanation() default "";
}