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

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 Details

    • 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

      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:

    • 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 specify TimestampAscending to have the oldest history returned first.

      Parameters:
      scanBy - Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending 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

      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 specify TimestampAscending to have the oldest history returned first.

      Parameters:
      scanBy - Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      DescribeAlarmHistoryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeAlarmHistoryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.