Package co.elastic.clients.elasticsearch.indices

Class CreateIndexRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.CreateIndexRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class CreateIndexRequest extends RequestBase implements JsonpSerializable
Create an index. You can use the create index API to add a new index to an Elasticsearch cluster. When creating an index, you can specify the following:
  • Settings for the index.
  • Mappings for fields in the index.
  • Index aliases

Wait for active shards

By default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out. The index creation response will indicate what happened. For example, acknowledged indicates whether the index was successfully created in the cluster, while shards_acknowledged indicates whether the requisite number of shard copies were started for each shard in the index before timing out. Note that it is still possible for either acknowledged or shards_acknowledged to be false, but for the index creation to be successful. These values simply indicate whether the operation completed before the timeout. If acknowledged is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon. If shards_acknowledged is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, acknowledged is true).

You can change the default of only waiting for the primary shards to start through the index setting index.write.wait_for_active_shards. Note that changing this setting will also affect the wait_for_active_shards value on all subsequent write operations.

See Also:

  • Field Details

  • Method Details

    • of

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

    • aliases

      public final Map<String,Alias> aliases()
      Aliases for the index.

      API name: aliases

    • index

      public final String index()
      Required - Name of the index you wish to create. Index names must meet the following criteria:
      • Lowercase only
      • Cannot include \, /, *, ?, ", <, >, |, (space character), ,, or #
      • Indices prior to 7.0 could contain a colon (:), but that has been deprecated and will not be supported in later versions
      • Cannot start with -, _, or +
      • Cannot be . or ..
      • Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster)
      • Names starting with . are deprecated, except for hidden indices and internal indices managed by plugins

      API name: index

    • mappings

      @Nullable public final TypeMapping mappings()
      Mapping for fields in the index. If specified, this mapping can include:
      • Field names
      • Field data types
      • Mapping parameters

      API name: mappings

    • 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

    • settings

      @Nullable public final IndexSettings settings()
      Configuration options for the index.

      API name: settings

    • timeout

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

      API name: timeout

    • waitForActiveShards

      @Nullable public final WaitForActiveShards waitForActiveShards()
      The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

      API name: wait_for_active_shards

    • 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)

    • setupCreateIndexRequestDeserializer

      protected static void setupCreateIndexRequestDeserializer(ObjectDeserializer<CreateIndexRequest.Builder> op)