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:

ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

@Generated(value="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 and Description
static interface	DescribeEventsRequest.Builder

Method Summary

Modifier and Type	Method and 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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 the version of the custom platform.
String	requestId() If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

applicationName

public 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 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 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 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 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 String platformArn()

The ARN of the version of the custom platform.

Returns:

The ARN of the version of the custom platform.

requestId

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

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 interface ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

Returns:

a builder for type T

builder

public static DescribeEventsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeEventsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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