Class Transport
- java.lang.Object
-
- software.amazon.awssdk.services.mediaconnect.model.Transport
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Transport.Builder,Transport>
@Generated("software.amazon.awssdk:codegen") public final class Transport extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Transport.Builder,Transport>
Attributes related to the transport stream that are used in a source or output.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceTransport.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Transport.Builderbuilder()List<String>cidrAllowList()The range of IP addresses that should be allowed to initiate output requests to this flow.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCidrAllowList()For responses, this returns true if the service returned a value for the CidrAllowList property.inthashCode()IntegermaxBitrate()The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.IntegermaxLatency()The maximum latency in milliseconds.IntegermaxSyncBuffer()The size of the buffer (in milliseconds) to use to sync incoming source data.IntegerminLatency()The minimum latency in milliseconds for SRT-based streams.Protocolprotocol()The protocol that is used by the source or output.StringprotocolAsString()The protocol that is used by the source or output.StringremoteId()The remote ID for the Zixi-pull stream.List<SdkField<?>>sdkFields()IntegersenderControlPort()The port that the flow uses to send outbound requests to initiate connection with the sender.StringsenderIpAddress()The IP address that the flow communicates with to initiate connection with the sender.static Class<? extends Transport.Builder>serializableBuilderClass()IntegersmoothingLatency()The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.StringsourceListenerAddress()Source IP or domain name for SRT-caller protocol.IntegersourceListenerPort()Source port for SRT-caller protocol.StringstreamId()The stream ID that you want to use for this transport.Transport.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasCidrAllowList
public final boolean hasCidrAllowList()
For responses, this returns true if the service returned a value for the CidrAllowList 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.
-
cidrAllowList
public final List<String> cidrAllowList()
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.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
hasCidrAllowList()method.- Returns:
- The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
-
maxBitrate
public final Integer maxBitrate()
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.- Returns:
- The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
-
maxLatency
public final Integer maxLatency()
The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.- Returns:
- The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
-
maxSyncBuffer
public final Integer maxSyncBuffer()
The size of the buffer (in milliseconds) to use to sync incoming source data.- Returns:
- The size of the buffer (in milliseconds) to use to sync incoming source data.
-
minLatency
public final Integer minLatency()
The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.- Returns:
- The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
-
protocol
public final Protocol protocol()
The protocol that is used by the source or output.If the service returns an enum value that is not available in the current SDK version,
protocolwill returnProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprotocolAsString().- Returns:
- The protocol that is used by the source or output.
- See Also:
Protocol
-
protocolAsString
public final String protocolAsString()
The protocol that is used by the source or output.If the service returns an enum value that is not available in the current SDK version,
protocolwill returnProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromprotocolAsString().- Returns:
- The protocol that is used by the source or output.
- See Also:
Protocol
-
remoteId
public final String remoteId()
The remote ID for the Zixi-pull stream.- Returns:
- The remote ID for the Zixi-pull stream.
-
senderControlPort
public final Integer senderControlPort()
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.
-
senderIpAddress
public final String senderIpAddress()
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.
-
smoothingLatency
public final Integer smoothingLatency()
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.- Returns:
- The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
-
sourceListenerAddress
public final String sourceListenerAddress()
Source IP or domain name for SRT-caller protocol.- Returns:
- Source IP or domain name for SRT-caller protocol.
-
sourceListenerPort
public final Integer sourceListenerPort()
Source port for SRT-caller protocol.- Returns:
- Source port for SRT-caller protocol.
-
streamId
public final String streamId()
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.- Returns:
- The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
-
toBuilder
public Transport.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Transport.Builder,Transport>
-
builder
public static Transport.Builder builder()
-
serializableBuilderClass
public static Class<? extends Transport.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-