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
final AggregationDuration	aggregationDuration()	The aggregation preference of the NotificationConfiguration.
final String	aggregationDurationAsString()	The aggregation preference of the NotificationConfiguration.
final String	arn()	The Amazon Resource Name (ARN) of the NotificationConfiguration resource.
static NotificationConfigurationStructure.Builder	builder()
final Instant	creationTime()	The creation time of the NotificationConfiguration.
final String	description()	The description of the NotificationConfiguration.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	name()	The name of the NotificationConfiguration.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends NotificationConfigurationStructure.Builder>	serializableBuilderClass()
final NotificationConfigurationStatus	status()	The current status of the NotificationConfiguration.
final String	statusAsString()	The current status of the NotificationConfiguration.
NotificationConfigurationStructure.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

arn

public final String arn()

The Amazon Resource Name (ARN) of the NotificationConfiguration resource.

Returns:

The Amazon Resource Name (ARN) of the NotificationConfiguration 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 current status of the NotificationConfiguration.

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 current status of the NotificationConfiguration.

See Also:

• NotificationConfigurationStatus

statusAsString

public final String statusAsString()

The current status of the NotificationConfiguration.

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 current status of the NotificationConfiguration.

See Also:

• NotificationConfigurationStatus

creationTime

public final Instant creationTime()

The creation time of the NotificationConfiguration.

Returns:

The creation time of the NotificationConfiguration.

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.

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.

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.

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.

See Also:

• AggregationDuration

toBuilder

public NotificationConfigurationStructure.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<NotificationConfigurationStructure.Builder,NotificationConfigurationStructure>

Returns:

a builder for type T

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)

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)

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.