software.amazon.awssdk.services.mediaconnect.model

Class SetSourceRequest

java.lang.Object

software.amazon.awssdk.services.mediaconnect.model.SetSourceRequest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SetSourceRequest.Builder,SetSourceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SetSourceRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SetSourceRequest.Builder,SetSourceRequest>

The settings for the source of the flow.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SetSourceRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SetSourceRequest.Builder	builder()
Encryption	decryption() The type of encryption that is used on the content ingested from this source.
String	description() A description for the source.
String	entitlementArn() The ARN of the entitlement that allows you to subscribe to this flow.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMediaStreamSourceConfigurations() For responses, this returns true if the service returned a value for the MediaStreamSourceConfigurations property.
Integer	ingestPort() The port that the flow will be listening on for incoming content.
Integer	maxBitrate() The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
Integer	maxLatency() The maximum latency in milliseconds.
Integer	maxSyncBuffer() The size of the buffer (in milliseconds) to use to sync incoming source data.
List<MediaStreamSourceConfigurationRequest>	mediaStreamSourceConfigurations() The media streams that are associated with the source, and the parameters for those associations.
Integer	minLatency() The minimum latency in milliseconds for SRT-based streams.
String	name() The name of the source.
Protocol	protocol() The protocol that is used by the source.
String	protocolAsString() The protocol that is used by the source.
List<SdkField<?>>	sdkFields()
Integer	senderControlPort() The port that the flow uses to send outbound requests to initiate connection with the sender.
String	senderIpAddress() The IP address that the flow communicates with to initiate connection with the sender.
static Class<? extends SetSourceRequest.Builder>	serializableBuilderClass()
String	sourceListenerAddress() Source IP or domain name for SRT-caller protocol.
Integer	sourceListenerPort() Source port for SRT-caller protocol.
String	streamId() The stream ID that you want to use for this transport.
SetSourceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vpcInterfaceName() The name of the VPC interface to use for this source.
String	whitelistCidr() The range of IP addresses that should be allowed to contribute content to your source.

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

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 AWS Elemental MediaConnect account.

Returns:

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

entitlementArn

public final String entitlementArn()

The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow 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 this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.

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.

maxBitrate

public final Integer maxBitrate()

The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.

Returns:

The smoothing max bitrate 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.

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

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.

name

public final String name()

The name of the source.

Returns:

The name of the source.

protocol

public final Protocol protocol()

The protocol that is used by the source.

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

Returns:

The protocol that is used by the source.

See Also:

Protocol

protocolAsString

public final String protocolAsString()

The protocol that is used by the source.

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

Returns:

The protocol that is used by the source.

See Also:

Protocol

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.

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-based streams.

Returns:

The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.

vpcInterfaceName

public final String vpcInterfaceName()

The name of the VPC interface to use for this source.

Returns:

The name of the VPC interface to use 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.

toBuilder

public SetSourceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetSourceRequest.Builder,SetSourceRequest>

builder

public static SetSourceRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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