Class AddOutputRequest

java.lang.Object
software.amazon.awssdk.services.mediaconnect.model.AddOutputRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AddOutputRequest.Builder,AddOutputRequest>
@Generated("software.amazon.awssdk:codegen") public final class AddOutputRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AddOutputRequest.Builder,AddOutputRequest>
The output that you want to add to this flow.
See Also:

  • Method Details

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

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

    • description

      public final String description()
      A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
      Returns:
      A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.

    • destination

      public final String destination()
      The IP address from which video will be sent to output destinations.
      Returns:
      The IP address from which video will be sent to output destinations.

    • encryption

      public final Encryption encryption()
      The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.
      Returns:
      The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.

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

    • hasMediaStreamOutputConfigurations

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

    • mediaStreamOutputConfigurations

      public final List<MediaStreamOutputConfigurationRequest> mediaStreamOutputConfigurations()
      The media streams that are associated with the output, 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 hasMediaStreamOutputConfigurations() method.

      Returns:
      The media streams that are associated with the output, 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 output. This value must be unique within the current flow.
      Returns:
      The name of the output. This value must be unique within the current flow.

    • port

      public final Integer port()
      The port to use when content is distributed to this output.
      Returns:
      The port to use when content is distributed to this output.

    • protocol

      public final Protocol protocol()
      The protocol to use for the output.

      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 to use for the output.
      See Also:

    • protocolAsString

      public final String protocolAsString()
      The protocol to use for the output.

      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 to use for the output.
      See Also:

    • remoteId

      public final String remoteId()
      The remote ID for the Zixi-pull output stream.
      Returns:
      The remote ID for the Zixi-pull output 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.

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

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

    • vpcInterfaceAttachment

      public final VpcInterfaceAttachment vpcInterfaceAttachment()
      The name of the VPC interface attachment to use for this output.
      Returns:
      The name of the VPC interface attachment to use for this output.

    • outputStatus

      public final OutputStatus outputStatus()
      An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.

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

      Returns:
      An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.
      See Also:

    • outputStatusAsString

      public final String outputStatusAsString()
      An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.

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

      Returns:
      An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.
      See Also:

    • toBuilder

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

    • builder

      public static AddOutputRequest.Builder builder()

    • serializableBuilderClass

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