Class NdiConfig

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

Specifies the configuration settings for NDI outputs. Required when the flow includes NDI outputs.

See Also:

  • Method Details

    • ndiState

      public final NdiState ndiState()

      A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.

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

      Returns:
      A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.
      See Also:

    • ndiStateAsString

      public final String ndiStateAsString()

      A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.

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

      Returns:
      A setting that controls whether NDI outputs can be used in the flow. Must be ENABLED to add NDI outputs. Default is DISABLED.
      See Also:

    • machineName

      public final String machineName()

      A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.

      Returns:
      A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.

    • hasNdiDiscoveryServers

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

    • ndiDiscoveryServers

      public final List<NdiDiscoveryServerConfig> ndiDiscoveryServers()

      A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly.

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

      Returns:
      A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly.

    • toBuilder

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

    • builder

      public static NdiConfig.Builder builder()

    • serializableBuilderClass

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