Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.transform.transforms

Class SourceConfig

java.lang.Object

org.elasticsearch.xpack.core.transform.transforms.SourceConfig

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class SourceConfig
extends Object
implements Writeable, ToXContentObject

Nested Class Summary

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	INDEX
static final ConstructingObjectParser<SourceConfig,TransformParsingContext>	LENIENT_PARSER
static final ParseField	PROJECT_ROUTING
static final ParseField	QUERY
static final ConstructingObjectParser<SourceConfig,TransformParsingContext>	STRICT_PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SourceConfig(String... index)	Create a new SourceConfig for the provided indices.
SourceConfig(String[] index, QueryConfig queryConfig, Map<String,Object> runtimeMappings, String projectRouting)	Create a new SourceConfig for the provided indices, from which data is gathered with the provided QueryConfig
SourceConfig(String[] index, QueryConfig queryConfig, Map<String,Object> runtimeMappings, IndicesOptions indicesOptions, String projectRouting)	Create a new SourceConfig for the provided indices, from which data is gathered with the provided QueryConfig
SourceConfig(StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	checkForDeprecations(String id, NamedXContentRegistry namedXContentRegistry, Consumer<DeprecationIssue> onDeprecation)
boolean	equals(Object other)
static SourceConfig	fromXContent(XContentParser parser, boolean lenient, TransformParsingContext context)
String[]	getIndex()
String	getProjectRouting()
QueryConfig	getQueryConfig()
Map<String,Object>	getRuntimeMappings()
Map<String,Object>	getScriptBasedRuntimeMappings()
int	hashCode()
IndicesOptions	indicesOptions()
boolean	requiresRemoteCluster()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate(ActionRequestValidationException validationException)
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

QUERY

public static final ParseField QUERY

INDEX

public static final ParseField INDEX

PROJECT_ROUTING

public static final ParseField PROJECT_ROUTING

STRICT_PARSER

public static final ConstructingObjectParser<SourceConfig,TransformParsingContext> STRICT_PARSER

LENIENT_PARSER

public static final ConstructingObjectParser<SourceConfig,TransformParsingContext> LENIENT_PARSER

Constructor Details

SourceConfig

public SourceConfig(String... index)

Create a new SourceConfig for the provided indices. QueryConfig defaults to a MatchAll query.

Parameters:

index - Any number of indices. At least one non-null, non-empty, index should be provided

SourceConfig

public SourceConfig(String[] index,
 QueryConfig queryConfig,
 Map<String,Object> runtimeMappings,
 @Nullable
 String projectRouting)

Create a new SourceConfig for the provided indices, from which data is gathered with the provided QueryConfig

Parameters:

index - Any number of indices. At least one non-null, non-empty, index should be provided

queryConfig - A QueryConfig object that contains the desired query, needs to be non-null

runtimeMappings - Search-time runtime fields that can be used by the transform

projectRouting - filter for cross-project search, null when cross-project search is disabled

SourceConfig

public SourceConfig(String[] index,
 QueryConfig queryConfig,
 Map<String,Object> runtimeMappings,
 IndicesOptions indicesOptions,
 @Nullable
 String projectRouting)

Create a new SourceConfig for the provided indices, from which data is gathered with the provided QueryConfig

Parameters:

index - Any number of indices. At least one non-null, non-empty, index should be provided

queryConfig - A QueryConfig object that contains the desired query, needs to be non-null

runtimeMappings - Search-time runtime fields that can be used by the transform

indicesOptions - IndicesOptions to use when searching the index

projectRouting - filter for cross-project search, null when cross-project search is disabled

SourceConfig

public SourceConfig(StreamInput in)
             throws IOException

Throws:

IOException

Method Details

getIndex

public String[] getIndex()

getQueryConfig

public QueryConfig getQueryConfig()

getRuntimeMappings

public Map<String,Object> getRuntimeMappings()

getScriptBasedRuntimeMappings

public Map<String,Object> getScriptBasedRuntimeMappings()

getProjectRouting

@Nullable
public String getProjectRouting()

indicesOptions

public IndicesOptions indicesOptions()

validate

public ActionRequestValidationException validate(ActionRequestValidationException validationException)

checkForDeprecations

public void checkForDeprecations(String id,
 NamedXContentRegistry namedXContentRegistry,
 Consumer<DeprecationIssue> onDeprecation)

requiresRemoteCluster

public boolean requiresRemoteCluster()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

fromXContent

public static SourceConfig fromXContent(XContentParser parser,
 boolean lenient,
 TransformParsingContext context)
                                 throws IOException

Throws:

IOException