Interface DescribeAlarmHistoryRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudWatchRequest.Builder
,CopyableBuilder<DescribeAlarmHistoryRequest.Builder,DescribeAlarmHistoryRequest>
,SdkBuilder<DescribeAlarmHistoryRequest.Builder,DescribeAlarmHistoryRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- DescribeAlarmHistoryRequest
public static interface DescribeAlarmHistoryRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<DescribeAlarmHistoryRequest.Builder,DescribeAlarmHistoryRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DescribeAlarmHistoryRequest.Builder
alarmName(String alarmName)
The name of the alarm.DescribeAlarmHistoryRequest.Builder
alarmTypes(Collection<AlarmType> alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.DescribeAlarmHistoryRequest.Builder
alarmTypes(AlarmType... alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.DescribeAlarmHistoryRequest.Builder
alarmTypesWithStrings(String... alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.DescribeAlarmHistoryRequest.Builder
alarmTypesWithStrings(Collection<String> alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.DescribeAlarmHistoryRequest.Builder
endDate(Instant endDate)
The ending date to retrieve alarm history.DescribeAlarmHistoryRequest.Builder
historyItemType(String historyItemType)
The type of alarm histories to retrieve.DescribeAlarmHistoryRequest.Builder
historyItemType(HistoryItemType historyItemType)
The type of alarm histories to retrieve.DescribeAlarmHistoryRequest.Builder
maxRecords(Integer maxRecords)
The maximum number of alarm history records to retrieve.DescribeAlarmHistoryRequest.Builder
nextToken(String nextToken)
The token returned by a previous call to indicate that there is more data available.DescribeAlarmHistoryRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeAlarmHistoryRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeAlarmHistoryRequest.Builder
scanBy(String scanBy)
Specified whether to return the newest or oldest alarm history first.DescribeAlarmHistoryRequest.Builder
scanBy(ScanBy scanBy)
Specified whether to return the newest or oldest alarm history first.DescribeAlarmHistoryRequest.Builder
startDate(Instant startDate)
The starting date to retrieve alarm history.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
alarmName
DescribeAlarmHistoryRequest.Builder alarmName(String alarmName)
The name of the alarm.
- Parameters:
alarmName
- The name of the alarm.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmTypesWithStrings
DescribeAlarmHistoryRequest.Builder alarmTypesWithStrings(Collection<String> alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
- Parameters:
alarmTypes
- Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmTypesWithStrings
DescribeAlarmHistoryRequest.Builder alarmTypesWithStrings(String... alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
- Parameters:
alarmTypes
- Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmTypes
DescribeAlarmHistoryRequest.Builder alarmTypes(Collection<AlarmType> alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
- Parameters:
alarmTypes
- Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmTypes
DescribeAlarmHistoryRequest.Builder alarmTypes(AlarmType... alarmTypes)
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.
- Parameters:
alarmTypes
- Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
historyItemType
DescribeAlarmHistoryRequest.Builder historyItemType(String historyItemType)
The type of alarm histories to retrieve.
- Parameters:
historyItemType
- The type of alarm histories to retrieve.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
HistoryItemType
,HistoryItemType
-
historyItemType
DescribeAlarmHistoryRequest.Builder historyItemType(HistoryItemType historyItemType)
The type of alarm histories to retrieve.
- Parameters:
historyItemType
- The type of alarm histories to retrieve.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
HistoryItemType
,HistoryItemType
-
startDate
DescribeAlarmHistoryRequest.Builder startDate(Instant startDate)
The starting date to retrieve alarm history.
- Parameters:
startDate
- The starting date to retrieve alarm history.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endDate
DescribeAlarmHistoryRequest.Builder endDate(Instant endDate)
The ending date to retrieve alarm history.
- Parameters:
endDate
- The ending date to retrieve alarm history.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxRecords
DescribeAlarmHistoryRequest.Builder maxRecords(Integer maxRecords)
The maximum number of alarm history records to retrieve.
- Parameters:
maxRecords
- The maximum number of alarm history records to retrieve.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
DescribeAlarmHistoryRequest.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.
-
scanBy
DescribeAlarmHistoryRequest.Builder scanBy(String scanBy)
Specified whether to return the newest or oldest alarm history first. Specify
TimestampDescending
to have the newest event history returned first, and specifyTimestampAscending
to have the oldest history returned first.- Parameters:
scanBy
- Specified whether to return the newest or oldest alarm history first. SpecifyTimestampDescending
to have the newest event history returned first, and specifyTimestampAscending
to have the oldest history returned first.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ScanBy
,ScanBy
-
scanBy
DescribeAlarmHistoryRequest.Builder scanBy(ScanBy scanBy)
Specified whether to return the newest or oldest alarm history first. Specify
TimestampDescending
to have the newest event history returned first, and specifyTimestampAscending
to have the oldest history returned first.- Parameters:
scanBy
- Specified whether to return the newest or oldest alarm history first. SpecifyTimestampDescending
to have the newest event history returned first, and specifyTimestampAscending
to have the oldest history returned first.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ScanBy
,ScanBy
-
overrideConfiguration
DescribeAlarmHistoryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
DescribeAlarmHistoryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-