Package co.elastic.clients.elasticsearch.esql

Class PutDatasetRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.esql.PutDatasetRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class PutDatasetRequest extends RequestBase implements JsonpSerializable
Create or update an ES|QL dataset.

Creates or replaces a dataset that references a data source in ES|QL data federation. Dataset names participate in the index namespace and must follow index or alias naming rules. Returns 404 if the referenced data source does not exist.

See Also:

  • Field Details

  • Method Details

    • of

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

    • dataSource

      public final String dataSource()
      Required - The name of the referenced data source. The data source must already exist.

      API name: data_source

    • description

      @Nullable public final String description()
      A free-text description of the dataset.

      API name: description

    • mappings

      @Nullable public final DatasetMapping mappings()
      User-declared mapping on the dataset definition

      API name: mappings

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Period to wait for a connection to the master node.

      API name: master_timeout

    • name

      public final String name()
      Required - The dataset name to create or update.

      API name: name

    • resource

      public final String resource()
      Required - The URI that identifies the data to read, resolved against the referenced data source. It can include glob patterns. For example, a recursive pattern can match all Parquet files under the s3://logs-bucket/access prefix.

      API name: resource

    • settings

      public final Map<String,JsonData> settings()
      Format and parsing-specific settings that configure how the resource is read. Common keys include format, which explicitly selects a registered format, and partition_detection, which accepts auto, hive, template, or none. Additional keys depend on the format reader. Compression can be inferred from the resource URI.

      API name: settings

    • timeout

      @Nullable public final Time timeout()
      The time to wait for the request to be completed.

      API name: timeout

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

    • rebuild

      public PutDatasetRequest.Builder rebuild()
      Returns:
      New PutDatasetRequest.Builder initialized with field values of this instance

    • setupPutDatasetRequestDeserializer

      protected static void setupPutDatasetRequestDeserializer(ObjectDeserializer<PutDatasetRequest.Builder> op)