A B C D E F G H I J M N P Q R S T U V W

A

alterRetentionPolicy(String, RetentionPolicy) - Method in class com.github.nickrm.jflux.JFluxClient

Alters the specified retention policy.

alterRetentionPolicy(String, String, RetentionPolicy) - Method in class com.github.nickrm.jflux.JFluxClient

Alters the specified retention policy.

AnnotationProcessingException - Exception in com.github.nickrm.jflux.annotation.exception

Thrown to indicate that something went wrong when processing an annotated class or object.

AnnotationProcessingException(String, Throwable) - Constructor for exception com.github.nickrm.jflux.annotation.exception.AnnotationProcessingException

Constructs a new exception with the specified message and cause.

ApiResponse - Class in com.github.nickrm.jflux.api.response

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

ApiResponse.Builder - Class in com.github.nickrm.jflux.api.response

Creates instances of ApiResponse.

ApiResponseConverter - Class in com.github.nickrm.jflux.api.converter

Converts a Response to an ApiResponse.

ApiResponseConverter() - Constructor for class com.github.nickrm.jflux.api.converter.ApiResponseConverter

Initializes a new instance.

asDefault(boolean) - Method in class com.github.nickrm.jflux.domain.RetentionPolicy

Creates a copy of this instance with a new value for RetentionPolicy.isDefault.

B

batchQuery(String) - Method in class com.github.nickrm.jflux.api.JFluxHttpClient

Executes a query and returns the result.

build() - Method in class com.github.nickrm.jflux.api.JFluxHttpClient.Builder

Constructs a new JFluxHttpClient instance from this builder's configuration.

build() - Method in class com.github.nickrm.jflux.api.response.ApiResponse.Builder

Builds a new ApiResponse instance with the values set in this builder.

build() - Method in class com.github.nickrm.jflux.api.response.QueryResult.Builder

Builds a new instance of QueryResult using the values set in this builder.

build() - Method in class com.github.nickrm.jflux.api.response.ResponseMetadata.Builder

Builds a new ResponseMetadata instance with the values set in this builder.

build() - Method in class com.github.nickrm.jflux.domain.Measurement.Builder

Creates a new Measurement instance using the values in this builder.

build() - Method in class com.github.nickrm.jflux.domain.Point.Builder

Builds a new Point instance using the values in this builder.

build() - Method in class com.github.nickrm.jflux.domain.RetentionPolicy.Builder

Constructs a retention policy instance from the values set in this builder.

build() - Method in class com.github.nickrm.jflux.JFluxClient.Builder

Constructs a new JFluxClient instance from this builder's configuration.

Builder(String) - Constructor for class com.github.nickrm.jflux.api.JFluxHttpClient.Builder

Initializes a new builder instance, setting the InfluxDB host URL.

Builder() - Constructor for class com.github.nickrm.jflux.api.response.ApiResponse.Builder

Builder() - Constructor for class com.github.nickrm.jflux.api.response.QueryResult.Builder

Builder() - Constructor for class com.github.nickrm.jflux.api.response.ResponseMetadata.Builder

Builder() - Constructor for class com.github.nickrm.jflux.domain.Measurement.Builder

Builder() - Constructor for class com.github.nickrm.jflux.domain.Point.Builder

Builder(String, Duration) - Constructor for class com.github.nickrm.jflux.domain.RetentionPolicy.Builder

Initializes a new instance setting the required fields.

Builder(String) - Constructor for class com.github.nickrm.jflux.JFluxClient.Builder

Initializes a new builder instance, setting the InfluxDB host URL.

BuildType - Enum in com.github.nickrm.jflux.domain

The build type of an InfluxDB instance.

C

close() - Method in class com.github.nickrm.jflux.api.JFluxHttpClient

close() - Method in class com.github.nickrm.jflux.JFluxClient

com.github.nickrm.jflux - package com.github.nickrm.jflux

