Package software.amazon.awssdk.services.notifications.model

Class ListNotificationEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.notifications.model.NotificationsRequest

software.amazon.awssdk.services.notifications.model.ListNotificationEventsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListNotificationEventsRequest.Builder,ListNotificationEventsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListNotificationEventsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	aggregateNotificationEventArn()	The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.
static ListNotificationEventsRequest.Builder	builder()
Instant	endTime()	Latest time of events to return from this call.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeChildEvents()	Include aggregated child events in the result.
LocaleCode	locale()	The locale code of the language used for the retrieved NotificationEvent.
String	localeAsString()	The locale code of the language used for the retrieved NotificationEvent.
Integer	maxResults()	The maximum number of results to be returned in this call.
String	nextToken()	The start token for paginated calls.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListNotificationEventsRequest.Builder>	serializableBuilderClass()
String	source()	The matched event source.
Instant	startTime()	The earliest time of events to return from this call.
ListNotificationEventsRequest.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

startTime

public final Instant startTime()

The earliest time of events to return from this call.

Returns:

The earliest time of events to return from this call.

endTime

public final Instant endTime()

Latest time of events to return from this call.

Returns:

Latest time of events to return from this call.

locale

public final LocaleCode locale()

The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).

If the service returns an enum value that is not available in the current SDK version, locale will return LocaleCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from localeAsString().

Returns:

The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).

See Also:

LocaleCode

localeAsString

public final String localeAsString()

The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).

If the service returns an enum value that is not available in the current SDK version, locale will return LocaleCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from localeAsString().

Returns:

The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).

See Also:

LocaleCode

source

public final String source()

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

Returns:

The matched event source.

Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

includeChildEvents

public final Boolean includeChildEvents()

Include aggregated child events in the result.

Returns:

Include aggregated child events in the result.

aggregateNotificationEventArn

public final String aggregateNotificationEventArn()

The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.

Returns:

The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.

maxResults

public final Integer maxResults()

The maximum number of results to be returned in this call. Defaults to 20.

Returns:

The maximum number of results to be returned in this call. Defaults to 20.

nextToken

public final String nextToken()

The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.

Returns:

The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.

toBuilder

public ListNotificationEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListNotificationEventsRequest.Builder,ListNotificationEventsRequest>

Specified by:

toBuilder in class NotificationsRequest

builder

public static ListNotificationEventsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListNotificationEventsRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo