Class GetDocumentMessage
java.lang.Object
com.yahoo.messagebus.Routable
com.yahoo.messagebus.Message
com.yahoo.documentapi.messagebus.protocol.DocumentMessage
com.yahoo.documentapi.messagebus.protocol.GetDocumentMessage
- Author:
- Simon Thoresen Hult
-
Constructor Summary
ConstructorDescriptionGetDocumentMessage
(com.yahoo.document.DocumentId documentId) Constructs a new document get message.GetDocumentMessage
(com.yahoo.document.DocumentId documentId, String fieldSet) Constructs a new document get message. -
Method Summary
Modifier and TypeMethodDescriptionCreates and returns a reply to this message.int
com.yahoo.document.DocumentId
Returns the identifier of the document to retrieve.int
getType()
void
setDocumentId
(com.yahoo.document.DocumentId documentId) Sets the identifier of the document to retrieve.Methods inherited from class com.yahoo.documentapi.messagebus.protocol.DocumentMessage
getPriority, getProtocol, setPriority, swapState
Methods inherited from class com.yahoo.messagebus.Message
getBucketSequence, getRetry, getRetryEnabled, getRoute, getSequenceId, getTimeReceived, getTimeRemaining, getTimeRemainingNow, hasBucketSequence, hasSequenceId, isExpired, setRetry, setRetryEnabled, setRoute, setTimeReceived, setTimeReceivedNow, setTimeRemaining
Methods inherited from class com.yahoo.messagebus.Routable
discard, getCallStack, getContext, getTrace, popHandler, pushHandler, setContext
-
Constructor Details
-
GetDocumentMessage
public GetDocumentMessage(com.yahoo.document.DocumentId documentId) Constructs a new document get message.- Parameters:
documentId
- The identifier of the document to get.
-
GetDocumentMessage
Constructs a new document get message.- Parameters:
documentId
- The identifier of the document to get.fieldSet
- Which fields to retrieve from the document
-
-
Method Details
-
getDocumentId
public com.yahoo.document.DocumentId getDocumentId()Returns the identifier of the document to retrieve.- Returns:
- The document id.
-
setDocumentId
public void setDocumentId(com.yahoo.document.DocumentId documentId) Sets the identifier of the document to retrieve.- Parameters:
documentId
- The document id to set.
-
getFieldSet
-
createReply
Description copied from class:DocumentMessage
Creates and returns a reply to this message.- Specified by:
createReply
in classDocumentMessage
- Returns:
- The created reply.
-
getApproxSize
public int getApproxSize()- Overrides:
getApproxSize
in classDocumentMessage
-
getType
public int getType()- Specified by:
getType
in classcom.yahoo.messagebus.Routable
-