com.github.nickrm.jflux.api.response

Class ApiResponse

java.lang.Object

com.github.nickrm.jflux.api.response.ApiResponse

public final class ApiResponse
extends Object

A response from the InfluxDB API, acts as a wrapper for the (possibly multiple) results returned.

A response will have more than one result when a query with more than one statement is executed. For instance, the following query will return a response with two results:

 SELECT * FROM measurement_1; SELECT * FROM measurement_2
 

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiResponse.Builder Creates instances of ApiResponse.

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage() Gets the error message for this response, if any.
ResponseMetadata	getMetadata() Gets the metadata for this response.
List<QueryResult>	getResults()
int	getStatusCode() Gets the status code of this response.
boolean	hasError() Gets a value indicating whether any of the results in this response returned an error.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getMetadata

public ResponseMetadata getMetadata()

Gets the metadata for this response.

Returns:

the response metadata

getStatusCode

public int getStatusCode()

Gets the status code of this response.

Returns:

the response status code

hasError

public boolean hasError()

Gets a value indicating whether any of the results in this response returned an error.

Returns:

true if the response contains any errors, false otherwise

getErrorMessage

public String getErrorMessage()

Gets the error message for this response, if any.

If this response contains multiple errors, this method returns the first one.

Returns:

the response error message, or null if no error

getResults

public List<QueryResult> getResults()

toString

public String toString()

Overrides:

toString in class Object