com.amazonaws.services.ssmincidents.model

Class ListTimelineEventsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ssmincidents.model.ListTimelineEventsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListTimelineEventsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListTimelineEventsRequest()

Method Summary

Modifier and Type	Method and Description
ListTimelineEventsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<Filter>	getFilters() Filters the timeline events based on the provided conditional values.
String	getIncidentRecordArn() The Amazon Resource Name (ARN) of the incident that includes the timeline event.
Integer	getMaxResults() The maximum number of results per page.
String	getNextToken() The pagination token for the next set of items to return.
String	getSortBy() Sort timeline events by the specified key value pair.
String	getSortOrder() Sorts the order of timeline events by the value specified in the sortBy field.
int	hashCode()
void	setFilters(Collection<Filter> filters) Filters the timeline events based on the provided conditional values.
void	setIncidentRecordArn(String incidentRecordArn) The Amazon Resource Name (ARN) of the incident that includes the timeline event.
void	setMaxResults(Integer maxResults) The maximum number of results per page.
void	setNextToken(String nextToken) The pagination token for the next set of items to return.
void	setSortBy(String sortBy) Sort timeline events by the specified key value pair.
void	setSortOrder(String sortOrder) Sorts the order of timeline events by the value specified in the sortBy field.
String	toString() Returns a string representation of this object.
ListTimelineEventsRequest	withFilters(Collection<Filter> filters) Filters the timeline events based on the provided conditional values.
ListTimelineEventsRequest	withFilters(Filter... filters) Filters the timeline events based on the provided conditional values.
ListTimelineEventsRequest	withIncidentRecordArn(String incidentRecordArn) The Amazon Resource Name (ARN) of the incident that includes the timeline event.
ListTimelineEventsRequest	withMaxResults(Integer maxResults) The maximum number of results per page.
ListTimelineEventsRequest	withNextToken(String nextToken) The pagination token for the next set of items to return.
ListTimelineEventsRequest	withSortBy(String sortBy) Sort timeline events by the specified key value pair.
ListTimelineEventsRequest	withSortBy(TimelineEventSort sortBy) Sort timeline events by the specified key value pair.
ListTimelineEventsRequest	withSortOrder(SortOrder sortOrder) Sorts the order of timeline events by the value specified in the sortBy field.
ListTimelineEventsRequest	withSortOrder(String sortOrder) Sorts the order of timeline events by the value specified in the sortBy field.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListTimelineEventsRequest

public ListTimelineEventsRequest()

Method Detail

getFilters

public List<Filter> getFilters()

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:

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.

setFilters

public void setFilters(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.

withFilters

public ListTimelineEventsRequest withFilters(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.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

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.

withFilters

public ListTimelineEventsRequest withFilters(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.

setIncidentRecordArn

public void setIncidentRecordArn(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.

getIncidentRecordArn

public String getIncidentRecordArn()

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.

withIncidentRecordArn

public ListTimelineEventsRequest withIncidentRecordArn(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.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results per page.

Parameters:

maxResults - The maximum number of results per page.

getMaxResults

public Integer getMaxResults()

The maximum number of results per page.

Returns:

The maximum number of results per page.

withMaxResults

public ListTimelineEventsRequest withMaxResults(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.

setNextToken

public void setNextToken(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.)

getNextToken

public String getNextToken()

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

withNextToken

public ListTimelineEventsRequest withNextToken(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.

setSortBy

public void setSortBy(String sortBy)

Sort timeline events by the specified key value pair.

Parameters:

sortBy - Sort timeline events by the specified key value pair.

See Also:

TimelineEventSort

getSortBy

public String getSortBy()

Sort timeline events by the specified key value pair.

Returns:

Sort timeline events by the specified key value pair.

See Also:

TimelineEventSort

withSortBy

public ListTimelineEventsRequest withSortBy(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:

TimelineEventSort

withSortBy

public ListTimelineEventsRequest withSortBy(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:

TimelineEventSort

setSortOrder

public void setSortOrder(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.

See Also:

SortOrder

getSortOrder

public String getSortOrder()

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

Returns:

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

See Also:

SortOrder

withSortOrder

public ListTimelineEventsRequest withSortOrder(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

withSortOrder

public ListTimelineEventsRequest withSortOrder(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:

SortOrder

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListTimelineEventsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()