Package co.arago.hiro.client.rest

Class GraphAPI.QueryBodyConf<T extends GraphAPI.QueryBodyConf<T,R>,R>

java.lang.Object

co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf<T,R>

co.arago.hiro.client.rest.AuthenticatedAPIHandler.SendBodyAPIRequestConf<T,R>

co.arago.hiro.client.rest.GraphAPI.QueryBodyConf<T,R>

Type Parameters:

T - The Builder type

R - The type of the result expected from AuthenticatedAPIHandler.APIRequestConf.execute()

Direct Known Subclasses:

GraphAPI.QueryByIdsCommand, GraphAPI.QueryByXidCommand, GraphAPI.QueryGremlinCommand, GraphAPI.QueryTimeseriesCommand, GraphAPI.QueryVerticesCommand

Enclosing class:

GraphAPI

protected abstract static class GraphAPI.QueryBodyConf<T extends GraphAPI.QueryBodyConf<T,R>,R>
extends AuthenticatedAPIHandler.SendBodyAPIRequestConf<T,R>

A config class that contains common parameters for all Graph Queries.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,java.lang.String>	bodyMap

Fields inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.SendBodyAPIRequestConf

body

Fields inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf

fragment, headers, httpRequestTimeout, maxRetries, path, query

Constructor Summary

Constructors

Constructor	Description
QueryBodyConf(java.lang.String... pathParts)

Method Summary

Modifier and Type	Method	Description
T	addToBody(java.lang.String id, java.lang.String value)	Set arbitrary string to the bodyMap.
protected java.lang.String	createBody()
T	setFields(java.lang.String fields)	Set query fields
T	setIncludeDeleted(java.lang.Boolean includeDeleted)	Set includeDeleted
T	setListMeta(java.lang.Boolean listMeta)	Set listMeta

Methods inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.SendBodyAPIRequestConf

setBody, setJsonBodyFromMap, setJsonBodyFromMessage

Methods inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler.APIRequestConf

execute, self, setHttpHeaders, setHttpRequestTimeout, setMaxRetries, setUrlFragment, setUrlQuery

Methods inherited from class java.lang.Object

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

Field Detail

bodyMap

protected java.util.Map<java.lang.String,java.lang.String> bodyMap

Constructor Detail

QueryBodyConf

public QueryBodyConf(java.lang.String... pathParts)

Method Detail

addToBody

public T addToBody(java.lang.String id,
                   java.lang.String value)

Set arbitrary string to the bodyMap.

Parameters:

id - Key for the map

value - Value for the map. Existing keys in the map will be removed when value == null.

Returns:

AuthenticatedAPIHandler.APIRequestConf.self();

setFields

public T setFields(java.lang.String fields)

Set query fields

Parameters:

fields - the comma separated list of fields to return.

Returns:

this

setListMeta

public T setListMeta(java.lang.Boolean listMeta)

Set listMeta

Parameters:

listMeta - return list type attributes with metadata

Returns:

this

setIncludeDeleted

public T setIncludeDeleted(java.lang.Boolean includeDeleted)

Set includeDeleted

Parameters:

includeDeleted - allow getting if ogit/_is-deleted=true

Returns:

this

createBody

protected java.lang.String createBody()