Categorygithub.com/orangetux/kapacitorclientv1

package

1.0.0

Repository: https://github.com/orangetux/kapacitor.git

Documentation: pkg.go.dev

# README

Kapacitor HTTP API Go client

This package provides an official Go client package for the Kapacitor HTTP API.

API stability

NOTE: This package will not be considered stable until the 1.0 release of Kapacitor.

This is version 1 of the client, after the 1.0 release no breaking changes will be made to this package. Future versions may be added as necessary.

Docs

# Functions

New

Create a new client.

# Constants

BatchTask

No description provided by the author

BearerAuthentication

Supported authentication methods.

DefaultUserAgent

No description provided by the author

Disabled

No description provided by the author

Enabled

No description provided by the author

Failed

No description provided by the author

Fast

No description provided by the author

Finished

No description provided by the author

Real

No description provided by the author

Running

No description provided by the author

Self

No description provided by the author

StreamTask

No description provided by the author

UserAuthentication

Supported authentication methods.

VarBool

No description provided by the author

VarDuration

No description provided by the author

VarFloat

No description provided by the author

VarInt

No description provided by the author

VarLambda

No description provided by the author

VarList

No description provided by the author

VarRegex

No description provided by the author

VarStar

No description provided by the author

VarString

No description provided by the author

VarUnknown

No description provided by the author

# Structs

Client

Basic HTTP client.

Config

HTTP configuration for connecting to Kapacitor.

CreateReplayOptions

No description provided by the author

CreateTaskOptions

No description provided by the author

CreateTemplateOptions

No description provided by the author

Credentials

Set of credentials depending on the authentication method.

DBRP

No description provided by the author

DebugVars

No description provided by the author

ExecutionStats

Statistics about the execution of a task.

Link

No description provided by the author

ListRecordingsOptions

No description provided by the author

ListReplaysOptions

No description provided by the author

ListTasksOptions

No description provided by the author

ListTemplatesOptions

No description provided by the author

LogLevelOptions

No description provided by the author

RecordBatchOptions

No description provided by the author

Recording

Information about a recording.

RecordQueryOptions

No description provided by the author

RecordStreamOptions

No description provided by the author

Replay

Information about a replay.

ReplayBatchOptions

No description provided by the author

ReplayQueryOptions

No description provided by the author

Stat

No description provided by the author

Task

A Task plus its read-only attributes.

TaskOptions

No description provided by the author

Template

A Template plus its read-only attributes.

TemplateOptions

No description provided by the author

UpdateTaskOptions

No description provided by the author

UpdateTemplateOptions

No description provided by the author

Var

No description provided by the author

# Type aliases

AuthenticationMethod

AuthenticationMethod defines the type of authentication used.

Clock

No description provided by the author

Relation

No description provided by the author

Status

No description provided by the author

TaskStatus

No description provided by the author

TaskType

No description provided by the author

Vars

No description provided by the author

VarType

No description provided by the author