Class DescribeInputResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.medialive.model.MediaLiveResponse
-
- software.amazon.awssdk.services.medialive.model.DescribeInputResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<DescribeInputResponse.Builder,DescribeInputResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeInputResponse extends MediaLiveResponse implements ToCopyableBuilder<DescribeInputResponse.Builder,DescribeInputResponse>
Placeholder documentation for DescribeInputResponse
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeInputResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()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 DescribeInputResponse.Builderbuilder()List<InputDestination>destinations()A list of the destinations of the input (PUSH-type).booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAttachedChannels()For responses, this returns true if the service returned a value for the AttachedChannels property.booleanhasDestinations()For responses, this returns true if the service returned a value for the Destinations property.inthashCode()booleanhasInputDevices()For responses, this returns true if the service returned a value for the InputDevices property.booleanhasInputPartnerIds()For responses, this returns true if the service returned a value for the InputPartnerIds property.booleanhasMediaConnectFlows()For responses, this returns true if the service returned a value for the MediaConnectFlows property.booleanhasSecurityGroups()For responses, this returns true if the service returned a value for the SecurityGroups property.booleanhasSources()For responses, this returns true if the service returned a value for the Sources property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringid()The generated ID of the input (unique for user account, immutable).InputClassinputClass()STANDARD - MediaLive expects two sources to be connected to this input.StringinputClassAsString()STANDARD - MediaLive expects two sources to be connected to this input.List<InputDeviceSettings>inputDevices()Settings for the input devices.InputNetworkLocationinputNetworkLocation()The location of this input.StringinputNetworkLocationAsString()The location of this input.List<String>inputPartnerIds()A list of IDs for all Inputs which are partners of this one.InputSourceTypeinputSourceType()Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions.StringinputSourceTypeAsString()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.MulticastSettingsmulticastSettings()Multicast Input settings.Stringname()The user-assigned name (This is a mutable value).StringroleArn()The Amazon Resource Name (ARN) of the role this input assumes during and after creation.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()List<String>securityGroups()A list of IDs for all the Input Security Groups attached to the input.static Class<? extends DescribeInputResponse.Builder>serializableBuilderClass()List<InputSource>sources()A list of the sources of the input (PULL-type).SrtSettingssrtSettings()The settings associated with an SRT input.InputStatestate()Returns the value of the State property for this object.StringstateAsString()Returns the value of the State property for this object.Map<String,String>tags()A collection of key-value pairs.DescribeInputResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.InputTypetype()Returns the value of the Type property for this object.StringtypeAsString()Returns the value of the Type property for this object.-
Methods inherited from class software.amazon.awssdk.services.medialive.model.MediaLiveResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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 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
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 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
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,
inputClasswill 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:
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,
inputClasswill 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:
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 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
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 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
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,
inputSourceTypewill 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:
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,
inputSourceTypewill 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:
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 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
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 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
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 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
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,
statewill 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:
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,
statewill 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:
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 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
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,
typewill 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:
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,
typewill 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:
InputType
-
srtSettings
public final SrtSettings srtSettings()
The settings associated with an SRT input.- Returns:
- The settings associated with an SRT input.
-
inputNetworkLocation
public final InputNetworkLocation inputNetworkLocation()
The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem for an input in a customer network.If the service returns an enum value that is not available in the current SDK version,
inputNetworkLocationwill returnInputNetworkLocation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominputNetworkLocationAsString().- Returns:
- The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem for an input in a customer network.
- See Also:
InputNetworkLocation
-
inputNetworkLocationAsString
public final String inputNetworkLocationAsString()
The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem for an input in a customer network.If the service returns an enum value that is not available in the current SDK version,
inputNetworkLocationwill returnInputNetworkLocation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominputNetworkLocationAsString().- Returns:
- The location of this input. AWS, for an input existing in the AWS Cloud, On-Prem for an input in a customer network.
- See Also:
InputNetworkLocation
-
multicastSettings
public final MulticastSettings multicastSettings()
Multicast Input settings.- Returns:
- Multicast Input settings.
-
toBuilder
public DescribeInputResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeInputResponse.Builder,DescribeInputResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static DescribeInputResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeInputResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-