Package co.elastic.clients.elasticsearch.indices

Class SimulateIndexTemplateRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.SimulateIndexTemplateRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class SimulateIndexTemplateRequest
extends RequestBase
implements JsonpSerializable
Simulate matching the given index name against the index templates in the system
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static SimulateIndexTemplateRequest of​(java.util.function.Function<SimulateIndexTemplateRequest.Builder,​ObjectBuilder<SimulateIndexTemplateRequest>> fn)

    • meta

      public final java.util.Map<java.lang.String,​JsonData> meta()
      API name: _meta

    • allowAutoCreate

      @Nullable public final java.lang.Boolean allowAutoCreate()
      API name: allow_auto_create

    • composedOf

      public final java.util.List<java.lang.String> composedOf()
      API name: composed_of

    • create

      @Nullable public final java.lang.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 DataStream dataStream()
      API name: data_stream

    • indexPatterns

      public final java.util.List<java.lang.String> indexPatterns()
      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

      public final java.lang.String name()
      Required - Index or template name to simulate

      API name: name

    • priority

      @Nullable public final java.lang.Integer priority()
      API name: priority

    • template

      @Nullable public final IndexTemplateMapping template()
      API name: template

    • version

      @Nullable public final java.lang.Long version()
      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)

    • setupSimulateIndexTemplateRequestDeserializer

      protected static void setupSimulateIndexTemplateRequestDeserializer​(ObjectDeserializer<SimulateIndexTemplateRequest.Builder> op)