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.

  • Method Details

    • 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:

    • 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:

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.