@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface Api
Modifier and Type | Optional Element and Description |
---|---|
java.lang.String[] |
audiences
Audience for IdTokens, applicable to all methods of the API unless overridden by
@ApiClass#audiences or @ApiMethod#audiences . |
ApiAuth |
auth
Configures authentication information.
|
AuthLevel |
authLevel
Set frontend auth level, applicable to all methods of the API unless overridden by
@ApiClass#authLevel or @ApiMethod#authLevel . |
java.lang.String |
backendRoot
Backend root URL, e.g.
|
ApiCacheControl |
cacheControl
Configures the Cache-Control header in the response.
|
java.lang.String |
canonicalName
Optional name, which indicates how an API name should be split into parts.
|
java.lang.String[] |
clientIds
Client IDs allowed to call this method, applicable to all methods of the API unless overridden
by
@ApiClass#clientIds or @ApiMethod#clientIds . |
AnnotationBoolean |
defaultVersion
Marks this version of an API as the default version to use when a JSON-RPC call is executed
against the API.
|
java.lang.String |
description
Description of this API.
|
java.lang.String |
documentationLink
A link to human readable documentation for the API.
|
ApiFrontendLimits |
frontendLimits
Configures quota enforcement.
|
AnnotationBoolean |
isAbstract
true if this API configuration is used as the base for another. |
java.lang.String |
name
Name of the API, e.g.
|
ApiNamespace |
namespace
Configures namespacing for generated clients.
|
java.lang.String |
resource
The name (in plural) of the resource collection.
|
java.lang.String |
root
Frontend root URL, e.g.
|
java.lang.String[] |
scopes
OAuth 2 scopes, one of which is required for calling this method, applicable to all methods
of the API unless overridden by
@ApiClass#scopes or @ApiMethod#scopes . |
java.lang.String |
title
The title of an API.
|
java.lang.Class<? extends Transformer<?,?>>[] |
transformers
Custom transformers to be used for this API.
|
AnnotationBoolean |
useDatastoreForAdditionalConfig
AnnotationBoolean.TRUE to request that overriding configuration be loaded from the
appengine datastore for all API classes except for those classes that override using
@ApiClass#useDatastoreForAdditionalConfig . |
java.lang.String |
version
Version of the API, e.g.
|
public abstract java.lang.String root
public abstract java.lang.String name
public abstract java.lang.String canonicalName
public abstract java.lang.String version
public abstract java.lang.String title
public abstract java.lang.String description
public abstract java.lang.String documentationLink
public abstract java.lang.String backendRoot
public abstract ApiAuth auth
ApiAuth
for details.public abstract ApiFrontendLimits frontendLimits
ApiFrontendLimits
for details.public abstract ApiCacheControl cacheControl
ApiCacheControl
for details.public abstract AuthLevel authLevel
@ApiClass#authLevel
or @ApiMethod#authLevel
.public abstract java.lang.String[] scopes
@ApiClass#scopes
or @ApiMethod#scopes
.public abstract java.lang.String[] audiences
@ApiClass#audiences
or @ApiMethod#audiences
.public abstract java.lang.String[] clientIds
@ApiClass#clientIds
or @ApiMethod#clientIds
.public abstract AnnotationBoolean isAbstract
true
if this API configuration is used as the base for another. Should be
false
for most situations.public abstract AnnotationBoolean defaultVersion
public abstract java.lang.String resource
public abstract java.lang.Class<? extends Transformer<?,?>>[] transformers
public abstract AnnotationBoolean useDatastoreForAdditionalConfig
AnnotationBoolean.TRUE
to request that overriding configuration be loaded from the
appengine datastore for all API classes except for those classes that override using
@ApiClass#useDatastoreForAdditionalConfig
.public abstract ApiNamespace namespace
ApiNamespace
for details.