Class RebootInputDeviceRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.medialive.model.MediaLiveRequest
software.amazon.awssdk.services.medialive.model.RebootInputDeviceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RebootInputDeviceRequest.Builder,RebootInputDeviceRequest>
@Generated("software.amazon.awssdk:codegen") public final class RebootInputDeviceRequest extends MediaLiveRequest implements ToCopyableBuilder<RebootInputDeviceRequest.Builder,RebootInputDeviceRequest>
A request to reboot an AWS Elemental device.

  • Method Details

    • force

      public final RebootInputDeviceForce force()
      Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes.

      If the service returns an enum value that is not available in the current SDK version, force will return RebootInputDeviceForce.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from forceAsString().

      Returns:
      Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes.
      See Also:

    • forceAsString

      public final String forceAsString()
      Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes.

      If the service returns an enum value that is not available in the current SDK version, force will return RebootInputDeviceForce.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from forceAsString().

      Returns:
      Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes.
      See Also:

    • inputDeviceId

      public final String inputDeviceId()
      The unique ID of the input device to reboot. For example, hd-123456789abcdef.
      Returns:
      The unique ID of the input device to reboot. For example, hd-123456789abcdef.

    • toBuilder

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

    • builder

      public static RebootInputDeviceRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.