Class FindStructureRequest

java.lang.Object
org.elasticsearch.client.textstructure.FindStructureRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

public class FindStructureRequest
extends java.lang.Object
implements Validatable, org.elasticsearch.common.xcontent.ToXContentFragment
  • Nested Class Summary

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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
  • Field Summary

    Fields
    Modifier and Type Field Description
    static org.elasticsearch.common.ParseField CHARSET  
    static org.elasticsearch.common.ParseField COLUMN_NAMES  
    static org.elasticsearch.common.ParseField DELIMITER  
    static org.elasticsearch.common.ParseField EXPLAIN  
    static org.elasticsearch.common.ParseField FORMAT  
    static org.elasticsearch.common.ParseField GROK_PATTERN  
    static org.elasticsearch.common.ParseField HAS_HEADER_ROW  
    static org.elasticsearch.common.ParseField LINE_MERGE_SIZE_LIMIT  
    static org.elasticsearch.common.ParseField LINES_TO_SAMPLE  
    static org.elasticsearch.common.ParseField QUOTE  
    static org.elasticsearch.common.ParseField SHOULD_TRIM_FIELDS  
    static org.elasticsearch.common.ParseField TIMEOUT  
    static org.elasticsearch.common.ParseField TIMESTAMP_FIELD  
    static org.elasticsearch.common.ParseField TIMESTAMP_FORMAT  

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

    EMPTY_PARAMS

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY
  • Constructor Summary

    Constructors
    Constructor Description
    FindStructureRequest()  
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object other)  
    java.lang.String getCharset()  
    java.util.List<java.lang.String> getColumnNames()  
    java.lang.Character getDelimiter()  
    java.lang.Boolean getExplain()  
    TextStructure.Format getFormat()  
    java.lang.String getGrokPattern()  
    java.lang.Boolean getHasHeaderRow()  
    java.lang.Integer getLineMergeSizeLimit()  
    java.lang.Integer getLinesToSample()  
    java.lang.Character getQuote()  
    org.elasticsearch.common.bytes.BytesReference getSample()  
    java.lang.Boolean getShouldTrimFields()  
    org.elasticsearch.common.unit.TimeValue getTimeout()  
    java.lang.String getTimestampField()  
    java.lang.String getTimestampFormat()  
    int hashCode()  
    void setCharset​(java.lang.String charset)  
    void setColumnNames​(java.lang.String[] columnNames)  
    void setColumnNames​(java.util.List<java.lang.String> columnNames)  
    void setDelimiter​(java.lang.Character delimiter)  
    void setDelimiter​(java.lang.String delimiter)  
    void setExplain​(java.lang.Boolean explain)  
    void setFormat​(java.lang.String format)  
    void setFormat​(TextStructure.Format format)  
    void setGrokPattern​(java.lang.String grokPattern)  
    void setHasHeaderRow​(java.lang.Boolean hasHeaderRow)  
    void setLineMergeSizeLimit​(java.lang.Integer lineMergeSizeLimit)  
    void setLinesToSample​(java.lang.Integer linesToSample)  
    void setQuote​(java.lang.Character quote)  
    void setQuote​(java.lang.String quote)  
    void setSample​(byte[] sample)  
    void setSample​(org.elasticsearch.common.bytes.BytesReference sample)  
    void setShouldTrimFields​(java.lang.Boolean shouldTrimFields)  
    void setTimeout​(org.elasticsearch.common.unit.TimeValue timeout)  
    void setTimestampField​(java.lang.String timestampField)  
    void setTimestampFormat​(java.lang.String timestampFormat)  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    java.util.Optional<ValidationException> validate()
    Perform validation.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

    isFragment
  • Field Details

    • LINES_TO_SAMPLE

      public static final org.elasticsearch.common.ParseField LINES_TO_SAMPLE
    • LINE_MERGE_SIZE_LIMIT

      public static final org.elasticsearch.common.ParseField LINE_MERGE_SIZE_LIMIT
    • TIMEOUT

      public static final org.elasticsearch.common.ParseField TIMEOUT
    • CHARSET

      public static final org.elasticsearch.common.ParseField CHARSET
    • FORMAT

      public static final org.elasticsearch.common.ParseField FORMAT
    • COLUMN_NAMES

      public static final org.elasticsearch.common.ParseField COLUMN_NAMES
    • HAS_HEADER_ROW

      public static final org.elasticsearch.common.ParseField HAS_HEADER_ROW
    • DELIMITER

      public static final org.elasticsearch.common.ParseField DELIMITER
    • QUOTE

      public static final org.elasticsearch.common.ParseField QUOTE
    • SHOULD_TRIM_FIELDS

      public static final org.elasticsearch.common.ParseField SHOULD_TRIM_FIELDS
    • GROK_PATTERN

      public static final org.elasticsearch.common.ParseField GROK_PATTERN
    • TIMESTAMP_FORMAT

      public static final org.elasticsearch.common.ParseField TIMESTAMP_FORMAT
    • TIMESTAMP_FIELD

      public static final org.elasticsearch.common.ParseField TIMESTAMP_FIELD
    • EXPLAIN

      public static final org.elasticsearch.common.ParseField EXPLAIN
  • Constructor Details

    • FindStructureRequest

      public FindStructureRequest()
  • Method Details

    • getLinesToSample

      public java.lang.Integer getLinesToSample()
    • setLinesToSample

      public void setLinesToSample​(java.lang.Integer linesToSample)
    • getLineMergeSizeLimit

      public java.lang.Integer getLineMergeSizeLimit()
    • setLineMergeSizeLimit

      public void setLineMergeSizeLimit​(java.lang.Integer lineMergeSizeLimit)
    • getTimeout

      public org.elasticsearch.common.unit.TimeValue getTimeout()
    • setTimeout

      public void setTimeout​(org.elasticsearch.common.unit.TimeValue timeout)
    • getCharset

      public java.lang.String getCharset()
    • setCharset

      public void setCharset​(java.lang.String charset)
    • getFormat

      public TextStructure.Format getFormat()
    • setFormat

      public void setFormat​(TextStructure.Format format)
    • setFormat

      public void setFormat​(java.lang.String format)
    • getColumnNames

      public java.util.List<java.lang.String> getColumnNames()
    • setColumnNames

      public void setColumnNames​(java.util.List<java.lang.String> columnNames)
    • setColumnNames

      public void setColumnNames​(java.lang.String[] columnNames)
    • getHasHeaderRow

      public java.lang.Boolean getHasHeaderRow()
    • setHasHeaderRow

      public void setHasHeaderRow​(java.lang.Boolean hasHeaderRow)
    • getDelimiter

      public java.lang.Character getDelimiter()
    • setDelimiter

      public void setDelimiter​(java.lang.Character delimiter)
    • setDelimiter

      public void setDelimiter​(java.lang.String delimiter)
    • getQuote

      public java.lang.Character getQuote()
    • setQuote

      public void setQuote​(java.lang.Character quote)
    • setQuote

      public void setQuote​(java.lang.String quote)
    • getShouldTrimFields

      public java.lang.Boolean getShouldTrimFields()
    • setShouldTrimFields

      public void setShouldTrimFields​(java.lang.Boolean shouldTrimFields)
    • getGrokPattern

      public java.lang.String getGrokPattern()
    • setGrokPattern

      public void setGrokPattern​(java.lang.String grokPattern)
    • getTimestampFormat

      public java.lang.String getTimestampFormat()
    • setTimestampFormat

      public void setTimestampFormat​(java.lang.String timestampFormat)
    • getTimestampField

      public java.lang.String getTimestampField()
    • setTimestampField

      public void setTimestampField​(java.lang.String timestampField)
    • getExplain

      public java.lang.Boolean getExplain()
    • setExplain

      public void setExplain​(java.lang.Boolean explain)
    • getSample

      public org.elasticsearch.common.bytes.BytesReference getSample()
    • setSample

      public void setSample​(byte[] sample)
    • setSample

      public void setSample​(org.elasticsearch.common.bytes.BytesReference sample)
    • validate

      public java.util.Optional<ValidationException> validate()
      Description copied from interface: Validatable
      Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. A ValidationException that is not null is assumed to contain validation errors and will be thrown.
      Specified by:
      validate in interface Validatable
      Returns:
      An Optional ValidationException that contains a list of validation errors.
    • toXContent

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

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

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