Package org.apache.tinkerpop.gremlin.util.message

Class RequestMessage.Builder

java.lang.Object

org.apache.tinkerpop.gremlin.util.message.RequestMessage.Builder

Enclosing class:

RequestMessage

public static final class RequestMessage.Builder
extends Object

Builder class for RequestMessage.

Method Summary

Modifier and Type	Method	Description
RequestMessage.Builder	add(String key, Object value)	Add a custom field to the request.
RequestMessage.Builder	addBulkResults(boolean bulking)
RequestMessage.Builder	addChunkSize(int chunkSize)
RequestMessage.Builder	addG(String g)
RequestMessage.Builder	addLanguage(String language)
RequestMessage.Builder	addMaterializeProperties(String materializeProps)
RequestMessage.Builder	addParameters(String parametersString)	Sets the query parameters as a gremlin-lang map literal string.
RequestMessage.Builder	addParameters(Map<String,Object> otherParameters)	Sets the query parameters from a map by converting it to a gremlin-lang map literal string using GremlinLang.convertParametersToString(Map).
RequestMessage.Builder	addTimeoutMillis(long timeout)
RequestMessage.Builder	addTransactionId(String transactionId)	Adds a transaction ID to the request message.
RequestMessage	create()	Create the request message given the settings provided to the RequestMessage.Builder.

Methods inherited from class java.lang.Object

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

Method Details

add

public RequestMessage.Builder add(String key,
 Object value)

Add a custom field to the request. This is intended for provider-specific fields that interceptors need to include in the serialized request body.

addLanguage

public RequestMessage.Builder addLanguage(String language)

addParameters

public RequestMessage.Builder addParameters(String parametersString)

Sets the query parameters as a gremlin-lang map literal string. Calling this method multiple times will replace the previous parameters (last-one-wins).

addParameters

public RequestMessage.Builder addParameters(Map<String,Object> otherParameters)

Sets the query parameters from a map by converting it to a gremlin-lang map literal string using GremlinLang.convertParametersToString(Map). Calling this method multiple times will replace the previous parameters (last-one-wins).

addG

public RequestMessage.Builder addG(String g)

addChunkSize

public RequestMessage.Builder addChunkSize(int chunkSize)

addMaterializeProperties

public RequestMessage.Builder addMaterializeProperties(String materializeProps)

addTimeoutMillis

public RequestMessage.Builder addTimeoutMillis(long timeout)

addBulkResults

public RequestMessage.Builder addBulkResults(boolean bulking)

addTransactionId

public RequestMessage.Builder addTransactionId(String transactionId)

Adds a transaction ID to the request message. The transaction ID is used to track multi-request transactions over HTTP. All requests within a transaction must include the same transaction ID.

Parameters:

transactionId - the unique transaction identifier (typically a UUID)

Returns:

this builder

create

public RequestMessage create()

Create the request message given the settings provided to the RequestMessage.Builder.