COSMOS ${releaseVersion} data-collection Project
Public API Specification

org.eclipse.cosmos.dc.mgmt.annotations
Annotation Type ManagedProperty


@Target(value=FIELD)
@Retention(value=RUNTIME)
public @interface ManagedProperty

Annotation used to indicate a manageable property. The class is expected to provide a get (and optionally a set) method for the property. The default behavior is to look for getXXX and setXXX, where XXX is the name of the property. If no getXXX is found, isXXX may be used as a substitute.


Optional Element Summary
 java.lang.String description
          A text description of the capability.
 boolean isConfigurationProperty
          If true, the resource will be exposed as part of a Configuration capability and be visible through introspection using that capability.
 java.lang.String namespace
          The namespace to be used for the property.
 boolean resourceID
          If true, the property will be used to supply a unique resource identifier for the resource.
 

description

public abstract java.lang.String description
A text description of the capability. This attribute is intended for tooling support.

Default:
""

namespace

public abstract java.lang.String namespace
The namespace to be used for the property. If no namespace is provided, the namespace of ManagedResource annotation will be used.

Default:
""

resourceID

public abstract boolean resourceID
If true, the property will be used to supply a unique resource identifier for the resource. The class is checked to ensure that this is a read-only property, as the resource id must be constant for the life of the resource.

Default:
false

isConfigurationProperty

public abstract boolean isConfigurationProperty
If true, the resource will be exposed as part of a Configuration capability and be visible through introspection using that capability.

Default:
false

COSMOS ${releaseVersion} data-collection Project
Public API Specification