Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.textstructure.structurefinder

Class TextStructure

java.lang.Object

org.elasticsearch.xpack.core.textstructure.structurefinder.TextStructure

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class TextStructure
extends Object
implements ToXContentObject, Writeable

Stores the determined file format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TextStructure.Builder
static enum	TextStructure.Format

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	CHARSET
static final ParseField	COLUMN_NAMES
static final ParseField	DELIMITER
static final ParseField	ECS_COMPATIBILITY
static final ParseField	EXCLUDE_LINES_PATTERN
static final String	EXPLAIN
static final ParseField	EXPLANATION
static final ParseField	FIELD_STATS
static final ParseField	FORMAT
static final ParseField	GROK_PATTERN
static final ParseField	HAS_BYTE_ORDER_MARKER
static final ParseField	HAS_HEADER_ROW
static final ParseField	INGEST_PIPELINE
static final ParseField	JAVA_TIMESTAMP_FORMATS
static final ParseField	JODA_TIMESTAMP_FORMATS
static final ParseField	MAPPINGS
static final ParseField	MULTILINE_START_PATTERN
static final ParseField	NEED_CLIENT_TIMEZONE
static final ParseField	NUM_LINES_ANALYZED
static final ParseField	NUM_MESSAGES_ANALYZED
static final ObjectParser<TextStructure.Builder,Void>	PARSER
static final ParseField	QUOTE
static final ParseField	SAMPLE_START
static final ParseField	SHOULD_TRIM_FIELDS
static final ParseField	TIMESTAMP_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TextStructure(int numLinesAnalyzed, int numMessagesAnalyzed, String sampleStart, String charset, Boolean hasByteOrderMarker, TextStructure.Format format, String multilineStartPattern, String excludeLinesPattern, List<String> columnNames, Boolean hasHeaderRow, Character delimiter, Character quote, Boolean shouldTrimFields, String grokPattern, String ecsCompatibility, String timestampField, List<String> jodaTimestampFormats, List<String> javaTimestampFormats, boolean needClientTimezone, Map<String,Object> mappings, Map<String,Object> ingestPipeline, Map<String,FieldStats> fieldStats, List<String> explanation)
TextStructure(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
String	getCharset()
List<String>	getColumnNames()
Character	getDelimiter()
String	getEcsCompatibility()
String	getExcludeLinesPattern()
List<String>	getExplanation()
SortedMap<String,FieldStats>	getFieldStats()
TextStructure.Format	getFormat()
String	getGrokPattern()
Boolean	getHasByteOrderMarker()
Boolean	getHasHeaderRow()
Map<String,Object>	getIngestPipeline()
List<String>	getJavaTimestampFormats()
List<String>	getJodaTimestampFormats()
SortedMap<String,Object>	getMappings()
String	getMultilineStartPattern()
int	getNumLinesAnalyzed()
int	getNumMessagesAnalyzed()
Character	getQuote()
String	getSampleStart()
Boolean	getShouldTrimFields()
String	getTimestampField()
int	hashCode()
boolean	needClientTimezone()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

EXPLAIN

public static final String EXPLAIN

See Also:

• Constant Field Values

NUM_LINES_ANALYZED

public static final ParseField NUM_LINES_ANALYZED

NUM_MESSAGES_ANALYZED

public static final ParseField NUM_MESSAGES_ANALYZED

SAMPLE_START

public static final ParseField SAMPLE_START

CHARSET

public static final ParseField CHARSET

HAS_BYTE_ORDER_MARKER

public static final ParseField HAS_BYTE_ORDER_MARKER

FORMAT

public static final ParseField FORMAT

MULTILINE_START_PATTERN

public static final ParseField MULTILINE_START_PATTERN

EXCLUDE_LINES_PATTERN

public static final ParseField EXCLUDE_LINES_PATTERN

COLUMN_NAMES

public static final ParseField COLUMN_NAMES

HAS_HEADER_ROW

public static final ParseField HAS_HEADER_ROW

DELIMITER

public static final ParseField DELIMITER

QUOTE

public static final ParseField QUOTE

SHOULD_TRIM_FIELDS

public static final ParseField SHOULD_TRIM_FIELDS

GROK_PATTERN

public static final ParseField GROK_PATTERN

ECS_COMPATIBILITY

public static final ParseField ECS_COMPATIBILITY

TIMESTAMP_FIELD

public static final ParseField TIMESTAMP_FIELD

JODA_TIMESTAMP_FORMATS

public static final ParseField JODA_TIMESTAMP_FORMATS

JAVA_TIMESTAMP_FORMATS

public static final ParseField JAVA_TIMESTAMP_FORMATS

NEED_CLIENT_TIMEZONE

public static final ParseField NEED_CLIENT_TIMEZONE

MAPPINGS

public static final ParseField MAPPINGS

INGEST_PIPELINE

public static final ParseField INGEST_PIPELINE

FIELD_STATS

public static final ParseField FIELD_STATS

EXPLANATION

public static final ParseField EXPLANATION

PARSER

public static final ObjectParser<TextStructure.Builder,Void> PARSER

Constructor Details

TextStructure

public TextStructure(int numLinesAnalyzed,
 int numMessagesAnalyzed,
 String sampleStart,
 String charset,
 Boolean hasByteOrderMarker,
 TextStructure.Format format,
 String multilineStartPattern,
 String excludeLinesPattern,
 List<String> columnNames,
 Boolean hasHeaderRow,
 Character delimiter,
 Character quote,
 Boolean shouldTrimFields,
 String grokPattern,
 String ecsCompatibility,
 String timestampField,
 List<String> jodaTimestampFormats,
 List<String> javaTimestampFormats,
 boolean needClientTimezone,
 Map<String,Object> mappings,
 Map<String,Object> ingestPipeline,
 Map<String,FieldStats> fieldStats,
 List<String> explanation)

TextStructure

public TextStructure(StreamInput in)
              throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getNumLinesAnalyzed

public int getNumLinesAnalyzed()

getNumMessagesAnalyzed

public int getNumMessagesAnalyzed()

getSampleStart

public String getSampleStart()

getCharset

public String getCharset()

getHasByteOrderMarker

public Boolean getHasByteOrderMarker()

getFormat

public TextStructure.Format getFormat()

getMultilineStartPattern

public String getMultilineStartPattern()

getExcludeLinesPattern

public String getExcludeLinesPattern()

getColumnNames

public List<String> getColumnNames()

getHasHeaderRow

public Boolean getHasHeaderRow()

getDelimiter

public Character getDelimiter()

getQuote

public Character getQuote()

getShouldTrimFields

public Boolean getShouldTrimFields()

getGrokPattern

public String getGrokPattern()

getEcsCompatibility

public String getEcsCompatibility()

getTimestampField

public String getTimestampField()

getJodaTimestampFormats

public List<String> getJodaTimestampFormats()

getJavaTimestampFormats

public List<String> getJavaTimestampFormats()

needClientTimezone

public boolean needClientTimezone()

getMappings

public SortedMap<String,Object> getMappings()

getIngestPipeline

public Map<String,Object> getIngestPipeline()

getFieldStats

public SortedMap<String,FieldStats> getFieldStats()

getExplanation

public List<String> getExplanation()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object