Package software.amazon.awssdk.services.elasticbeanstalk.model

Class DescribeEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkRequest

software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeEventsRequest
extends ElasticBeanstalkRequest
implements ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

Request to retrieve a list of events for an environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeEventsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationName()	If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
static DescribeEventsRequest.Builder	builder()
Instant	endTime()	If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.
String	environmentId()	If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
String	environmentName()	If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxRecords()	Specifies the maximum number of events that can be returned, beginning with the most recent event.
String	nextToken()	Pagination token.
String	platformArn()	The ARN of a custom platform version.
String	requestId()	If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeEventsRequest.Builder>	serializableBuilderClass()
EventSeverity	severity()	If specified, limits the events returned from this call to include only those with the specified severity or higher.
String	severityAsString()	If specified, limits the events returned from this call to include only those with the specified severity or higher.
Instant	startTime()	If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.
String	templateName()	If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
DescribeEventsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	versionLabel()	If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

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

applicationName

public final String applicationName()

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

Returns:

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

versionLabel

public final String versionLabel()

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

Returns:

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

templateName

public final String templateName()

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

Returns:

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

environmentId

public final String environmentId()

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.

environmentName

public final String environmentName()

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.

platformArn

public final String platformArn()

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.

Returns:

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.

requestId

public final String requestId()

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.

severity

public final EventSeverity severity()

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

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

Returns:

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

See Also:

EventSeverity

severityAsString

public final String severityAsString()

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

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

Returns:

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

See Also:

EventSeverity

startTime

public final Instant startTime()

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.

endTime

public final Instant endTime()

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.

maxRecords

public final Integer maxRecords()

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

Returns:

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

nextToken

public final String nextToken()

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.

toBuilder

public DescribeEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

builder

public static DescribeEventsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeEventsRequest.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