Class DescribeEventsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeEventsRequest.Builder,
DescribeEventsRequest>
Request to retrieve a list of events for an environment.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.builder()
final Instant
endTime()
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, theEndTime
.final String
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.final String
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
Specifies the maximum number of events that can be returned, beginning with the most recent event.final String
Pagination token.final String
The ARN of a custom platform version.final String
If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.static Class
<? extends DescribeEventsRequest.Builder> final EventSeverity
severity()
If specified, limits the events returned from this call to include only those with the specified severity or higher.final String
If specified, limits the events returned from this call to include only those with the specified severity or higher.final Instant
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.final String
If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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
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
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
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 returnEventSeverity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromseverityAsString()
.- Returns:
- If specified, limits the events returned from this call to include only those with the specified severity or higher.
- See Also:
-
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 returnEventSeverity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromseverityAsString()
.- Returns:
- If specified, limits the events returned from this call to include only those with the specified severity or higher.
- See Also:
-
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
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
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
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
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 interfaceToCopyableBuilder<DescribeEventsRequest.Builder,
DescribeEventsRequest> - Specified by:
toBuilder
in classElasticBeanstalkRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-