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(value="software.amazon.awssdk:codegen")
public final class DescribeDeviceResponse
extends SnowDeviceManagementResponse
implements ToCopyableBuilder<DescribeDeviceResponse.Builder,DescribeDeviceResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDeviceResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	associatedWithJob() The ID of the job used when ordering the device.
static DescribeDeviceResponse.Builder	builder()
List<Capacity>	deviceCapacities() The hardware specifications of the device.
UnlockState	deviceState() The current state of the device.
String	deviceStateAsString() The current state of the device.
String	deviceType() The type of Amazon Web Services Snow Family device.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDeviceCapacities() For responses, this returns true if the service returned a value for the DeviceCapacities property.
int	hashCode()
boolean	hasPhysicalNetworkInterfaces() For responses, this returns true if the service returned a value for the PhysicalNetworkInterfaces property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Instant	lastReachedOutAt() When the device last contacted the Amazon Web Services Cloud.
Instant	lastUpdatedAt() When the device last pushed an update to the Amazon Web Services Cloud.
String	managedDeviceArn() The Amazon Resource Name (ARN) of the device.
String	managedDeviceId() The ID of the device that you checked the information for.
List<PhysicalNetworkInterface>	physicalNetworkInterfaces() The network interfaces available on the device.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDeviceResponse.Builder>	serializableBuilderClass()
SoftwareInformation	software() The software installed on the device.
Map<String,String>	tags() Optional metadata that you assign to a resource.
DescribeDeviceResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.snowdevicemanagement.model.SnowDeviceManagementResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

UnlockState

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:

UnlockState

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

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDeviceResponse.Builder,DescribeDeviceResponse>

Overrides:

toBuilder in class AwsResponse

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo