software.amazon.awssdk.services.iotwireless.model

Class SidewalkDevice

java.lang.Object

software.amazon.awssdk.services.iotwireless.model.SidewalkDevice

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SidewalkDevice.Builder,SidewalkDevice>

@Generated(value="software.amazon.awssdk:codegen")
public final class SidewalkDevice
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SidewalkDevice.Builder,SidewalkDevice>

Sidewalk device object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SidewalkDevice.Builder

Method Summary

Modifier and Type	Method and Description
String	amazonId() Returns the value of the AmazonId property for this object.
static SidewalkDevice.Builder	builder()
String	certificateId() The ID of the Sidewalk device profile.
List<CertificateList>	deviceCertificates() The sidewalk device certificates for Ed25519 and P256r1.
String	deviceProfileId() The ID of the Sidewalk device profile.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDeviceCertificates() For responses, this returns true if the service returned a value for the DeviceCertificates property.
int	hashCode()
boolean	hasPrivateKeys() For responses, this returns true if the service returned a value for the PrivateKeys property.
List<CertificateList>	privateKeys() The Sidewalk device private keys that will be used for onboarding the device.
List<SdkField<?>>	sdkFields()
static Class<? extends SidewalkDevice.Builder>	serializableBuilderClass()
String	sidewalkId() The sidewalk device identification.
String	sidewalkManufacturingSn() The Sidewalk manufacturing series number.
WirelessDeviceSidewalkStatus	status() The Sidewalk device status, such as provisioned or registered.
String	statusAsString() The Sidewalk device status, such as provisioned or registered.
SidewalkDevice.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

amazonId

public final String amazonId()

Returns the value of the AmazonId property for this object.

Returns:

The value of the AmazonId property for this object.

sidewalkId

public final String sidewalkId()

The sidewalk device identification.

Returns:

The sidewalk device identification.

sidewalkManufacturingSn

public final String sidewalkManufacturingSn()

The Sidewalk manufacturing series number.

Returns:

The Sidewalk manufacturing series number.

hasDeviceCertificates

public final boolean hasDeviceCertificates()

For responses, this returns true if the service returned a value for the DeviceCertificates 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.

deviceCertificates

public final List<CertificateList> deviceCertificates()

The sidewalk device certificates for Ed25519 and P256r1.

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

Returns:

The sidewalk device certificates for Ed25519 and P256r1.

hasPrivateKeys

public final boolean hasPrivateKeys()

For responses, this returns true if the service returned a value for the PrivateKeys 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.

privateKeys

public final List<CertificateList> privateKeys()

The Sidewalk device private keys that will be used for onboarding 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 hasPrivateKeys() method.

Returns:

The Sidewalk device private keys that will be used for onboarding the device.

deviceProfileId

public final String deviceProfileId()

The ID of the Sidewalk device profile.

Returns:

The ID of the Sidewalk device profile.

certificateId

public final String certificateId()

The ID of the Sidewalk device profile.

Returns:

The ID of the Sidewalk device profile.

status

public final WirelessDeviceSidewalkStatus status()

The Sidewalk device status, such as provisioned or registered.

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

Returns:

The Sidewalk device status, such as provisioned or registered.

See Also:

WirelessDeviceSidewalkStatus

statusAsString

public final String statusAsString()

The Sidewalk device status, such as provisioned or registered.

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

Returns:

The Sidewalk device status, such as provisioned or registered.

See Also:

WirelessDeviceSidewalkStatus

toBuilder

public SidewalkDevice.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SidewalkDevice.Builder,SidewalkDevice>

builder

public static SidewalkDevice.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo