Class Builder

Builder class for RequestMessage.

Index

Constructors

Properties

additionalFields batchSize? bulkResults? g? language materializeProperties? timeoutMillis?

Methods

addBatchSize addBulkResults addField addG addLanguage addMaterializeProperties addParameter addParameters addParametersString addTimeoutMillis create

Constructors

constructor

new Builder(gremlin: string): Builder
Parameters
- gremlin: string
Returns Builder
- Defined in gremlin-javascript/lib/driver/request-message.ts:172

Properties

additionalFields

additionalFields: Map<string, any> = ...

`Optional`batchSize

batchSize?: number

`Optional`bulkResults

bulkResults?: boolean

`Optional`g

g?: string

language

language: string

`Optional`materializeProperties

materializeProperties?: string

`Optional`timeoutMillis

timeoutMillis?: number

Methods

addBatchSize

addBatchSize(batchSize: number): Builder
Parameters
- batchSize: number
Returns Builder
- Defined in gremlin-javascript/lib/driver/request-message.ts:245

addBulkResults

addBulkResults(bulking: boolean): Builder
Parameters
- bulking: boolean
Returns Builder
- Defined in gremlin-javascript/lib/driver/request-message.ts:240

addField

addField(key: string, value: any): Builder
Parameters
- key: string
- value: any
Returns Builder
- Defined in gremlin-javascript/lib/driver/request-message.ts:251

addG

addG(g: string): Builder
Parameters
- g: string
Returns Builder
- Defined in gremlin-javascript/lib/driver/request-message.ts:217

addLanguage

addLanguage(language: string): Builder
Parameters
- language: string
Returns Builder
- Defined in gremlin-javascript/lib/driver/request-message.ts:177

addMaterializeProperties

addMaterializeProperties(materializeProps: string): Builder
Parameters
- materializeProps: string
Returns Builder
- Defined in gremlin-javascript/lib/driver/request-message.ts:223

addParameter

addParameter(key: string, value: any): Builder
Adds a single query parameter. The accumulated parameters map is converted to a gremlin-lang map literal string when the message is created. Cannot be mixed with addParametersString.
Parameters
- key: string
- value: any
Returns Builder
- Defined in gremlin-javascript/lib/driver/request-message.ts:188

addParameters

addParameters(otherParameters: object): Builder
Merges the provided parameters into the accumulated parameters map. The values are converted to a gremlin-lang map literal string when the message is created. Cannot be mixed with addParametersString.
Parameters
- otherParameters: object
Returns Builder
- Defined in gremlin-javascript/lib/driver/request-message.ts:199

addParametersString

addParametersString(parametersString: string): Builder
Sets the query parameters as a pre-formatted gremlin-lang map literal string (e.g. '["x":1,"y":"knows"]'). Calling this method replaces any previously set parameters string (last-one-wins). Cannot be mixed with addParameter or addParameters.
Parameters
- parametersString: string
Returns Builder
- Defined in gremlin-javascript/lib/driver/request-message.ts:211

addTimeoutMillis

addTimeoutMillis(timeout: number): Builder
Parameters
- timeout: number
Returns Builder
- Defined in gremlin-javascript/lib/driver/request-message.ts:234

create

create(): RequestMessage
Create the request message given the settings provided to the Builder.

Returns RequestMessage
- Defined in gremlin-javascript/lib/driver/request-message.ts:259