Package com.yahoo.documentapi.messagebus.protocol

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
public class GetDocumentMessage extends DocumentMessage
Author:
Simon Thoresen Hult

  • Constructor Summary

    Constructors
    Constructor
    Description
    GetDocumentMessage(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 Type
    Method
    Description
    DocumentReply
    createReply()
    Creates and returns a reply to this message.
    int
    getApproxSize()
     
    Integer
    getDebugReplicaNodeId()
    Returns non-null if the document should be get from a specific replica.
    com.yahoo.document.DocumentId
    getDocumentId()
    Returns the identifier of the document to retrieve.
    String
    getFieldSet()
     
    int
    getType()
     
    boolean
    hasDebugReplicaNodeId()
     
    void
    setDebugReplicaNodeId(Integer debugReplicaNodeId)
    Sets the node ID of the replica to read from, for debugging purposes.
    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

    Methods inherited from class java.lang.Object

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

  • 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

      public GetDocumentMessage(com.yahoo.document.DocumentId documentId, String fieldSet)
      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

      public String getFieldSet()

    • setDebugReplicaNodeId

      public void setDebugReplicaNodeId(Integer debugReplicaNodeId)
      Sets the node ID of the replica to read from, for debugging purposes. If non-null, the document will be fetched from the specified replica.
      Parameters:
      debugReplicaNodeId - the node ID of the replica to get the document from

    • getDebugReplicaNodeId

      public Integer getDebugReplicaNodeId()
      Returns non-null if the document should be get from a specific replica.

    • hasDebugReplicaNodeId

      public boolean hasDebugReplicaNodeId()

    • createReply

      public DocumentReply createReply()
      Description copied from class: DocumentMessage
      Creates and returns a reply to this message.
      Specified by:
      createReply in class DocumentMessage
      Returns:
      The created reply.

    • getApproxSize

      public int getApproxSize()
      Overrides:
      getApproxSize in class DocumentMessage

    • getType

      public int getType()
      Specified by:
      getType in class com.yahoo.messagebus.Routable