public class VisitorParameters extends Parameters
Modifier and Type | Field and Description |
---|---|
private String |
bucketSpace |
(package private) Set<com.yahoo.document.BucketId> |
bucketsToVisit |
private VisitorControlHandler |
controlHandler |
private String |
documentSelection |
private boolean |
dynamicallyIncreaseMaxBucketsPerVisitor |
private float |
dynamicMaxBucketsIncreaseFactor |
private String |
fieldSet |
private long |
fromTimestamp |
private Map<String,byte[]> |
libraryParameters |
private com.yahoo.documentapi.messagebus.loadtypes.LoadType |
loadType |
private VisitorDataHandler |
localDataHandler |
private int |
maxBucketsPerVisitor |
private long |
maxFirstPassHits |
private int |
maxPending |
private long |
maxTotalHits |
private DocumentProtocol.Priority |
priority |
private String |
remoteDataHandler |
private String |
resumeFileName |
private ProgressToken |
resumeToken |
private long |
sessionTimeoutMs |
private boolean |
skipBucketsOnFatalErrors |
private com.yahoo.messagebus.ThrottlePolicy |
throttlePolicy |
private long |
timeoutMs |
private long |
toTimestamp |
private int |
traceLevel |
(package private) boolean |
visitInconsistentBuckets |
private String |
visitorLibrary |
private int |
visitorOrdering |
(package private) boolean |
visitRemoves |
private com.yahoo.messagebus.routing.Route |
visitRoute |
private float |
weight |
Constructor and Description |
---|
VisitorParameters(String documentSelection)
Creates visitor parameters from a document selection expression, using
defaults for other parameters.
|
VisitorParameters(VisitorParameters params)
Copy constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
fieldSet() |
void |
fieldSet(String fieldSet)
Set field set to use.
|
String |
getBucketSpace() |
Set<com.yahoo.document.BucketId> |
getBucketsToVisit() |
VisitorControlHandler |
getControlHandler() |
String |
getDocumentSelection() |
boolean |
getDynamicallyIncreaseMaxBucketsPerVisitor() |
float |
getDynamicMaxBucketsIncreaseFactor() |
String |
getFieldSet() |
long |
getFromTimestamp() |
Map<String,byte[]> |
getLibraryParameters() |
com.yahoo.documentapi.messagebus.loadtypes.LoadType |
getLoadType() |
VisitorDataHandler |
getLocalDataHandler() |
int |
getMaxBucketsPerVisitor() |
long |
getMaxFirstPassHits() |
int |
getMaxPending() |
long |
getMaxTotalHits() |
DocumentProtocol.Priority |
getPriority() |
String |
getRemoteDataHandler() |
String |
getResumeFileName() |
ProgressToken |
getResumeToken() |
com.yahoo.messagebus.routing.Route |
getRoute() |
long |
getSessionTimeoutMs() |
com.yahoo.messagebus.ThrottlePolicy |
getThrottlePolicy() |
long |
getTimeoutMs() |
long |
getToTimestamp() |
int |
getTraceLevel() |
boolean |
getVisitHeadersOnly() |
boolean |
getVisitInconsistentBuckets() |
String |
getVisitorLibrary() |
int |
getVisitorOrdering() |
boolean |
getVisitRemoves() |
void |
setBucketSpace(String bucketSpace)
Set which (single) bucket space this visiting will be against.
|
void |
setBucketsToVisit(Set<com.yahoo.document.BucketId> buckets) |
void |
setControlHandler(VisitorControlHandler controlHandler)
Set control handler.
|
void |
setDocumentSelection(String selection)
Set the document selection expression
|
void |
setDynamicallyIncreaseMaxBucketsPerVisitor(boolean dynamicallyIncreaseMaxBucketsPerVisitor)
Set whether or not max buckets per visitor value should be dynamically
increased when using orderdoc and visitors do not return at least half
the desired amount of documents
|
void |
setDynamicMaxBucketsIncreaseFactor(float dynamicMaxBucketsIncreaseFactor)
Set factor with which max buckets are dynamically increased each time
|
void |
setFieldSet(String fieldSet) |
void |
setFromTimestamp(long timestamp)
Set from timestamp in microseconds.
|
void |
setLibraryParameter(String param,
byte[] value)
Set a visitor library specific parameter.
|
void |
setLibraryParameter(String param,
String value)
Set a visitor library specific parameter.
|
void |
setLibraryParameters(Map<String,byte[]> params)
Set all visitor library specific parameters.
|
void |
setLoadType(com.yahoo.documentapi.messagebus.loadtypes.LoadType loadType) |
void |
setLocalDataHandler(VisitorDataHandler localDataHandler)
Set local data handler.
|
void |
setMaxBucketsPerVisitor(int max) |
void |
setMaxFirstPassHits(long max)
Set the maximum number of documents to visit (max documents returned by the visitor)
|
void |
setMaxPending(int maxPending)
Set maximum pending messages one storage visitor will have pending to this client before stalling, waiting for acks.
|
void |
setMaxTotalHits(long max)
Set the maximum number of documents to visit (max documents returned by the visitor)
|
void |
setPriority(DocumentProtocol.Priority priority) |
void |
setRemoteDataHandler(String remoteDataHandler)
Set address for the remote data handler.
|
void |
setResumeFileName(String fileName)
Set filename for reading/storing progress token.
|
void |
setResumeToken(ProgressToken token)
Set progress token, which can be used to resume visitor.
|
void |
setRoute(com.yahoo.messagebus.routing.Route route)
Set the route to visit.
|
void |
setRoute(String route)
Set the name of the storage cluster route to visit.
|
void |
setSessionTimeoutMs(long timeoutMs)
Sets timeout for the entire visiting session, in milliseconds.
|
void |
setThrottlePolicy(com.yahoo.messagebus.ThrottlePolicy policy) |
void |
setTimeoutMs(long timeoutMs)
Set the timeout for each visitor command in milliseconds.
|
void |
setToTimestamp(long timestamp)
Set to timestamp in microseconds.
|
void |
setTraceLevel(int traceLevel) |
void |
setVisitHeadersOnly(boolean headersOnly) |
void |
setVisitInconsistentBuckets(boolean visitInconsistentBuckets) |
void |
setVisitorLibrary(String library)
Set which visitor library is used for visiting in storage.
|
void |
setVisitorOrdering(int order) |
void |
setVisitRemoves(boolean visitRemoves) |
boolean |
skipBucketsOnFatalErrors() |
void |
skipBucketsOnFatalErrors(boolean skipBucketsOnFatalErrors) |
String |
toString() |
boolean |
visitInconsistentBuckets() |
void |
visitInconsistentBuckets(boolean visitInconsistentBuckets)
Set whether to visit inconsistent buckets.
|
boolean |
visitRemoves() |
void |
visitRemoves(boolean visitRemoves)
Set whether to visit remove entries.
|
private String documentSelection
private String bucketSpace
private String visitorLibrary
private int maxPending
private long timeoutMs
private long sessionTimeoutMs
private long fromTimestamp
private long toTimestamp
boolean visitRemoves
private String fieldSet
boolean visitInconsistentBuckets
private ProgressToken resumeToken
private String resumeFileName
private String remoteDataHandler
private VisitorDataHandler localDataHandler
private VisitorControlHandler controlHandler
private com.yahoo.messagebus.routing.Route visitRoute
private float weight
private long maxFirstPassHits
private long maxTotalHits
private int visitorOrdering
private int maxBucketsPerVisitor
private boolean dynamicallyIncreaseMaxBucketsPerVisitor
private float dynamicMaxBucketsIncreaseFactor
private com.yahoo.documentapi.messagebus.loadtypes.LoadType loadType
private DocumentProtocol.Priority priority
private int traceLevel
private com.yahoo.messagebus.ThrottlePolicy throttlePolicy
private boolean skipBucketsOnFatalErrors
Set<com.yahoo.document.BucketId> bucketsToVisit
public VisitorParameters(String documentSelection)
documentSelection
- document selection expressionpublic VisitorParameters(VisitorParameters params)
params
- object to copypublic String getDocumentSelection()
public String getBucketSpace()
public String getVisitorLibrary()
public int getMaxPending()
public long getTimeoutMs()
public long getSessionTimeoutMs()
public long getFromTimestamp()
public long getToTimestamp()
public boolean visitRemoves()
public boolean getVisitRemoves()
public boolean getVisitHeadersOnly()
public String fieldSet()
public String getFieldSet()
public boolean visitInconsistentBuckets()
public boolean getVisitInconsistentBuckets()
public Map<String,byte[]> getLibraryParameters()
public ProgressToken getResumeToken()
public String getResumeFileName()
public String getRemoteDataHandler()
public VisitorDataHandler getLocalDataHandler()
public VisitorControlHandler getControlHandler()
public boolean getDynamicallyIncreaseMaxBucketsPerVisitor()
public float getDynamicMaxBucketsIncreaseFactor()
public DocumentProtocol.Priority getPriority()
public void setDocumentSelection(String selection)
public void setBucketSpace(String bucketSpace)
public void setVisitorLibrary(String library)
public void setMaxPending(int maxPending)
public void setTimeoutMs(long timeoutMs)
public void setSessionTimeoutMs(long timeoutMs)
public void setFromTimestamp(long timestamp)
public void setToTimestamp(long timestamp)
public void visitRemoves(boolean visitRemoves)
public void setVisitRemoves(boolean visitRemoves)
public void setVisitHeadersOnly(boolean headersOnly)
public void fieldSet(String fieldSet)
public void setFieldSet(String fieldSet)
public void visitInconsistentBuckets(boolean visitInconsistentBuckets)
public void setVisitInconsistentBuckets(boolean visitInconsistentBuckets)
public void setLibraryParameter(String param, String value)
public void setLibraryParameter(String param, byte[] value)
public void setLibraryParameters(Map<String,byte[]> params)
public void setResumeToken(ProgressToken token)
public void setResumeFileName(String fileName)
public void setRemoteDataHandler(String remoteDataHandler)
public void setLocalDataHandler(VisitorDataHandler localDataHandler)
public void setControlHandler(VisitorControlHandler controlHandler)
public void setRoute(String route)
public void setRoute(com.yahoo.messagebus.routing.Route route)
public com.yahoo.messagebus.routing.Route getRoute()
public void setMaxFirstPassHits(long max)
public long getMaxFirstPassHits()
public void setMaxTotalHits(long max)
public long getMaxTotalHits()
public Set<com.yahoo.document.BucketId> getBucketsToVisit()
public void setBucketsToVisit(Set<com.yahoo.document.BucketId> buckets)
public int getVisitorOrdering()
public void setVisitorOrdering(int order)
public int getMaxBucketsPerVisitor()
public void setMaxBucketsPerVisitor(int max)
public void setTraceLevel(int traceLevel)
public int getTraceLevel()
public void setPriority(DocumentProtocol.Priority priority)
public com.yahoo.messagebus.ThrottlePolicy getThrottlePolicy()
public void setThrottlePolicy(com.yahoo.messagebus.ThrottlePolicy policy)
public void setLoadType(com.yahoo.documentapi.messagebus.loadtypes.LoadType loadType)
public com.yahoo.documentapi.messagebus.loadtypes.LoadType getLoadType()
public boolean skipBucketsOnFatalErrors()
public void skipBucketsOnFatalErrors(boolean skipBucketsOnFatalErrors)
public void setDynamicallyIncreaseMaxBucketsPerVisitor(boolean dynamicallyIncreaseMaxBucketsPerVisitor)
dynamicallyIncreaseMaxBucketsPerVisitor
- whether or not to increasepublic void setDynamicMaxBucketsIncreaseFactor(float dynamicMaxBucketsIncreaseFactor)
dynamicMaxBucketsIncreaseFactor
- increase factor (must be 1 or more)Copyright © 2018. All rights reserved.