Package com.yahoo.documentapi

Class DocumentOperationParameters

java.lang.Object

com.yahoo.documentapi.DocumentOperationParameters

public class DocumentOperationParameters
extends Object

Optional parameters for a document operation. Immutable class.

Author:

jonmv

Method Summary

Modifier and Type	Method	Description
Optional<Instant>	deadline()
boolean	equals(Object o)
Optional<String>	fieldSet()
int	hashCode()
static DocumentOperationParameters	parameters()
Optional<DocumentProtocol.Priority>	priority()	Deprecated, for removal: This API element is subject to removal in a future version. explicit operation priority is deprecated
Optional<ResponseHandler>	responseHandler()
Optional<String>	route()
String	toString()
OptionalInt	traceLevel()
DocumentOperationParameters	withDeadline(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(String fieldSet)	Sets the field set used for retrieval.
DocumentOperationParameters	withPriority(DocumentProtocol.Priority priority)	Deprecated, for removal: This API element is subject to removal in a future version. specifying explicit operation priority is deprecated
DocumentOperationParameters	withResponseHandler(ResponseHandler responseHandler)	Sets the ResponseHandler to handle the Response of an async operation, instead of the session default.
DocumentOperationParameters	withRoute(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 Details

parameters

public static DocumentOperationParameters parameters()

withPriority

@Deprecated(forRemoval=true)
public DocumentOperationParameters withPriority(DocumentProtocol.Priority priority)

Deprecated, for removal: This API element is subject to removal in a future version.

specifying explicit operation priority is deprecated

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(String fieldSet)

Sets the field set used for retrieval.

withRoute

public DocumentOperationParameters withRoute(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(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

@Deprecated(forRemoval=true)
public Optional<DocumentProtocol.Priority> priority()

Deprecated, for removal: This API element is subject to removal in a future version.

explicit operation priority is deprecated

fieldSet

public Optional<String> fieldSet()

route

public Optional<String> route()

traceLevel

public OptionalInt traceLevel()

deadline

public Optional<Instant> deadline()

responseHandler

public Optional<ResponseHandler> responseHandler()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object