Package 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("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:

  • Method Details

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

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

    • 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()
      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<AutomaticInputFailoverSettings.Builder,AutomaticInputFailoverSettings>
      Returns:
      a builder for type T

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