Class RequestMessage

The model for a request message in the HTTP body that is sent to the server beginning in 4.0.0.

Index

Methods

getBatchSize getBulkResults getFields getG getGremlin getLanguage getMaterializeProperties getParameters getTimeoutMillis toJSON build

Methods

getBatchSize

getBatchSize(): number | undefined
Returns number | undefined
- Defined in gremlin-javascript/lib/driver/request-message.ts:103

getBulkResults

getBulkResults(): boolean | undefined
Returns boolean | undefined
- Defined in gremlin-javascript/lib/driver/request-message.ts:99

getFields

getFields(): ReadonlyMap<string, any>
Returns ReadonlyMap<string, any>
- Defined in gremlin-javascript/lib/driver/request-message.ts:107

getG

getG(): string | undefined
Returns string | undefined
- Defined in gremlin-javascript/lib/driver/request-message.ts:91

getGremlin

getGremlin(): string
Returns string
- Defined in gremlin-javascript/lib/driver/request-message.ts:75

getLanguage

getLanguage(): string
Returns string
- Defined in gremlin-javascript/lib/driver/request-message.ts:79

getMaterializeProperties

getMaterializeProperties(): string | undefined
Returns string | undefined
- Defined in gremlin-javascript/lib/driver/request-message.ts:95

getParameters

getParameters(): object | undefined
Returns object | undefined
- Defined in gremlin-javascript/lib/driver/request-message.ts:87

getTimeoutMillis

getTimeoutMillis(): number | undefined
Returns number | undefined
- Defined in gremlin-javascript/lib/driver/request-message.ts:83

toJSON

toJSON(): Record<string, any>
Builds the plain object that represents this message on the wire. Standard fields are included when set, and custom fields are flattened to the top level. This method is invoked automatically by JSON.stringify.

When a new standard field is added to this class, it should be added here as well so that it is included in the serialized request body.

Returns Record<string, any>
- Defined in gremlin-javascript/lib/driver/request-message.ts:119

`Static`build

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