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:

ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeEventsRequest.Builder

Method Summary

Modifier and Type	Method and 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)
<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 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.
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() 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

requestOverrideConfig

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 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 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 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 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 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 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 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 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, AWS 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, AWS 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()

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 RedshiftRequest

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