Class Output

    • Method Detail

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