Class ListTimelineEventsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListTimelineEventsRequest.Builder,
ListTimelineEventsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filters()
Filters the timeline events based on the provided conditional values.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final String
The Amazon Resource Name (ARN) of the incident that includes the timeline event.final Integer
The maximum number of results per page.final String
The pagination token for the next set of items to return.static Class
<? extends ListTimelineEventsRequest.Builder> final TimelineEventSort
sortBy()
Sort timeline events by the specified key value pair.final String
Sort timeline events by the specified key value pair.final SortOrder
Sorts the order of timeline events by the value specified in thesortBy
field.final String
Sorts the order of timeline events by the value specified in thesortBy
field.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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.
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:
-
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.
-
-
-
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
The maximum number of results per page.
- Returns:
- The maximum number of results per page.
-
nextToken
The pagination token for the next set of items to return. (You received this token from a previous call.)
- Returns:
- The pagination token for the next set of items to return. (You received this token from a previous call.)
-
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 returnTimelineEventSort.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- Sort timeline events by the specified key value pair.
- See Also:
-
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 returnTimelineEventSort.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- Sort timeline events by the specified key value pair.
- See Also:
-
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 returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- Sorts the order of timeline events by the value specified in the
sortBy
field. - See Also:
-
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 returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- Sorts the order of timeline events by the value specified in the
sortBy
field. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListTimelineEventsRequest.Builder,
ListTimelineEventsRequest> - Specified by:
toBuilder
in classSsmIncidentsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-