@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface ApiMethod
Modifier and Type | Optional Element and Description |
---|---|
java.lang.String[] |
audiences
Audience for IdTokens.
|
AuthLevel |
authLevel
Set frontend auth level.
|
ApiMethodCacheControl |
cacheControl
Cache-Control header settings for this method.
|
java.lang.String[] |
clientIds
Client IDs allowed to call this method.
|
java.lang.String |
httpMethod
The HTTP method to use to access this method.
|
java.lang.String |
name
The name for this method in the .api file.
|
java.lang.String |
path
The URI path to use to access this method.
|
java.lang.String[] |
scopes
OAuth 2 scopes, one of which is required for calling this method.
|
public abstract java.lang.String name
"<apiname>."
to create a unique name for the method.
If not set the method name will be derived from the Java method name.public abstract java.lang.String path
public abstract java.lang.String httpMethod
public abstract ApiMethodCacheControl cacheControl
ApiMethodCacheControl
for details.public abstract AuthLevel authLevel
public abstract java.lang.String[] scopes
public abstract java.lang.String[] audiences
public abstract java.lang.String[] clientIds