com.google.api.server.spi.config

Annotation Type ApiResourceProperty

@Retention(value=RUNTIME)
public @interface ApiResourceProperty

Annotation for configuring bean properties for API resources.

This annotation can be used on all parts of the definition of a property: the field, the accessor (getter), or the mutator (setter). However, it should only be used on one of the three; behavior for multiple annotations on one property is not defined.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	description The description that the property represented by the annotated getter, setter, or field should appear as in the API.
AnnotationBoolean	ignored Whether or not the property represented by the annotated getter, setter or field should be ignored for the API.
java.lang.String	name The name that the property represented by the annotated getter, setter, or field should appear as in the API.

Element Detail

name

public abstract java.lang.String name

The name that the property represented by the annotated getter, setter, or field should appear as in the API.

Default:

""

description

public abstract java.lang.String description

The description that the property represented by the annotated getter, setter, or field should appear as in the API.

Default:

""

ignored

public abstract AnnotationBoolean ignored

Whether or not the property represented by the annotated getter, setter or field should be ignored for the API.

Default:

com.google.api.server.spi.config.AnnotationBoolean.UNSPECIFIED