Package co.elastic.clients.elasticsearch.indices

Class SimulateTemplateRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.indices.SimulateTemplateRequest.Builder
All Implemented Interfaces:
ObjectBuilder<SimulateTemplateRequest>
Enclosing class:
SimulateTemplateRequest
public static class SimulateTemplateRequest.Builder
extends java.lang.Object
implements ObjectBuilder<SimulateTemplateRequest>
Builder for SimulateTemplateRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • name

      public SimulateTemplateRequest.Builder name​(@Nullable java.lang.String value)
      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

    • create

      public SimulateTemplateRequest.Builder create​(@Nullable java.lang.Boolean value)
      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

    • masterTimeout

      public SimulateTemplateRequest.Builder masterTimeout​(@Nullable java.lang.String value)
      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

    • template

      public SimulateTemplateRequest.Builder template​(IndexTemplate value)
      Required - Request body.

      API name: _value_body

    • template

      public SimulateTemplateRequest.Builder template​(java.util.function.Function<IndexTemplate.Builder,​ObjectBuilder<IndexTemplate>> fn)
      Required - Request body.

      API name: _value_body

    • build

      public SimulateTemplateRequest build()
      Builds a SimulateTemplateRequest.
      Specified by:
      build in interface ObjectBuilder<SimulateTemplateRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.