com.amazonaws.services.iot.client

Annotation Type AWSIotDeviceProperty

@Retention(value=RUNTIME)
public @interface AWSIotDeviceProperty

Annotation class that is used to annotate properties in AWSIotDevice. Properties annotated must be accessible via corresponding getter and setter methods.

With optional values provided by this annotation class, properties can also be configured to disable reporting to the shadow or not to accept updates from the shadow. If enableReport() is disabled, property getter function is not required. Likewise, if allowUpdate() is disabled for a property, its setter method is not required.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowUpdate Allow updates from the shadow.
boolean	enableReport Enable reporting the annotated property to the shadow.
String	name An optional name can be provided to the annotated property, which will be used for publishing to the shadow as well as receiving updates from the shadow.

Element Detail

name

public abstract String name

An optional name can be provided to the annotated property, which will be used for publishing to the shadow as well as receiving updates from the shadow. If not provided, the actual property name will be used.

Returns:

the name of the property.

Default:

""

enableReport

public abstract boolean enableReport

Enable reporting the annotated property to the shadow. It's enabled by default.

Returns:

true to enable reporting to the shadow, false otherwise.

Default:

true

allowUpdate

public abstract boolean allowUpdate

Allow updates from the shadow. It's enabled by default.

Returns:

true to allow updates from the shadow, false otherwise.

Default:

true