IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

PropertyName

@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = [ElementType.METHOD, ElementType.FIELD])
public annotation PropertyName

Marks a field to be renamed when serialized.

Kotlin Note

When applying this annotation to a property of a Kotlin class, both the @get and @set use-site targets should be used.

Here is an example of a class that can both be written into and read from Firestore whose foo property will be stored into and read from a field named my_foo in the Firestore document:

data class Pojo(@get:PropertyName("my_foo") @set:PropertyName("my_foo") var foo: String? = null) {
  constructor() : this(null) // Used by Firestore to create new instances
}

If the class only needs to be written into Firestore (and not read from Firestore) then the class can be simplified as follows:

data class Pojo(@get:PropertyName("my_foo") val foo: String? = null)

That is, var can be tightened to val, the secondary no-argument constructor can be omitted, and the @set use-site target can be omitted.

Summary

Public methods
`abstract String`	`value()`

Public methods

value

public abstract String value()