Package software.amazon.awssdk.services.iotevents.model

Interface DescribeAlarmModelResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeAlarmModelResponse.Builder,DescribeAlarmModelResponse>, IotEventsResponse.Builder, SdkBuilder<DescribeAlarmModelResponse.Builder,DescribeAlarmModelResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeAlarmModelResponse

public static interface DescribeAlarmModelResponse.Builder
extends IotEventsResponse.Builder, SdkPojo, CopyableBuilder<DescribeAlarmModelResponse.Builder,DescribeAlarmModelResponse>

Method Summary

Modifier and Type	Method	Description
default DescribeAlarmModelResponse.Builder	alarmCapabilities(Consumer<AlarmCapabilities.Builder> alarmCapabilities)	Contains the configuration information of alarm state changes.
DescribeAlarmModelResponse.Builder	alarmCapabilities(AlarmCapabilities alarmCapabilities)	Contains the configuration information of alarm state changes.
default DescribeAlarmModelResponse.Builder	alarmEventActions(Consumer<AlarmEventActions.Builder> alarmEventActions)	Contains information about one or more alarm actions.
DescribeAlarmModelResponse.Builder	alarmEventActions(AlarmEventActions alarmEventActions)	Contains information about one or more alarm actions.
DescribeAlarmModelResponse.Builder	alarmModelArn(String alarmModelArn)	The ARN of the alarm model.
DescribeAlarmModelResponse.Builder	alarmModelDescription(String alarmModelDescription)	The description of the alarm model.
DescribeAlarmModelResponse.Builder	alarmModelName(String alarmModelName)	The name of the alarm model.
DescribeAlarmModelResponse.Builder	alarmModelVersion(String alarmModelVersion)	The version of the alarm model.
default DescribeAlarmModelResponse.Builder	alarmNotification(Consumer<AlarmNotification.Builder> alarmNotification)	Contains information about one or more notification actions.
DescribeAlarmModelResponse.Builder	alarmNotification(AlarmNotification alarmNotification)	Contains information about one or more notification actions.
default DescribeAlarmModelResponse.Builder	alarmRule(Consumer<AlarmRule.Builder> alarmRule)	Defines when your alarm is invoked.
DescribeAlarmModelResponse.Builder	alarmRule(AlarmRule alarmRule)	Defines when your alarm is invoked.
DescribeAlarmModelResponse.Builder	creationTime(Instant creationTime)	The time the alarm model was created, in the Unix epoch format.
DescribeAlarmModelResponse.Builder	key(String key)	An input attribute used as a key to create an alarm.
DescribeAlarmModelResponse.Builder	lastUpdateTime(Instant lastUpdateTime)	The time the alarm model was last updated, in the Unix epoch format.
DescribeAlarmModelResponse.Builder	roleArn(String roleArn)	The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
DescribeAlarmModelResponse.Builder	severity(Integer severity)	A non-negative integer that reflects the severity level of the alarm.
DescribeAlarmModelResponse.Builder	status(String status)	The status of the alarm model.
DescribeAlarmModelResponse.Builder	status(AlarmModelVersionStatus status)	The status of the alarm model.
DescribeAlarmModelResponse.Builder	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 Detail

creationTime

DescribeAlarmModelResponse.Builder creationTime(Instant 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

DescribeAlarmModelResponse.Builder alarmModelArn(String 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

DescribeAlarmModelResponse.Builder alarmModelVersion(String 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

DescribeAlarmModelResponse.Builder lastUpdateTime(Instant 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

DescribeAlarmModelResponse.Builder status(String 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:

AlarmModelVersionStatus, AlarmModelVersionStatus

status

DescribeAlarmModelResponse.Builder status(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.

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:

AlarmModelVersionStatus, AlarmModelVersionStatus

statusMessage

DescribeAlarmModelResponse.Builder statusMessage(String 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

DescribeAlarmModelResponse.Builder alarmModelName(String 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

DescribeAlarmModelResponse.Builder alarmModelDescription(String 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

DescribeAlarmModelResponse.Builder roleArn(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.

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

DescribeAlarmModelResponse.Builder key(String 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

DescribeAlarmModelResponse.Builder severity(Integer 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

DescribeAlarmModelResponse.Builder alarmRule(AlarmRule 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

default DescribeAlarmModelResponse.Builder alarmRule(Consumer<AlarmRule.Builder> alarmRule)

Defines when your alarm is invoked.

This is a convenience method that creates an instance of the AlarmRule.Builder avoiding the need to create one manually via AlarmRule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarmRule(AlarmRule).

Parameters:

alarmRule - a consumer that will call methods on AlarmRule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

alarmRule(AlarmRule)

alarmNotification

DescribeAlarmModelResponse.Builder alarmNotification(AlarmNotification 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 the AlarmNotification.Builder avoiding the need to create one manually via AlarmNotification.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarmNotification(AlarmNotification).

Parameters:

alarmNotification - a consumer that will call methods on AlarmNotification.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

alarmNotification(AlarmNotification)

alarmEventActions

DescribeAlarmModelResponse.Builder alarmEventActions(AlarmEventActions 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 the AlarmEventActions.Builder avoiding the need to create one manually via AlarmEventActions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarmEventActions(AlarmEventActions).

Parameters:

alarmEventActions - a consumer that will call methods on AlarmEventActions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

alarmEventActions(AlarmEventActions)

alarmCapabilities

DescribeAlarmModelResponse.Builder alarmCapabilities(AlarmCapabilities 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 the AlarmCapabilities.Builder avoiding the need to create one manually via AlarmCapabilities.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarmCapabilities(AlarmCapabilities).

Parameters:

alarmCapabilities - a consumer that will call methods on AlarmCapabilities.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

alarmCapabilities(AlarmCapabilities)