Package com.yahoo.documentapi.messagebus.protocol

Class CreateVisitorMessage

java.lang.Object

com.yahoo.messagebus.Routable

com.yahoo.messagebus.Message

com.yahoo.documentapi.messagebus.protocol.DocumentMessage

com.yahoo.documentapi.messagebus.protocol.CreateVisitorMessage

public class CreateVisitorMessage
extends DocumentMessage

Constructor Summary

Constructors

Constructor	Description
CreateVisitorMessage(String libraryName, String instanceId, String controlDestination, String dataDestination)

Method Summary

Modifier and Type	Method	Description
DocumentReply	createReply()	Creates and returns a reply to this message.
int	getApproxSize()
List<com.yahoo.document.BucketId>	getBuckets()
String	getBucketSpace()
String	getControlDestination()
String	getDataDestination()
String	getDocumentSelection()
String	getFieldSet()
long	getFromTimestamp()
String	getInstanceId()
String	getLibraryName()
int	getMaxBucketsPerVisitor()
int	getMaxPendingReplyCount()
Map<String,byte[]>	getParameters()
long	getToTimestamp()
int	getType()
boolean	getVisitInconsistentBuckets()
boolean	getVisitRemoves()
void	setBuckets(List<com.yahoo.document.BucketId> buckets)
void	setBucketSpace(String bucketSpace)
void	setControlDestination(String controlDestination)
void	setDataDestination(String dataDestination)
void	setDocumentSelection(String documentSelection)
void	setFieldSet(String fieldSet)
void	setFromTimestamp(long from)
void	setInstanceId(String instanceId)
void	setLibraryName(String libraryName)
void	setMaxBucketsPerVisitor(int max)
void	setMaxPendingReplyCount(int count)
void	setParameters(Map<String,byte[]> parameters)
void	setToTimestamp(long to)
void	setVisitInconsistentBuckets(boolean visitInconsistentBuckets)
void	setVisitRemoves(boolean visitRemoves)
String	toString()

Methods inherited from class com.yahoo.documentapi.messagebus.protocol.DocumentMessage

getLoadType, getPriority, getProtocol, setLoadType, 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, wait, wait, wait

Constructor Detail

CreateVisitorMessage

public CreateVisitorMessage(String libraryName,
                            String instanceId,
                            String controlDestination,
                            String dataDestination)

Method Detail

getLibraryName

public String getLibraryName()

setLibraryName

public void setLibraryName(String libraryName)

getInstanceId

public String getInstanceId()

setInstanceId

public void setInstanceId(String instanceId)

getControlDestination

public String getControlDestination()

setControlDestination

public void setControlDestination(String controlDestination)

getDataDestination

public String getDataDestination()

setDataDestination

public void setDataDestination(String dataDestination)

getDocumentSelection

public String getDocumentSelection()

setDocumentSelection

public void setDocumentSelection(String documentSelection)

getBucketSpace

public String getBucketSpace()

setBucketSpace

public void setBucketSpace(String bucketSpace)

getMaxPendingReplyCount

public int getMaxPendingReplyCount()

setMaxPendingReplyCount

public void setMaxPendingReplyCount(int count)

getParameters

public Map<String,byte[]> getParameters()

setParameters

public void setParameters(Map<String,byte[]> parameters)

getBuckets

public List<com.yahoo.document.BucketId> getBuckets()

setBuckets

public void setBuckets(List<com.yahoo.document.BucketId> buckets)

getVisitRemoves

public boolean getVisitRemoves()

setVisitRemoves

public void setVisitRemoves(boolean visitRemoves)

getFieldSet

public String getFieldSet()

setFieldSet

public void setFieldSet(String fieldSet)

getVisitInconsistentBuckets

public boolean getVisitInconsistentBuckets()

setVisitInconsistentBuckets

public void setVisitInconsistentBuckets(boolean visitInconsistentBuckets)

setFromTimestamp

public void setFromTimestamp(long from)

setToTimestamp

public void setToTimestamp(long to)

getFromTimestamp

public long getFromTimestamp()

getToTimestamp

public long getToTimestamp()

setMaxBucketsPerVisitor

public void setMaxBucketsPerVisitor(int max)

getMaxBucketsPerVisitor

public int getMaxBucketsPerVisitor()

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

toString

public String toString()

Overrides:

toString in class Object