DescribeEventsRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest
    - - software.amazon.awssdk.services.elasticache.model.DescribeEventsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

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

Represents the input of a DescribeEvents operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeEventsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeEventsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeEventsRequest.Builder`	`builder()`
`Integer`	`duration()` The number of minutes worth of events to retrieve.
`Instant`	`endTime()` The end of the time interval for which to retrieve events, specified in ISO 8601 format.
`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()`
`String`	`marker()` An optional marker returned from a prior request.
`Integer`	`maxRecords()` The maximum number of records to include in the response.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeEventsRequest.Builder>`	`serializableBuilderClass()`
`String`	`sourceIdentifier()` The identifier of the event source for which events are returned.
`SourceType`	`sourceType()` The event source to retrieve events for.
`String`	`sourceTypeAsString()` The event source to retrieve events for.
`Instant`	`startTime()` The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
`DescribeEventsRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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
  - sourceIdentifier
```
public String sourceIdentifier()
```
    The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
    
    Returns:
    
    The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
  - sourceType
```
public SourceType sourceType()
```
    The event source to retrieve events for. If no value is specified, all events are returned.
    
    If the service returns an enum value that is not available in the current SDK version, sourceType will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().
    
    Returns:
    
    The event source to retrieve events for. If no value is specified, all events are returned.
    
    See Also:
    
    SourceType
  - sourceTypeAsString
```
public String sourceTypeAsString()
```
    The event source to retrieve events for. If no value is specified, all events are returned.
    
    If the service returns an enum value that is not available in the current SDK version, sourceType will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().
    
    Returns:
    
    The event source to retrieve events for. If no value is specified, all events are returned.
    
    See Also:
    
    SourceType
  - startTime
```
public Instant startTime()
```
    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
    
    Example: 2017-03-30T07:03:49.555Z
    
    Returns:
    
    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
    
    Example: 2017-03-30T07:03:49.555Z
  - endTime
```
public Instant endTime()
```
    The end of the time interval for which to retrieve events, specified in ISO 8601 format.
    
    Example: 2017-03-30T07:03:49.555Z
    
    Returns:
    
    The end of the time interval for which to retrieve events, specified in ISO 8601 format.
    
    Example: 2017-03-30T07:03:49.555Z
  - duration
```
public Integer duration()
```
    The number of minutes worth of events to retrieve.
    
    Returns:
    
    The number of minutes worth of events to retrieve.
  - maxRecords
```
public Integer maxRecords()
```
    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
    
    Default: 100
    
    Constraints: minimum 20; maximum 100.
    
    Returns:
    
    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
    
    Default: 100
    
    Constraints: minimum 20; maximum 100.
  - marker
```
public String marker()
```
    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    
    Returns:
    
    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  - 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 ElastiCacheRequest
    
    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
  - sdkFields
```
public 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.

Class DescribeEventsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

sourceIdentifier

sourceType

sourceTypeAsString

startTime

endTime

duration

maxRecords

marker

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields