Package co.elastic.clients.elasticsearch.indices

Class SimulateTemplateRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.SimulateTemplateRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class SimulateTemplateRequest extends RequestBase implements JsonpSerializable
Returns the index configuration that would be applied by a particular index template.
See Also:

  • Field Details

  • Method Details

    • of

      public static SimulateTemplateRequest of(Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)

    • meta

      public final Map<String,JsonData> meta()
      Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.

      API name: _meta

    • allowAutoCreate

      @Nullable public final Boolean allowAutoCreate()
      This setting overrides the value of the action.auto_create_index cluster setting. If set to true in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via actions.auto_create_index. If set to false, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.

      API name: allow_auto_create

    • composedOf

      public final List<String> composedOf()
      An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.

      API name: composed_of

    • create

      @Nullable public final Boolean create()
      If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.

      API name: create

    • dataStream

      @Nullable public final DataStreamVisibility dataStream()
      If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a data_stream object.

      API name: data_stream

    • deprecated

      @Nullable public final Boolean deprecated()
      Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.

      API name: deprecated

    • ignoreMissingComponentTemplates

      public final List<String> ignoreMissingComponentTemplates()
      The configuration option ignore_missing_component_templates can be used when an index template references a component template that might not exist

      API name: ignore_missing_component_templates

    • includeDefaults

      @Nullable public final Boolean includeDefaults()
      If true, returns all relevant default configurations for the index template.

      API name: include_defaults

    • indexPatterns

      public final List<String> indexPatterns()
      Array of wildcard (*) expressions used to match the names of data streams and indices during creation.

      API name: index_patterns

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • name

      @Nullable public final String name()
      Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.

      API name: name

    • priority

      @Nullable public final Long priority()
      Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.

      API name: priority

    • template

      @Nullable public final IndexTemplateMapping template()
      Template to be applied. It may optionally include an aliases, mappings, or settings configuration.

      API name: template

    • version

      @Nullable public final Long version()
      Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.

      API name: version

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupSimulateTemplateRequestDeserializer

      protected static void setupSimulateTemplateRequestDeserializer(ObjectDeserializer<SimulateTemplateRequest.Builder> op)