com.amazonaws.services.medialive.model

Class AutomaticInputFailoverSettings

java.lang.Object

com.amazonaws.services.medialive.model.AutomaticInputFailoverSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AutomaticInputFailoverSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

The settings for Automatic Input Failover.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AutomaticInputFailoverSettings()

Method Summary

Modifier and Type	Method and Description
AutomaticInputFailoverSettings	clone()
boolean	equals(Object obj)
Integer	getErrorClearTimeMsec() This clear time defines the requirement a recovered input must meet to be considered healthy.
List<FailoverCondition>	getFailoverConditions() A list of failover conditions.
String	getInputPreference() Input preference when deciding which input to make active when a previously failed input has recovered.
String	getSecondaryInputId() The input ID of the secondary input in the automatic input failover pair.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setErrorClearTimeMsec(Integer errorClearTimeMsec) This clear time defines the requirement a recovered input must meet to be considered healthy.
void	setFailoverConditions(Collection<FailoverCondition> failoverConditions) A list of failover conditions.
void	setInputPreference(String inputPreference) Input preference when deciding which input to make active when a previously failed input has recovered.
void	setSecondaryInputId(String secondaryInputId) The input ID of the secondary input in the automatic input failover pair.
String	toString() Returns a string representation of this object.
AutomaticInputFailoverSettings	withErrorClearTimeMsec(Integer errorClearTimeMsec) This clear time defines the requirement a recovered input must meet to be considered healthy.
AutomaticInputFailoverSettings	withFailoverConditions(Collection<FailoverCondition> failoverConditions) A list of failover conditions.
AutomaticInputFailoverSettings	withFailoverConditions(FailoverCondition... failoverConditions) A list of failover conditions.
AutomaticInputFailoverSettings	withInputPreference(InputPreference inputPreference) Input preference when deciding which input to make active when a previously failed input has recovered.
AutomaticInputFailoverSettings	withInputPreference(String inputPreference) Input preference when deciding which input to make active when a previously failed input has recovered.
AutomaticInputFailoverSettings	withSecondaryInputId(String secondaryInputId) The input ID of the secondary input in the automatic input failover pair.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AutomaticInputFailoverSettings

public AutomaticInputFailoverSettings()

Method Detail

setErrorClearTimeMsec

public void setErrorClearTimeMsec(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.

Parameters:

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.

getErrorClearTimeMsec

public Integer getErrorClearTimeMsec()

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.

withErrorClearTimeMsec

public AutomaticInputFailoverSettings withErrorClearTimeMsec(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getFailoverConditions

public List<FailoverCondition> getFailoverConditions()

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

Returns:

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

setFailoverConditions

public void setFailoverConditions(Collection<FailoverCondition> failoverConditions)

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

Parameters:

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

withFailoverConditions

public AutomaticInputFailoverSettings withFailoverConditions(FailoverCondition... failoverConditions)

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

NOTE: This method appends the values to the existing list (if any). Use setFailoverConditions(java.util.Collection) or withFailoverConditions(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withFailoverConditions

public AutomaticInputFailoverSettings withFailoverConditions(Collection<FailoverCondition> failoverConditions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setInputPreference

public void setInputPreference(String inputPreference)

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

Parameters:

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

See Also:

InputPreference

getInputPreference

public String getInputPreference()

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

Returns:

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

See Also:

InputPreference

withInputPreference

public AutomaticInputFailoverSettings withInputPreference(String inputPreference)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InputPreference

withInputPreference

public AutomaticInputFailoverSettings withInputPreference(InputPreference inputPreference)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InputPreference

setSecondaryInputId

public void setSecondaryInputId(String secondaryInputId)

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

Parameters:

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

getSecondaryInputId

public String getSecondaryInputId()

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.

withSecondaryInputId

public AutomaticInputFailoverSettings withSecondaryInputId(String secondaryInputId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AutomaticInputFailoverSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.