Input (AWS Java SDK :: Services :: AWS Elemental MediaLive 2.18.21 API)

java.lang.Object
- software.amazon.awssdk.services.medialive.model.Input

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Input.Builder,Input>

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

Placeholder documentation for Input

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Input.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Input.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Unique ARN of the input (generated, immutable).
`List<String>`	`attachedChannels()` A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).
`static Input.Builder`	`builder()`
`List<InputDestination>`	`destinations()` A list of the destinations of the input (PUSH-type).
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttachedChannels()` For responses, this returns true if the service returned a value for the AttachedChannels property.
`boolean`	`hasDestinations()` For responses, this returns true if the service returned a value for the Destinations property.
`int`	`hashCode()`
`boolean`	`hasInputDevices()` For responses, this returns true if the service returned a value for the InputDevices property.
`boolean`	`hasInputPartnerIds()` For responses, this returns true if the service returned a value for the InputPartnerIds property.
`boolean`	`hasMediaConnectFlows()` For responses, this returns true if the service returned a value for the MediaConnectFlows property.
`boolean`	`hasSecurityGroups()` For responses, this returns true if the service returned a value for the SecurityGroups property.
`boolean`	`hasSources()` For responses, this returns true if the service returned a value for the Sources property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`id()` The generated ID of the input (unique for user account, immutable).
`InputClass`	`inputClass()` STANDARD - MediaLive expects two sources to be connected to this input.
`String`	`inputClassAsString()` STANDARD - MediaLive expects two sources to be connected to this input.
`List<InputDeviceSettings>`	`inputDevices()` Settings for the input devices.
`List<String>`	`inputPartnerIds()` A list of IDs for all Inputs which are partners of this one.
`InputSourceType`	`inputSourceType()` Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions.
`String`	`inputSourceTypeAsString()` Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions.
`List<MediaConnectFlow>`	`mediaConnectFlows()` A list of MediaConnect Flows for this input.
`String`	`name()` The user-assigned name (This is a mutable value).
`String`	`roleArn()` The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()` A list of IDs for all the Input Security Groups attached to the input.
`static Class<? extends Input.Builder>`	`serializableBuilderClass()`
`List<InputSource>`	`sources()` A list of the sources of the input (PULL-type).
`InputState`	`state()` Returns the value of the State property for this object.
`String`	`stateAsString()` Returns the value of the State property for this object.
`Map<String,String>`	`tags()` A collection of key-value pairs.
`Input.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`InputType`	`type()` Returns the value of the Type property for this object.
`String`	`typeAsString()` Returns the value of the Type property for this object.

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
  - 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:
    
    InputClass
  - 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:
    
    InputClass
  - 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:
    
    InputSourceType
  - 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:
    
    InputSourceType
  - 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:
    
    InputState
  - 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:
    
    InputState
  - 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:
    
    InputType
  - 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:
    
    InputType
  - toBuilder
```
public Input.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Input.Builder,Input>
  - 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)
```
    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

Class Input

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

hasAttachedChannels

attachedChannels

hasDestinations

destinations

id

inputClass

inputClassAsString

hasInputDevices

inputDevices

hasInputPartnerIds

inputPartnerIds

inputSourceType

inputSourceTypeAsString

hasMediaConnectFlows

mediaConnectFlows

name

roleArn

hasSecurityGroups

securityGroups

hasSources

sources

state

stateAsString

hasTags

tags

type

typeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields