Package com.cognite.client.servicesV1.response

Class JsonStringAttributeResponseParser

java.lang.Object

com.cognite.client.servicesV1.response.DefaultResponseParser

com.cognite.client.servicesV1.response.JsonStringAttributeResponseParser

All Implemented Interfaces:

ResponseParser<String>, Serializable

public abstract class JsonStringAttributeResponseParser
extends DefaultResponseParser

Parses a single attribute from a json payload as a single item. A cursor is never returned from this parser.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonStringAttributeResponseParser.Builder

Field Summary

Fields inherited from class com.cognite.client.servicesV1.response.DefaultResponseParser

instanceId, LOG, MAX_LENGTH_JSON_LOG, objectMapper

Constructor Summary

Constructors

Constructor	Description
JsonStringAttributeResponseParser()

Method Summary

Modifier and Type	Method	Description
static JsonStringAttributeResponseParser	create()
com.google.common.collect.ImmutableList<String>	extractItems(String json)	Extract the main items from a results json payload.
Optional<String>	extractNextCursor(String json)	Extract the next cursor from a results json payload.
abstract List<String>	getAttributePath()
JsonStringAttributeResponseParser	withAttributePath(String path)	Sets the path to the attribute to extract.

Methods inherited from class com.cognite.client.servicesV1.response.DefaultResponseParser

extractItems, extractNextCursor, parseToString

Methods inherited from class java.lang.Object

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

Constructor Details

JsonStringAttributeResponseParser

public JsonStringAttributeResponseParser()

Method Details

create

public static JsonStringAttributeResponseParser create()

getAttributePath

public abstract List<String> getAttributePath()

withAttributePath

public JsonStringAttributeResponseParser withAttributePath(String path)

Sets the path to the attribute to extract.

Parameters:

path -

Returns:

extractNextCursor

public Optional<String> extractNextCursor(String json)

Extract the next cursor from a results json payload. Will always return an empty Optional.

Overrides:

extractNextCursor in class DefaultResponseParser

Parameters:

json - The results json payload

Returns:

Throws:

IOException

extractItems

public com.google.common.collect.ImmutableList<String> extractItems(String json)
                                                             throws Exception

Extract the main items from a results json payload. Returns the entire payload as a json string.

Overrides:

extractItems in class DefaultResponseParser

Parameters:

json - The results json payload

Returns:

Throws:

IOException

IOException

Exception