MultiGetItemResponse (server 7.3.2 API)

java.lang.Object
- org.elasticsearch.action.get.MultiGetItemResponse

All Implemented Interfaces:: Streamable

public class MultiGetItemResponse
extends java.lang.Object
implements Streamable

A single multi get response.

Constructor Summary

Constructors
Constructor Description

MultiGetItemResponse(GetResponse response, MultiGetResponse.Failure failure)

Method Summary

Modifier and Type	Method	Description
`MultiGetResponse.Failure`	`getFailure()`	The failure if relevant.
`java.lang.String`	`getId()`	The id of the document.
`java.lang.String`	`getIndex()`	The index name of the document.
`GetResponse`	`getResponse()`	The actual get response, `null` if its a failure.
`java.lang.String`	`getType()`	The type of the document.
`boolean`	`isFailed()`	Is this a failed execution?
`void`	`readFrom(StreamInput in)`	Set this object's fields from a StreamInput.
`static MultiGetItemResponse`	`readItemResponse(StreamInput in)`
`void`	`writeTo(StreamOutput out)`	Write this object's fields to a StreamOutput.

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

Constructor Detail

MultiGetItemResponse

public MultiGetItemResponse(GetResponse response,
                            MultiGetResponse.Failure failure)

Method Detail
- getIndex
```
public java.lang.String getIndex()
```
  The index name of the document.
- getType
```
public java.lang.String getType()
```
  The type of the document.
- getId
```
public java.lang.String getId()
```
  The id of the document.
- isFailed
```
public boolean isFailed()
```
  Is this a failed execution?
- getResponse
```
public GetResponse getResponse()
```
  The actual get response, null if its a failure.
- getFailure
```
public MultiGetResponse.Failure getFailure()
```
  The failure if relevant.
- readItemResponse
```
public static MultiGetItemResponse readItemResponse(StreamInput in)
                                             throws java.io.IOException
```
  Throws:
  
  java.io.IOException
- readFrom
```
public void readFrom(StreamInput in)
              throws java.io.IOException
```
  Description copied from interface: Streamable
  
  Set this object's fields from a StreamInput.
  
  Specified by:
  
  readFrom in interface Streamable
  
  Throws:
  
  java.io.IOException
- writeTo
```
public void writeTo(StreamOutput out)
             throws java.io.IOException
```
  Description copied from interface: Streamable
  
  Write this object's fields to a StreamOutput.
  
  Specified by:
  
  writeTo in interface Streamable
  
  Throws:
  
  java.io.IOException