Interface DocumentMaskOrBuilder (3.28.0)

Version latest

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public interface DocumentMaskOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFieldPaths(int index)

public abstract String getFieldPaths(int index)

The list of field paths in the mask. See Document.fields for a field path syntax reference.

repeated string field_paths = 1;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The fieldPaths at the given index.

getFieldPathsBytes(int index)

public abstract ByteString getFieldPathsBytes(int index)

The list of field paths in the mask. See Document.fields for a field path syntax reference.

repeated string field_paths = 1;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the fieldPaths at the given index.

getFieldPathsCount()

public abstract int getFieldPathsCount()

The list of field paths in the mask. See Document.fields for a field path syntax reference.

repeated string field_paths = 1;

Returns
Type	Description
int	The count of fieldPaths.

getFieldPathsList()

public abstract List<String> getFieldPathsList()

The list of field paths in the mask. See Document.fields for a field path syntax reference.

repeated string field_paths = 1;

Returns
Type	Description
List<String>	A list containing the fieldPaths.