Class Output

java.lang.Object
software.amazon.awssdk.services.mediaconnect.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>
The settings for an output.
See Also:

  • Method Details

    • dataTransferSubscriberFeePercent

      public final Integer dataTransferSubscriberFeePercent()
      Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
      Returns:
      Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

    • description

      public final String description()
      A description of the output.
      Returns:
      A description of the output.

    • destination

      public final String destination()
      The address where you want to send the output.
      Returns:
      The address where you want to send the output.

    • encryption

      public final Encryption encryption()
      The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      Returns:
      The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

    • entitlementArn

      public final String entitlementArn()
      The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
      Returns:
      The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.

    • listenerAddress

      public final String listenerAddress()
      The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
      Returns:
      The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.

    • mediaLiveInputArn

      public final String mediaLiveInputArn()
      The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
      Returns:
      The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.

    • hasMediaStreamOutputConfigurations

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

    • mediaStreamOutputConfigurations

      public final List<MediaStreamOutputConfiguration> mediaStreamOutputConfigurations()
      The configuration for each media stream that is associated with the 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 hasMediaStreamOutputConfigurations() method.

      Returns:
      The configuration for each media stream that is associated with the output.

    • name

      public final String name()
      The name of the output. This value must be unique within the current flow.
      Returns:
      The name of the output. This value must be unique within the current flow.

    • outputArn

      public final String outputArn()
      The ARN of the output.
      Returns:
      The ARN of the output.

    • port

      public final Integer port()
      The port to use when content is distributed to this output.
      Returns:
      The port to use when content is distributed to this output.

    • transport

      public final Transport transport()
      Attributes related to the transport stream that are used in the output.
      Returns:
      Attributes related to the transport stream that are used in the output.

    • vpcInterfaceAttachment

      public final VpcInterfaceAttachment vpcInterfaceAttachment()
      The name of the VPC interface attachment to use for this output.
      Returns:
      The name of the VPC interface attachment to use for this output.

    • bridgeArn

      public final String bridgeArn()
      The ARN of the bridge that added this output.
      Returns:
      The ARN of the bridge that added this output.

    • hasBridgePorts

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

    • bridgePorts

      public final List<Integer> bridgePorts()
      The bridge output ports currently in use.

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

      Returns:
      The bridge output ports currently in use.

    • outputStatus

      public final OutputStatus outputStatus()
      An indication of whether the output is transmitting data or not.

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

      Returns:
      An indication of whether the output is transmitting data or not.
      See Also:

    • outputStatusAsString

      public final String outputStatusAsString()
      An indication of whether the output is transmitting data or not.

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

      Returns:
      An indication of whether the output is transmitting data or not.
      See Also:

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