Package com.cognite.client.servicesV1.response

Class FileBinaryResponseParser

java.lang.Object

com.cognite.client.servicesV1.response.FileBinaryResponseParser

All Implemented Interfaces:

ResponseParser<FileBinary>

public abstract class FileBinaryResponseParser
extends Object
implements ResponseParser<FileBinary>

Parses a file binary based on a request and binary response payload. The request parameters must contain a single item with either the *externalId* or the *id*. The response payload represents the file binary.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileBinaryResponseParser.Builder

Constructor Summary

Constructors

Constructor	Description
FileBinaryResponseParser()

Method Summary

Modifier and Type	Method	Description
static FileBinaryResponseParser	create()
com.google.common.collect.ImmutableList<FileBinary>	extractItems(byte[] payload)	Extract the file binary from the response body.
Optional<String>	extractNextCursor(byte[] payload)	Returns Optional.empty() as there is no next cursor in a file binary response.
static FileBinaryResponseParser	of(Request requestParameters)
abstract FileBinaryResponseParser.Builder	toBuilder()
FileBinaryResponseParser	withRequest(Request requestParameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBinaryResponseParser

public FileBinaryResponseParser()

Method Detail

create

public static FileBinaryResponseParser create()

of

public static FileBinaryResponseParser of(Request requestParameters)

toBuilder

public abstract FileBinaryResponseParser.Builder toBuilder()

withRequest

public FileBinaryResponseParser withRequest(Request requestParameters)

extractNextCursor

public Optional<String> extractNextCursor(byte[] payload)
                                   throws Exception

Returns Optional.empty() as there is no next cursor in a file binary response.

Specified by:

extractNextCursor in interface ResponseParser<FileBinary>

Parameters:

payload - The response body

Returns:

Throws:

Exception

IOException

extractItems

public com.google.common.collect.ImmutableList<FileBinary> extractItems(byte[] payload)
                                                                 throws Exception

Extract the file binary from the response body.

Specified by:

extractItems in interface ResponseParser<FileBinary>

Parameters:

payload - The reponse body

Returns:

Throws:

Exception