Class Source
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Source.Builder,
Source>
The settings for the source of the flow.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic Source.Builder
builder()
final Integer
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.final Encryption
The type of encryption that is used on the content ingested from this source.final String
A description for the source.final String
The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services account.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final GatewayBridgeSource
The source configuration for cloud flows receiving a stream from a bridge.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MediaStreamSourceConfigurations property.final String
ingestIp()
The IP address that the flow will be listening on for incoming content.final Integer
The port that the flow will be listening on for incoming content.The media streams that are associated with the source, and the parameters for those associations.final String
name()
The name of the source.final String
The IP address of the device that is currently sending content to this source.final Integer
The IP address that the flow communicates with to initiate connection with the sender.final String
The port that the flow uses to send outbound requests to initiate connection with the sender.static Class
<? extends Source.Builder> final String
The ARN of the source.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Transport
Attributes related to the transport stream that are used in the source.final String
The name of the VPC interface that is used for this source.final String
The range of IP addresses that should be allowed to contribute content to your source.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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
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 theisEmpty()
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
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
-
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
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
-
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
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
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
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
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
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 interfaceToCopyableBuilder<Source.Builder,
Source> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-