api library

Classes

AddResourceMemberRequestBody
ApiClient
ApiKeyAuth
Authentication
Authorization
AuthorizationAllOf
AuthorizationPostRequest
AuthorizationPostRequestStatusEnum
If inactive the token is inactive and requests using the token will be rejected.
AuthorizationPostRequestStatusEnumTypeTransformer
Transformation class that can encode an instance of AuthorizationPostRequestStatusEnum to String, and decode dynamic data back to AuthorizationPostRequestStatusEnum.
Authorizations
AuthorizationsApi
AuthorizationStatusEnum
If inactive the token is inactive and requests using the token will be rejected.
AuthorizationStatusEnumTypeTransformer
Transformation class that can encode an instance of AuthorizationStatusEnum to String, and decode dynamic data back to AuthorizationStatusEnum.
AuthorizationUpdateRequest
AuthorizationUpdateRequestStatusEnum
If inactive the token is inactive and requests using the token will be rejected.
AuthorizationUpdateRequestStatusEnumTypeTransformer
Transformation class that can encode an instance of AuthorizationUpdateRequestStatusEnum to String, and decode dynamic data back to AuthorizationUpdateRequestStatusEnum.
Bucket
Buckets
BucketsApi
BucketTypeEnum
BucketTypeEnumTypeTransformer
Transformation class that can encode an instance of BucketTypeEnum to String, and decode dynamic data back to BucketTypeEnum.
DBRP
DBRPCreate
DBRPGet
DBRPs
DBRPsApi
DBRPUpdate
DefaultService
Superclass for all services.
DeleteApi
DeletePredicateRequest
DeleteService
DeserializationMessage
Primarily intended for use in an isolate.
Dialect
DialectAnnotationsEnum
DialectAnnotationsEnumTypeTransformer
Transformation class that can encode an instance of DialectAnnotationsEnum to String, and decode dynamic data back to DialectAnnotationsEnum.
DialectDateTimeFormatEnum
Format of timestamps
DialectDateTimeFormatEnumTypeTransformer
Transformation class that can encode an instance of DialectDateTimeFormatEnum to String, and decode dynamic data back to DialectDateTimeFormatEnum.
FluxColumn
Holds metadata about the column the in the table
FluxRecord
FluxRecord represents row in the Flux query response.
FluxTableMetaData
Represents metadata of a {@link http://bit.ly/flux-spec#table | flux table}.
FluxTransformer
Parses Flux query result and transforms the CSV stream of List
HealthApi
HealthCheck
HealthCheckStatusEnum
HealthCheckStatusEnumTypeTransformer
Transformation class that can encode an instance of HealthCheckStatusEnum to String, and decode dynamic data back to HealthCheckStatusEnum.
HttpBasicAuth
HttpBearerAuth
InfluxDBClient
Main InfluxDB client class
InvokableScriptsApi
InvokableScriptsService
Use API invokable scripts to create custom InfluxDB API endpoints that query, process, and shape data.
IsOnboarding
Label
LabelCreateRequest
LabelMapping
LabelResponse
LabelsApi
LabelsResponse
LabelUpdate
LogEvent
LoggingClient
Logging wrapper for http client.
Logs
OAuth
OnboardingRequest
OnboardingResponse
Organization
Organizations
OrganizationsApi
OrganizationStatusEnum
If inactive the organization is inactive.
OrganizationStatusEnumTypeTransformer
Transformation class that can encode an instance of OrganizationStatusEnum to String, and decode dynamic data back to OrganizationStatusEnum.
PasswordResetBody
PatchBucketRequest
PatchOrganizationRequest
PatchRetentionRule
PatchRetentionRuleTypeEnum
PatchRetentionRuleTypeEnumTypeTransformer
Transformation class that can encode an instance of PatchRetentionRuleTypeEnum to String, and decode dynamic data back to PatchRetentionRuleTypeEnum.
Permission
PermissionActionEnum
PermissionActionEnumTypeTransformer
Transformation class that can encode an instance of PermissionActionEnum to String, and decode dynamic data back to PermissionActionEnum.
PingApi
Point
Point defines values of a single measurement.
PostBucketRequest
PostOrganizationRequest
Query
QueryApi
QueryOptions
QueryParam
QueryService
Query InfluxDB 2.x. Provides methods for stream Flux query. See {@link https://docs.influxdata.com/influxdb/latest/api/#operation/PostQuery }
QueryTypeEnum
The type of query. Must be "flux".
QueryTypeEnumTypeTransformer
Transformation class that can encode an instance of QueryTypeEnum to String, and decode dynamic data back to QueryTypeEnum.
Ready
ReadyApi
ReadyStatusEnum
ReadyStatusEnumTypeTransformer
Transformation class that can encode an instance of ReadyStatusEnum to String, and decode dynamic data back to ReadyStatusEnum.
Resource
ResourceMember
ResourceMemberAllOf
ResourceMemberAllOfRoleEnum
ResourceMemberAllOfRoleEnumTypeTransformer
Transformation class that can encode an instance of ResourceMemberAllOfRoleEnum to String, and decode dynamic data back to ResourceMemberAllOfRoleEnum.
ResourceMemberRoleEnum
ResourceMemberRoleEnumTypeTransformer
Transformation class that can encode an instance of ResourceMemberRoleEnum to String, and decode dynamic data back to ResourceMemberRoleEnum.
ResourceMembers
ResourceMemberStatusEnum
If inactive the user is inactive.
ResourceMemberStatusEnumTypeTransformer
Transformation class that can encode an instance of ResourceMemberStatusEnum to String, and decode dynamic data back to ResourceMemberStatusEnum.
ResourceOwner
ResourceOwnerAllOf
ResourceOwnerAllOfRoleEnum
ResourceOwnerAllOfRoleEnumTypeTransformer
Transformation class that can encode an instance of ResourceOwnerAllOfRoleEnum to String, and decode dynamic data back to ResourceOwnerAllOfRoleEnum.
ResourceOwnerRoleEnum
ResourceOwnerRoleEnumTypeTransformer
Transformation class that can encode an instance of ResourceOwnerRoleEnum to String, and decode dynamic data back to ResourceOwnerRoleEnum.
ResourceOwners
ResourceOwnerStatusEnum
If inactive the user is inactive.
ResourceOwnerStatusEnumTypeTransformer
Transformation class that can encode an instance of ResourceOwnerStatusEnum to String, and decode dynamic data back to ResourceOwnerStatusEnum.
ResourceTypeEnum
ResourceTypeEnumTypeTransformer
Transformation class that can encode an instance of ResourceTypeEnum to String, and decode dynamic data back to ResourceTypeEnum.
RetentionRule
RetentionRuleTypeEnum
RetentionRuleTypeEnumTypeTransformer
Transformation class that can encode an instance of RetentionRuleTypeEnum to String, and decode dynamic data back to RetentionRuleTypeEnum.
RetryOptions
Object holding options for retrying a function.
Run
RunManually
Runs
RunStatusEnum
RunStatusEnumTypeTransformer
Transformation class that can encode an instance of RunStatusEnum to String, and decode dynamic data back to RunStatusEnum.
SchemaType
SchemaTypeTypeTransformer
Transformation class that can encode an instance of SchemaType to String, and decode dynamic data back to SchemaType.
Script
ScriptCreateRequest
ScriptInvocationParams
ScriptLanguage
ScriptLanguageTypeTransformer
Transformation class that can encode an instance of ScriptLanguage to String, and decode dynamic data back to ScriptLanguage.
Scripts
ScriptUpdateRequest
SecretKeys
SecretKeysResponse
SecretKeysResponseAllOf
SecretsApi
SetupApi
Task
TaskCreateRequest
TaskLastRunStatusEnum
TaskLastRunStatusEnumTypeTransformer
Transformation class that can encode an instance of TaskLastRunStatusEnum to String, and decode dynamic data back to TaskLastRunStatusEnum.
Tasks
TasksApi
TaskStatusType
TaskStatusTypeTypeTransformer
Transformation class that can encode an instance of TaskStatusType to String, and decode dynamic data back to TaskStatusType.
TaskUpdateRequest
User
UserResponse
UserResponseStatusEnum
If inactive the user is inactive.
UserResponseStatusEnumTypeTransformer
Transformation class that can encode an instance of UserResponseStatusEnum to String, and decode dynamic data back to UserResponseStatusEnum.
Users
UsersApi
UserStatusEnum
If inactive the user is inactive.
UserStatusEnumTypeTransformer
Transformation class that can encode an instance of UserStatusEnum to String, and decode dynamic data back to UserStatusEnum.
Variable
VariableProperties
VariablePropertiesTypeEnum
VariablePropertiesTypeEnumTypeTransformer
Transformation class that can encode an instance of VariablePropertiesTypeEnum to String, and decode dynamic data back to VariablePropertiesTypeEnum.
Variables
VariablesApi
WriteApi
WriteOptions
Options used by WriteApi .
WritePrecision
WritePrecisionTypeTransformer
Transformation class that can encode an instance of WritePrecision to String, and decode dynamic data back to WritePrecision.
WriteService

Enums

FluxResponseMode
The configuration for expected amount of metadata response from InfluxDB.

Constants

annotationDatatype → const String
annotationDefault → const String
annotationGroup → const String
annotations → const List<String>

Properties

clientName String
getter/setter pair
clientVersion String
getter/setter pair
defaultApiClient ApiClient
getter/setter pair
defaultDialect Dialect
final
defaultQueryOptions QueryOptions
final
logPrint ↔ void Function(Object object)
Log printer; defaults print log to console.
getter/setter pair
serializers Map<String, dynamic>
Map of serializers for each datatype in flux query response
getter/setter pair

Functions

deserializeAsync(DeserializationMessage message) Future
Primarily intended for use in an isolate.
identity<T>(T x) → T
Identity function
mapCastOfType<K, V>(dynamic map, String key) Map<K, V>?
Returns a valid Map<K, V> found at the specified Map key, null otherwise.
mapDateTime(dynamic map, String key, [String? pattern]) DateTime?
Returns a valid DateTime found at the specified Map key, null otherwise.
mapValueOfType<T>(dynamic map, String key) → T?
Returns a valid T value found at the specified Map key, null otherwise.
parameterToString(dynamic value) String
Format the given parameter object into a String.
serializeAsync(Object value) Future<String>
Primarily intended for use in an isolate.
serializeDateTimeAsDate() → void

Typedefs

HttpBearerAuthProvider = String Function()

Exceptions / Errors

ApiException
FluxCsvParserException
FluxCsvParserException is thrown when flux csv parser failed
FluxQueryException
FluxQueryException is thrown when Flux response contains error from server
InfluxDBException
RetryException