Package co.elastic.clients.elasticsearch.transform

Class Source

java.lang.Object
co.elastic.clients.elasticsearch.transform.Source
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class Source
extends java.lang.Object
implements JsonpSerializable
See Also:
API specification

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  Source.Builder
    Builder for Source.

  • Field Summary

    Fields
    Modifier and Type Field Description
    static JsonpDeserializer<Source> _DESERIALIZER
    Json deserializer for Source

  • Method Summary

    Modifier and Type Method Description
    java.util.List<java.lang.String> index()
    Required - The source indices for the transform.
    static Source of​(java.util.function.Function<Source.Builder,​ObjectBuilder<Source>> fn)  
    Query query()
    A query clause that retrieves a subset of data from the source index.
    java.util.Map<java.lang.String,​java.util.List<RuntimeField>> runtimeMappings()
    Definitions of search-time runtime fields that can be used by the transform.
    void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
    Serialize this object to JSON.
    protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)  
    protected static void setupSourceDeserializer​(ObjectDeserializer<Source.Builder> op)  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Method Details

    • of

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

    • index

      public final java.util.List<java.lang.String> index()
      Required - The source indices for the transform. It can be a single index, an index pattern (for example, "my-index-*""), an array of indices (for example, ["my-index-000001", "my-index-000002"]), or an array of index patterns (for example, ["my-index-*", "my-other-index-*"]. For remote indices use the syntax "remote_name:index_name". If any indices are in remote clusters then the master node and at least one transform node must have the remote_cluster_client node role.

      API name: index

    • query

      @Nullable public final Query query()
      A query clause that retrieves a subset of data from the source index.

      API name: query

    • runtimeMappings

      public final java.util.Map<java.lang.String,​java.util.List<RuntimeField>> runtimeMappings()
      Definitions of search-time runtime fields that can be used by the transform. For search runtime fields all data nodes, including remote nodes, must be 7.12 or later.

      API name: runtime_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)

    • setupSourceDeserializer

      protected static void setupSourceDeserializer​(ObjectDeserializer<Source.Builder> op)