Class AddMediaStreamRequest

java.lang.Object
software.amazon.awssdk.services.mediaconnect.model.AddMediaStreamRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AddMediaStreamRequest.Builder,AddMediaStreamRequest>
@Generated("software.amazon.awssdk:codegen") public final class AddMediaStreamRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AddMediaStreamRequest.Builder,AddMediaStreamRequest>

The media stream that you want to add to the flow.

See Also:

  • Method Details

    • attributes

      public final MediaStreamAttributesRequest attributes()

      The attributes that you want to assign to the new media stream.

      Returns:
      The attributes that you want to assign to the new media stream.

    • clockRate

      public final Integer clockRate()

      The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.

      Returns:
      The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.

    • description

      public final String description()

      A description that can help you quickly identify what your media stream is used for.

      Returns:
      A description that can help you quickly identify what your media stream is used for.

    • mediaStreamId

      public final Integer mediaStreamId()

      A unique identifier for the media stream.

      Returns:
      A unique identifier for the media stream.

    • mediaStreamName

      public final String mediaStreamName()

      A name that helps you distinguish one media stream from another.

      Returns:
      A name that helps you distinguish one media stream from another.

    • mediaStreamType

      public final MediaStreamType mediaStreamType()

      The type of media stream.

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

      Returns:
      The type of media stream.
      See Also:

    • mediaStreamTypeAsString

      public final String mediaStreamTypeAsString()

      The type of media stream.

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

      Returns:
      The type of media stream.
      See Also:

    • videoFormat

      public final String videoFormat()

      The resolution of the video.

      Returns:
      The resolution of the video.

    • hasMediaStreamTags

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

    • mediaStreamTags

      public final Map<String,String> mediaStreamTags()

      The key-value pairs that can be used to tag and organize the media stream.

      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 hasMediaStreamTags() method.

      Returns:
      The key-value pairs that can be used to tag and organize the media stream.

    • toBuilder

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

    • builder

      public static AddMediaStreamRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.