Class Source

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

The settings for the source of the flow.

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.

    • decryption

      public final Encryption decryption()

      The type of encryption that is used on the content ingested from this source.

      Returns:
      The type of encryption that is used on the content ingested from this source.

    • description

      public final String description()

      A description for the source. This value is not used or seen outside of the current MediaConnect account.

      Returns:
      A description for the source. This value is not used or seen outside of the current MediaConnect account.

    • entitlementArn

      public final String entitlementArn()

      The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.

      Returns:
      The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.

    • ingestIp

      public final String ingestIp()

      The IP address that the flow will be listening on for incoming content.

      Returns:
      The IP address that the flow will be listening on for incoming content.

    • ingestPort

      public final Integer ingestPort()

      The port that the flow will be listening on for incoming content.

      Returns:
      The port that the flow will be listening on for incoming content.

    • hasMediaStreamSourceConfigurations

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

    • mediaStreamSourceConfigurations

      public final List<MediaStreamSourceConfiguration> mediaStreamSourceConfigurations()

      The media streams that are associated with the source, and the parameters for those associations.

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

      Returns:
      The media streams that are associated with the source, and the parameters for those associations.

    • name

      public final String name()

      The name of the source.

      Returns:
      The name of the source.

    • senderControlPort

      public final Integer senderControlPort()

      The IP address that the flow communicates with to initiate connection with the sender.

      Returns:
      The IP address that the flow communicates with to initiate connection with the sender.

    • senderIpAddress

      public final String senderIpAddress()

      The port that the flow uses to send outbound requests to initiate connection with the sender.

      Returns:
      The port that the flow uses to send outbound requests to initiate connection with the sender.

    • sourceArn

      public final String sourceArn()

      The ARN of the source.

      Returns:
      The ARN of the source.

    • transport

      public final Transport transport()

      Attributes related to the transport stream that are used in the source.

      Returns:
      Attributes related to the transport stream that are used in the source.

    • vpcInterfaceName

      public final String vpcInterfaceName()

      The name of the VPC interface that is used for this source.

      Returns:
      The name of the VPC interface that is used for this source.

    • whitelistCidr

      public final String whitelistCidr()

      The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

      Returns:
      The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

    • gatewayBridgeSource

      public final GatewayBridgeSource gatewayBridgeSource()

      The source configuration for cloud flows receiving a stream from a bridge.

      Returns:
      The source configuration for cloud flows receiving a stream from a bridge.

    • peerIpAddress

      public final String peerIpAddress()

      The IP address of the device that is currently sending content to this source.

      • For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address.

      • For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender.

      • Peer IP addresses aren't available for entitlements and CDI/ST2110 sources.

      • The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.

      Returns:
      The IP address of the device that is currently sending content to this source.

      • For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address.

      • For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender.

      • Peer IP addresses aren't available for entitlements and CDI/ST2110 sources.

      • The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.

    • toBuilder

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

    • builder

      public static Source.Builder builder()

    • serializableBuilderClass

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