com.amazonaws.services.dax.model

Class DescribeEventsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.dax.model.DescribeEventsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeEventsRequest
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
DescribeEventsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeEventsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Integer	getDuration() The number of minutes' worth of events to retrieve.
Date	getEndTime() The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Integer	getMaxResults() The maximum number of results to include in the response.
String	getNextToken() An optional token returned from a prior request.
String	getSourceName() The identifier of the event source for which events will be returned.
String	getSourceType() The event source to retrieve events for.
Date	getStartTime() The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
int	hashCode()
void	setDuration(Integer duration) The number of minutes' worth of events to retrieve.
void	setEndTime(Date endTime) The end of the time interval for which to retrieve events, specified in ISO 8601 format.
void	setMaxResults(Integer maxResults) The maximum number of results to include in the response.
void	setNextToken(String nextToken) An optional token returned from a prior request.
void	setSourceName(String sourceName) The identifier of the event source for which events will be returned.
void	setSourceType(SourceType sourceType) The event source to retrieve events for.
void	setSourceType(String sourceType) The event source to retrieve events for.
void	setStartTime(Date startTime) The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeEventsRequest	withDuration(Integer duration) The number of minutes' worth of events to retrieve.
DescribeEventsRequest	withEndTime(Date endTime) The end of the time interval for which to retrieve events, specified in ISO 8601 format.
DescribeEventsRequest	withMaxResults(Integer maxResults) The maximum number of results to include in the response.
DescribeEventsRequest	withNextToken(String nextToken) An optional token returned from a prior request.
DescribeEventsRequest	withSourceName(String sourceName) The identifier of the event source for which events will be returned.
DescribeEventsRequest	withSourceType(SourceType sourceType) The event source to retrieve events for.
DescribeEventsRequest	withSourceType(String sourceType) The event source to retrieve events for.
DescribeEventsRequest	withStartTime(Date startTime) The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

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

DescribeEventsRequest

public DescribeEventsRequest()

Method Detail

setSourceName

public void setSourceName(String sourceName)

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Parameters:

sourceName - The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

getSourceName

public String getSourceName()

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Returns:

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

withSourceName

public DescribeEventsRequest withSourceName(String sourceName)

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Parameters:

sourceName - The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Returns:

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

setSourceType

public void setSourceType(String sourceType)

The event source to retrieve events for. If no value is specified, all events are returned.

Parameters:

sourceType - The event source to retrieve events for. If no value is specified, all events are returned.

See Also:

SourceType

getSourceType

public String getSourceType()

The event source to retrieve events for. If no value is specified, all events are returned.

Returns:

The event source to retrieve events for. If no value is specified, all events are returned.

See Also:

SourceType

withSourceType

public DescribeEventsRequest withSourceType(String sourceType)

The event source to retrieve events for. If no value is specified, all events are returned.

Parameters:

sourceType - The event source to retrieve events for. If no value is specified, all events are returned.

Returns:

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

See Also:

SourceType

setSourceType

public void setSourceType(SourceType sourceType)

The event source to retrieve events for. If no value is specified, all events are returned.

Parameters:

sourceType - The event source to retrieve events for. If no value is specified, all events are returned.

See Also:

SourceType

withSourceType

public DescribeEventsRequest withSourceType(SourceType sourceType)

The event source to retrieve events for. If no value is specified, all events are returned.

Parameters:

sourceType - The event source to retrieve events for. If no value is specified, all events are returned.

Returns:

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

See Also:

SourceType

setStartTime

public void setStartTime(Date startTime)

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Parameters:

startTime - The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

getStartTime

public Date getStartTime()

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Returns:

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

withStartTime

public DescribeEventsRequest withStartTime(Date startTime)

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Parameters:

startTime - The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Returns:

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

setEndTime

public void setEndTime(Date endTime)

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Parameters:

endTime - The end of the time interval for which to retrieve events, specified in ISO 8601 format.

getEndTime

public Date getEndTime()

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Returns:

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

withEndTime

public DescribeEventsRequest withEndTime(Date endTime)

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Parameters:

endTime - The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Returns:

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

setDuration

public void setDuration(Integer duration)

The number of minutes' worth of events to retrieve.

Parameters:

duration - The number of minutes' worth of events to retrieve.

getDuration

public Integer getDuration()

The number of minutes' worth of events to retrieve.

Returns:

The number of minutes' worth of events to retrieve.

withDuration

public DescribeEventsRequest withDuration(Integer duration)

The number of minutes' worth of events to retrieve.

Parameters:

duration - The number of minutes' worth of events to retrieve.

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 to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

Parameters:

maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

getMaxResults

public Integer getMaxResults()

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

Returns:

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

withMaxResults

public DescribeEventsRequest withMaxResults(Integer maxResults)

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

Parameters:

maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Parameters:

nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

getNextToken

public String getNextToken()

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Returns:

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

withNextToken

public DescribeEventsRequest withNextToken(String nextToken)

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Parameters:

nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Returns:

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

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

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 DescribeEventsRequest 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()