Package software.amazon.awssdk.services.snowdevicemanagement.model

Class DescribeDeviceResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.snowdevicemanagement.model.SnowDeviceManagementResponse
software.amazon.awssdk.services.snowdevicemanagement.model.DescribeDeviceResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeDeviceResponse.Builder,DescribeDeviceResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeDeviceResponse extends SnowDeviceManagementResponse implements ToCopyableBuilder<DescribeDeviceResponse.Builder,DescribeDeviceResponse>

  • Method Details

    • associatedWithJob

      public final String associatedWithJob()

      The ID of the job used when ordering the device.

      Returns:
      The ID of the job used when ordering the device.

    • hasDeviceCapacities

      public final boolean hasDeviceCapacities()
      For responses, this returns true if the service returned a value for the DeviceCapacities 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.

    • deviceCapacities

      public final List<Capacity> deviceCapacities()

      The hardware specifications of the device.

      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 hasDeviceCapacities() method.

      Returns:
      The hardware specifications of the device.

    • deviceState

      public final UnlockState deviceState()

      The current state of the device.

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

      Returns:
      The current state of the device.
      See Also:

    • deviceStateAsString

      public final String deviceStateAsString()

      The current state of the device.

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

      Returns:
      The current state of the device.
      See Also:

    • deviceType

      public final String deviceType()

      The type of Amazon Web Services Snow Family device.

      Returns:
      The type of Amazon Web Services Snow Family device.

    • lastReachedOutAt

      public final Instant lastReachedOutAt()

      When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.

      Returns:
      When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.

      Returns:
      When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.

    • managedDeviceArn

      public final String managedDeviceArn()

      The Amazon Resource Name (ARN) of the device.

      Returns:
      The Amazon Resource Name (ARN) of the device.

    • managedDeviceId

      public final String managedDeviceId()

      The ID of the device that you checked the information for.

      Returns:
      The ID of the device that you checked the information for.

    • hasPhysicalNetworkInterfaces

      public final boolean hasPhysicalNetworkInterfaces()
      For responses, this returns true if the service returned a value for the PhysicalNetworkInterfaces 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.

    • physicalNetworkInterfaces

      public final List<PhysicalNetworkInterface> physicalNetworkInterfaces()

      The network interfaces available on the device.

      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 hasPhysicalNetworkInterfaces() method.

      Returns:
      The network interfaces available on the device.

    • software

      public final SoftwareInformation software()

      The software installed on the device.

      Returns:
      The software installed on the device.

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

      Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

      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:
      Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

    • toBuilder

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

    • builder

      public static DescribeDeviceResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeDeviceResponse.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.