Class InputDeviceSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InputDeviceSummary.Builder,
InputDeviceSummary>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The unique ARN of the input device.final String
The Availability Zone associated with this input device.static InputDeviceSummary.Builder
builder()
The state of the connection between the input device and AWS.final String
The state of the connection between the input device and AWS.final DeviceSettingsSyncState
The status of the action to synchronize the device configuration.final String
The status of the action to synchronize the device configuration.final DeviceUpdateStatus
The status of software on the input device.final String
The status of software on the input device.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 int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MedialiveInputArns property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final InputDeviceHdSettings
Settings that describe an input device that is type HD.final String
id()
The unique ID of the input device.final String
The network MAC address of the input device.An array of the ARNs for the MediaLive inputs attached to the device.final String
name()
A name that you specify for the input device.Network settings for the input device.final InputDeviceOutputType
The output attachment type of the input device.final String
The output attachment type of the input device.static Class
<? extends InputDeviceSummary.Builder> final String
The unique serial number of the input device.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 InputDeviceType
type()
The type of the input device.final String
The type of the input device.final InputDeviceUhdSettings
Settings that describe an input device that is type UHD.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The unique ARN of the input device.- Returns:
- The unique ARN of the input device.
-
connectionState
The state of the connection between the input device and AWS.If the service returns an enum value that is not available in the current SDK version,
connectionState
will returnInputDeviceConnectionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectionStateAsString()
.- Returns:
- The state of the connection between the input device and AWS.
- See Also:
-
connectionStateAsString
The state of the connection between the input device and AWS.If the service returns an enum value that is not available in the current SDK version,
connectionState
will returnInputDeviceConnectionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectionStateAsString()
.- Returns:
- The state of the connection between the input device and AWS.
- See Also:
-
deviceSettingsSyncState
The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.If the service returns an enum value that is not available in the current SDK version,
deviceSettingsSyncState
will returnDeviceSettingsSyncState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeviceSettingsSyncStateAsString()
.- Returns:
- The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.
- See Also:
-
deviceSettingsSyncStateAsString
The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.If the service returns an enum value that is not available in the current SDK version,
deviceSettingsSyncState
will returnDeviceSettingsSyncState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeviceSettingsSyncStateAsString()
.- Returns:
- The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.
- See Also:
-
deviceUpdateStatus
The status of software on the input device.If the service returns an enum value that is not available in the current SDK version,
deviceUpdateStatus
will returnDeviceUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeviceUpdateStatusAsString()
.- Returns:
- The status of software on the input device.
- See Also:
-
deviceUpdateStatusAsString
The status of software on the input device.If the service returns an enum value that is not available in the current SDK version,
deviceUpdateStatus
will returnDeviceUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeviceUpdateStatusAsString()
.- Returns:
- The status of software on the input device.
- See Also:
-
hdDeviceSettings
Settings that describe an input device that is type HD.- Returns:
- Settings that describe an input device that is type HD.
-
id
The unique ID of the input device.- Returns:
- The unique ID of the input device.
-
macAddress
The network MAC address of the input device.- Returns:
- The network MAC address of the input device.
-
name
A name that you specify for the input device.- Returns:
- A name that you specify for the input device.
-
networkSettings
Network settings for the input device.- Returns:
- Network settings for the input device.
-
serialNumber
The unique serial number of the input device.- Returns:
- The unique serial number of the input device.
-
type
The type of the input device.If the service returns an enum value that is not available in the current SDK version,
type
will returnInputDeviceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the input device.
- See Also:
-
typeAsString
The type of the input device.If the service returns an enum value that is not available in the current SDK version,
type
will returnInputDeviceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the input device.
- See Also:
-
uhdDeviceSettings
Settings that describe an input device that is type UHD.- Returns:
- Settings that describe an input device that is type UHD.
-
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.
-
availabilityZone
The Availability Zone associated with this input device.- Returns:
- The Availability Zone associated with this input device.
-
hasMedialiveInputArns
public final boolean hasMedialiveInputArns()For responses, this returns true if the service returned a value for the MedialiveInputArns 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. -
medialiveInputArns
An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_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
hasMedialiveInputArns()
method.- Returns:
- An array of the ARNs for the MediaLive inputs attached to the device. Returned only if the outputType is MEDIALIVE_INPUT.
-
outputType
The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input.If the service returns an enum value that is not available in the current SDK version,
outputType
will returnInputDeviceOutputType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputTypeAsString()
.- Returns:
- The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input.
- See Also:
-
outputTypeAsString
The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input.If the service returns an enum value that is not available in the current SDK version,
outputType
will returnInputDeviceOutputType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputTypeAsString()
.- Returns:
- The output attachment type of the input device. Specifies MEDIACONNECT_FLOW if this device is the source for a MediaConnect flow. Specifies MEDIALIVE_INPUT if this device is the source for a MediaLive input.
- 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<InputDeviceSummary.Builder,
InputDeviceSummary> - 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
-