Package software.amazon.awssdk.services.lookoutmetrics.model

Class CreateAlertRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lookoutmetrics.model.LookoutMetricsRequest

software.amazon.awssdk.services.lookoutmetrics.model.CreateAlertRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAlertRequest.Builder,CreateAlertRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateAlertRequest
extends LookoutMetricsRequest
implements ToCopyableBuilder<CreateAlertRequest.Builder,CreateAlertRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateAlertRequest.Builder

Method Summary

Modifier and Type	Method	Description
Action	action()	Action that will be triggered when there is an alert.
String	alertDescription()	A description of the alert.
AlertFilters	alertFilters()	The configuration of the alert filters, containing MetricList and DimensionFilterList.
String	alertName()	The name of the alert.
Integer	alertSensitivityThreshold()	An integer from 0 to 100 specifying the alert sensitivity threshold.
String	anomalyDetectorArn()	The ARN of the detector to which the alert is attached.
static CreateAlertRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAlertRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	A list of tags to apply to the alert.
CreateAlertRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

alertName

public final String alertName()

The name of the alert.

Returns:

The name of the alert.

alertSensitivityThreshold

public final Integer alertSensitivityThreshold()

An integer from 0 to 100 specifying the alert sensitivity threshold.

Returns:

An integer from 0 to 100 specifying the alert sensitivity threshold.

alertDescription

public final String alertDescription()

A description of the alert.

Returns:

A description of the alert.

anomalyDetectorArn

public final String anomalyDetectorArn()

The ARN of the detector to which the alert is attached.

Returns:

The ARN of the detector to which the alert is attached.

action

public final Action action()

Action that will be triggered when there is an alert.

Returns:

Action that will be triggered when there is an alert.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

A list of tags to apply to the alert.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A list of tags to apply to the alert.

alertFilters

public final AlertFilters alertFilters()

The configuration of the alert filters, containing MetricList and DimensionFilterList.

Returns:

The configuration of the alert filters, containing MetricList and DimensionFilterList.

toBuilder

public CreateAlertRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAlertRequest.Builder,CreateAlertRequest>

Specified by:

toBuilder in class LookoutMetricsRequest

builder

public static CreateAlertRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateAlertRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo