Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.inference.action

Class GetInferenceFieldsInternalAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.xpack.core.inference.action.GetInferenceFieldsInternalAction.Request

All Implemented Interfaces:

IndicesRequest, IndicesRequest.CrossProjectCandidate, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest, TransportRequest

Enclosing class:

GetInferenceFieldsInternalAction

public static class GetInferenceFieldsInternalAction.Request
extends ActionRequest
implements IndicesRequest.Replaceable

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.CrossProjectCandidate, IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcards

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

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

Field Summary

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
Request(String[] indices, Map<String,Float> fields, boolean resolveWildcards, boolean useDefaultFields, String query)	An overload of Request(String[], Map, boolean, boolean, String, IndicesOptions) that uses IndicesOptions.DEFAULT
Request(String[] indices, Map<String,Float> fields, boolean resolveWildcards, boolean useDefaultFields, String query, IndicesOptions indicesOptions)	Constructs a request to get inference fields.
Request(String[] indices, Map<String,Float> fields, boolean resolveWildcards, boolean useDefaultFields, InferenceStringGroup input, IndicesOptions indicesOptions)	Constructs a request to get inference fields with a rich input that may include non-text data (e.g.
Request(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,Float>	fields()
int	hashCode()
boolean	includeDataStreams()
String[]	indices()
GetInferenceFieldsInternalAction.Request	indices(String... indices)
IndicesOptions	indicesOptions()
InferenceStringGroup	input()
boolean	resolveWildcards()
boolean	useDefaultFields()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest.CrossProjectCandidate

allowsCrossProject, getProjectRouting, getResolvedTargetProjects, setResolvedTargetProjects

Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable

allowsRemoteIndices, getResolvedIndexExpressions, setResolvedIndexExpressions

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Constructor Details

Request

public Request(String[] indices,
 Map<String,Float> fields,
 boolean resolveWildcards,
 boolean useDefaultFields,
 @Nullable
 String query)

An overload of Request(String[], Map, boolean, boolean, String, IndicesOptions) that uses IndicesOptions.DEFAULT

Request

public Request(String[] indices,
 Map<String,Float> fields,
 boolean resolveWildcards,
 boolean useDefaultFields,
 @Nullable
 String query,
 @Nullable
 IndicesOptions indicesOptions)

Constructs a request to get inference fields.

If useDefaultFields is true and fields is empty, then the field pattern map will be derived from the value of IndexSettings.DEFAULT_FIELD_SETTING for each index.

If query is null, then no inference results will be generated. This can be useful in scenarios where the caller only needs to check for the existence of inference fields.

Parameters:

indices - The indices to get inference fields for.

fields - The field pattern map, where the key is the field pattern and the value is the pattern weight.

resolveWildcards - If true, wildcards in field patterns will be resolved. Otherwise, only explicit matches will be returned.

useDefaultFields - If true, default fields will be used if fields is empty.

query - The text query to generate inference results for.

indicesOptions - The IndicesOptions to use when resolving indices.

Request

public Request(String[] indices,
 Map<String,Float> fields,
 boolean resolveWildcards,
 boolean useDefaultFields,
 @Nullable
 InferenceStringGroup input,
 @Nullable
 IndicesOptions indicesOptions)

Constructs a request to get inference fields with a rich input that may include non-text data (e.g. images).

Parameters:

indices - The indices to get inference fields for.

fields - The field pattern map, where the key is the field pattern and the value is the pattern weight.

resolveWildcards - If true, wildcards in field patterns will be resolved. Otherwise, only explicit matches will be returned.

useDefaultFields - If true, default fields will be used if fields is empty.

input - The input to generate inference results for. May contain non-text data such as images.

indicesOptions - The IndicesOptions to use when resolving indices.

Request

public Request(StreamInput in)
        throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

indices

public GetInferenceFieldsInternalAction.Request indices(String... indices)

Specified by:

indices in interface IndicesRequest.Replaceable

indices

public String[] indices()

Specified by:

indices in interface IndicesRequest

fields

public Map<String,Float> fields()

resolveWildcards

public boolean resolveWildcards()

useDefaultFields

public boolean useDefaultFields()

input

@Nullable
public InferenceStringGroup input()

indicesOptions

public IndicesOptions indicesOptions()

Specified by:

indicesOptions in interface IndicesRequest

includeDataStreams

public boolean includeDataStreams()

Specified by:

includeDataStreams in interface IndicesRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object