Interface DescribeAlarmModelResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeAlarmModelResponse.Builder,
,DescribeAlarmModelResponse> IotEventsResponse.Builder
,SdkBuilder<DescribeAlarmModelResponse.Builder,
,DescribeAlarmModelResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeAlarmModelResponse
-
Method Summary
Modifier and TypeMethodDescriptionalarmCapabilities
(Consumer<AlarmCapabilities.Builder> alarmCapabilities) Contains the configuration information of alarm state changes.alarmCapabilities
(AlarmCapabilities alarmCapabilities) Contains the configuration information of alarm state changes.alarmEventActions
(Consumer<AlarmEventActions.Builder> alarmEventActions) Contains information about one or more alarm actions.alarmEventActions
(AlarmEventActions alarmEventActions) Contains information about one or more alarm actions.alarmModelArn
(String alarmModelArn) The ARN of the alarm model.alarmModelDescription
(String alarmModelDescription) The description of the alarm model.alarmModelName
(String alarmModelName) The name of the alarm model.alarmModelVersion
(String alarmModelVersion) The version of the alarm model.alarmNotification
(Consumer<AlarmNotification.Builder> alarmNotification) Contains information about one or more notification actions.alarmNotification
(AlarmNotification alarmNotification) Contains information about one or more notification actions.alarmRule
(Consumer<AlarmRule.Builder> alarmRule) Defines when your alarm is invoked.Defines when your alarm is invoked.creationTime
(Instant creationTime) The time the alarm model was created, in the Unix epoch format.An input attribute used as a key to create an alarm.lastUpdateTime
(Instant lastUpdateTime) The time the alarm model was last updated, in the Unix epoch format.The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.A non-negative integer that reflects the severity level of the alarm.The status of the alarm model.status
(AlarmModelVersionStatus status) The status of the alarm model.statusMessage
(String statusMessage) Contains information about the status of the alarm model.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.iotevents.model.IotEventsResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
creationTime
The time the alarm model was created, in the Unix epoch format.
- Parameters:
creationTime
- The time the alarm model was created, in the Unix epoch format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmModelArn
The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
- Parameters:
alarmModelArn
- The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmModelVersion
The version of the alarm model.
- Parameters:
alarmModelVersion
- The version of the alarm model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdateTime
The time the alarm model was last updated, in the Unix epoch format.
- Parameters:
lastUpdateTime
- The time the alarm model was last updated, in the Unix epoch format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
statusMessage
Contains information about the status of the alarm model.
- Parameters:
statusMessage
- Contains information about the status of the alarm model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmModelName
The name of the alarm model.
- Parameters:
alarmModelName
- The name of the alarm model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmModelDescription
The description of the alarm model.
- Parameters:
alarmModelDescription
- The description of the alarm model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
key
An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.
- Parameters:
key
- An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
severity
A non-negative integer that reflects the severity level of the alarm.
- Parameters:
severity
- A non-negative integer that reflects the severity level of the alarm.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmRule
Defines when your alarm is invoked.
- Parameters:
alarmRule
- Defines when your alarm is invoked.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmRule
Defines when your alarm is invoked.
This is a convenience method that creates an instance of theAlarmRule.Builder
avoiding the need to create one manually viaAlarmRule.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toalarmRule(AlarmRule)
.- Parameters:
alarmRule
- a consumer that will call methods onAlarmRule.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
alarmNotification
Contains information about one or more notification actions.
- Parameters:
alarmNotification
- Contains information about one or more notification actions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmNotification
default DescribeAlarmModelResponse.Builder alarmNotification(Consumer<AlarmNotification.Builder> alarmNotification) Contains information about one or more notification actions.
This is a convenience method that creates an instance of theAlarmNotification.Builder
avoiding the need to create one manually viaAlarmNotification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toalarmNotification(AlarmNotification)
.- Parameters:
alarmNotification
- a consumer that will call methods onAlarmNotification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
alarmEventActions
Contains information about one or more alarm actions.
- Parameters:
alarmEventActions
- Contains information about one or more alarm actions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmEventActions
default DescribeAlarmModelResponse.Builder alarmEventActions(Consumer<AlarmEventActions.Builder> alarmEventActions) Contains information about one or more alarm actions.
This is a convenience method that creates an instance of theAlarmEventActions.Builder
avoiding the need to create one manually viaAlarmEventActions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toalarmEventActions(AlarmEventActions)
.- Parameters:
alarmEventActions
- a consumer that will call methods onAlarmEventActions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
alarmCapabilities
Contains the configuration information of alarm state changes.
- Parameters:
alarmCapabilities
- Contains the configuration information of alarm state changes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmCapabilities
default DescribeAlarmModelResponse.Builder alarmCapabilities(Consumer<AlarmCapabilities.Builder> alarmCapabilities) Contains the configuration information of alarm state changes.
This is a convenience method that creates an instance of theAlarmCapabilities.Builder
avoiding the need to create one manually viaAlarmCapabilities.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toalarmCapabilities(AlarmCapabilities)
.- Parameters:
alarmCapabilities
- a consumer that will call methods onAlarmCapabilities.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-