Class Device
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Device.Builder,
Device>
Describes a device.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AWSLocation
The Amazon Web Services location of the device.static Device.Builder
builder()
final Instant
The date and time that the site was created.final String
The description of the device.final String
The Amazon Resource Name (ARN) of the device.final String
deviceId()
The ID of the device.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final String
The ID of the global network.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Location
location()
The site location.final String
model()
The device model.static Class
<? extends Device.Builder> final String
The device serial number.final String
siteId()
The site ID.final DeviceState
state()
The device state.final String
The device state.tags()
The tags for the device.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
type()
The device type.final String
vendor()
The device vendor.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
deviceId
The ID of the device.
- Returns:
- The ID of the device.
-
deviceArn
The Amazon Resource Name (ARN) of the device.
- Returns:
- The Amazon Resource Name (ARN) of the device.
-
globalNetworkId
The ID of the global network.
- Returns:
- The ID of the global network.
-
awsLocation
The Amazon Web Services location of the device.
- Returns:
- The Amazon Web Services location of the device.
-
description
The description of the device.
- Returns:
- The description of the device.
-
type
The device type.
- Returns:
- The device type.
-
vendor
The device vendor.
- Returns:
- The device vendor.
-
model
The device model.
- Returns:
- The device model.
-
serialNumber
The device serial number.
- Returns:
- The device serial number.
-
location
The site location.
- Returns:
- The site location.
-
siteId
The site ID.
- Returns:
- The site ID.
-
createdAt
The date and time that the site was created.
- Returns:
- The date and time that the site was created.
-
state
The device state.
If the service returns an enum value that is not available in the current SDK version,
state
will returnDeviceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The device state.
- See Also:
-
stateAsString
The device state.
If the service returns an enum value that is not available in the current SDK version,
state
will returnDeviceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The device state.
- See Also:
-
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 theisEmpty()
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
The tags for 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
hasTags()
method.- Returns:
- The tags for the device.
-
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 interfaceToCopyableBuilder<Device.Builder,
Device> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-