com.influxdb.client

Interface ChecksApi

public interface ChecksApi

The client of the InfluxDB 2.0 that implement Check Api.

Author:

Jakub Bednar (18/09/2019 08:07)

Method Summary

Modifier and Type	Method and Description
LabelResponse	addLabel(Label label, Check check) Add a label to a check.
LabelResponse	addLabel(String labelID, String checkID) Add a label to a check.
Check	createCheck(Check check) Add new check.
DeadmanCheck	createDeadmanCheck(String name, String query, String field, String every, String timeSince, String staleTime, String messageTemplate, CheckStatusLevel level, String orgID) Add new Deadman check.
ThresholdCheck	createThresholdCheck(String name, String query, String field, String every, String messageTemplate, List<Threshold> thresholds, String orgID) Add new Threshold check.
ThresholdCheck	createThresholdCheck(String name, String query, String field, String every, String messageTemplate, Threshold threshold, String orgID) Add new Threshold check.
void	deleteCheck(Check check) Delete a check.
void	deleteCheck(String checkID) Delete a check.
void	deleteLabel(Label label, Check check) Delete label from a check.
void	deleteLabel(String labelID, String checkID) Delete label from a check.
Check	findCheckByID(String checkID) Get a check.
List<Check>	findChecks(String orgID) Get checks.
Checks	findChecks(String orgID, FindOptions findOptions) Get all checks.
List<Label>	getLabels(Check check) List all labels for a check.
List<Label>	getLabels(String checkID) List all labels for a check.
Check	updateCheck(Check check) Update a check.
Check	updateCheck(String checkID, CheckPatch patch) Update a check.

Method Detail

createThresholdCheck

@Nonnull
ThresholdCheck createThresholdCheck(@Nonnull
                                             String name,
                                             @Nonnull
                                             String query,
                                             @Nonnull
                                             String field,
                                             @Nonnull
                                             String every,
                                             @Nonnull
                                             String messageTemplate,
                                             @Nonnull
                                             Threshold threshold,
                                             @Nonnull
                                             String orgID)

Add new Threshold check.

Parameters:

name - the check name

query - The text of the flux query

field - The field name uses for check

every - Check repetition interval

messageTemplate - template that is used to generate and write a status message

threshold - condition for that specific status

orgID - the organization that owns this check

Returns:

ThresholdCheck created

createThresholdCheck

@Nonnull
ThresholdCheck createThresholdCheck(@Nonnull
                                             String name,
                                             @Nonnull
                                             String query,
                                             @Nonnull
                                             String field,
                                             @Nonnull
                                             String every,
                                             @Nonnull
                                             String messageTemplate,
                                             @Nonnull
                                             List<Threshold> thresholds,
                                             @Nonnull
                                             String orgID)

Add new Threshold check.

Parameters:

name - the check name

query - The text of the flux query

field - The field name uses for check

every - Check repetition interval

messageTemplate - template that is used to generate and write a status message

thresholds - conditions for that specific status

orgID - the organization that owns this check

Returns:

ThresholdCheck created

createDeadmanCheck

@Nonnull
DeadmanCheck createDeadmanCheck(@Nonnull
                                         String name,
                                         @Nonnull
                                         String query,
                                         @Nonnull
                                         String field,
                                         @Nonnull
                                         String every,
                                         @Nonnull
                                         String timeSince,
                                         @Nonnull
                                         String staleTime,
                                         @Nonnull
                                         String messageTemplate,
                                         @Nonnull
                                         CheckStatusLevel level,
                                         @Nonnull
                                         String orgID)

Add new Deadman check.

Parameters:

name - the check name

query - The text of the flux query

field - The field name uses for check

every - Check repetition interval

timeSince - string duration before deadman triggers

staleTime - string duration for time that a series is considered stale and should not trigger deadman

messageTemplate - template that is used to generate and write a status message

level - the state to record if check matches a criteria

orgID - the organization that owns this check

Returns:

DeadmanCheck created

createCheck

@Nonnull
Check createCheck(@Nonnull
                           Check check)

Add new check.

Parameters:

check - check to create

Returns:

Check created

updateCheck

@Nonnull
Check updateCheck(@Nonnull
                           Check check)

Update a check.

Parameters:

check - check update to apply

Returns:

An updated check

updateCheck

@Nonnull
Check updateCheck(@Nonnull
                           String checkID,
                           @Nonnull
                           CheckPatch patch)

Update a check.

Parameters:

checkID - ID of check

patch - update to apply

Returns:

An updated check

deleteCheck

void deleteCheck(@Nonnull
                 Check check)

Delete a check.

Parameters:

check - the check to delete

deleteCheck

void deleteCheck(@Nonnull
                 String checkID)

Delete a check.

Parameters:

checkID - the ID of check to delete

findCheckByID

@Nonnull
Check findCheckByID(@Nonnull
                             String checkID)

Get a check.

Parameters:

checkID - ID of check

Returns:

the check requested

findChecks

@Nonnull
List<Check> findChecks(@Nonnull
                                String orgID)

Get checks.

Parameters:

orgID - only show checks belonging to specified organization

Returns:

A list of checks

findChecks

@Nonnull
Checks findChecks(@Nonnull
                           String orgID,
                           @Nonnull
                           FindOptions findOptions)

Get all checks.

Parameters:

orgID - only show checks belonging to specified organization

findOptions - find options

Returns:

A list of checks

getLabels

@Nonnull
List<Label> getLabels(@Nonnull
                               Check check)

List all labels for a check.

Parameters:

check - the check

Returns:

a list of all labels for a check

getLabels

@Nonnull
List<Label> getLabels(@Nonnull
                               String checkID)

List all labels for a check.

Parameters:

checkID - ID of the check

Returns:

a list of all labels for a check

addLabel

@Nonnull
LabelResponse addLabel(@Nonnull
                                Label label,
                                @Nonnull
                                Check check)

Add a label to a check.

Parameters:

label - label to add

check - the check

Returns:

the label was added to the check

addLabel

@Nonnull
LabelResponse addLabel(@Nonnull
                                String labelID,
                                @Nonnull
                                String checkID)

Add a label to a check.

Parameters:

labelID - ID of label to add

checkID - ID of the check

Returns:

the label was added to the check

deleteLabel

void deleteLabel(@Nonnull
                 Label label,
                 @Nonnull
                 Check check)

Delete label from a check.

Parameters:

label - the label to delete

check - he check

deleteLabel

void deleteLabel(@Nonnull
                 String labelID,
                 @Nonnull
                 String checkID)

Delete label from a check.

Parameters:

labelID - the label id to delete

checkID - ID of the check