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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FIELD_PATHS_FIELD_NUMBER
public static final int FIELD_PATHS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static DocumentMask getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DocumentMask.Builder newBuilder()
newBuilder(DocumentMask prototype)
public static DocumentMask.Builder newBuilder(DocumentMask prototype)
public static DocumentMask parseDelimitedFrom(InputStream input)
public static DocumentMask parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DocumentMask parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentMask parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DocumentMask parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentMask parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentMask parseFrom(CodedInputStream input)
public static DocumentMask parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentMask parseFrom(InputStream input)
public static DocumentMask parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DocumentMask parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentMask parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DocumentMask> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public DocumentMask getDefaultInstanceForType()
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;
getParserForType()
public Parser<DocumentMask> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DocumentMask.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentMask.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public DocumentMask.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides