Package ai.shipeasy.admin.model

Class CreateAlertRuleRequest

java.lang.Object

ai.shipeasy.admin.model.CreateAlertRuleRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class CreateAlertRuleRequest
extends Object

CreateAlertRuleRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CreateAlertRuleRequest.ComparatorEnum	How the metric value is compared to the threshold (gt/gte/lt/lte).
static class	CreateAlertRuleRequest.CustomTypeAdapterFactory
static enum	CreateAlertRuleRequest.SeverityEnum	Severity of the raised alert.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_COMPARATOR
static final String	SERIALIZED_NAME_ENABLED
static final String	SERIALIZED_NAME_METRIC_ID
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_NOTIFY
static final String	SERIALIZED_NAME_SEVERITY
static final String	SERIALIZED_NAME_THRESHOLD
static final String	SERIALIZED_NAME_WINDOW_HOURS

Constructor Summary

Constructors

Constructor	Description
CreateAlertRuleRequest()

Method Summary

Modifier and Type	Method	Description
CreateAlertRuleRequest	comparator(CreateAlertRuleRequest.ComparatorEnum comparator)
CreateAlertRuleRequest	enabled(Boolean enabled)
boolean	equals(Object o)
static CreateAlertRuleRequest	fromJson(String jsonString)	Create an instance of CreateAlertRuleRequest given an JSON string
CreateAlertRuleRequest.ComparatorEnum	getComparator()	How the metric value is compared to the threshold (gt/gte/lt/lte).
Boolean	getEnabled()	Whether the rule is evaluated by the cron.
String	getMetricId()	Id of the metric to evaluate.
String	getName()	Human label for the rule, shown on the alert and the rules list.
NotificationTarget	getNotify()	Get notify
CreateAlertRuleRequest.SeverityEnum	getSeverity()	Severity of the raised alert.
BigDecimal	getThreshold()	Threshold the metric value is compared against.
Integer	getWindowHours()	Lookback window (hours) the metric is aggregated over.
int	hashCode()
CreateAlertRuleRequest	metricId(String metricId)
CreateAlertRuleRequest	name(String name)
CreateAlertRuleRequest	notify(NotificationTarget notify)
void	setComparator(CreateAlertRuleRequest.ComparatorEnum comparator)
void	setEnabled(Boolean enabled)
void	setMetricId(String metricId)
void	setName(String name)
void	setNotify(NotificationTarget notify)
void	setSeverity(CreateAlertRuleRequest.SeverityEnum severity)
void	setThreshold(BigDecimal threshold)
void	setWindowHours(Integer windowHours)
CreateAlertRuleRequest	severity(CreateAlertRuleRequest.SeverityEnum severity)
CreateAlertRuleRequest	threshold(BigDecimal threshold)
String	toJson()	Convert an instance of CreateAlertRuleRequest to an JSON string
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found
CreateAlertRuleRequest	windowHours(Integer windowHours)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_METRIC_ID

public static final String SERIALIZED_NAME_METRIC_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_COMPARATOR

public static final String SERIALIZED_NAME_COMPARATOR

See Also:

• Constant Field Values

SERIALIZED_NAME_THRESHOLD

public static final String SERIALIZED_NAME_THRESHOLD

See Also:

• Constant Field Values

SERIALIZED_NAME_WINDOW_HOURS

public static final String SERIALIZED_NAME_WINDOW_HOURS

See Also:

• Constant Field Values

SERIALIZED_NAME_SEVERITY

public static final String SERIALIZED_NAME_SEVERITY

See Also:

• Constant Field Values

SERIALIZED_NAME_ENABLED

public static final String SERIALIZED_NAME_ENABLED

See Also:

• Constant Field Values

SERIALIZED_NAME_NOTIFY

public static final String SERIALIZED_NAME_NOTIFY

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

CreateAlertRuleRequest

public CreateAlertRuleRequest()

Method Details

name

public CreateAlertRuleRequest name(@Nonnull
 String name)

getName

@Nonnull
public String getName()

Human label for the rule, shown on the alert and the rules list.

Returns:

name

setName

public void setName(@Nonnull
 String name)

metricId

public CreateAlertRuleRequest metricId(@Nonnull
 String metricId)

getMetricId

@Nonnull
public String getMetricId()

Id of the metric to evaluate.

Returns:

metricId

setMetricId

public void setMetricId(@Nonnull
 String metricId)

comparator

public CreateAlertRuleRequest comparator(@Nonnull
 CreateAlertRuleRequest.ComparatorEnum comparator)

getComparator

@Nonnull
public CreateAlertRuleRequest.ComparatorEnum getComparator()

How the metric value is compared to the threshold (gt/gte/lt/lte).

Returns:

comparator

setComparator

public void setComparator(@Nonnull
 CreateAlertRuleRequest.ComparatorEnum comparator)

threshold

public CreateAlertRuleRequest threshold(@Nonnull
 BigDecimal threshold)

getThreshold

@Nonnull
public BigDecimal getThreshold()

Threshold the metric value is compared against.

Returns:

threshold

setThreshold

public void setThreshold(@Nonnull
 BigDecimal threshold)

windowHours

public CreateAlertRuleRequest windowHours(@Nullable
 Integer windowHours)

getWindowHours

@Nullable
public Integer getWindowHours()

Lookback window (hours) the metric is aggregated over. 1–720. minimum: 1 maximum: 720

Returns:

windowHours

setWindowHours

public void setWindowHours(@Nullable
 Integer windowHours)

severity

public CreateAlertRuleRequest severity(@Nullable
 CreateAlertRuleRequest.SeverityEnum severity)

getSeverity

@Nullable
public CreateAlertRuleRequest.SeverityEnum getSeverity()

Severity of the raised alert.

Returns:

severity

setSeverity

public void setSeverity(@Nullable
 CreateAlertRuleRequest.SeverityEnum severity)

enabled

public CreateAlertRuleRequest enabled(@Nullable
 Boolean enabled)

getEnabled

@Nullable
public Boolean getEnabled()

Whether the rule is evaluated by the cron.

Returns:

enabled

setEnabled

public void setEnabled(@Nullable
 Boolean enabled)

notify

public CreateAlertRuleRequest notify(@Nullable
 NotificationTarget notify)

getNotify

@Nullable
public NotificationTarget getNotify()

Get notify

Returns:

notify

setNotify

public void setNotify(@Nullable
 NotificationTarget notify)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to CreateAlertRuleRequest

fromJson

public static CreateAlertRuleRequest fromJson(String jsonString)
                                       throws IOException

Create an instance of CreateAlertRuleRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CreateAlertRuleRequest

Throws:

IOException - if the JSON string is invalid with respect to CreateAlertRuleRequest

toJson

public String toJson()

Convert an instance of CreateAlertRuleRequest to an JSON string

Returns:

JSON string