software.amazon.awssdk.services.ssmincidents.model

Class ListTimelineEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssmincidents.model.SsmIncidentsRequest

software.amazon.awssdk.services.ssmincidents.model.ListTimelineEventsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListTimelineEventsRequest.Builder,ListTimelineEventsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListTimelineEventsRequest
extends SsmIncidentsRequest
implements ToCopyableBuilder<ListTimelineEventsRequest.Builder,ListTimelineEventsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListTimelineEventsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListTimelineEventsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters() Filters the timeline events based on the provided conditional values.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
String	incidentRecordArn() The Amazon Resource Name (ARN) of the incident that includes the timeline event.
Integer	maxResults() The maximum number of results per page.
String	nextToken() The pagination token to continue to the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListTimelineEventsRequest.Builder>	serializableBuilderClass()
TimelineEventSort	sortBy() Sort timeline events by the specified key value pair.
String	sortByAsString() Sort timeline events by the specified key value pair.
SortOrder	sortOrder() Sorts the order of timeline events by the value specified in the sortBy field.
String	sortOrderAsString() Sorts the order of timeline events by the value specified in the sortBy field.
ListTimelineEventsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

filters

public final List<Filter> filters()

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

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

Returns:

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

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

incidentRecordArn

public final String incidentRecordArn()

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

Returns:

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

maxResults

public final Integer maxResults()

The maximum number of results per page.

Returns:

The maximum number of results per page.

nextToken

public final String nextToken()

The pagination token to continue to the next page of results.

Returns:

The pagination token to continue to the next page of results.

sortBy

public final TimelineEventSort sortBy()

Sort timeline events by the specified key value pair.

If the service returns an enum value that is not available in the current SDK version, sortBy will return TimelineEventSort.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

Returns:

Sort timeline events by the specified key value pair.

See Also:

TimelineEventSort

sortByAsString

public final String sortByAsString()

Sort timeline events by the specified key value pair.

If the service returns an enum value that is not available in the current SDK version, sortBy will return TimelineEventSort.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

Returns:

Sort timeline events by the specified key value pair.

See Also:

TimelineEventSort

sortOrder

public final SortOrder sortOrder()

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

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

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

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

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

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

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

See Also:

SortOrder

toBuilder

public ListTimelineEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListTimelineEventsRequest.Builder,ListTimelineEventsRequest>

Specified by:

toBuilder in class SsmIncidentsRequest

builder

public static ListTimelineEventsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListTimelineEventsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo