Package software.amazon.awssdk.services.medialive.model

Class InputDeviceSummary

    • Method Detail

      • arn

        public final String arn()
        The unique ARN of the input device.
        Returns:
        The unique ARN of the input device.

      • deviceSettingsSyncState

        public final DeviceSettingsSyncState 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 return DeviceSettingsSyncState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceSettingsSyncStateAsString().

        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:
        DeviceSettingsSyncState

      • deviceSettingsSyncStateAsString

        public final String 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 return DeviceSettingsSyncState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceSettingsSyncStateAsString().

        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:
        DeviceSettingsSyncState

      • hdDeviceSettings

        public final InputDeviceHdSettings hdDeviceSettings()
        Settings that describe an input device that is type HD.
        Returns:
        Settings that describe an input device that is type HD.

      • id

        public final String id()
        The unique ID of the input device.
        Returns:
        The unique ID of the input device.

      • macAddress

        public final String macAddress()
        The network MAC address of the input device.
        Returns:
        The network MAC address of the input device.

      • name

        public final String name()
        A name that you specify for the input device.
        Returns:
        A name that you specify for the input device.

      • networkSettings

        public final InputDeviceNetworkSettings networkSettings()
        Network settings for the input device.
        Returns:
        Network settings for the input device.

      • serialNumber

        public final String serialNumber()
        The unique serial number of the input device.
        Returns:
        The unique serial number of the input device.

      • uhdDeviceSettings

        public final InputDeviceUhdSettings 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 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.

      • availabilityZone

        public final String 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 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.

      • medialiveInputArns

        public final List<String> 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

        public final InputDeviceOutputType 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 return InputDeviceOutputType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputTypeAsString().

        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:
        InputDeviceOutputType

      • outputTypeAsString

        public final String 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 return InputDeviceOutputType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputTypeAsString().

        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:
        InputDeviceOutputType

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)