Class Output

java.lang.Object
software.amazon.awssdk.services.medialive.model.Output
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Output.Builder,Output>
@Generated("software.amazon.awssdk:codegen") public final class Output extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Output.Builder,Output>
Output settings. There can be multiple outputs within a group.
See Also:

  • Method Details

    • hasAudioDescriptionNames

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

    • audioDescriptionNames

      public final List<String> audioDescriptionNames()
      The names of the AudioDescriptions used as audio sources for this output.

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

      Returns:
      The names of the AudioDescriptions used as audio sources for this output.

    • hasCaptionDescriptionNames

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

    • captionDescriptionNames

      public final List<String> captionDescriptionNames()
      The names of the CaptionDescriptions used as caption sources for this output.

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

      Returns:
      The names of the CaptionDescriptions used as caption sources for this output.

    • outputName

      public final String outputName()
      The name used to identify an output.
      Returns:
      The name used to identify an output.

    • outputSettings

      public final OutputSettings outputSettings()
      Output type-specific settings.
      Returns:
      Output type-specific settings.

    • videoDescriptionName

      public final String videoDescriptionName()
      The name of the VideoDescription used as the source for this output.
      Returns:
      The name of the VideoDescription used as the source for this output.

    • toBuilder

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

    • builder

      public static Output.Builder builder()

    • serializableBuilderClass

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