java.lang.Object
software.amazon.awssdk.services.medialive.model.Input
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Input.Builder,Input>

@Generated("software.amazon.awssdk:codegen") public final class Input extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Input.Builder,Input>
Placeholder documentation for Input
See Also:
  • Method Details

    • arn

      public final String arn()
      The Unique ARN of the input (generated, immutable).
      Returns:
      The Unique ARN of the input (generated, immutable).
    • hasAttachedChannels

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

      public final List<String> attachedChannels()
      A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).

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

      Returns:
      A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).
    • hasDestinations

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

      public final List<InputDestination> destinations()
      A list of the destinations of the input (PUSH-type).

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

      Returns:
      A list of the destinations of the input (PUSH-type).
    • id

      public final String id()
      The generated ID of the input (unique for user account, immutable).
      Returns:
      The generated ID of the input (unique for user account, immutable).
    • inputClass

      public final InputClass inputClass()
      STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.

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

      Returns:
      STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.
      See Also:
    • inputClassAsString

      public final String inputClassAsString()
      STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.

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

      Returns:
      STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.
      See Also:
    • hasInputDevices

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

      public final List<InputDeviceSettings> inputDevices()
      Settings for the input devices.

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

      Returns:
      Settings for the input devices.
    • hasInputPartnerIds

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

      public final List<String> inputPartnerIds()
      A list of IDs for all Inputs which are partners of this one.

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

      Returns:
      A list of IDs for all Inputs which are partners of this one.
    • inputSourceType

      public final InputSourceType inputSourceType()
      Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs.

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

      Returns:
      Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs.
      See Also:
    • inputSourceTypeAsString

      public final String inputSourceTypeAsString()
      Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs.

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

      Returns:
      Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs.
      See Also:
    • hasMediaConnectFlows

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

      public final List<MediaConnectFlow> mediaConnectFlows()
      A list of MediaConnect Flows for this input.

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

      Returns:
      A list of MediaConnect Flows for this input.
    • name

      public final String name()
      The user-assigned name (This is a mutable value).
      Returns:
      The user-assigned name (This is a mutable value).
    • roleArn

      public final String roleArn()
      The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
      Returns:
      The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
    • hasSecurityGroups

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

      public final List<String> securityGroups()
      A list of IDs for all the Input Security Groups attached to the input.

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

      Returns:
      A list of IDs for all the Input Security Groups attached to the input.
    • hasSources

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

      public final List<InputSource> sources()
      A list of the sources of the input (PULL-type).

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

      Returns:
      A list of the sources of the input (PULL-type).
    • state

      public final InputState state()
      Returns the value of the State property for this object.

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

      Returns:
      The value of the State property for this object.
      See Also:
    • stateAsString

      public final String stateAsString()
      Returns the value of the State property for this object.

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

      Returns:
      The value of the State property for this object.
      See Also:
    • hasTags

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

      public final Map<String,String> tags()
      A collection of key-value pairs.

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

      Returns:
      A collection of key-value pairs.
    • type

      public final InputType type()
      Returns the value of the Type property for this object.

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

      Returns:
      The value of the Type property for this object.
      See Also:
    • typeAsString

      public final String typeAsString()
      Returns the value of the Type property for this object.

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

      Returns:
      The value of the Type property for this object.
      See Also:
    • toBuilder

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

      public static Input.Builder builder()
    • serializableBuilderClass

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