Class UpdateFlowSourceRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.mediaconnect.model.MediaConnectRequest
software.amazon.awssdk.services.mediaconnect.model.UpdateFlowSourceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateFlowSourceRequest.Builder,UpdateFlowSourceRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateFlowSourceRequest extends MediaConnectRequest implements ToCopyableBuilder<UpdateFlowSourceRequest.Builder,UpdateFlowSourceRequest>

  • Method Details

    • decryption

      public final UpdateEncryption decryption()

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

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

    • description

      public final String description()

      A description of the source. This description is not visible outside of the current Amazon Web Services account.

      Returns:
      A description of the source. This description is not visible outside of the current Amazon Web Services account.

    • entitlementArn

      public final String entitlementArn()

      The Amazon Resource Name (ARN) of the entitlement that allows you to subscribe to the flow. The entitlement is set by the content originator, and the ARN is generated as part of the originator's flow.

      Returns:
      The Amazon Resource Name (ARN) of the entitlement that allows you to subscribe to the flow. The entitlement is set by the content originator, and the ARN is generated as part of the originator's flow.

    • flowArn

      public final String flowArn()

      The ARN of the flow that you want to update.

      Returns:
      The ARN of the flow that you want to update.

    • ingestPort

      public final Integer ingestPort()

      The port that the flow listens on for incoming content. If the protocol of the source is Zixi, the port must be set to 2088.

      Returns:
      The port that the flow listens on for incoming content. If the protocol of the source is Zixi, the port must be set to 2088.

    • maxBitrate

      public final Integer maxBitrate()

      The maximum bitrate for RIST, RTP, and RTP-FEC streams.

      Returns:
      The maximum 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 and Zixi-based streams.

      Returns:
      The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-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 stream that is associated with the source, and the parameters for that association.

      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 stream that is associated with the source, and the parameters for that association.

    • 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 the source uses to deliver the content to MediaConnect.

      Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.

      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 the source uses to deliver the content to MediaConnect.

      Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.

      See Also:

    • protocolAsString

      public final String protocolAsString()

      The protocol that the source uses to deliver the content to MediaConnect.

      Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.

      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 the source uses to deliver the content to MediaConnect.

      Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.

      See Also:

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

    • sourceArn

      public final String sourceArn()

      The ARN of the source that you want to update.

      Returns:
      The ARN of the source that you want to update.

    • sourceListenerAddress

      public final String sourceListenerAddress()

      The source IP or domain name for SRT-caller protocol.

      Returns:
      The 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.

    • vpcInterfaceName

      public final String vpcInterfaceName()

      The name of the VPC interface that you want to send your output to.

      Returns:
      The name of the VPC interface that you want to send your output to.

    • whitelistCidr

      public final String whitelistCidr()

      The range of IP addresses that are allowed to contribute content to your source. Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

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

    • gatewayBridgeSource

      public final UpdateGatewayBridgeSourceRequest 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.

    • toBuilder

      public UpdateFlowSourceRequest.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<UpdateFlowSourceRequest.Builder,UpdateFlowSourceRequest>
      Specified by:
      toBuilder in class MediaConnectRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateFlowSourceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateFlowSourceRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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