Package org.elasticsearch.client.graph
Class VertexRequest
java.lang.Object
org.elasticsearch.client.graph.VertexRequest
- All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
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.Params
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addExclude
(String term) Adds a term that should be excluded from resultsvoid
addInclude
(String term, float boost) Adds a term to the set of allowed values - the boost defines the relative importance when pursuing connections in subsequentHop
s.String[]
boolean
boolean
String[]
int
minDocCount
(int value) A "certainty" threshold which defines the weight-of-evidence required before a term found in this field is identified as a useful connectionint
shardMinDocCount
(int value) A "certainty" threshold which defines the weight-of-evidence required before a term found in this field is identified as a useful connectionint
size()
size
(int size) org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods 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
-
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 subsequentHop
s. The boost value appears as part of the query.- Parameters:
term
- a required termboost
- an optional boost
-
includeValues
-
includeValuesAsStringArray
-
excludesAsArray
-
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:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-