package
1.7.6
Repository: https://github.com/influxdata/kapacitor.git
Documentation: pkg.go.dev

# Functions

ErrTimeout returns a new TimeoutError.
NewClient returns a new Client, which will make requests to the Meta node listening on addr.
NewError returns a new Error value.

# Constants

BasicAuth means basic user authentication will be used.
BearerAuth means JWT tokens will be used.
DefaultBackoffCap is the maximum duration a backoff value can have.
DefaultTimeout is the duration that the client will continue to retry a failed operation.
MaxClientRedirects is the maximum number of redirects the Client will attempt to follow for a single request, before failing.
NoAuth means no authentication will be used.

# Variables

ErrAddressMissing is returned when a required addr parameter is missing.
ErrAntiEntropyDisabled is returned when the anti-entropy service returns a 501 Not Implemented HTTP status.
ErrEmptyCluster is returned when there are no nodes known to the cluster.
ErrHTTPAddressMissing is returned when a required httpAddr parameter is missing.
ErrLeaseConflict is returned when there is a conflict while attempting to require a lease.
ErrLeaseNameMissing is returned when a required lease name is missing.
ErrMaximumRedirectsReached is returned when a Client has been redirected too many times for a single request.
ErrNotMetaNode is returned when attempting to add a non-meta node as a meta node in the cluster.
ErrTCPAddressMissing is returned when a required tcpAddr parameter is missing.
UseAuth sets the authentication type and credentials that will be used.
WithTimeout specifies the duration the client will continue to retry failed operations before giving up.
WithTLS specifies if communication to the meta node uses the specified TLS config if any and if we skip verifying certificates, allowing for self-signed certificates.

# Structs

Client is a client for the HTTP API exposed by a Plutonium Meta node.
Error represent an error message sent in a response body from a meta node.
A FatalError is returned when an operation on the meta node API was not successful and retrying the operation would always result in the same error being returned.
A TimeoutError is returned when an operation on the meta node API was not successful, and repeated attempts to succeed have failed.
User holds information about a user's credentials and permissions.

# Type aliases

AuthType identifies a method of authentication.
ClientOption is a functional option for a Client.
Permission type NOTE: Keep this type up-to-date with the corresponding type in meta/data.go The type cannot be imported as it creates an import cycle.