com.amazonaws.services.elasticbeanstalk.model

Class DescribeEventsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticbeanstalk.model.DescribeEventsRequest

All Implemented Interfaces:

Serializable

public class DescribeEventsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeEvents operation.

Returns list of event descriptions matching criteria up to the last 6 weeks.

NOTE: This action returns the most recent 1,000 events from the specified NextToken.

See Also:

AWSElasticBeanstalk.describeEvents(DescribeEventsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeEventsRequest() Default constructor for a new DescribeEventsRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getApplicationName() If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
Date	getEndTime() If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.
String	getEnvironmentId() If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
String	getEnvironmentName() If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
Integer	getMaxRecords() Specifies the maximum number of events that can be returned, beginning with the most recent event.
String	getNextToken() Pagination token.
String	getRequestId() If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
String	getSeverity() If specified, limits the events returned from this call to include only those with the specified severity or higher.
Date	getStartTime() If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
String	getTemplateName() If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
String	getVersionLabel() If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
int	hashCode()
void	setApplicationName(String applicationName) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
void	setEndTime(Date endTime) If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.
void	setEnvironmentId(String environmentId) If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
void	setEnvironmentName(String environmentName) If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
void	setMaxRecords(Integer maxRecords) Specifies the maximum number of events that can be returned, beginning with the most recent event.
void	setNextToken(String nextToken) Pagination token.
void	setRequestId(String requestId) If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
void	setSeverity(EventSeverity severity) If specified, limits the events returned from this call to include only those with the specified severity or higher.
void	setSeverity(String severity) If specified, limits the events returned from this call to include only those with the specified severity or higher.
void	setStartTime(Date startTime) If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
void	setTemplateName(String templateName) If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
void	setVersionLabel(String versionLabel) If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeEventsRequest	withApplicationName(String applicationName) If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
DescribeEventsRequest	withEndTime(Date endTime) If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.
DescribeEventsRequest	withEnvironmentId(String environmentId) If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
DescribeEventsRequest	withEnvironmentName(String environmentName) If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
DescribeEventsRequest	withMaxRecords(Integer maxRecords) Specifies the maximum number of events that can be returned, beginning with the most recent event.
DescribeEventsRequest	withNextToken(String nextToken) Pagination token.
DescribeEventsRequest	withRequestId(String requestId) If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
DescribeEventsRequest	withSeverity(EventSeverity severity) If specified, limits the events returned from this call to include only those with the specified severity or higher.
DescribeEventsRequest	withSeverity(String severity) If specified, limits the events returned from this call to include only those with the specified severity or higher.
DescribeEventsRequest	withStartTime(Date startTime) If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
DescribeEventsRequest	withTemplateName(String templateName) If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
DescribeEventsRequest	withVersionLabel(String versionLabel) If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeEventsRequest

public DescribeEventsRequest()

Default constructor for a new DescribeEventsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Method Detail

getApplicationName

public String getApplicationName()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

Constraints:
Length: 1 - 100

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

setApplicationName

public void setApplicationName(String applicationName)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

Constraints:
Length: 1 - 100

Parameters:

applicationName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

withApplicationName

public DescribeEventsRequest withApplicationName(String applicationName)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

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

Constraints:
Length: 1 - 100

Parameters:

applicationName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

Returns:

A reference to this updated object so that method calls can be chained together.

getVersionLabel

public String getVersionLabel()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

Constraints:
Length: 1 - 100

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

setVersionLabel

public void setVersionLabel(String versionLabel)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

Constraints:
Length: 1 - 100

Parameters:

versionLabel - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

withVersionLabel

public DescribeEventsRequest withVersionLabel(String versionLabel)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

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

Constraints:
Length: 1 - 100

Parameters:

versionLabel - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

Returns:

A reference to this updated object so that method calls can be chained together.

getTemplateName

public String getTemplateName()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

Constraints:
Length: 1 - 100

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

setTemplateName

public void setTemplateName(String templateName)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

Constraints:
Length: 1 - 100

Parameters:

templateName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

withTemplateName

public DescribeEventsRequest withTemplateName(String templateName)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

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

Constraints:
Length: 1 - 100

Parameters:

templateName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

Returns:

A reference to this updated object so that method calls can be chained together.

getEnvironmentId

public String getEnvironmentId()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

setEnvironmentId

public void setEnvironmentId(String environmentId)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Parameters:

environmentId - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

withEnvironmentId

public DescribeEventsRequest withEnvironmentId(String environmentId)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

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

Parameters:

environmentId - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Returns:

A reference to this updated object so that method calls can be chained together.

getEnvironmentName

public String getEnvironmentName()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Constraints:
Length: 4 - 23

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

setEnvironmentName

public void setEnvironmentName(String environmentName)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Constraints:
Length: 4 - 23

Parameters:

environmentName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

withEnvironmentName

public DescribeEventsRequest withEnvironmentName(String environmentName)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

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

Constraints:
Length: 4 - 23

Parameters:

environmentName - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Returns:

A reference to this updated object so that method calls can be chained together.

getRequestId

public String getRequestId()

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

Returns:

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

setRequestId

public void setRequestId(String requestId)

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

Parameters:

requestId - If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

withRequestId

public DescribeEventsRequest withRequestId(String requestId)

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

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

Parameters:

requestId - If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

Returns:

A reference to this updated object so that method calls can be chained together.

getSeverity

public String getSeverity()

If specified, limits the events returned from this call to include only those with the specified severity or higher.

Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Returns:

If specified, limits the events returned from this call to include only those with the specified severity or higher.

See Also:

EventSeverity

setSeverity

public void setSeverity(String severity)

If specified, limits the events returned from this call to include only those with the specified severity or higher.

Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Parameters:

severity - If specified, limits the events returned from this call to include only those with the specified severity or higher.

See Also:

EventSeverity

withSeverity

public DescribeEventsRequest withSeverity(String severity)

If specified, limits the events returned from this call to include only those with the specified severity or higher.

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

Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Parameters:

severity - If specified, limits the events returned from this call to include only those with the specified severity or higher.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

EventSeverity

setSeverity

public void setSeverity(EventSeverity severity)

If specified, limits the events returned from this call to include only those with the specified severity or higher.

Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Parameters:

severity - If specified, limits the events returned from this call to include only those with the specified severity or higher.

See Also:

EventSeverity

withSeverity

public DescribeEventsRequest withSeverity(EventSeverity severity)

If specified, limits the events returned from this call to include only those with the specified severity or higher.

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

Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Parameters:

severity - If specified, limits the events returned from this call to include only those with the specified severity or higher.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

EventSeverity

getStartTime

public Date getStartTime()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

setStartTime

public void setStartTime(Date startTime)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

Parameters:

startTime - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

withStartTime

public DescribeEventsRequest withStartTime(Date startTime)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

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

Parameters:

startTime - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

Returns:

A reference to this updated object so that method calls can be chained together.

getEndTime

public Date getEndTime()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

setEndTime

public void setEndTime(Date endTime)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

Parameters:

endTime - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

withEndTime

public DescribeEventsRequest withEndTime(Date endTime)

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

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

Parameters:

endTime - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxRecords

public Integer getMaxRecords()

Specifies the maximum number of events that can be returned, beginning with the most recent event.

Constraints:
Range: 1 - 1000

Returns:

Specifies the maximum number of events that can be returned, beginning with the most recent event.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

Specifies the maximum number of events that can be returned, beginning with the most recent event.

Constraints:
Range: 1 - 1000

Parameters:

maxRecords - Specifies the maximum number of events that can be returned, beginning with the most recent event.

withMaxRecords

public DescribeEventsRequest withMaxRecords(Integer maxRecords)

Specifies the maximum number of events that can be returned, beginning with the most recent event.

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

Constraints:
Range: 1 - 1000

Parameters:

maxRecords - Specifies the maximum number of events that can be returned, beginning with the most recent event.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

Pagination token. If specified, the events return the next batch of results.

Returns:

Pagination token. If specified, the events return the next batch of results.

setNextToken

public void setNextToken(String nextToken)

Pagination token. If specified, the events return the next batch of results.

Parameters:

nextToken - Pagination token. If specified, the events return the next batch of results.

withNextToken

public DescribeEventsRequest withNextToken(String nextToken)

Pagination token. If specified, the events return the next batch of results.

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

Parameters:

nextToken - Pagination token. If specified, the events return the next batch of results.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object