Class FailoverRouterInputConfiguration

java.lang.Object
software.amazon.awssdk.services.mediaconnect.model.FailoverRouterInputConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FailoverRouterInputConfiguration.Builder,FailoverRouterInputConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class FailoverRouterInputConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FailoverRouterInputConfiguration.Builder,FailoverRouterInputConfiguration>

Configuration settings for a failover router input that allows switching between two input sources.

See Also:

  • Method Details

    • networkInterfaceArn

      public final String networkInterfaceArn()

      The ARN of the network interface to use for this failover router input.

      Returns:
      The ARN of the network interface to use for this failover router input.

    • hasProtocolConfigurations

      public final boolean hasProtocolConfigurations()
      For responses, this returns true if the service returned a value for the ProtocolConfigurations 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.

    • protocolConfigurations

      public final List<FailoverRouterInputProtocolConfiguration> protocolConfigurations()

      A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.

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

      Returns:
      A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.

    • sourcePriorityMode

      public final FailoverInputSourcePriorityMode sourcePriorityMode()

      The mode for determining source priority in failover configurations.

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

      Returns:
      The mode for determining source priority in failover configurations.
      See Also:

    • sourcePriorityModeAsString

      public final String sourcePriorityModeAsString()

      The mode for determining source priority in failover configurations.

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

      Returns:
      The mode for determining source priority in failover configurations.
      See Also:

    • primarySourceIndex

      public final Integer primarySourceIndex()

      The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY

      Returns:
      The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY

    • toBuilder

      public FailoverRouterInputConfiguration.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<FailoverRouterInputConfiguration.Builder,FailoverRouterInputConfiguration>
      Returns:
      a builder for type T

    • builder

      public static FailoverRouterInputConfiguration.Builder builder()

    • serializableBuilderClass

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