Stay organized with collections
Save and categorize content based on your preferences.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["\u003cp\u003e\u003ccode\u003e@ApiResourceProperty\u003c/code\u003e is an annotation used to configure bean properties for API resources.\u003c/p\u003e\n"],["\u003cp\u003eThis annotation can be applied to a field, getter, or setter, but only to one of these per property, with behavior undefined if multiple are used.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e element specifies the property's name in the API, defaulting to an empty string.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eignored\u003c/code\u003e element determines if a property should be omitted from the API, with \u003ccode\u003eUNSPECIFIED\u003c/code\u003e as the default.\u003c/p\u003e\n"]]],[],null,["# ApiResourceProperty\n\ncom.google.api.server.spi.config\n\nAnnotation Type ApiResourceProperty\n-----------------------------------\n\n-\n\n *** ** * ** ***\n\n \u003cbr /\u003e\n\n ```\n @Retention(value=RUNTIME)\n public @interface ApiResourceProperty\n ``` \n Annotation for configuring bean properties for API resources.\n\n\n This annotation can be used on all parts of the definition of a property: the field, the\n accessor (getter), or the mutator (setter). However, it should only be used on one of the three;\nbehavior for multiple annotations on one property is not defined. \n-\n -\n\n ### Optional Element Summary\n\n-\n -\n\n ### Element Detail\n\n\n -\n\n #### name\n\n ```\n public abstract java.lang.String name\n ``` \n The name that the property represented by the annotated getter, setter, or field should appear as in the API.\n\n Default:\n : \"\"\n\n \u003c!-- --\u003e\n\n -\n\n -\n\n #### ignored\n\n ```\n public abstract AnnotationBoolean ignored\n ``` \n Whether or not the property represented by the annotated getter, setter or field should be ignored for the API.\n\n Default:\n : com.google.api.server.spi.config.AnnotationBoolean.UNSPECIFIED"]]
