java.lang.Object
org.elasticsearch.protocol.xpack.graph.VertexRequest
- All Implemented Interfaces:
Writeable,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject
public class VertexRequest
extends Object
implements org.elasticsearch.xcontent.ToXContentObject, Writeable
A request to identify terms from a choice of field as part of a
Hop.
Optionally, a set of terms can be provided that are used as an exclusion or
inclusion list to filter which terms are considered.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddExclude(String term) Adds a term that should be excluded from resultsvoidaddInclude(String term, float boost) Adds a term to the set of allowed values - the boost defines the relative importance when pursuing connections in subsequentHops.SortedSet<org.apache.lucene.util.BytesRef> booleanbooleanSortedSet<org.apache.lucene.util.BytesRef> intminDocCount(int value) A "certainty" threshold which defines the weight-of-evidence required before a term found in this field is identified as a useful connectionintshardMinDocCount(int value) A "certainty" threshold which defines the weight-of-evidence required before a term found in this field is identified as a useful connectionintsize()size(int size) org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
DEFAULT_SIZE
public static final int DEFAULT_SIZE- See Also:
-
DEFAULT_MIN_DOC_COUNT
public static final int DEFAULT_MIN_DOC_COUNT- See Also:
-
DEFAULT_SHARD_MIN_DOC_COUNT
public static final int DEFAULT_SHARD_MIN_DOC_COUNT- See Also:
-
-
Constructor Details
-
VertexRequest
public VertexRequest()
-
-
Method Details
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
fieldName
-
fieldName
-
size
public int size() -
size
- Parameters:
size- The maximum number of terms that should be returned from this field as part of thisHop
-
hasIncludeClauses
public boolean hasIncludeClauses() -
hasExcludeClauses
public boolean hasExcludeClauses() -
addExclude
Adds a term that should be excluded from results- Parameters:
term- A term to be excluded
-
addInclude
Adds a term to the set of allowed values - the boost defines the relative importance when pursuing connections in subsequentHops. The boost value appears as part of the query.- Parameters:
term- a required termboost- an optional boost
-
includeValues
-
includeValuesAsSortedSet
-
excludesAsSortedSet
-
minDocCount
public int minDocCount() -
minDocCount
A "certainty" threshold which defines the weight-of-evidence required before a term found in this field is identified as a useful connection- Parameters:
value- The minimum number of documents that contain this term found in the samples used across all shards
-
shardMinDocCount
public int shardMinDocCount() -
shardMinDocCount
A "certainty" threshold which defines the weight-of-evidence required before a term found in this field is identified as a useful connection- Parameters:
value- The minimum number of documents that contain this term found in the samples used across all shards
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-