Contains the main high-level InfluxDB client provided by this library, plus the classes that support its functionality (e.g.

com.github.nickrm.jflux.annotation - package com.github.nickrm.jflux.annotation

Annotations used for annotation based conversion between Java classes and InfluxDB data.

com.github.nickrm.jflux.annotation.exception - package com.github.nickrm.jflux.annotation.exception

Exceptions related to converting from/to annotated Java classes and InfluxDB data (e.g.

com.github.nickrm.jflux.api - package com.github.nickrm.jflux.api

Lower level client for the InfluxDB HTTP API, and the classes that support it.

com.github.nickrm.jflux.api.converter - package com.github.nickrm.jflux.api.converter

Converters used for data sent to/received from the InfluxDB HTTP API.

com.github.nickrm.jflux.api.exception - package com.github.nickrm.jflux.api.exception

Exceptions thrown when an issue is encountered when communicating with the InfluxDB HTTP API.

com.github.nickrm.jflux.api.response - package com.github.nickrm.jflux.api.response

Classes relating to responses from the InfluxDB HTTP API.

com.github.nickrm.jflux.domain - package com.github.nickrm.jflux.domain

Domain classes which represent domain entities defined by or relevant to InfluxDB, and used throughout this library.

com.github.nickrm.jflux.exception - package com.github.nickrm.jflux.exception

Exceptions explicitly thrown by the high level client provided by this library.

compareTo(Version) - Method in class com.github.nickrm.jflux.domain.Version

convert(Response<ResponseBody>) - Method in class com.github.nickrm.jflux.api.converter.ApiResponseConverter

Converts a response wrapper to an API response domain instance.

createDatabase(String) - Method in class com.github.nickrm.jflux.JFluxClient

Creates a new database with the specified name.

createRetentionPolicy(RetentionPolicy) - Method in class com.github.nickrm.jflux.JFluxClient

Creates a new retention policy on the selected database.

createRetentionPolicy(RetentionPolicy, String) - Method in class com.github.nickrm.jflux.JFluxClient

Creates a new retention policy on the specified database.

D

DatabaseAlreadyExistsException - Exception in com.github.nickrm.jflux.exception

Thrown to indicate that a database cannot be created because a database with the specified name already exists.

DatabaseAlreadyExistsException(String) - Constructor for exception com.github.nickrm.jflux.exception.DatabaseAlreadyExistsException

Creates a new instance setting the name of the database.

databaseExists(String) - Method in class com.github.nickrm.jflux.JFluxClient

Gets a value indicating whether the specified database exists.

dbBuildType(BuildType) - Method in class com.github.nickrm.jflux.api.response.ResponseMetadata.Builder

Sets the build type of the InfluxDB instance.

dbVersion(Version) - Method in class com.github.nickrm.jflux.api.response.ResponseMetadata.Builder

Sets the version of the InfluxDB instance.

dropDatabase(String) - Method in class com.github.nickrm.jflux.JFluxClient

Drops the specified database.

dropRetentionPolicy(String) - Method in class com.github.nickrm.jflux.JFluxClient

Drops the specified retention policy on the selected database.

dropRetentionPolicy(String, String) - Method in class com.github.nickrm.jflux.JFluxClient

Drops the specified retention policy.

DuplicateAnnotatedMembersException - Exception in com.github.nickrm.jflux.annotation.exception

Thrown to indicate that an annotation which should only appear once, was found more than once.

DuplicateAnnotatedMembersException(Object, Class<? extends Annotation>) - Constructor for exception com.github.nickrm.jflux.annotation.exception.DuplicateAnnotatedMembersException

Constructs a new exception with the specified target object and annotation class.

duration(Duration) - Method in class com.github.nickrm.jflux.domain.RetentionPolicy.Builder

Sets the RetentionPolicy.duration for the retention policy.

E

equals(Object) - Method in class com.github.nickrm.jflux.domain.RetentionPolicy

equals(Object) - Method in class com.github.nickrm.jflux.domain.Version

error(String) - Method in class com.github.nickrm.jflux.api.response.QueryResult.Builder

Sets the error message of the query result to be constructed.

errorMessage(String) - Method in class com.github.nickrm.jflux.api.response.ApiResponse.Builder

Sets the error message for this response.

execute(String) - Method in class com.github.nickrm.jflux.api.JFluxHttpClient

Executes DDL statements, such as CREATE or ALTER.

F

Field - Annotation Type in com.github.nickrm.jflux.annotation

Indicates that a class member should be written and read as a field in InfluxDB.

fields(Map<String, Object>) - Method in class com.github.nickrm.jflux.domain.Point.Builder

Sets the fields for the point to be constructed.

fromIdentifier(String) - Static method in enum com.github.nickrm.jflux.domain.BuildType

Gets the build type with the specified shorthand identifier.

fromString(String) - Static method in class com.github.nickrm.jflux.domain.Version

Creates a new instance from the specified string.

G

getAllPoints(Class<T>) - Method in class com.github.nickrm.jflux.JFluxClient

Alias for JFluxClient.getAllPoints(String, Class) using a preselected database.

getAllPoints(String, Class<T>) - Method in class com.github.nickrm.jflux.JFluxClient

Retrieves all points for the specified class.

getAllPoints(String) - Method in class com.github.nickrm.jflux.JFluxClient

Alias for JFluxClient.getAllPoints(String, String) using a preselected database.

getAllPoints(String, String) - Method in class com.github.nickrm.jflux.JFluxClient

Retrieves all points for the specified measurement.

getDatabases() - Method in class com.github.nickrm.jflux.JFluxClient

Gets the existing databases.

getDbBuildType() - Method in class com.github.nickrm.jflux.api.response.ResponseMetadata

Gets the build type of the InfluxDB instance.

getDbVersion() - Method in class com.github.nickrm.jflux.api.response.ResponseMetadata

Gets the version of the InfluxDB instance.

getDuration() - Method in class com.github.nickrm.jflux.domain.RetentionPolicy

Gets the RetentionPolicy.duration of this retention policy.

getError() - Method in class com.github.nickrm.jflux.api.response.QueryResult

Gets the error message for this result if available.

getErrorMessage() - Method in class com.github.nickrm.jflux.api.response.ApiResponse

Gets the error message for this response, if any.

getFields() - Method in class com.github.nickrm.jflux.domain.Point

Gets the fields contained in this point.

getHostUrl() - Method in class com.github.nickrm.jflux.api.JFluxHttpClient

Gets the URL of the InfluxDB instance this client is pointed to.

getMetadata() - Method in class com.github.nickrm.jflux.api.response.ApiResponse

Gets the metadata for this response.

getName() - Method in class com.github.nickrm.jflux.domain.Measurement

Gets the name of this measurement.

getName() - Method in class com.github.nickrm.jflux.domain.RetentionPolicy

Gets the name of this retention policy.

getPoints() - Method in class com.github.nickrm.jflux.domain.Measurement

Gets the points in this measurement.

getReplication() - Method in class com.github.nickrm.jflux.domain.RetentionPolicy

Gets the replication factor of this retention policy.

getRequestId() - Method in class com.github.nickrm.jflux.api.response.ResponseMetadata

Gets the request ID for the response.

getResults() - Method in class com.github.nickrm.jflux.api.response.ApiResponse

getResults() - Method in class com.github.nickrm.jflux.api.response.QueryResult

Gets the series contained in this result.

getRetentionPolicies() - Method in class com.github.nickrm.jflux.JFluxClient

Gets all the retention policies defined on the currently selected database.

getRetentionPolicies(String) - Method in class com.github.nickrm.jflux.JFluxClient

Gets all the retention policies defined on the specified database.

getRetentionPolicy(String) - Method in class com.github.nickrm.jflux.JFluxClient

Gets the definition of the specified retention policy.

getRetentionPolicy(String, String) - Method in class com.github.nickrm.jflux.JFluxClient

Gets the definition of the specified retention policy.

getShardDuration() - Method in class com.github.nickrm.jflux.domain.RetentionPolicy

Gets the shard duration of this retention policy.

getStatementId() - Method in class com.github.nickrm.jflux.api.response.QueryResult

Gets the ID of the statement that this result corresponds to.

getStatusCode() - Method in class com.github.nickrm.jflux.api.response.ApiResponse

Gets the status code of this response.

getTags() - Method in class com.github.nickrm.jflux.domain.Point

Gets the tags for this point.

getTimestamp() - Method in class com.github.nickrm.jflux.api.response.ResponseMetadata

Gets the timestamp of the response.

getTimestamp() - Method in class com.github.nickrm.jflux.domain.Point

Gets the timestamp of this point.

H

hasError() - Method in class com.github.nickrm.jflux.api.response.ApiResponse

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

hashCode() - Method in class com.github.nickrm.jflux.domain.RetentionPolicy

hashCode() - Method in class com.github.nickrm.jflux.domain.Version

I

IllegalStatementException - Exception in com.github.nickrm.jflux.api.exception

Thrown to indicate that an InfluxQL statement cannot be executed because it has invalid format and/or syntax.

IllegalStatementException(String) - Constructor for exception com.github.nickrm.jflux.api.exception.IllegalStatementException

Creates a new instance setting the message.

InfluxClientException - Exception in com.github.nickrm.jflux.api.exception

Thrown to indicate that a call to the InfluxDB API was incorrect (e.g.

InfluxClientException(String) - Constructor for exception com.github.nickrm.jflux.api.exception.InfluxClientException

Initializes a new instance setting the message.

InvalidAnnotatedType - Exception in com.github.nickrm.jflux.annotation.exception

Thrown to indicate that an annotation was applied to a member of a type incompatible with that annotation (e.g.

InvalidAnnotatedType(Member, Class<?>) - Constructor for exception com.github.nickrm.jflux.annotation.exception.InvalidAnnotatedType

Constructs a new exception for the specified class member and type.

InvalidAnnotatedType(Member, Collection<Class<?>>) - Constructor for exception com.github.nickrm.jflux.annotation.exception.InvalidAnnotatedType

Constructs a new exception for the specified class member and types.

isDefault(boolean) - Method in class com.github.nickrm.jflux.domain.RetentionPolicy.Builder

Sets a value indicating whether this retention policy should be the default retention policy.

isDefault() - Method in class com.github.nickrm.jflux.domain.RetentionPolicy

Gets a value indicating whether this retention policy is the default.

J

JFluxClient - Class in com.github.nickrm.jflux

Client for InfluxDB.

JFluxClient.Builder - Class in com.github.nickrm.jflux

Used to construct instances of JFluxClient.

JFluxHttpClient - Class in com.github.nickrm.jflux.api

Makes calls to the InfluxDB HTTP API.

JFluxHttpClient.Builder - Class in com.github.nickrm.jflux.api

Used to construct JFluxHttpClient instances.

M

Measurement - Annotation Type in com.github.nickrm.jflux.annotation

Indicates that instances of a class can be serialized to/deserialized from InfluxDB.

Measurement - Class in com.github.nickrm.jflux.domain

A container of Points, roughly equivalent to a relational DB table.

Measurement.Builder - Class in com.github.nickrm.jflux.domain

Creates instances of Measurement.

metadata(ResponseMetadata) - Method in class com.github.nickrm.jflux.api.response.ApiResponse.Builder

Sets the metadata for this response.

MissingAnnotatedMemberException - Exception in com.github.nickrm.jflux.annotation.exception

Thrown to indicate that a required annotation is missing.

MissingAnnotatedMemberException(Object, Class<? extends Annotation>) - Constructor for exception com.github.nickrm.jflux.annotation.exception.MissingAnnotatedMemberException

Constructs a new exception with the specified target object and annotation type.

N

name(String) - Method in class com.github.nickrm.jflux.domain.Measurement.Builder

Sets the name for the measurement to be constructed.

NoDatabaseSelectedException - Exception in com.github.nickrm.jflux.exception

Thrown to indicate that an operation that requires a database to be preselected has been called, but a database has not been selected.

NoDatabaseSelectedException() - Constructor for exception com.github.nickrm.jflux.exception.NoDatabaseSelectedException

Creates a new instance setting a default detail message.

P

ping() - Method in class com.github.nickrm.jflux.api.JFluxHttpClient

Tests the connection to the InfluxDB API and returns the result.

Point - Class in com.github.nickrm.jflux.domain

A collection of fields within a series.

Point.Builder - Class in com.github.nickrm.jflux.domain

Used to create instances of Point.

points(List<Point>) - Method in class com.github.nickrm.jflux.domain.Measurement.Builder

Sets the points for the measurement to be constructed.

Q

query(String) - Method in class com.github.nickrm.jflux.api.JFluxHttpClient

Executes a query and returns the result.

queryMultipleSeries(String) - Method in class com.github.nickrm.jflux.api.JFluxHttpClient

Executes a query and returns the result.

QueryResult - Class in com.github.nickrm.jflux.api.response

An InfluxQL result, acts as a wrapper for the (possibly multiple) series returned.

QueryResult.Builder - Class in com.github.nickrm.jflux.api.response

Creates instances of QueryResult.

R

replication(int) - Method in class com.github.nickrm.jflux.domain.RetentionPolicy.Builder

Sets the replication factor for the retention policy.

requestId(String) - Method in class com.github.nickrm.jflux.api.response.ResponseMetadata.Builder

Sets the request ID of the response

ResponseMetadata - Class in com.github.nickrm.jflux.api.response

Metadata relevant to an ApiResponse.

ResponseMetadata.Builder - Class in com.github.nickrm.jflux.api.response

Used to build instances of ResponseMetadata.

results(List<QueryResult>) - Method in class com.github.nickrm.jflux.api.response.ApiResponse.Builder

Sets the query results for this response.

RetentionPolicy - Class in com.github.nickrm.jflux.domain

A retention policy specifies how long data is kept for.

RetentionPolicy.Builder - Class in com.github.nickrm.jflux.domain

Used to create instances of RetentionPolicy.

RetentionPolicyAlreadyExistsException - Exception in com.github.nickrm.jflux.exception

Thrown to indicate that a retention policy cannot be created because a retention policy with the same name already exists on the database.

RetentionPolicyAlreadyExistsException(String, String) - Constructor for exception com.github.nickrm.jflux.exception.RetentionPolicyAlreadyExistsException

Creates a new instance setting the message.

retentionPolicyExists(String) - Method in class com.github.nickrm.jflux.JFluxClient

Returns a value indicating whether the specified retention policy exists on the selected database.

retentionPolicyExists(String, String) - Method in class com.github.nickrm.jflux.JFluxClient

Returns a value indicating whether the specified retention policy exists on the specified database.

S

series(List<Measurement>) - Method in class com.github.nickrm.jflux.api.response.QueryResult.Builder

Sets the results of the query.

shardDuration(Duration) - Method in class com.github.nickrm.jflux.domain.RetentionPolicy.Builder

Sets the shard duration for the retention policy.

statementId(int) - Method in class com.github.nickrm.jflux.api.response.QueryResult.Builder

Sets the statement ID for the query result to be constructed.

statusCode(int) - Method in class com.github.nickrm.jflux.api.response.ApiResponse.Builder

Sets the status code for this response.

T

Tag - Annotation Type in com.github.nickrm.jflux.annotation

Indicates that a class member should be written and read as a tag in InfluxDB.

tags(Map<String, String>) - Method in class com.github.nickrm.jflux.domain.Point.Builder

Sets the tags for the point to be constructed.

Timestamp - Annotation Type in com.github.nickrm.jflux.annotation

Indicates that a class member should be written and read as the point timestamp in InfluxDB.

timestamp(Instant) - Method in class com.github.nickrm.jflux.api.response.ResponseMetadata.Builder

Sets the timestamp of the response.

timestamp(Instant) - Method in class com.github.nickrm.jflux.domain.Point.Builder

Sets the timestamp for the point to be constructed.

toString() - Method in class com.github.nickrm.jflux.api.response.ApiResponse

toString() - Method in class com.github.nickrm.jflux.api.response.QueryResult

toString() - Method in class com.github.nickrm.jflux.api.response.ResponseMetadata

toString() - Method in enum com.github.nickrm.jflux.domain.BuildType

toString() - Method in class com.github.nickrm.jflux.domain.Measurement

toString() - Method in class com.github.nickrm.jflux.domain.Point

toString() - Method in class com.github.nickrm.jflux.domain.RetentionPolicy

toString() - Method in class com.github.nickrm.jflux.domain.Version

U

UnknownDatabaseException - Exception in com.github.nickrm.jflux.exception

Throw to indicate that an operation cannot be performed on a database because the database does not exist.

UnknownDatabaseException(String) - Constructor for exception com.github.nickrm.jflux.exception.UnknownDatabaseException

Creates a new instance setting the name of the unknown database.

UnknownRetentionPolicyException - Exception in com.github.nickrm.jflux.exception

Thrown to indicate that an operation cannot be performed on a retention policy because the retention policy does not exist.

UnknownRetentionPolicyException(String, String) - Constructor for exception com.github.nickrm.jflux.exception.UnknownRetentionPolicyException

Creates a new instance setting the message.

useDatabase(String) - Method in class com.github.nickrm.jflux.JFluxClient

Selects a database to use implicitly with methods in this class.

V

valueOf(String) - Static method in enum com.github.nickrm.jflux.domain.BuildType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.nickrm.jflux.domain.BuildType

Returns an array containing the constants of this enum type, in the order they are declared.

Version - Class in com.github.nickrm.jflux.domain

Represents a version following semantic versioning schema.

W

withDuration(Duration) - Method in class com.github.nickrm.jflux.domain.RetentionPolicy

Creates a copy of this instance with the specified RetentionPolicy.duration.

withReplication(int) - Method in class com.github.nickrm.jflux.domain.RetentionPolicy

Creates a copy of this instance with the specified replication factor.

withShardDuration(Duration) - Method in class com.github.nickrm.jflux.domain.RetentionPolicy

Creates a copy of this instance with a new shard duration.

write(String, String) - Method in class com.github.nickrm.jflux.api.JFluxHttpClient

Writes points into the default retention policy.

write(String, String, String) - Method in class com.github.nickrm.jflux.api.JFluxHttpClient

Writes points into the specified retention policy.

write(Object) - Method in class com.github.nickrm.jflux.JFluxClient

Alias for JFluxClient.write(Collection) for a single object.

write(String, Object) - Method in class com.github.nickrm.jflux.JFluxClient

Alias for JFluxClient.write(String, Collection) for a single point.

write(Collection<?>) - Method in class com.github.nickrm.jflux.JFluxClient

Writes the specified data using the specified retention policy.

write(String, Collection<?>) - Method in class com.github.nickrm.jflux.JFluxClient

Writes the specified data to the specified database, using the default retention policy.

write(Object, String) - Method in class com.github.nickrm.jflux.JFluxClient

Alias for JFluxClient.write(Collection, String) for a single point.

write(String, Object, String) - Method in class com.github.nickrm.jflux.JFluxClient

Alias for JFluxClient.write(String, Collection, String) for a single point.

write(Collection<?>, String) - Method in class com.github.nickrm.jflux.JFluxClient

Writes the specified data using the specified retention policy.

write(String, Collection<?>, String) - Method in class com.github.nickrm.jflux.JFluxClient

Writes the specified data to the specified database, using the specified retention policy.

writePoint(String, Point) - Method in class com.github.nickrm.jflux.JFluxClient

Alias for JFluxClient.writePoints(String, Collection) for a single point.

writePoint(String, String, Point) - Method in class com.github.nickrm.jflux.JFluxClient

Alias for JFluxClient.writePoints(String, String, Collection) for a single point.

writePoint(String, Point, String) - Method in class com.github.nickrm.jflux.JFluxClient

Alias for JFluxClient.writePoints(String, Collection, String) for a single point.

writePoint(String, String, Point, String) - Method in class com.github.nickrm.jflux.JFluxClient

Alias for JFluxClient.writePoints(String, String, Collection, String) for a single point.

writePoints(String, Collection<Point>) - Method in class com.github.nickrm.jflux.JFluxClient

Writes the specified points to InfluxDB, using the default retention policy.

writePoints(String, String, Collection<Point>) - Method in class com.github.nickrm.jflux.JFluxClient

Writes the specified points to InfluxDB, using the default retention policy.

writePoints(String, Collection<Point>, String) - Method in class com.github.nickrm.jflux.JFluxClient

Writes the specified points to InfluxDB.

writePoints(String, String, Collection<Point>, String) - Method in class com.github.nickrm.jflux.JFluxClient

Writes the specified points to InfluxDB.

A B C D E F G H I J M N P Q R S T U V W