Package co.elastic.clients.elasticsearch.esql

Class ESQLDataset

java.lang.Object
co.elastic.clients.elasticsearch.esql.ESQLDataset
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class ESQLDataset extends Object implements JsonpSerializable
Represents a dataset definition stored in cluster state. A dataset is a named reference to external data that participates in the index namespace alongside indices, aliases, and views. Datasets inherit credentials from their referenced data source at query time.
See Also:

  • Field Details

  • Method Details

    • of

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

    • name

      public final String name()
      Required - The dataset name.

      API name: name

    • dataSource

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

      API name: data_source

    • 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 that matches Parquet files under s3://logs-bucket/access.

      API name: resource

    • description

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

      API name: description

    • settings

      public final Map<String,JsonData> settings()
      Format- and parsing-specific settings that configure how the resource is read. Common keys include format and partition_detection. Additional keys depend on the format reader; compression can be inferred from the resource URI.

      API name: settings

    • mappings

      @Nullable public final DatasetMapping mappings()
      The user-declared mapping on the dataset definition.

      API name: mappings

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • rebuild

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

    • setupESQLDatasetDeserializer

      protected static void setupESQLDatasetDeserializer(ObjectDeserializer<ESQLDataset.Builder> op)