Package software.amazon.awssdk.services.cloudwatch.model

Interface DescribeAlarmsRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeAlarmsRequest.Builder,DescribeAlarmsRequest>, SdkBuilder<DescribeAlarmsRequest.Builder,DescribeAlarmsRequest>

Enclosing class:

DescribeAlarmsRequest

public static interface DescribeAlarmsRequest.Builder
extends CopyableBuilder<DescribeAlarmsRequest.Builder,DescribeAlarmsRequest>

Method Summary

Modifier and Type	Method	Description
DescribeAlarmsRequest.Builder	actionPrefix(String actionPrefix)	The action name prefix.
DescribeAlarmsRequest.Builder	alarmNamePrefix(String alarmNamePrefix)	The alarm name prefix.
DescribeAlarmsRequest.Builder	alarmNames(String... alarmNames)	The names of the alarms.
DescribeAlarmsRequest.Builder	alarmNames(Collection<String> alarmNames)	The names of the alarms.
DescribeAlarmsRequest.Builder	maxRecords(Integer maxRecords)	The maximum number of alarm descriptions to retrieve.
DescribeAlarmsRequest.Builder	nextToken(String nextToken)	The token returned by a previous call to indicate that there is more data available.
DescribeAlarmsRequest.Builder	stateValue(String stateValue)	The state value to be used in matching alarms.
DescribeAlarmsRequest.Builder	stateValue(StateValue stateValue)	The state value to be used in matching alarms.

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

copy

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

apply, build

Method Detail

alarmNames

DescribeAlarmsRequest.Builder alarmNames(Collection<String> alarmNames)

The names of the alarms.

Parameters:

alarmNames - The names of the alarms.

Returns:

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

alarmNames

DescribeAlarmsRequest.Builder alarmNames(String... alarmNames)

The names of the alarms.

NOTE: This method appends the values to the existing list (if any). Use #setAlarmNames(java.util.Collection) or #withAlarmNames(java.util.Collection) if you want to override the existing values.

Parameters:

alarmNames - The names of the alarms.

Returns:

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

alarmNamePrefix

DescribeAlarmsRequest.Builder alarmNamePrefix(String alarmNamePrefix)

The alarm name prefix. You cannot specify AlarmNames if this parameter is specified.

Parameters:

alarmNamePrefix - The alarm name prefix. You cannot specify AlarmNames if this parameter is specified.

Returns:

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

stateValue

DescribeAlarmsRequest.Builder stateValue(String stateValue)

The state value to be used in matching alarms.

Parameters:

stateValue - The state value to be used in matching alarms.

Returns:

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

See Also:

StateValue

stateValue

DescribeAlarmsRequest.Builder stateValue(StateValue stateValue)

The state value to be used in matching alarms.

Parameters:

stateValue - The state value to be used in matching alarms.

Returns:

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

See Also:

StateValue

actionPrefix

DescribeAlarmsRequest.Builder actionPrefix(String actionPrefix)

The action name prefix.

Parameters:

actionPrefix - The action name prefix.

Returns:

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

maxRecords

DescribeAlarmsRequest.Builder maxRecords(Integer maxRecords)

The maximum number of alarm descriptions to retrieve.

Parameters:

maxRecords - The maximum number of alarm descriptions to retrieve.

Returns:

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

nextToken

DescribeAlarmsRequest.Builder nextToken(String nextToken)

The token returned by a previous call to indicate that there is more data available.

Parameters:

nextToken - The token returned by a previous call to indicate that there is more data available.

Returns:

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