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

Class NotificationConfigurationStructure

java.lang.Object

software.amazon.awssdk.services.notifications.model.NotificationConfigurationStructure

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NotificationConfigurationStructure.Builder,NotificationConfigurationStructure>

@Generated("software.amazon.awssdk:codegen")
public final class NotificationConfigurationStructure
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NotificationConfigurationStructure.Builder,NotificationConfigurationStructure>

Contains the complete list of fields for a NotificationConfiguration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NotificationConfigurationStructure.Builder

Method Summary

Modifier and Type	Method	Description
AggregationDuration	aggregationDuration()	The aggregation preference of the NotificationConfiguration.
String	aggregationDurationAsString()	The aggregation preference of the NotificationConfiguration.
String	arn()	The Amazon Resource Name (ARN) of the resource.
static NotificationConfigurationStructure.Builder	builder()
Instant	creationTime()	The creation time of the resource.
String	description()	The description of the NotificationConfiguration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the NotificationConfiguration.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends NotificationConfigurationStructure.Builder>	serializableBuilderClass()
NotificationConfigurationStatus	status()	The status of this NotificationConfiguration.
String	statusAsString()	The status of this NotificationConfiguration.
NotificationConfigurationStructure.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

arn

public final String arn()

The Amazon Resource Name (ARN) of the resource.

Returns:

The Amazon Resource Name (ARN) of the resource.

name

public final String name()

The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.

Returns:

The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.

description

public final String description()

The description of the NotificationConfiguration.

Returns:

The description of the NotificationConfiguration.

status

public final NotificationConfigurationStatus status()

The status of this NotificationConfiguration.

The status should always be INACTIVE when part of the CreateNotificationConfiguration response.

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

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

    • 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 status of this NotificationConfiguration.

The status should always be INACTIVE when part of the CreateNotificationConfiguration response.

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

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

    • Only GET and LIST calls can be run.

See Also:

NotificationConfigurationStatus

statusAsString

public final String statusAsString()

The status of this NotificationConfiguration.

The status should always be INACTIVE when part of the CreateNotificationConfiguration response.

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

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

    • 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 status of this NotificationConfiguration.

The status should always be INACTIVE when part of the CreateNotificationConfiguration response.

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

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

    • Only GET and LIST calls can be run.

See Also:

NotificationConfigurationStatus

creationTime

public final Instant creationTime()

The creation time of the resource.

Returns:

The creation time of the resource.

aggregationDuration

public final AggregationDuration aggregationDuration()

The aggregation preference of the NotificationConfiguration.

• Values:

  • LONG

    • Aggregate notifications for long periods of time (12 hours).

  • SHORT

    • Aggregate notifications for short periods of time (5 minutes).

  • NONE

    • Don't aggregate notifications.

      No delay in delivery.

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

Returns:

The aggregation preference of the NotificationConfiguration.

• Values:

  • LONG

    • Aggregate notifications for long periods of time (12 hours).

  • SHORT

    • Aggregate notifications for short periods of time (5 minutes).

  • NONE

    • Don't aggregate notifications.

      No delay in delivery.

See Also:

AggregationDuration

aggregationDurationAsString

public final String aggregationDurationAsString()

The aggregation preference of the NotificationConfiguration.

• Values:

  • LONG

    • Aggregate notifications for long periods of time (12 hours).

  • SHORT

    • Aggregate notifications for short periods of time (5 minutes).

  • NONE

    • Don't aggregate notifications.

      No delay in delivery.

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

Returns:

The aggregation preference of the NotificationConfiguration.

• Values:

  • LONG

    • Aggregate notifications for long periods of time (12 hours).

  • SHORT

    • Aggregate notifications for short periods of time (5 minutes).

  • NONE

    • Don't aggregate notifications.

      No delay in delivery.

See Also:

AggregationDuration

toBuilder

public NotificationConfigurationStructure.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NotificationConfigurationStructure.Builder,NotificationConfigurationStructure>

builder

public static NotificationConfigurationStructure.Builder builder()

serializableBuilderClass

public static Class<? extends NotificationConfigurationStructure.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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