Package org.opensearch.cluster.metadata

Class ComposableIndexTemplate.DataStreamTemplate

java.lang.Object
org.opensearch.cluster.metadata.ComposableIndexTemplate.DataStreamTemplate
All Implemented Interfaces:
Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject
Enclosing class:
ComposableIndexTemplate
public static class ComposableIndexTemplate.DataStreamTemplate
extends java.lang.Object
implements Writeable, org.opensearch.common.xcontent.ToXContentObject

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

    org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>

  • Field Summary

    Fields inherited from interface org.opensearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors 
    Constructor Description
    DataStreamTemplate()  
    DataStreamTemplate​(DataStream.TimestampField timestampField)  
    DataStreamTemplate​(StreamInput in)  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    static ComposableIndexTemplate.DataStreamTemplate fromXContent​(org.opensearch.common.xcontent.XContentParser parser)  
    java.util.Map<java.lang.String,​java.lang.Object> getDataStreamMappingSnippet()  
    DataStream.TimestampField getTimestampField()  
    int hashCode()  
    org.opensearch.common.xcontent.XContentBuilder toXContent​(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)  
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

    isFragment

  • Constructor Details

  • Method Details

    • getTimestampField

      public DataStream.TimestampField getTimestampField()

    • getDataStreamMappingSnippet

      public java.util.Map<java.lang.String,​java.lang.Object> getDataStreamMappingSnippet()
      Returns:
      a mapping snippet for a backing index with `_data_stream_timestamp` meta field mapper properly configured.

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • toXContent

      public org.opensearch.common.xcontent.XContentBuilder toXContent​(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.opensearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • fromXContent

      public static ComposableIndexTemplate.DataStreamTemplate fromXContent​(org.opensearch.common.xcontent.XContentParser parser)

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object