public class DescribeEventsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Represents the input of a DescribeEvents action.
Modifier and Type | Field and Description |
---|---|
private java.lang.Integer |
duration
The number of minutes' worth of events to retrieve.
|
private java.util.Date |
endTime
The end of the time interval for which to retrieve events, specified in
ISO 8601 format.
|
private java.lang.String |
marker
An optional marker returned from a prior request.
|
private java.lang.Integer |
maxRecords
The maximum number of records to include in the response.
|
private java.lang.String |
sourceIdentifier
The identifier of the event source for which events will be returned.
|
private java.lang.String |
sourceType
The event source to retrieve events for.
|
private java.util.Date |
startTime
The beginning of the time interval to retrieve events for, specified in
ISO 8601 format.
|
NOOP
Constructor and Description |
---|
DescribeEventsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeEventsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.Integer |
getDuration()
The number of minutes' worth of events to retrieve.
|
java.util.Date |
getEndTime()
The end of the time interval for which to retrieve events, specified in
ISO 8601 format.
|
java.lang.String |
getMarker()
An optional marker returned from a prior request.
|
java.lang.Integer |
getMaxRecords()
The maximum number of records to include in the response.
|
java.lang.String |
getSourceIdentifier()
The identifier of the event source for which events will be returned.
|
java.lang.String |
getSourceType()
The event source to retrieve events for.
|
java.util.Date |
getStartTime()
The beginning of the time interval to retrieve events for, specified in
ISO 8601 format.
|
int |
hashCode() |
void |
setDuration(java.lang.Integer duration)
The number of minutes' worth of events to retrieve.
|
void |
setEndTime(java.util.Date endTime)
The end of the time interval for which to retrieve events, specified in
ISO 8601 format.
|
void |
setMarker(java.lang.String marker)
An optional marker returned from a prior request.
|
void |
setMaxRecords(java.lang.Integer maxRecords)
The maximum number of records to include in the response.
|
void |
setSourceIdentifier(java.lang.String sourceIdentifier)
The identifier of the event source for which events will be returned.
|
void |
setSourceType(SourceType sourceType)
The event source to retrieve events for.
|
void |
setSourceType(java.lang.String sourceType)
The event source to retrieve events for.
|
void |
setStartTime(java.util.Date startTime)
The beginning of the time interval to retrieve events for, specified in
ISO 8601 format.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeEventsRequest |
withDuration(java.lang.Integer duration)
The number of minutes' worth of events to retrieve.
|
DescribeEventsRequest |
withEndTime(java.util.Date endTime)
The end of the time interval for which to retrieve events, specified in
ISO 8601 format.
|
DescribeEventsRequest |
withMarker(java.lang.String marker)
An optional marker returned from a prior request.
|
DescribeEventsRequest |
withMaxRecords(java.lang.Integer maxRecords)
The maximum number of records to include in the response.
|
DescribeEventsRequest |
withSourceIdentifier(java.lang.String sourceIdentifier)
The identifier of the event source for which events will be returned.
|
DescribeEventsRequest |
withSourceType(SourceType sourceType)
The event source to retrieve events for.
|
DescribeEventsRequest |
withSourceType(java.lang.String sourceType)
The event source to retrieve events for.
|
DescribeEventsRequest |
withStartTime(java.util.Date startTime)
The beginning of the time interval to retrieve events for, specified in
ISO 8601 format.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private java.lang.String sourceIdentifier
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
private java.lang.String sourceType
The event source to retrieve events for. If no value is specified, all events are returned.
Valid values are: cache-cluster
|
cache-parameter-group
| cache-security-group
|
cache-subnet-group
private java.util.Date startTime
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
private java.util.Date endTime
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
private java.lang.Integer duration
The number of minutes' worth of events to retrieve.
private java.lang.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.
private java.lang.String marker
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
public void setSourceIdentifier(java.lang.String sourceIdentifier)
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
sourceIdentifier
- The identifier of the event source for which events will be
returned. If not specified, then all sources are included in the
response.public java.lang.String getSourceIdentifier()
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
public DescribeEventsRequest withSourceIdentifier(java.lang.String sourceIdentifier)
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
sourceIdentifier
- The identifier of the event source for which events will be
returned. If not specified, then all sources are included in the
response.public void setSourceType(java.lang.String sourceType)
The event source to retrieve events for. If no value is specified, all events are returned.
Valid values are: cache-cluster
|
cache-parameter-group
| cache-security-group
|
cache-subnet-group
sourceType
- The event source to retrieve events for. If no value is specified,
all events are returned.
Valid values are: cache-cluster
|
cache-parameter-group
|
cache-security-group
|
cache-subnet-group
SourceType
public java.lang.String getSourceType()
The event source to retrieve events for. If no value is specified, all events are returned.
Valid values are: cache-cluster
|
cache-parameter-group
| cache-security-group
|
cache-subnet-group
Valid values are: cache-cluster
|
cache-parameter-group
|
cache-security-group
|
cache-subnet-group
SourceType
public DescribeEventsRequest withSourceType(java.lang.String sourceType)
The event source to retrieve events for. If no value is specified, all events are returned.
Valid values are: cache-cluster
|
cache-parameter-group
| cache-security-group
|
cache-subnet-group
sourceType
- The event source to retrieve events for. If no value is specified,
all events are returned.
Valid values are: cache-cluster
|
cache-parameter-group
|
cache-security-group
|
cache-subnet-group
SourceType
public void setSourceType(SourceType sourceType)
The event source to retrieve events for. If no value is specified, all events are returned.
Valid values are: cache-cluster
|
cache-parameter-group
| cache-security-group
|
cache-subnet-group
sourceType
- The event source to retrieve events for. If no value is specified,
all events are returned.
Valid values are: cache-cluster
|
cache-parameter-group
|
cache-security-group
|
cache-subnet-group
SourceType
public DescribeEventsRequest withSourceType(SourceType sourceType)
The event source to retrieve events for. If no value is specified, all events are returned.
Valid values are: cache-cluster
|
cache-parameter-group
| cache-security-group
|
cache-subnet-group
sourceType
- The event source to retrieve events for. If no value is specified,
all events are returned.
Valid values are: cache-cluster
|
cache-parameter-group
|
cache-security-group
|
cache-subnet-group
SourceType
public void setStartTime(java.util.Date startTime)
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
startTime
- The beginning of the time interval to retrieve events for,
specified in ISO 8601 format.public java.util.Date getStartTime()
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
public DescribeEventsRequest withStartTime(java.util.Date startTime)
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
startTime
- The beginning of the time interval to retrieve events for,
specified in ISO 8601 format.public void setEndTime(java.util.Date endTime)
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
endTime
- The end of the time interval for which to retrieve events,
specified in ISO 8601 format.public java.util.Date getEndTime()
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
public DescribeEventsRequest withEndTime(java.util.Date endTime)
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
endTime
- The end of the time interval for which to retrieve events,
specified in ISO 8601 format.public void setDuration(java.lang.Integer duration)
The number of minutes' worth of events to retrieve.
duration
- The number of minutes' worth of events to retrieve.public java.lang.Integer getDuration()
The number of minutes' worth of events to retrieve.
public DescribeEventsRequest withDuration(java.lang.Integer duration)
The number of minutes' worth of events to retrieve.
duration
- The number of minutes' worth of events to retrieve.public void setMaxRecords(java.lang.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.
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.
public java.lang.Integer getMaxRecords()
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.
MaxRecords
value, a
marker is included in the response so that the remaining results
can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
public DescribeEventsRequest withMaxRecords(java.lang.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.
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.
public void setMarker(java.lang.String marker)
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
marker
- An optional marker returned from a prior request. Use this marker
for pagination of results from this action. If this parameter is
specified, the response includes only records beyond the marker,
up to the value specified by MaxRecords.public java.lang.String getMarker()
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
public DescribeEventsRequest withMarker(java.lang.String marker)
An optional marker returned from a prior request. Use this marker for pagination of results from this action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
marker
- An optional marker returned from a prior request. Use this marker
for pagination of results from this action. If this parameter is
specified, the response includes only records beyond the marker,
up to the value specified by MaxRecords.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribeEventsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()