Class BehaviorCriteria
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BehaviorCriteria.Builder,
BehaviorCriteria>
The criteria by which the behavior is determined to be normal.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic BehaviorCriteria.Builder
builder()
final ComparisonOperator
The operator that relates the thing measured (metric
) to the criteria (containing avalue
orstatisticalThreshold
).final String
The operator that relates the thing measured (metric
) to the criteria (containing avalue
orstatisticalThreshold
).final Integer
If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.final Integer
If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared.final Integer
Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example,NUM_MESSAGES_SENT
).final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
The configuration of an ML Detectstatic Class
<? extends BehaviorCriteria.Builder> final StatisticalThreshold
A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final MetricValue
value()
The value to be compared with themetric
.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
comparisonOperator
The operator that relates the thing measured (
metric
) to the criteria (containing avalue
orstatisticalThreshold
). Valid operators include:-
string-list
:in-set
andnot-in-set
-
number-list
:in-set
andnot-in-set
-
ip-address-list
:in-cidr-set
andnot-in-cidr-set
-
number
:less-than
,less-than-equals
,greater-than
, andgreater-than-equals
If the service returns an enum value that is not available in the current SDK version,
comparisonOperator
will returnComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparisonOperatorAsString()
.- Returns:
- The operator that relates the thing measured (
metric
) to the criteria (containing avalue
orstatisticalThreshold
). Valid operators include:-
string-list
:in-set
andnot-in-set
-
number-list
:in-set
andnot-in-set
-
ip-address-list
:in-cidr-set
andnot-in-cidr-set
-
number
:less-than
,less-than-equals
,greater-than
, andgreater-than-equals
-
- See Also:
-
-
comparisonOperatorAsString
The operator that relates the thing measured (
metric
) to the criteria (containing avalue
orstatisticalThreshold
). Valid operators include:-
string-list
:in-set
andnot-in-set
-
number-list
:in-set
andnot-in-set
-
ip-address-list
:in-cidr-set
andnot-in-cidr-set
-
number
:less-than
,less-than-equals
,greater-than
, andgreater-than-equals
If the service returns an enum value that is not available in the current SDK version,
comparisonOperator
will returnComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparisonOperatorAsString()
.- Returns:
- The operator that relates the thing measured (
metric
) to the criteria (containing avalue
orstatisticalThreshold
). Valid operators include:-
string-list
:in-set
andnot-in-set
-
number-list
:in-set
andnot-in-set
-
ip-address-list
:in-cidr-set
andnot-in-cidr-set
-
number
:less-than
,less-than-equals
,greater-than
, andgreater-than-equals
-
- See Also:
-
-
value
The value to be compared with the
metric
.- Returns:
- The value to be compared with the
metric
.
-
durationSeconds
Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example,
NUM_MESSAGES_SENT
). For astatisticalThreshhold
metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.- Returns:
- Use this to specify the time duration over which the behavior is evaluated, for those criteria that have
a time dimension (for example,
NUM_MESSAGES_SENT
). For astatisticalThreshhold
metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.
-
consecutiveDatapointsToAlarm
If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
- Returns:
- If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
-
consecutiveDatapointsToClear
If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
- Returns:
- If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
-
statisticalThreshold
A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
- Returns:
- A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
-
mlDetectionConfig
The configuration of an ML Detect
- Returns:
- The configuration of an ML Detect
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<BehaviorCriteria.Builder,
BehaviorCriteria> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-