software.amazon.awssdk.services.neptune.model

Class DescribeEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.neptune.model.NeptuneRequest

software.amazon.awssdk.services.neptune.model.DescribeEventsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeEventsRequest
extends NeptuneRequest
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 to retrieve events for.
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)
List<String>	eventCategories() A list of event categories that trigger notifications for a event notification subscription.
List<Filter>	filters() This parameter is not currently supported.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEventCategories() Returns true if the EventCategories property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasFilters() Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	marker() An optional pagination token provided by a previous DescribeEvents 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()
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 are returned. If not specified, then all sources are included in the response.

Constraints:

• If SourceIdentifier is supplied, SourceType must also be provided.

• If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.

• If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.

• If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.

• If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.

• Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

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

Constraints:

• If SourceIdentifier is supplied, SourceType must also be provided.

• If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.

• If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.

• If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.

• If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.

• Cannot end with a hyphen or contain two consecutive hyphens.

sourceType

public final 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 final 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 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 to retrieve events for.

Default: 60

Returns:

The number of minutes to retrieve events for.

Default: 60

hasEventCategories

public final boolean hasEventCategories()

Returns true if the EventCategories property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

eventCategories

public final List<String> eventCategories()

A list of event categories that trigger notifications for a event notification subscription.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasEventCategories() to see if a value was sent in this field.

Returns:

A list of event categories that trigger notifications for a event notification subscription.

hasFilters

public final boolean hasFilters()

Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

filters

public final List<Filter> filters()

This parameter is not currently supported.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFilters() to see if a value was sent in this field.

Returns:

This parameter is not currently supported.

maxRecords

public final Integer maxRecords()

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called 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 pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

marker

public final String marker()

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

An optional pagination token provided by a previous DescribeEvents request. 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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

Specified by:

toBuilder in class NeptuneRequest

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