software.amazon.awssdk.services.medialive.model

Class AutomaticInputFailoverSettings

java.lang.Object

software.amazon.awssdk.services.medialive.model.AutomaticInputFailoverSettings

All Implemented Interfaces:

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

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

The settings for Automatic Input Failover.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AutomaticInputFailoverSettings.Builder

Method Summary

Modifier and Type	Method and Description
static AutomaticInputFailoverSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	errorClearTimeMsec() This clear time defines the requirement a recovered input must meet to be considered healthy.
List<FailoverCondition>	failoverConditions() A list of failover conditions.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFailoverConditions() For responses, this returns true if the service returned a value for the FailoverConditions property.
int	hashCode()
InputPreference	inputPreference() Input preference when deciding which input to make active when a previously failed input has recovered.
String	inputPreferenceAsString() Input preference when deciding which input to make active when a previously failed input has recovered.
List<SdkField<?>>	sdkFields()
String	secondaryInputId() The input ID of the secondary input in the automatic input failover pair.
static Class<? extends AutomaticInputFailoverSettings.Builder>	serializableBuilderClass()
AutomaticInputFailoverSettings.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

errorClearTimeMsec

public final Integer errorClearTimeMsec()

This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input_preference for the failover pair is set to PRIMARY_INPUT_PREFERRED, because after this time, MediaLive will switch back to the primary input.

Returns:

This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input_preference for the failover pair is set to PRIMARY_INPUT_PREFERRED, because after this time, MediaLive will switch back to the primary input.

hasFailoverConditions

public final boolean hasFailoverConditions()

For responses, this returns true if the service returned a value for the FailoverConditions 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.

failoverConditions

public final List<FailoverCondition> failoverConditions()

A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input.

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 hasFailoverConditions() method.

Returns:

A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input.

inputPreference

public final InputPreference inputPreference()

Input preference when deciding which input to make active when a previously failed input has recovered.

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

Returns:

Input preference when deciding which input to make active when a previously failed input has recovered.

See Also:

InputPreference

inputPreferenceAsString

public final String inputPreferenceAsString()

Input preference when deciding which input to make active when a previously failed input has recovered.

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

Returns:

Input preference when deciding which input to make active when a previously failed input has recovered.

See Also:

InputPreference

secondaryInputId

public final String secondaryInputId()

The input ID of the secondary input in the automatic input failover pair.

Returns:

The input ID of the secondary input in the automatic input failover pair.

toBuilder

public AutomaticInputFailoverSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AutomaticInputFailoverSettings.Builder,AutomaticInputFailoverSettings>

builder

public static AutomaticInputFailoverSettings.Builder builder()

serializableBuilderClass

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