Uses of Class
org.jooq.JSON

Packages that use JSON

Package	Description
org.jooq	This package contains jOOQ's public API.
org.jooq.impl	This package contains jOOQ's implementation classes.
org.jooq.util.access	This package contains classes related to the SQLDialect.ACCESS dialect family.
org.jooq.util.ase	This package contains classes related to the SQLDialect.ASE dialect family.
org.jooq.util.cockroachdb	This package contains classes related to the SQLDialect.COCKROACHDB dialect family.
org.jooq.util.db2	This package contains classes related to the SQLDialect.DB2 dialect family.
org.jooq.util.derby	This package contains classes related to the SQLDialect.DERBY dialect family.
org.jooq.util.exasol	This package contains classes related to the SQLDialect.EXASOL dialect family.
org.jooq.util.firebird	This package contains classes related to the SQLDialect.FIREBIRD dialect family.
org.jooq.util.h2	This package contains classes related to the SQLDialect.H2 dialect family.
org.jooq.util.hana	This package contains classes related to the SQLDialect.HANA dialect family.
org.jooq.util.hsqldb	This package contains classes related to the SQLDialect.HSQLDB dialect family.
org.jooq.util.informix	This package contains classes related to the SQLDialect.INFORMIX dialect family.
org.jooq.util.ingres	This package contains classes related to the SQLDialect.INGRES dialect family.
org.jooq.util.mariadb	This package contains classes related to the SQLDialect.MARIADB dialect family.
org.jooq.util.memsql	This package contains classes related to the SQLDialect.MEMSQL dialect family.
org.jooq.util.mysql	This package contains classes related to the SQLDialect.MYSQL dialect family.
org.jooq.util.oracle	This package contains classes related to the SQLDialect.ORACLE dialect family.
org.jooq.util.postgres	This package contains classes related to the SQLDialect.POSTGRES dialect family.
org.jooq.util.snowflake	This package contains classes related to the SQLDialect.SNOWFLAKE dialect family.
org.jooq.util.sqlite	This package contains classes related to the SQLDialect.SQLITE dialect family.
org.jooq.util.sybase	This package contains classes related to the SQLDialect.SYBASE dialect family.
org.jooq.util.teradata	This package contains classes related to the SQLDialect.TERADATA dialect family.
org.jooq.util.vertica	This package contains classes related to the SQLDialect.VERTICA dialect family.
org.jooq.util.yugabytedb	This package contains classes related to the SQLDialect.YUGABYTEDB dialect family.

Uses of JSON in org.jooq

Methods in org.jooq that return JSON

Modifier and Type	Method	Description
static final @NotNull JSON	JSON.json(String data)	Create a new JSON instance from string data input.
static final @Nullable JSON	JSON.jsonOrNull(String data)	Create a new JSON instance from string data input, or null if the input is null.
static final @NotNull JSON	JSON.valueOf(String data)	Create a new JSON instance from string data input.

Methods in org.jooq that return types with arguments of type JSON

Modifier and Type	Method	Description
@NotNull SelectForJSONStep<Record1<JSON>>	SelectForStep.forJSON()	Add a SQL Server-style FOR JSON clause.

Uses of JSON in org.jooq.impl

Fields in org.jooq.impl with type parameters of type JSON

Modifier and Type	Field	Description
static final DataType<JSON>	SQLDataType.JSON	The JSON type.

Methods in org.jooq.impl that return types with arguments of type JSON

Modifier and Type	Method	Description
default @NotNull Field<JSON>	QOM.JSONArrayLength.$field()
default @NotNull Field<JSON>	QOM.JSONGetAttribute.$field()	The JSON document
default @NotNull Field<JSON>	QOM.JSONGetAttributeAsText.$field()	The JSON document
default @NotNull Field<JSON>	QOM.JSONGetElement.$field()	The JSON document
default @NotNull Field<JSON>	QOM.JSONGetElementAsText.$field()	The JSON document
default @NotNull Field<JSON>	QOM.JSONInsert.$field()
default @NotNull Field<JSON>	QOM.JSONKeys.$field()
default @NotNull Field<JSON>	QOM.JSONRemove.$field()
default @NotNull Field<JSON>	QOM.JSONReplace.$field()
default @NotNull Field<JSON>	QOM.JSONSet.$field()
default @NotNull Field<JSON>	QOM.JSONKeyExists.$json()	The JSON object
static @NotNull Param<JSON>	DSL.inline(JSON value)	Create a bind value that is always inlined.
static @NotNull JSONArrayNullStep<JSON>	DSL.jsonArray(Collection<? extends Field<?>> fields)	The JSON_ARRAY function.
static @NotNull JSONArrayNullStep<JSON>	DSL.jsonArray(Field<?>... fields)	The JSON_ARRAY function.
static @NotNull JSONArrayAggOrderByStep<JSON>	DSL.jsonArrayAgg(Field<?> value)	The JSON array aggregate function.
static @NotNull JSONArrayAggOrderByStep<JSON>	DSL.jsonArrayAggDistinct(Field<?> value)	The JSON array aggregate function.
static @NotNull Field<JSON>	DSL.jsonGetAttribute(Field<JSON> field, String attribute)	The JSON_GET_ATTRIBUTE function.
static @NotNull Field<JSON>	DSL.jsonGetAttribute(Field<JSON> field, Field<String> attribute)	The JSON_GET_ATTRIBUTE function.
static @NotNull Field<JSON>	DSL.jsonGetAttribute(JSON field, String attribute)	The JSON_GET_ATTRIBUTE function.
static @NotNull Field<JSON>	DSL.jsonGetAttribute(JSON field, Field<String> attribute)	The JSON_GET_ATTRIBUTE function.
static @NotNull Field<JSON>	DSL.jsonGetElement(Field<JSON> field, int index)	The JSON_GET_ELEMENT function.
static @NotNull Field<JSON>	DSL.jsonGetElement(Field<JSON> field, Field<Integer> index)	The JSON_GET_ELEMENT function.
static @NotNull Field<JSON>	DSL.jsonGetElement(JSON field, int index)	The JSON_GET_ELEMENT function.
static @NotNull Field<JSON>	DSL.jsonGetElement(JSON field, Field<Integer> index)	The JSON_GET_ELEMENT function.
static @NotNull Field<JSON>	DSL.jsonInsert(Field<JSON> field, String path, Object value)	The JSON_INSERT function.
static @NotNull Field<JSON>	DSL.jsonInsert(Field<JSON> field, String path, Field<?> value)	The JSON_INSERT function.
static @NotNull Field<JSON>	DSL.jsonInsert(Field<JSON> field, Field<String> path, Object value)	The JSON_INSERT function.
static @NotNull Field<JSON>	DSL.jsonInsert(Field<JSON> field, Field<String> path, Field<?> value)	The JSON_INSERT function.
static @NotNull Field<JSON>	DSL.jsonKeys(Field<JSON> field)	The JSON_KEYS function.
static @NotNull Field<JSON>	DSL.jsonKeys(JSON field)	The JSON_KEYS function.
static @NotNull JSONObjectNullStep<JSON>	DSL.jsonObject()	The JSON object constructor.
static @NotNull JSONObjectNullStep<JSON>	DSL.jsonObject(String key, Field<?> value)	The JSON object constructor.
static @NotNull JSONObjectNullStep<JSON>	DSL.jsonObject(Collection<? extends JSONEntry<?>> entries)	The JSON_OBJECT function.
static @NotNull JSONObjectNullStep<JSON>	DSL.jsonObject(Field<?>... entries)	Deprecated, for removal: This API element is subject to removal in a future version. - [#15196] - 3.19.0 - The semantics of the Field arguments in this method is inconsistent with that of other overloads, such as DSL.jsonbObject(Field, Field), which can lead to subtle bugs.
static @NotNull JSONObjectNullStep<JSON>	DSL.jsonObject(Field<String> key, Field<?> value)	The JSON object constructor.
static @NotNull JSONObjectNullStep<JSON>	DSL.jsonObject(Field<String> key, Select<? extends Record1<?>> value)	The JSON object constructor.
static @NotNull JSONObjectNullStep<JSON>	DSL.jsonObject(JSONEntry<?>... entries)	The JSON_OBJECT function.
static @NotNull JSONObjectAggNullStep<JSON>	DSL.jsonObjectAgg(String key, Field<?> value)	The JSON object aggregate function.
static @NotNull JSONObjectAggNullStep<JSON>	DSL.jsonObjectAgg(Field<?> value)	The JSON object aggregate function.
static @NotNull JSONObjectAggNullStep<JSON>	DSL.jsonObjectAgg(Field<String> key, Field<?> value)	The JSON object aggregate function.
static @NotNull JSONObjectAggNullStep<JSON>	DSL.jsonObjectAgg(JSONEntry<?> entry)	The JSON object aggregate function.
static @NotNull Field<JSON>	DSL.jsonRemove(Field<JSON> field, String path)	The JSON_REMOVE function.
static @NotNull Field<JSON>	DSL.jsonRemove(Field<JSON> field, Field<String> path)	The JSON_REMOVE function.
static @NotNull Field<JSON>	DSL.jsonReplace(Field<JSON> field, String path, Object value)	The JSON_REPLACE function.
static @NotNull Field<JSON>	DSL.jsonReplace(Field<JSON> field, String path, Field<?> value)	The JSON_REPLACE function.
static @NotNull Field<JSON>	DSL.jsonReplace(Field<JSON> field, Field<String> path, Object value)	The JSON_REPLACE function.
static @NotNull Field<JSON>	DSL.jsonReplace(Field<JSON> field, Field<String> path, Field<?> value)	The JSON_REPLACE function.
static @NotNull Field<JSON>	DSL.jsonSet(Field<JSON> field, String path, Object value)	The JSON_SET function.
static @NotNull Field<JSON>	DSL.jsonSet(Field<JSON> field, String path, Field<?> value)	The JSON_SET function.
static @NotNull Field<JSON>	DSL.jsonSet(Field<JSON> field, Field<String> path, Object value)	The JSON_SET function.
static @NotNull Field<JSON>	DSL.jsonSet(Field<JSON> field, Field<String> path, Field<?> value)	The JSON_SET function.
static @NotNull JSONValueOnStep<JSON>	DSL.jsonValue(Field<JSON> json, String path)	The JSON value extractor function.
static @NotNull JSONValueOnStep<JSON>	DSL.jsonValue(Field<JSON> json, Field<String> path)	The JSON value extractor function.
static @NotNull Param<JSON>	DSL.val(JSON value)	Get a bind value.
static @NotNull Param<JSON>	DSL.value(JSON value)	A synonym for DSL.val(JSON) to be used in Scala and Groovy, where val is a reserved keyword.

Methods in org.jooq.impl with parameters of type JSON

Modifier and Type	Method	Description
static @NotNull Param<JSON>	DSL.inline(JSON value)	Create a bind value that is always inlined.
static @NotNull Field<Integer>	DSL.jsonArrayLength(JSON field)	The JSON_ARRAY_LENGTH function.
static @NotNull Field<JSON>	DSL.jsonGetAttribute(JSON field, String attribute)	The JSON_GET_ATTRIBUTE function.
static @NotNull Field<JSON>	DSL.jsonGetAttribute(JSON field, Field<String> attribute)	The JSON_GET_ATTRIBUTE function.
static @NotNull Field<String>	DSL.jsonGetAttributeAsText(JSON field, String attribute)	The JSON_GET_ATTRIBUTE_AS_TEXT function.
static @NotNull Field<String>	DSL.jsonGetAttributeAsText(JSON field, Field<String> attribute)	The JSON_GET_ATTRIBUTE_AS_TEXT function.
static @NotNull Field<JSON>	DSL.jsonGetElement(JSON field, int index)	The JSON_GET_ELEMENT function.
static @NotNull Field<JSON>	DSL.jsonGetElement(JSON field, Field<Integer> index)	The JSON_GET_ELEMENT function.
static @NotNull Field<String>	DSL.jsonGetElementAsText(JSON field, int index)	The JSON_GET_ELEMENT_AS_TEXT function.
static @NotNull Field<String>	DSL.jsonGetElementAsText(JSON field, Field<Integer> index)	The JSON_GET_ELEMENT_AS_TEXT function.
static @NotNull Condition	DSL.jsonKeyExists(JSON json, String key)	The JSON_KEY_EXISTS function.
static @NotNull Condition	DSL.jsonKeyExists(JSON json, Field<String> key)	The JSON_KEY_EXISTS function.
static @NotNull Field<JSON>	DSL.jsonKeys(JSON field)	The JSON_KEYS function.
static @NotNull JSONTableColumnsFirstStep	DSL.jsonTable(JSON json, String path)	The JSON table function.
static @NotNull Param<JSON>	DSL.val(JSON value)	Get a bind value.
static @NotNull Param<JSON>	DSL.value(JSON value)	A synonym for DSL.val(JSON) to be used in Scala and Groovy, where val is a reserved keyword.

Method parameters in org.jooq.impl with type arguments of type JSON

Modifier and Type	Method	Description
default @NotNull QOM.JSONArrayLength	QOM.JSONArrayLength.$field(Field<JSON> newField)
default @NotNull QOM.JSONGetAttribute	QOM.JSONGetAttribute.$field(Field<JSON> newField)	The JSON document
default @NotNull QOM.JSONGetAttributeAsText	QOM.JSONGetAttributeAsText.$field(Field<JSON> newField)	The JSON document
default @NotNull QOM.JSONGetElement	QOM.JSONGetElement.$field(Field<JSON> newField)	The JSON document
default @NotNull QOM.JSONGetElementAsText	QOM.JSONGetElementAsText.$field(Field<JSON> newField)	The JSON document
default @NotNull QOM.JSONInsert	QOM.JSONInsert.$field(Field<JSON> newField)
default @NotNull QOM.JSONKeys	QOM.JSONKeys.$field(Field<JSON> newField)
default @NotNull QOM.JSONRemove	QOM.JSONRemove.$field(Field<JSON> newField)
default @NotNull QOM.JSONReplace	QOM.JSONReplace.$field(Field<JSON> newField)
default @NotNull QOM.JSONSet	QOM.JSONSet.$field(Field<JSON> newField)
default @NotNull QOM.JSONKeyExists	QOM.JSONKeyExists.$json(Field<JSON> newJson)	The JSON object
static @NotNull Field<Integer>	DSL.jsonArrayLength(Field<JSON> field)	The JSON_ARRAY_LENGTH function.
static @NotNull JSONExistsOnStep	DSL.jsonExists(Field<JSON> field, String path)	The JSON exists predicate.
static @NotNull JSONExistsOnStep	DSL.jsonExists(Field<JSON> field, Field<String> path)	The JSON exists predicate.
static @NotNull Field<JSON>	DSL.jsonGetAttribute(Field<JSON> field, String attribute)	The JSON_GET_ATTRIBUTE function.
static @NotNull Field<JSON>	DSL.jsonGetAttribute(Field<JSON> field, Field<String> attribute)	The JSON_GET_ATTRIBUTE function.
static @NotNull Field<String>	DSL.jsonGetAttributeAsText(Field<JSON> field, String attribute)	The JSON_GET_ATTRIBUTE_AS_TEXT function.
static @NotNull Field<String>	DSL.jsonGetAttributeAsText(Field<JSON> field, Field<String> attribute)	The JSON_GET_ATTRIBUTE_AS_TEXT function.
static @NotNull Field<JSON>	DSL.jsonGetElement(Field<JSON> field, int index)	The JSON_GET_ELEMENT function.
static @NotNull Field<JSON>	DSL.jsonGetElement(Field<JSON> field, Field<Integer> index)	The JSON_GET_ELEMENT function.
static @NotNull Field<String>	DSL.jsonGetElementAsText(Field<JSON> field, int index)	The JSON_GET_ELEMENT_AS_TEXT function.
static @NotNull Field<String>	DSL.jsonGetElementAsText(Field<JSON> field, Field<Integer> index)	The JSON_GET_ELEMENT_AS_TEXT function.
static @NotNull Field<JSON>	DSL.jsonInsert(Field<JSON> field, String path, Object value)	The JSON_INSERT function.
static @NotNull Field<JSON>	DSL.jsonInsert(Field<JSON> field, String path, Field<?> value)	The JSON_INSERT function.
static @NotNull Field<JSON>	DSL.jsonInsert(Field<JSON> field, Field<String> path, Object value)	The JSON_INSERT function.
static @NotNull Field<JSON>	DSL.jsonInsert(Field<JSON> field, Field<String> path, Field<?> value)	The JSON_INSERT function.
static @NotNull Condition	DSL.jsonKeyExists(Field<JSON> json, String key)	The JSON_KEY_EXISTS function.
static @NotNull Condition	DSL.jsonKeyExists(Field<JSON> json, Field<String> key)	The JSON_KEY_EXISTS function.
static @NotNull Field<JSON>	DSL.jsonKeys(Field<JSON> field)	The JSON_KEYS function.
static @NotNull Field<JSON>	DSL.jsonRemove(Field<JSON> field, String path)	The JSON_REMOVE function.
static @NotNull Field<JSON>	DSL.jsonRemove(Field<JSON> field, Field<String> path)	The JSON_REMOVE function.
static @NotNull Field<JSON>	DSL.jsonReplace(Field<JSON> field, String path, Object value)	The JSON_REPLACE function.
static @NotNull Field<JSON>	DSL.jsonReplace(Field<JSON> field, String path, Field<?> value)	The JSON_REPLACE function.
static @NotNull Field<JSON>	DSL.jsonReplace(Field<JSON> field, Field<String> path, Object value)	The JSON_REPLACE function.
static @NotNull Field<JSON>	DSL.jsonReplace(Field<JSON> field, Field<String> path, Field<?> value)	The JSON_REPLACE function.
static @NotNull Field<JSON>	DSL.jsonSet(Field<JSON> field, String path, Object value)	The JSON_SET function.
static @NotNull Field<JSON>	DSL.jsonSet(Field<JSON> field, String path, Field<?> value)	The JSON_SET function.
static @NotNull Field<JSON>	DSL.jsonSet(Field<JSON> field, Field<String> path, Object value)	The JSON_SET function.
static @NotNull Field<JSON>	DSL.jsonSet(Field<JSON> field, Field<String> path, Field<?> value)	The JSON_SET function.
static @NotNull JSONTableColumnsFirstStep	DSL.jsonTable(Field<JSON> json, Field<String> path)	The JSON table function.
static @NotNull JSONValueOnStep<JSON>	DSL.jsonValue(Field<JSON> json, String path)	The JSON value extractor function.
static @NotNull JSONValueOnStep<JSON>	DSL.jsonValue(Field<JSON> json, Field<String> path)	The JSON value extractor function.

Uses of JSON in org.jooq.util.access

Fields in org.jooq.util.access with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	AccessDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.ase

Fields in org.jooq.util.ase with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	ASEDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.cockroachdb

Fields in org.jooq.util.cockroachdb with type parameters of type JSON

Modifier and Type	Field	Description
static final DataType<JSON>	CockroachDBDataType.JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.db2

Fields in org.jooq.util.db2 with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	DB2DataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.derby

Fields in org.jooq.util.derby with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	DerbyDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.exasol

Fields in org.jooq.util.exasol with type parameters of type JSON

Modifier and Type	Field	Description
static final DataType<JSON>	ExasolDataType.JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.firebird

Fields in org.jooq.util.firebird with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	FirebirdDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.h2

Fields in org.jooq.util.h2 with type parameters of type JSON

Modifier and Type	Field	Description
static final DataType<JSON>	H2DataType.JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.hana

Fields in org.jooq.util.hana with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	HanaDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.hsqldb

Fields in org.jooq.util.hsqldb with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	HSQLDBDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.informix

Fields in org.jooq.util.informix with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	InformixDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.ingres

Fields in org.jooq.util.ingres with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	IngresDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.mariadb

Fields in org.jooq.util.mariadb with type parameters of type JSON

Modifier and Type	Field	Description
static final DataType<JSON>	MariaDBDataType.JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.memsql

Fields in org.jooq.util.memsql with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	MemSQLDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.mysql

Fields in org.jooq.util.mysql with type parameters of type JSON

Modifier and Type	Field	Description
static final DataType<JSON>	MySQLDataType.JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.oracle

Fields in org.jooq.util.oracle with type parameters of type JSON

Modifier and Type	Field	Description
static final DataType<JSON>	OracleDataType.JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.postgres

Fields in org.jooq.util.postgres with type parameters of type JSON

Modifier and Type	Field	Description
static final DataType<JSON>	PostgresDataType.JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.snowflake

Fields in org.jooq.util.snowflake with type parameters of type JSON

Modifier and Type	Field	Description
static final DataType<JSON>	SnowflakeDataType.ARRAY	Deprecated, for removal: This API element is subject to removal in a future version.
static final DataType<JSON>	SnowflakeDataType.OBJECT	Deprecated, for removal: This API element is subject to removal in a future version.
static final DataType<JSON>	SnowflakeDataType.VARIANT	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.sqlite

Fields in org.jooq.util.sqlite with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	SQLiteDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.sybase

Fields in org.jooq.util.sybase with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	SybaseDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.teradata

Fields in org.jooq.util.teradata with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	TeradataDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.vertica

Fields in org.jooq.util.vertica with type parameters of type JSON

Modifier and Type	Field	Description
protected static final DataType<JSON>	VerticaDataType.__JSON	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of JSON in org.jooq.util.yugabytedb

Fields in org.jooq.util.yugabytedb with type parameters of type JSON

Modifier and Type	Field	Description
static final DataType<JSON>	YugabyteDBDataType.JSON	Deprecated, for removal: This API element is subject to removal in a future version.