Package software.amazon.awssdk.services.mediatailor.model

Class Alert

java.lang.Object

software.amazon.awssdk.services.mediatailor.model.Alert

All Implemented Interfaces:

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

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

Alert configuration parameters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Alert.Builder

Method Summary

Modifier and Type	Method	Description
String	alertCode()	The code for the alert.
String	alertMessage()	If an alert is generated for a resource, an explanation of the reason for the alert.
static Alert.Builder	builder()
AlertCategory	category()	The category that MediaTailor assigns to the alert.
String	categoryAsString()	The category that MediaTailor assigns to the alert.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRelatedResourceArns()	For responses, this returns true if the service returned a value for the RelatedResourceArns property.
Instant	lastModifiedTime()	The timestamp when the alert was last modified.
List<String>	relatedResourceArns()	The Amazon Resource Names (ARNs) related to this alert.
String	resourceArn()	The Amazon Resource Name (ARN) of the resource.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Alert.Builder>	serializableBuilderClass()
Alert.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

alertCode

public final String alertCode()

The code for the alert. For example, NOT_PROCESSED.

Returns:

The code for the alert. For example, NOT_PROCESSED.

alertMessage

public final String alertMessage()

If an alert is generated for a resource, an explanation of the reason for the alert.

Returns:

If an alert is generated for a resource, an explanation of the reason for the alert.

lastModifiedTime

public final Instant lastModifiedTime()

The timestamp when the alert was last modified.

Returns:

The timestamp when the alert was last modified.

hasRelatedResourceArns

public final boolean hasRelatedResourceArns()

For responses, this returns true if the service returned a value for the RelatedResourceArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

relatedResourceArns

public final List<String> relatedResourceArns()

The Amazon Resource Names (ARNs) related to this alert.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRelatedResourceArns() method.

Returns:

The Amazon Resource Names (ARNs) related to this alert.

resourceArn

public final String resourceArn()

The Amazon Resource Name (ARN) of the resource.

Returns:

The Amazon Resource Name (ARN) of the resource.

category

public final AlertCategory category()

The category that MediaTailor assigns to the alert.

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

Returns:

The category that MediaTailor assigns to the alert.

See Also:

AlertCategory

categoryAsString

public final String categoryAsString()

The category that MediaTailor assigns to the alert.

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

Returns:

The category that MediaTailor assigns to the alert.

See Also:

AlertCategory

toBuilder

public Alert.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Alert.Builder,Alert>

builder

public static Alert.Builder builder()

serializableBuilderClass

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