Package com.yahoo.documentapi
Class DocumentUpdateResponse
- java.lang.Object
-
- com.yahoo.documentapi.Response
-
- com.yahoo.documentapi.DocumentUpdateResponse
-
public class DocumentUpdateResponse extends Response
The asynchronous response to a document update operation. This is a value object.- Author:
- Einar M R Rosenvinge
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.yahoo.documentapi.Response
Response.Outcome
-
-
Constructor Summary
Constructors Constructor Description DocumentUpdateResponse(long requestId)
Creates a successful responseDocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate)
Creates a successful response containing a document updateDocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, String textMessage, boolean success)
Deprecated.DocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, String textMessage, Response.Outcome outcome)
Creates a response containing a textual message and/or a document updateDocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, String textMessage, Response.Outcome outcome, com.yahoo.messagebus.Trace trace)
Creates a response containing a textual message and/or a document updateDocumentUpdateResponse(long requestId, String textMessage, boolean success)
Deprecated.DocumentUpdateResponse(long requestId, String textMessage, Response.Outcome outcome)
Creates a response containing a textual message
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
com.yahoo.document.DocumentUpdate
getDocumentUpdate()
Returns the document update of this response or null if there is noneint
hashCode()
String
toString()
-
Methods inherited from class com.yahoo.documentapi.Response
getRequestId, getTextMessage, getTrace, isSuccess, outcome
-
-
-
-
Constructor Detail
-
DocumentUpdateResponse
public DocumentUpdateResponse(long requestId)
Creates a successful response
-
DocumentUpdateResponse
public DocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate)
Creates a successful response containing a document update- Parameters:
documentUpdate
- the DocumentUpdate to encapsulate in the Response
-
DocumentUpdateResponse
@Deprecated(since="7") public DocumentUpdateResponse(long requestId, String textMessage, boolean success)
Deprecated.Creates a response containing a textual message- Parameters:
textMessage
- the message to encapsulate in the Responsesuccess
- true if the response represents a successful call
-
DocumentUpdateResponse
public DocumentUpdateResponse(long requestId, String textMessage, Response.Outcome outcome)
Creates a response containing a textual message- Parameters:
textMessage
- the message to encapsulate in the Responseoutcome
- the outcome of this operation
-
DocumentUpdateResponse
@Deprecated(since="7") public DocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, String textMessage, boolean success)
Deprecated.Creates a response containing a textual message and/or a document update- Parameters:
documentUpdate
- the DocumentUpdate to encapsulate in the ResponsetextMessage
- the message to encapsulate in the Responsesuccess
- true if the response represents a successful call
-
DocumentUpdateResponse
public DocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, String textMessage, Response.Outcome outcome)
Creates a response containing a textual message and/or a document update- Parameters:
documentUpdate
- the DocumentUpdate to encapsulate in the ResponsetextMessage
- the message to encapsulate in the Responseoutcome
- the outcome of this operation
-
DocumentUpdateResponse
public DocumentUpdateResponse(long requestId, com.yahoo.document.DocumentUpdate documentUpdate, String textMessage, Response.Outcome outcome, com.yahoo.messagebus.Trace trace)
Creates a response containing a textual message and/or a document update- Parameters:
documentUpdate
- the DocumentUpdate to encapsulate in the ResponsetextMessage
- the message to encapsulate in the Responseoutcome
- the outcome of this operation
-
-