Class ListNotificationConfigurationsRequest

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.ListNotificationConfigurationsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListNotificationConfigurationsRequest.Builder,ListNotificationConfigurationsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListNotificationConfigurationsRequest extends NotificationsRequest implements ToCopyableBuilder<ListNotificationConfigurationsRequest.Builder,ListNotificationConfigurationsRequest>

  • Method Details

    • eventRuleSource

      public final String eventRuleSource()

      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.

    • channelArn

      public final String channelArn()

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

      Returns:
      The Amazon Resource Name (ARN) of the Channel to match.

    • status

      public final NotificationConfigurationStatus status()

      The NotificationConfiguration status to match.

      • Values:

        • ACTIVE

          • All EventRules are ACTIVE and any call can be run.

        • PARTIALLY_ACTIVE

          • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

          • Any call can be run.

        • INACTIVE

          • All EventRules are INACTIVE and any call can be run.

        • DELETING

          • This NotificationConfiguration is being deleted.

          • Only GET and LIST calls can be run.

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

      Returns:
      The NotificationConfiguration status to match.

      • Values:

        • ACTIVE

          • All EventRules are ACTIVE and any call can be run.

        • PARTIALLY_ACTIVE

          • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

          • Any call can be run.

        • INACTIVE

          • All EventRules are INACTIVE and any call can be run.

        • DELETING

          • This NotificationConfiguration is being deleted.

          • Only GET and LIST calls can be run.

      See Also:

    • statusAsString

      public final String statusAsString()

      The NotificationConfiguration status to match.

      • Values:

        • ACTIVE

          • All EventRules are ACTIVE and any call can be run.

        • PARTIALLY_ACTIVE

          • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

          • Any call can be run.

        • INACTIVE

          • All EventRules are INACTIVE and any call can be run.

        • DELETING

          • This NotificationConfiguration is being deleted.

          • Only GET and LIST calls can be run.

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

      Returns:
      The NotificationConfiguration status to match.

      • Values:

        • ACTIVE

          • All EventRules are ACTIVE and any call can be run.

        • PARTIALLY_ACTIVE

          • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

          • Any call can be run.

        • INACTIVE

          • All EventRules are INACTIVE and any call can be run.

        • DELETING

          • This NotificationConfiguration is being deleted.

          • Only GET and LIST calls can be run.

      See Also:

    • subtype

      public final NotificationConfigurationSubtype subtype()

      The subtype used to filter the notification configurations in the request.

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

      Returns:
      The subtype used to filter the notification configurations in the request.
      See Also:

    • subtypeAsString

      public final String subtypeAsString()

      The subtype used to filter the notification configurations in the request.

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

      Returns:
      The subtype used to filter the notification configurations in the request.
      See Also:

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

    • builder

      public static ListNotificationConfigurationsRequest.Builder builder()

    • serializableBuilderClass

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