com.google.firestore.v1beta1

Class DocumentMask

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1beta1.DocumentMask

All Implemented Interfaces:

DocumentMaskOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

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][google.firestore.v1beta1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1beta1.Value].
 

Protobuf type google.firestore.v1beta1.DocumentMask

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentMask.Builder A set of field paths on a document.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIELD_PATHS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static DocumentMask	getDefaultInstance()
DocumentMask	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
java.lang.String	getFieldPaths(int index) The list of field paths in the mask.
ByteString	getFieldPathsBytes(int index) The list of field paths in the mask.
int	getFieldPathsCount() The list of field paths in the mask.
ProtocolStringList	getFieldPathsList() The list of field paths in the mask.
Parser<DocumentMask>	getParserForType()
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DocumentMask.Builder	newBuilder()
static DocumentMask.Builder	newBuilder(DocumentMask prototype)
DocumentMask.Builder	newBuilderForType()
protected DocumentMask.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static DocumentMask	parseDelimitedFrom(java.io.InputStream input)
static DocumentMask	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static DocumentMask	parseFrom(byte[] data)
static DocumentMask	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static DocumentMask	parseFrom(java.nio.ByteBuffer data)
static DocumentMask	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static DocumentMask	parseFrom(ByteString data)
static DocumentMask	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static DocumentMask	parseFrom(CodedInputStream input)
static DocumentMask	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static DocumentMask	parseFrom(java.io.InputStream input)
static DocumentMask	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<DocumentMask>	parser()
DocumentMask.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FIELD_PATHS_FIELD_NUMBER

public static final int FIELD_PATHS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getFieldPathsList

public ProtocolStringList getFieldPathsList()

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

Specified by:

getFieldPathsList in interface DocumentMaskOrBuilder

getFieldPathsCount

public int getFieldPathsCount()

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

Specified by:

getFieldPathsCount in interface DocumentMaskOrBuilder

getFieldPaths

public java.lang.String getFieldPaths(int index)

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

Specified by:

getFieldPaths in interface DocumentMaskOrBuilder

getFieldPathsBytes

public ByteString getFieldPathsBytes(int index)

 The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
 path syntax reference.
 

repeated string field_paths = 1;

Specified by:

getFieldPathsBytes in interface DocumentMaskOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static DocumentMask parseFrom(java.nio.ByteBuffer data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DocumentMask parseFrom(java.nio.ByteBuffer data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DocumentMask parseFrom(ByteString data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DocumentMask parseFrom(ByteString data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DocumentMask parseFrom(byte[] data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DocumentMask parseFrom(byte[] data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DocumentMask parseFrom(java.io.InputStream input)
                              throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static DocumentMask parseFrom(java.io.InputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static DocumentMask parseDelimitedFrom(java.io.InputStream input)
                                       throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static DocumentMask parseDelimitedFrom(java.io.InputStream input,
                                              ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static DocumentMask parseFrom(CodedInputStream input)
                              throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static DocumentMask parseFrom(CodedInputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public DocumentMask.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static DocumentMask.Builder newBuilder()

newBuilder

public static DocumentMask.Builder newBuilder(DocumentMask prototype)

toBuilder

public DocumentMask.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected DocumentMask.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static DocumentMask getDefaultInstance()

parser

public static Parser<DocumentMask> parser()

getParserForType

public Parser<DocumentMask> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public DocumentMask getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder