Class DescribeInputDeviceResponse

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.DescribeInputDeviceResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeInputDeviceResponse.Builder,DescribeInputDeviceResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeInputDeviceResponse extends MediaLiveResponse implements ToCopyableBuilder<DescribeInputDeviceResponse.Builder,DescribeInputDeviceResponse>
Placeholder documentation for DescribeInputDeviceResponse

  • Method Details

    • arn

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

    • connectionState

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

      Returns:
      The state of the connection between the input device and AWS.
      See Also:

    • connectionStateAsString

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

      Returns:
      The state of the connection between the input device and AWS.
      See Also:

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

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

    • deviceUpdateStatus

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

      Returns:
      The status of software on the input device.
      See Also:

    • deviceUpdateStatusAsString

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

      Returns:
      The status of software on the input device.
      See Also:

    • 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()
      The network settings for the input device.
      Returns:
      The 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.

    • type

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

      Returns:
      The type of the input device.
      See Also:

    • typeAsString

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

      Returns:
      The type of the input device.
      See Also:

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

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

    • toBuilder

      public DescribeInputDeviceResponse.Builder 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 interface ToCopyableBuilder<DescribeInputDeviceResponse.Builder,DescribeInputDeviceResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeInputDeviceResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeInputDeviceResponse.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.