Package com.yahoo.documentapi

Class DocumentOperationParameters

java.lang.Object

com.yahoo.documentapi.DocumentOperationParameters

public class DocumentOperationParameters
extends java.lang.Object

Optional parameters for a document operation. Immutable class.

Author:

jonmv

Method Summary

Modifier and Type	Method	Description
java.util.Optional<java.time.Instant>	deadline()
boolean	equals(java.lang.Object o)
java.util.Optional<java.lang.String>	fieldSet()
int	hashCode()
static DocumentOperationParameters	parameters()
java.util.Optional<DocumentProtocol.Priority>	priority()
java.util.Optional<ResponseHandler>	responseHandler()
java.util.Optional<java.lang.String>	route()
java.lang.String	toString()
java.util.OptionalInt	traceLevel()
DocumentOperationParameters	withDeadline(java.time.Instant deadline)	Sets the deadline for an operation.
DocumentOperationParameters	withFieldSet(com.yahoo.document.fieldset.FieldSet fieldSet)	Sets the field set used for retrieval.
DocumentOperationParameters	withFieldSet(java.lang.String fieldSet)	Sets the field set used for retrieval.
DocumentOperationParameters	withPriority(DocumentProtocol.Priority priority)	Sets the priority with which to perform an operation.
DocumentOperationParameters	withResponseHandler(ResponseHandler responseHandler)	Sets the ResponseHandler to handle the Response of an async operation, instead of the session default.
DocumentOperationParameters	withRoute(java.lang.String route)	Sets the route along which to send the operation.
DocumentOperationParameters	withTraceLevel(int traceLevel)	Sets the trace level for an operation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

parameters

public static DocumentOperationParameters parameters()

withPriority

public DocumentOperationParameters withPriority(DocumentProtocol.Priority priority)

Sets the priority with which to perform an operation.

withFieldSet

public DocumentOperationParameters withFieldSet(com.yahoo.document.fieldset.FieldSet fieldSet)

Sets the field set used for retrieval.

withFieldSet

public DocumentOperationParameters withFieldSet(java.lang.String fieldSet)

Sets the field set used for retrieval.

withRoute

public DocumentOperationParameters withRoute(java.lang.String route)

Sets the route along which to send the operation.

withTraceLevel

public DocumentOperationParameters withTraceLevel(int traceLevel)

Sets the trace level for an operation.

withDeadline

public DocumentOperationParameters withDeadline(java.time.Instant deadline)

Sets the deadline for an operation.

withResponseHandler

public DocumentOperationParameters withResponseHandler(ResponseHandler responseHandler)

Sets the ResponseHandler to handle the Response of an async operation, instead of the session default.

priority

public java.util.Optional<DocumentProtocol.Priority> priority()

fieldSet

public java.util.Optional<java.lang.String> fieldSet()

route

public java.util.Optional<java.lang.String> route()

traceLevel

public java.util.OptionalInt traceLevel()

deadline

public java.util.Optional<java.time.Instant> deadline()

responseHandler

public java.util.Optional<ResponseHandler> responseHandler()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object