Package org.elasticsearch.client.dataframe.transforms

Class DataFrameTransformConfig

java.lang.Object

org.elasticsearch.client.dataframe.transforms.DataFrameTransformConfig

All Implemented Interfaces:

ToXContent, ToXContentObject

public class DataFrameTransformConfig
extends java.lang.Object
implements ToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataFrameTransformConfig.Builder

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	DESCRIPTION
static ParseField	DEST
static ParseField	ID
static ConstructingObjectParser<DataFrameTransformConfig,java.lang.Void>	PARSER
static ParseField	PIVOT_TRANSFORM
static ParseField	SOURCE

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
static DataFrameTransformConfig.Builder	builder()
boolean	equals(java.lang.Object other)
static DataFrameTransformConfig	forPreview(SourceConfig source, PivotConfig pivotConfig)	Helper method for previewing a data frame transform configuration The DataFrameTransformConfig returned from this method should only be used for previewing the resulting data.
static DataFrameTransformConfig	fromXContent(XContentParser parser)
java.lang.String	getDescription()
DestConfig	getDestination()
java.lang.String	getId()
PivotConfig	getPivotConfig()
SourceConfig	getSource()
int	hashCode()
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

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

isFragment

Field Detail

ID

public static final ParseField ID

SOURCE

public static final ParseField SOURCE

DEST

public static final ParseField DEST

DESCRIPTION

public static final ParseField DESCRIPTION

PIVOT_TRANSFORM

public static final ParseField PIVOT_TRANSFORM

PARSER

public static final ConstructingObjectParser<DataFrameTransformConfig,java.lang.Void> PARSER

Method Detail

fromXContent

public static DataFrameTransformConfig fromXContent(XContentParser parser)

forPreview

public static DataFrameTransformConfig forPreview(SourceConfig source,
                                                  PivotConfig pivotConfig)

Helper method for previewing a data frame transform configuration The DataFrameTransformConfig returned from this method should only be used for previewing the resulting data. A new, valid, DataFrameTransformConfig with an appropriate destination and ID will have to be constructed to create the transform.

Parameters:

source - Source configuration for gathering the data

pivotConfig - Pivot config to preview

Returns:

A DataFrameTransformConfig to preview, NOTE it will have a null id, destination and index.

getId

public java.lang.String getId()

getSource

public SourceConfig getSource()

getDestination

public DestConfig getDestination()

getPivotConfig

public PivotConfig getPivotConfig()

getDescription

@Nullable
public java.lang.String getDescription()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static DataFrameTransformConfig.Builder builder()