Package com.google.cloud.firestore

Class FieldMask

java.lang.Object

com.google.cloud.firestore.FieldMask

public final class FieldMask
extends Object

A FieldMask can be used to limit the number of fields returned by a `getAll()` call.

Method Summary

Modifier and Type	Method	Description
static FieldMask	of(FieldPath... fieldPaths)	Creates a FieldMask from the provided field paths.
static FieldMask	of(String... fieldPaths)	Creates a FieldMask from the provided field paths.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

of

@Nonnull
public static FieldMask of(String... fieldPaths)

Creates a FieldMask from the provided field paths.

Parameters:

fieldPaths - A list of field paths.

Returns:

A FieldMask that describes a subset of fields.

of

@Nonnull
public static FieldMask of(FieldPath... fieldPaths)

Creates a FieldMask from the provided field paths.

Parameters:

fieldPaths - A list of field paths.

Returns:

A FieldMask that describes a subset of fields.