CompletionSuggestion.Entry.Option

java.lang.Object
- org.elasticsearch.search.suggest.Suggest.Suggestion.Entry.Option
- - org.elasticsearch.search.suggest.completion.CompletionSuggestion.Entry.Option

All Implemented Interfaces:: Streamable, ToXContent

Enclosing class:: CompletionSuggestion.Entry

public static class CompletionSuggestion.Entry.Option
extends Suggest.Suggestion.Entry.Option

Nested Class Summary
- Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary
- Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
  EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
`protected`	`Option()`
	`Option(Text text, float score, BytesReference payload)`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`BytesReference`	`getPayload()`
`double`	`getPayloadAsDouble()`
`long`	`getPayloadAsLong()`
`Map<String,Object>`	`getPayloadAsMap()`
`String`	`getPayloadAsString()`
`protected XContentBuilder`	`innerToXContent(XContentBuilder builder, ToXContent.Params params)`
`void`	`readFrom(StreamInput in)`
`void`	`setPayload(BytesReference payload)`
`void`	`setScore(float score)`
`void`	`writeTo(StreamOutput out)`

Methods inherited from class org.elasticsearch.search.suggest.Suggest.Suggestion.Entry.Option
collateMatch, equals, getHighlighted, getScore, getText, hashCode, mergeInto, toXContent

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Option

public Option(Text text,
              float score,
              BytesReference payload)

Option
```
protected Option()
```

Method Detail

setPayload

public void setPayload(BytesReference payload)

getPayload
```
public BytesReference getPayload()
```

getPayloadAsString
```
public String getPayloadAsString()
```

getPayloadAsLong
```
public long getPayloadAsLong()
```

getPayloadAsDouble
```
public double getPayloadAsDouble()
```

getPayloadAsMap

public Map<String,Object> getPayloadAsMap()

setScore
```
public void setScore(float score)
```

innerToXContent

protected XContentBuilder innerToXContent(XContentBuilder builder,
                                          ToXContent.Params params)
                                   throws IOException

Overrides:: innerToXContent in class Suggest.Suggestion.Entry.Option
Throws:: IOException

readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class Suggest.Suggestion.Entry.Option

Throws:

IOException

writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class Suggest.Suggestion.Entry.Option

Throws:

IOException

Class CompletionSuggestion.Entry.Option

Nested Class Summary

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

Field Summary

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

Constructor Summary

Constructors

Method Summary

Methods inherited from class org.elasticsearch.search.suggest.Suggest.Suggestion.Entry.Option

Methods inherited from class java.lang.Object

Constructor Detail

Option

Option

Method Detail

setPayload

getPayload

getPayloadAsString

getPayloadAsLong

getPayloadAsDouble

getPayloadAsMap

setScore

innerToXContent

readFrom

writeTo