AlarmModelVersionSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.iotevents.model.AlarmModelVersionSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AlarmModelVersionSummary.Builder,AlarmModelVersionSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class AlarmModelVersionSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AlarmModelVersionSummary.Builder,AlarmModelVersionSummary>

Contains a summary of an alarm model version.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AlarmModelVersionSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AlarmModelVersionSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`alarmModelArn()` The ARN of the alarm model.
`String`	`alarmModelName()` The name of the alarm model.
`String`	`alarmModelVersion()` The version of the alarm model.
`static AlarmModelVersionSummary.Builder`	`builder()`
`Instant`	`creationTime()` The time the alarm model was created, in the Unix epoch format.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`lastUpdateTime()` The time the alarm model was last updated, in the Unix epoch format.
`String`	`roleArn()` The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AlarmModelVersionSummary.Builder>`	`serializableBuilderClass()`
`AlarmModelVersionStatus`	`status()` The status of the alarm model.
`String`	`statusAsString()` The status of the alarm model.
`String`	`statusMessage()` Contains information about the status of the alarm model version.
`AlarmModelVersionSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - alarmModelName
```
public final String alarmModelName()
```
    The name of the alarm model.
    
    Returns:
    
    The name of the alarm model.
  - alarmModelArn
```
public final String alarmModelArn()
```
    The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
    
    Returns:
    
    The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
  - alarmModelVersion
```
public final String alarmModelVersion()
```
    The version of the alarm model.
    
    Returns:
    
    The version of the alarm model.
  - roleArn
```
public final String roleArn()
```
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
    
    Returns:
    
    The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
  - creationTime
```
public final Instant creationTime()
```
    The time the alarm model was created, in the Unix epoch format.
    
    Returns:
    
    The time the alarm model was created, in the Unix epoch format.
  - lastUpdateTime
```
public final Instant lastUpdateTime()
```
    The time the alarm model was last updated, in the Unix epoch format.
    
    Returns:
    
    The time the alarm model was last updated, in the Unix epoch format.
  - status
```
public final AlarmModelVersionStatus status()
```
    The status of the alarm model. The status can be one of the following values:
    - ACTIVE - The alarm model is active and it's ready to evaluate data.
    - ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.
    - INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.
    - FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
    If the service returns an enum value that is not available in the current SDK version, status will return AlarmModelVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    The status of the alarm model. The status can be one of the following values:
    
    ACTIVE - The alarm model is active and it's ready to evaluate data.
    
    ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.
    
    INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.
    
    FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
    See Also:
    
    AlarmModelVersionStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the alarm model. The status can be one of the following values:
    - ACTIVE - The alarm model is active and it's ready to evaluate data.
    - ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.
    - INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.
    - FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
    If the service returns an enum value that is not available in the current SDK version, status will return AlarmModelVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    The status of the alarm model. The status can be one of the following values:
    
    ACTIVE - The alarm model is active and it's ready to evaluate data.
    
    ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.
    
    INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.
    
    FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
    See Also:
    
    AlarmModelVersionStatus
  - statusMessage
```
public final String statusMessage()
```
    Contains information about the status of the alarm model version.
    
    Returns:
    
    Contains information about the status of the alarm model version.
  - toBuilder
```
public AlarmModelVersionSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AlarmModelVersionSummary.Builder,AlarmModelVersionSummary>
  - builder
```
public static AlarmModelVersionSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AlarmModelVersionSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AlarmModelVersionSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

alarmModelName

alarmModelArn

alarmModelVersion

roleArn

creationTime

lastUpdateTime

status

statusAsString

statusMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields