com.google.api.server.spi.config.model

Enum EndpointsFlag

java.lang.Object

java.lang.Enum<EndpointsFlag>

com.google.api.server.spi.config.model.EndpointsFlag

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EndpointsFlag>

public enum EndpointsFlag
extends java.lang.Enum<EndpointsFlag>

These flags control various Endpoints behavior.

To set one of these enum flags, you can either:

• Set system property systemPropertyName (defined as "endpoints." + systemPropertySuffix) to any value except a false-y one
• Set env variable envVarName (defined as "ENDPOINTS_" + name()) to any value except a falsy one

Notes:

• System properties are evaluated before env variables.
• falsy is defined as a case-insensitive equality with "false".

Enum Constant Summary

Enum Constants

Enum Constant and Description
JSON_USE_JACKSON_ANNOTATIONS When enabled, allows use of Jackson serialization annotations.
MAP_SCHEMA_FORCE_JSON_MAP_SCHEMA Enables the previous behavior of Cloud Endpoints, using untyped "JsonMap" for all Map types.
MAP_SCHEMA_IGNORE_UNSUPPORTED_KEY_TYPES When enabled, schema generation will not throw an error when handling Map types with keys that are not serializable from / to string (previous Cloud Endpoints behavior).
MAP_SCHEMA_SUPPORT_ARRAYS_VALUES Array values in "additionalProperties" are supported by the API Explorer, but not by the Java client generation.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	envVarName
java.lang.String	systemPropertyName

Method Summary

Modifier and Type	Method and Description
boolean	isEnabled()
static EndpointsFlag	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EndpointsFlag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MAP_SCHEMA_FORCE_JSON_MAP_SCHEMA

public static final EndpointsFlag MAP_SCHEMA_FORCE_JSON_MAP_SCHEMA

Enables the previous behavior of Cloud Endpoints, using untyped "JsonMap" for all Map types. By default, schema generation uses "additionalProperties" in JsonSchema to describe Map types (both for Discovery and OpenAPI), with a proper description of the value types. Defaults to false.

MAP_SCHEMA_IGNORE_UNSUPPORTED_KEY_TYPES

public static final EndpointsFlag MAP_SCHEMA_IGNORE_UNSUPPORTED_KEY_TYPES

When enabled, schema generation will not throw an error when handling Map types with keys that are not serializable from / to string (previous Cloud Endpoints behavior). It will still probably generate an error when serializing / deserializing these types at runtime. MAP_SCHEMA_FORCE_JSON_MAP_SCHEMA must be disabled for this to take effect. Defaults to false.

MAP_SCHEMA_SUPPORT_ARRAYS_VALUES

public static final EndpointsFlag MAP_SCHEMA_SUPPORT_ARRAYS_VALUES

Array values in "additionalProperties" are supported by the API Explorer, but not by the Java client generation. This flag can be enabled when deploying an API to the server, but should always be disabled when generating Java clients. MAP_SCHEMA_FORCE_JSON_MAP_SCHEMA must be disabled for this to take effect. Defaults to false.

JSON_USE_JACKSON_ANNOTATIONS

public static final EndpointsFlag JSON_USE_JACKSON_ANNOTATIONS

When enabled, allows use of Jackson serialization annotations. Previously, the Jackson annotation introspector was unused because Jackson was a vendored dependency. Now that Jackson is an explicit dependency, this can cause conflict with apps that use Jackson annotations for reasons outside of using this framework. Defaults to true.

Field Detail

envVarName

public java.lang.String envVarName

systemPropertyName

public java.lang.String systemPropertyName

Method Detail

values

public static EndpointsFlag[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EndpointsFlag c : EndpointsFlag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EndpointsFlag valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isEnabled

public boolean isEnabled()