Package software.amazon.awssdk.services.redshift.model

Class DescribeEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshift.model.RedshiftRequest

software.amazon.awssdk.services.redshift.model.DescribeEventsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeEventsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeEventsRequest.Builder	builder()
Integer	duration()	The number of minutes prior to the time of the request for which to retrieve events.
Instant	endTime()	The end of the time interval for which to retrieve events, specified in ISO 8601 format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	marker()	An optional parameter that specifies the starting point to return a set of response records.
Integer	maxRecords()	The maximum number of response records to return in each call.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeEventsRequest.Builder>	serializableBuilderClass()
String	sourceIdentifier()	The identifier of the event source for which events will be 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()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

sourceIdentifier

public final String sourceIdentifier()

The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType must also be provided.

• Specify a cluster identifier when SourceType is cluster.

• Specify a cluster security group name when SourceType is cluster-security-group.

• Specify a cluster parameter group name when SourceType is cluster-parameter-group.

• Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

Returns:

The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType must also be provided.

• Specify a cluster identifier when SourceType is cluster.

• Specify a cluster security group name when SourceType is cluster-security-group.

• Specify a cluster parameter group name when SourceType is cluster-parameter-group.

• Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

sourceType

public final SourceType sourceType()

The event source to retrieve events for. If no value is specified, all events are returned.

Constraints:

If SourceType is supplied, SourceIdentifier must also be provided.

• Specify cluster when SourceIdentifier is a cluster identifier.

• Specify cluster-security-group when SourceIdentifier is a cluster security group name.

• Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

• Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

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.

Constraints:

If SourceType is supplied, SourceIdentifier must also be provided.

• Specify cluster when SourceIdentifier is a cluster identifier.

• Specify cluster-security-group when SourceIdentifier is a cluster security group name.

• Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

• Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

See Also:

SourceType

sourceTypeAsString

public final String sourceTypeAsString()

The event source to retrieve events for. If no value is specified, all events are returned.

Constraints:

If SourceType is supplied, SourceIdentifier must also be provided.

• Specify cluster when SourceIdentifier is a cluster identifier.

• Specify cluster-security-group when SourceIdentifier is a cluster security group name.

• Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

• Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

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.

Constraints:

If SourceType is supplied, SourceIdentifier must also be provided.

• Specify cluster when SourceIdentifier is a cluster identifier.

• Specify cluster-security-group when SourceIdentifier is a cluster security group name.

• Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

• Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

See Also:

SourceType

startTime

public final Instant startTime()

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

Returns:

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

endTime

public final Instant endTime()

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

Returns:

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

duration

public final Integer duration()

The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

Default: 60

Returns:

The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

Default: 60

maxRecords

public final Integer maxRecords()

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Returns:

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

marker

public final String marker()

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

toBuilder

public DescribeEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

Specified by:

toBuilder in class RedshiftRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo