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>

  • Method Details

    • 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:

    • 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:

    • 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()
      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<ListNotificationEventsRequest.Builder,ListNotificationEventsRequest>
      Specified by:
      toBuilder in class NotificationsRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.