Class Input
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Input.Builder,
Input>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Unique ARN of the input (generated, immutable).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()
final List
<InputDestination> A list of the destinations of the input (PUSH-type).final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AttachedChannels property.final boolean
For responses, this returns true if the service returned a value for the Destinations property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InputDevices property.final boolean
For responses, this returns true if the service returned a value for the InputPartnerIds property.final boolean
For responses, this returns true if the service returned a value for the MediaConnectFlows property.final boolean
For responses, this returns true if the service returned a value for the SecurityGroups property.final boolean
For responses, this returns true if the service returned a value for the Sources property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
id()
The generated ID of the input (unique for user account, immutable).final InputClass
STANDARD - MediaLive expects two sources to be connected to this input.final String
STANDARD - MediaLive expects two sources to be connected to this input.final List
<InputDeviceSettings> Settings for the input devices.A list of IDs for all Inputs which are partners of this one.final InputSourceType
Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions.final String
Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions.final List
<MediaConnectFlow> A list of MediaConnect Flows for this input.final String
name()
The user-assigned name (This is a mutable value).final String
roleArn()
The Amazon Resource Name (ARN) of the role this input assumes during and after creation.A list of IDs for all the Input Security Groups attached to the input.static Class
<? extends Input.Builder> final List
<InputSource> sources()
A list of the sources of the input (PULL-type).final InputState
state()
Returns the value of the State property for this object.final String
Returns the value of the State property for this object.tags()
A collection of key-value pairs.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final InputType
type()
Returns the value of the Type property for this object.final String
Returns the value of the Type property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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 theisEmpty()
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
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
The generated ID of the input (unique for user account, immutable).- Returns:
- The generated ID of the input (unique for user account, immutable).
-
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 returnInputClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputClassAsString()
.- 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
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 returnInputClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputClassAsString()
.- 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 theisEmpty()
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
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 theisEmpty()
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
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
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 returnInputSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputSourceTypeAsString()
.- 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
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 returnInputSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputSourceTypeAsString()
.- 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 theisEmpty()
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
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
The user-assigned name (This is a mutable value).- Returns:
- The user-assigned name (This is a mutable value).
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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 returnInputState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The value of the State property for this object.
- See Also:
-
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 returnInputState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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 theisEmpty()
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
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
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 returnInputType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The value of the Type property for this object.
- See Also:
-
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 returnInputType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The value of the Type property for this object.
- See Also:
-
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 interfaceToCopyableBuilder<Input.Builder,
Input> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-