com.google.api.services.appengine.v1.model

Class ApiConfigHandler

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.appengine.v1.model.ApiConfigHandler

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ApiConfigHandler
extends com.google.api.client.json.GenericJson

Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the App Engine Admin API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ApiConfigHandler()

Method Summary

Modifier and Type	Method and Description
ApiConfigHandler	clone()
String	getAuthFailAction() Action to take when users access resources that require authentication.
String	getLogin() Level of login required to access this resource.
String	getScript() Path to the script from the application root directory.
String	getSecurityLevel() Security (HTTPS) enforcement for this URL.
String	getUrl() URL to serve the endpoint at.
ApiConfigHandler	set(String fieldName, Object value)
ApiConfigHandler	setAuthFailAction(String authFailAction) Action to take when users access resources that require authentication.
ApiConfigHandler	setLogin(String login) Level of login required to access this resource.
ApiConfigHandler	setScript(String script) Path to the script from the application root directory.
ApiConfigHandler	setSecurityLevel(String securityLevel) Security (HTTPS) enforcement for this URL.
ApiConfigHandler	setUrl(String url) URL to serve the endpoint at.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ApiConfigHandler

public ApiConfigHandler()

Method Detail

getAuthFailAction

public String getAuthFailAction()

Action to take when users access resources that require authentication. Defaults to redirect.

Returns:

value or null for none

setAuthFailAction

public ApiConfigHandler setAuthFailAction(String authFailAction)

Action to take when users access resources that require authentication. Defaults to redirect.

Parameters:

authFailAction - authFailAction or null for none

getLogin

public String getLogin()

Level of login required to access this resource. Defaults to optional.

Returns:

value or null for none

setLogin

public ApiConfigHandler setLogin(String login)

Level of login required to access this resource. Defaults to optional.

Parameters:

login - login or null for none

getScript

public String getScript()

Path to the script from the application root directory.

Returns:

value or null for none

setScript

public ApiConfigHandler setScript(String script)

Path to the script from the application root directory.

Parameters:

script - script or null for none

getSecurityLevel

public String getSecurityLevel()

Security (HTTPS) enforcement for this URL.

Returns:

value or null for none

setSecurityLevel

public ApiConfigHandler setSecurityLevel(String securityLevel)

Security (HTTPS) enforcement for this URL.

Parameters:

securityLevel - securityLevel or null for none

getUrl

public String getUrl()

URL to serve the endpoint at.

Returns:

value or null for none

setUrl

public ApiConfigHandler setUrl(String url)

URL to serve the endpoint at.

Parameters:

url - url or null for none

set

public ApiConfigHandler set(String fieldName,
                            Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ApiConfigHandler clone()

Overrides:

clone in class com.google.api.client.json.GenericJson