java.lang.Object

co.elastic.clients.elasticsearch.core.search.InnerHits.Builder

All Implemented Interfaces:: ObjectBuilder<InnerHits>

Enclosing class:: InnerHits

public static class InnerHits.Builder
extends java.lang.Object
implements ObjectBuilder<InnerHits>

Builder for InnerHits.

Constructor Summary

Constructors

Constructor Description

Builder()

Method Summary

Modifier and Type	Method	Description
`InnerHits.Builder`	`addDocvalueFields(FieldAndFormat value)`	Add a value to `docvalueFields(List)`, creating the list if needed.
`InnerHits.Builder`	`addDocvalueFields(java.util.function.Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)`	Add a value to `docvalueFields(List)`, creating the list if needed.
`InnerHits.Builder`	`addFields(java.lang.String value)`	Add a value to `fields(List)`, creating the list if needed.
`InnerHits.Builder`	`addSort(jakarta.json.JsonValue value)`	Add a value to `sort(List)`, creating the list if needed.
`InnerHits.Builder`	`addStoredField(java.lang.String value)`	Add a value to `storedField(List)`, creating the list if needed.
`InnerHits`	`build()`	Builds a `InnerHits`.
`InnerHits.Builder`	`collapse(FieldCollapse value)`	API name: `collapse`
`InnerHits.Builder`	`collapse(java.util.function.Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)`	API name: `collapse`
`InnerHits.Builder`	`docvalueFields(FieldAndFormat... value)`	API name: `docvalue_fields`
`InnerHits.Builder`	`docvalueFields(java.util.function.Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)`	Set `docvalueFields(List)` to a singleton list.
`InnerHits.Builder`	`docvalueFields(java.util.List<FieldAndFormat> value)`	API name: `docvalue_fields`
`InnerHits.Builder`	`explain(java.lang.Boolean value)`	API name: `explain`
`InnerHits.Builder`	`fields(java.lang.String... value)`	API name: `fields`
`InnerHits.Builder`	`fields(java.util.List<java.lang.String> value)`	API name: `fields`
`InnerHits.Builder`	`from(java.lang.Integer value)`	API name: `from`
`InnerHits.Builder`	`highlight(Highlight value)`	API name: `highlight`
`InnerHits.Builder`	`highlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)`	API name: `highlight`
`InnerHits.Builder`	`ignoreUnmapped(java.lang.Boolean value)`	API name: `ignore_unmapped`
`InnerHits.Builder`	`name(java.lang.String value)`	API name: `name`
`InnerHits.Builder`	`putScriptFields(java.lang.String key, ScriptField value)`	Add a key/value to `scriptFields(Map)`, creating the map if needed.
`InnerHits.Builder`	`putScriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)`	Add a key/value to `scriptFields(Map)`, creating the map if needed.
`InnerHits.Builder`	`scriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)`	Set `scriptFields(Map)` to a singleton map.
`InnerHits.Builder`	`scriptFields(java.util.Map<java.lang.String,ScriptField> value)`	API name: `script_fields`
`InnerHits.Builder`	`seqNoPrimaryTerm(java.lang.Boolean value)`	API name: `seq_no_primary_term`
`InnerHits.Builder`	`size(java.lang.Integer value)`	API name: `size`
`InnerHits.Builder`	`sort(jakarta.json.JsonValue... value)`	API name: `sort`
`InnerHits.Builder`	`sort(java.util.List<jakarta.json.JsonValue> value)`	API name: `sort`
`InnerHits.Builder`	`source(jakarta.json.JsonValue value)`	API name: `_source`
`InnerHits.Builder`	`storedField(java.lang.String... value)`	API name: `stored_field`
`InnerHits.Builder`	`storedField(java.util.List<java.lang.String> value)`	API name: `stored_field`
`InnerHits.Builder`	`trackScores(java.lang.Boolean value)`	API name: `track_scores`
`InnerHits.Builder`	`version(java.lang.Boolean value)`	API name: `version`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Builder
  
  public Builder()
Method Details
- name
  
  public InnerHits.Builder name(@Nullable java.lang.String value)
  
  API name: name
- size
  
  public InnerHits.Builder size(@Nullable java.lang.Integer value)
  
  API name: size
- from
  
  public InnerHits.Builder from(@Nullable java.lang.Integer value)
  
  API name: from
- collapse
  
  public InnerHits.Builder collapse(@Nullable FieldCollapse value)
  
  API name: collapse
- collapse
  
  public InnerHits.Builder collapse(java.util.function.Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)
  
  API name: collapse
- docvalueFields
  
  public InnerHits.Builder docvalueFields(@Nullable java.util.List<FieldAndFormat> value)
  
  API name: docvalue_fields
- docvalueFields
  
  public InnerHits.Builder docvalueFields(FieldAndFormat... value)
  
  API name: docvalue_fields
- addDocvalueFields
  
  public InnerHits.Builder addDocvalueFields(FieldAndFormat value)
  
  Add a value to docvalueFields(List), creating the list if needed.
- docvalueFields
  
  public InnerHits.Builder docvalueFields(java.util.function.Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)
  
  Set docvalueFields(List) to a singleton list.
- addDocvalueFields
  
  public InnerHits.Builder addDocvalueFields(java.util.function.Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)
  
  Add a value to docvalueFields(List), creating the list if needed.
- explain
  
  public InnerHits.Builder explain(@Nullable java.lang.Boolean value)
  
  API name: explain
- highlight
  
  public InnerHits.Builder highlight(@Nullable Highlight value)
  
  API name: highlight
- highlight
  
  public InnerHits.Builder highlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)
  
  API name: highlight
- ignoreUnmapped
  
  public InnerHits.Builder ignoreUnmapped(@Nullable java.lang.Boolean value)
  
  API name: ignore_unmapped
- scriptFields
  
  public InnerHits.Builder scriptFields(@Nullable java.util.Map<java.lang.String,ScriptField> value)
  
  API name: script_fields
- putScriptFields
  
  public InnerHits.Builder putScriptFields(java.lang.String key, ScriptField value)
  
  Add a key/value to scriptFields(Map), creating the map if needed.
- scriptFields
  
  public InnerHits.Builder scriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)
  
  Set scriptFields(Map) to a singleton map.
- putScriptFields
  
  public InnerHits.Builder putScriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)
  
  Add a key/value to scriptFields(Map), creating the map if needed.
- seqNoPrimaryTerm
  
  public InnerHits.Builder seqNoPrimaryTerm(@Nullable java.lang.Boolean value)
  
  API name: seq_no_primary_term
- fields
  
  public InnerHits.Builder fields(@Nullable java.util.List<java.lang.String> value)
  
  API name: fields
- fields
  
  public InnerHits.Builder fields(java.lang.String... value)
  
  API name: fields
- addFields
  
  public InnerHits.Builder addFields(java.lang.String value)
  
  Add a value to fields(List), creating the list if needed.
- sort
  
  public InnerHits.Builder sort(@Nullable java.util.List<jakarta.json.JsonValue> value)
  
  API name: sort
- sort
  
  public InnerHits.Builder sort(jakarta.json.JsonValue... value)
  
  API name: sort
- addSort
  
  public InnerHits.Builder addSort(jakarta.json.JsonValue value)
  
  Add a value to sort(List), creating the list if needed.
- source
  
  public InnerHits.Builder source(@Nullable jakarta.json.JsonValue value)
  
  API name: _source
- storedField
  
  public InnerHits.Builder storedField(@Nullable java.util.List<java.lang.String> value)
  
  API name: stored_field
- storedField
  
  public InnerHits.Builder storedField(java.lang.String... value)
  
  API name: stored_field
- addStoredField
  
  public InnerHits.Builder addStoredField(java.lang.String value)
  
  Add a value to storedField(List), creating the list if needed.
- trackScores
  
  public InnerHits.Builder trackScores(@Nullable java.lang.Boolean value)
  
  API name: track_scores
- version
  
  public InnerHits.Builder version(@Nullable java.lang.Boolean value)
  
  API name: version
- build
  
  public InnerHits build()
  
  Builds a InnerHits.
  
  Specified by:
  
  build in interface ObjectBuilder<InnerHits>
  
  Throws:
  
  java.lang.NullPointerException - if some of the required fields are null.

Class InnerHits.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Builder

Method Details

name

size

from

collapse

collapse

docvalueFields

docvalueFields

addDocvalueFields

docvalueFields

addDocvalueFields

explain

highlight

highlight

ignoreUnmapped

scriptFields

putScriptFields

scriptFields

putScriptFields

seqNoPrimaryTerm

fields

fields

addFields

sort

sort

addSort

source

storedField

storedField

addStoredField

trackScores

version

build