Interface ListTimelineEventsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListTimelineEventsRequest.Builder,ListTimelineEventsRequest>, SdkBuilder<ListTimelineEventsRequest.Builder,ListTimelineEventsRequest>, SdkPojo, SdkRequest.Builder, SsmIncidentsRequest.Builder
Enclosing class:
ListTimelineEventsRequest
@Mutable @NotThreadSafe public static interface ListTimelineEventsRequest.Builder extends SsmIncidentsRequest.Builder, SdkPojo, CopyableBuilder<ListTimelineEventsRequest.Builder,ListTimelineEventsRequest>

  • Method Details

    • filters

      ListTimelineEventsRequest.Builder filters(Collection<Filter> filters)

      Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:

      • eventReference

      • eventTime

      • eventType

      Note the following when deciding how to use Filters:

      • If you don't specify a Filter, the response includes all timeline events.

      • If you specify more than one filter in a single request, the response returns timeline events that match all filters.

      • If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.

      Parameters:
      filters - Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:

      • eventReference

      • eventTime

      • eventType

      Note the following when deciding how to use Filters:

      • If you don't specify a Filter, the response includes all timeline events.

      • If you specify more than one filter in a single request, the response returns timeline events that match all filters.

      • If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.

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

    • filters

      ListTimelineEventsRequest.Builder filters(Filter... filters)

      Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:

      • eventReference

      • eventTime

      • eventType

      Note the following when deciding how to use Filters:

      • If you don't specify a Filter, the response includes all timeline events.

      • If you specify more than one filter in a single request, the response returns timeline events that match all filters.

      • If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.

      Parameters:
      filters - Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:

      • eventReference

      • eventTime

      • eventType

      Note the following when deciding how to use Filters:

      • If you don't specify a Filter, the response includes all timeline events.

      • If you specify more than one filter in a single request, the response returns timeline events that match all filters.

      • If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.

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

    • filters

      ListTimelineEventsRequest.Builder filters(Consumer<Filter.Builder>... filters)

      Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:

      • eventReference

      • eventTime

      • eventType

      Note the following when deciding how to use Filters:

      • If you don't specify a Filter, the response includes all timeline events.

      • If you specify more than one filter in a single request, the response returns timeline events that match all filters.

      • If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

      Parameters:
      filters - a consumer that will call methods on Filter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • incidentRecordArn

      ListTimelineEventsRequest.Builder incidentRecordArn(String incidentRecordArn)

      The Amazon Resource Name (ARN) of the incident that includes the timeline event.

      Parameters:
      incidentRecordArn - The Amazon Resource Name (ARN) of the incident that includes the timeline event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListTimelineEventsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results per page.

      Parameters:
      maxResults - The maximum number of results per page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListTimelineEventsRequest.Builder nextToken(String nextToken)

      The pagination token for the next set of items to return. (You received this token from a previous call.)

      Parameters:
      nextToken - The pagination token for the next set of items to return. (You received this token from a previous call.)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortBy

      ListTimelineEventsRequest.Builder sortBy(String sortBy)

      Sort timeline events by the specified key value pair.

      Parameters:
      sortBy - Sort timeline events by the specified key value pair.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortBy

      ListTimelineEventsRequest.Builder sortBy(TimelineEventSort sortBy)

      Sort timeline events by the specified key value pair.

      Parameters:
      sortBy - Sort timeline events by the specified key value pair.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      ListTimelineEventsRequest.Builder sortOrder(String sortOrder)

      Sorts the order of timeline events by the value specified in the sortBy field.

      Parameters:
      sortOrder - Sorts the order of timeline events by the value specified in the sortBy field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      ListTimelineEventsRequest.Builder sortOrder(SortOrder sortOrder)

      Sorts the order of timeline events by the value specified in the sortBy field.

      Parameters:
      sortOrder - Sorts the order of timeline events by the value specified in the sortBy field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ListTimelineEventsRequest.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

      ListTimelineEventsRequest.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.