com.google.firestore.v1

Class DocumentMask

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1.DocumentMask

All Implemented Interfaces:

DocumentMaskOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class DocumentMask
extends com.google.protobuf.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.v1.Document], and takes in account the dynamic
 nature of [Value][google.firestore.v1.Value].
 

Protobuf type google.firestore.v1.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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

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(Object obj)
static DocumentMask	getDefaultInstance()
DocumentMask	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFieldPaths(int index) The list of field paths in the mask.
com.google.protobuf.ByteString	getFieldPathsBytes(int index) The list of field paths in the mask.
int	getFieldPathsCount() The list of field paths in the mask.
com.google.protobuf.ProtocolStringList	getFieldPathsList() The list of field paths in the mask.
com.google.protobuf.Parser<DocumentMask>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DocumentMask.Builder	newBuilder()
static DocumentMask.Builder	newBuilder(DocumentMask prototype)
DocumentMask.Builder	newBuilderForType()
protected DocumentMask.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DocumentMask	parseDelimitedFrom(InputStream input)
static DocumentMask	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentMask	parseFrom(byte[] data)
static DocumentMask	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentMask	parseFrom(ByteBuffer data)
static DocumentMask	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentMask	parseFrom(com.google.protobuf.ByteString data)
static DocumentMask	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentMask	parseFrom(com.google.protobuf.CodedInputStream input)
static DocumentMask	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentMask	parseFrom(InputStream input)
static DocumentMask	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DocumentMask>	parser()
DocumentMask.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getFieldPathsList

public com.google.protobuf.ProtocolStringList getFieldPathsList()

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

repeated string field_paths = 1;

Specified by:

getFieldPathsList in interface DocumentMaskOrBuilder

Returns:

A list containing the fieldPaths.

getFieldPathsCount

public int getFieldPathsCount()

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

repeated string field_paths = 1;

Specified by:

getFieldPathsCount in interface DocumentMaskOrBuilder

Returns:

The count of fieldPaths.

getFieldPaths

public String getFieldPaths(int index)

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

repeated string field_paths = 1;

Specified by:

getFieldPaths in interface DocumentMaskOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The fieldPaths at the given index.

getFieldPathsBytes

public com.google.protobuf.ByteString getFieldPathsBytes(int index)

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

repeated string field_paths = 1;

Specified by:

getFieldPathsBytes in interface DocumentMaskOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the fieldPaths at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DocumentMask parseFrom(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentMask parseFrom(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentMask parseFrom(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentMask parseFrom(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentMask parseFrom(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentMask parseFrom(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentMask parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static DocumentMask parseFrom(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static DocumentMask parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static DocumentMask parseDelimitedFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseFrom

public static DocumentMask parseFrom(com.google.protobuf.CodedInputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static DocumentMask parseFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

newBuilderForType

public DocumentMask.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.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 com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DocumentMask.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DocumentMask getDefaultInstance()

parser

public static com.google.protobuf.Parser<DocumentMask> parser()

getParserForType

public com.google.protobuf.Parser<DocumentMask> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public DocumentMask getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder