io.searchbox.core

Class MultiGet.Builder.ById

java.lang.Object

io.searchbox.action.AbstractAction.Builder<T,K>

io.searchbox.action.AbstractMultiIndexActionBuilder<T,K>

io.searchbox.action.AbstractMultiTypeActionBuilder<MultiGet,MultiGet.Builder.ById>

io.searchbox.core.MultiGet.Builder.ById

Enclosing class:

MultiGet.Builder

public static class MultiGet.Builder.ById
extends AbstractMultiTypeActionBuilder<MultiGet,MultiGet.Builder.ById>

Field Summary

Fields inherited from class io.searchbox.action.AbstractMultiIndexActionBuilder

indexNames

Fields inherited from class io.searchbox.action.AbstractAction.Builder

cleanApiParameters, headers, parameters

Constructor Summary

Constructors

Constructor and Description
MultiGet.Builder.ById(String index, String type) The mget API allows for _type to be optional.

Method Summary

Methods

Modifier and Type	Method and Description
MultiGet.Builder.ById	addId(Collection<? extends String> ids)
MultiGet.Builder.ById	addId(String id)
MultiGet	build()

Methods inherited from class io.searchbox.action.AbstractMultiTypeActionBuilder

addType, addType, getJoinedTypes

Methods inherited from class io.searchbox.action.AbstractMultiIndexActionBuilder

addIndex, addIndex, allowNoIndices, getJoinedIndices, ignoreUnavailable

Methods inherited from class io.searchbox.action.AbstractAction.Builder

addCleanApiParameter, refresh, removeCleanApiParameter, resultCasing, setHeader, setHeader, setParameter, setParameter, toggleApiParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiGet.Builder.ById

public MultiGet.Builder.ById(String index,
                     String type)

The mget API allows for _type to be optional. Set it to _all or leave it empty in order to fetch the first document matching the id across all types. If you don’t set the type and have many documents sharing the same _id, you will end up getting only the first matching document.

Method Detail

addId

public MultiGet.Builder.ById addId(Collection<? extends String> ids)

addId

public MultiGet.Builder.ById addId(String id)

build

public MultiGet build()

Specified by:

build in class AbstractMultiIndexActionBuilder<MultiGet,MultiGet.Builder.ById>