io.searchbox.core

Class Get.Builder

java.lang.Object

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

io.searchbox.action.AbstractDocumentTargetedAction.Builder<Get,Get.Builder>

io.searchbox.core.Get.Builder

Enclosing class:

Get

public static class Get.Builder
extends AbstractDocumentTargetedAction.Builder<Get,Get.Builder>

Field Summary

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

cleanApiParameters, headers, parameters

Constructor Summary

Constructors

Constructor and Description
Get.Builder(String index, String id) Index and ID parameters are mandatory but type is optional (_all will be used for type if left blank).

Method Summary

Methods

Modifier and Type	Method and Description
Get	build()

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

id, index, type

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

Get.Builder

public Get.Builder(String index,
           String id)

Index and ID parameters are mandatory but type is optional (_all will be used for type if left blank).

The get API allows for _type to be optional. Set it to _all in order to fetch the first document matching the id across all types.

Method Detail

build

public Get build()

Specified by:

build in class AbstractAction.Builder<Get,Get.Builder>