Send feedback
Class DocumentMask (3.4.2)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.4.2 keyboard_arrow_down
public final class DocumentMask extends GeneratedMessageV3 implements DocumentMaskOrBuilder
A set of field paths on a document.
Used to restrict a get or update operation on a document to a subset of its
fields.
This is different from standard field masks, as this is always scoped to a
Document , and takes in account the dynamic nature of Value .
Protobuf type google.firestore.v1.DocumentMask
Static Fields
FIELD_PATHS_FIELD_NUMBER
public static final int FIELD_PATHS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DocumentMask getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static DocumentMask . Builder newBuilder ()
Returns
newBuilder(DocumentMask prototype)
public static DocumentMask . Builder newBuilder ( DocumentMask prototype )
Parameter
Returns
public static DocumentMask parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static DocumentMask parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DocumentMask parseFrom ( byte [] data )
Parameter
Name Description data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentMask parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DocumentMask parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentMask parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static DocumentMask parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static DocumentMask parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static DocumentMask parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static DocumentMask parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DocumentMask parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentMask parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<DocumentMask> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public DocumentMask getDefaultInstanceForType ()
Returns
getFieldPaths(int index)
public 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 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 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 ProtocolStringList getFieldPathsList ()
The list of field paths in the mask. See Document.fields for a field
path syntax reference.
repeated string field_paths = 1;
Returns
getParserForType()
public Parser<DocumentMask> getParserForType ()
Returns
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public DocumentMask . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentMask . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public DocumentMask . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]
