Class DocumentMask (0.15.0) 

public final class DocumentMask extends GeneratedMessageV3 implements DocumentMaskOrBuilder

A set of field paths on a document.

Protobuf type google.events.cloud.firestore.v1.DocumentMask

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentMask

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()
Returns
Type Description
DocumentMask

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DocumentMask.Builder newBuilder()
Returns
Type Description
DocumentMask.Builder

newBuilder(DocumentMask prototype)

public static DocumentMask.Builder newBuilder(DocumentMask prototype)
Parameter
Name Description
prototype DocumentMask
Returns
Type Description
DocumentMask.Builder

parseDelimitedFrom(InputStream input)

public static DocumentMask parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentMask
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentMask parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMask
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DocumentMask parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DocumentMask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentMask parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentMask parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DocumentMask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentMask parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentMask parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DocumentMask
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentMask parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMask
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DocumentMask parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentMask
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentMask parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMask
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DocumentMask parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DocumentMask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentMask parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMask
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DocumentMask> parser()
Returns
Type Description
Parser<DocumentMask>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DocumentMask getDefaultInstanceForType()
Returns
Type Description
DocumentMask

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
Type Description
ProtocolStringList

A list containing the fieldPaths.

getParserForType()

public Parser<DocumentMask> getParserForType()
Returns
Type Description
Parser<DocumentMask>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DocumentMask.Builder newBuilderForType()
Returns
Type Description
DocumentMask.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentMask.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DocumentMask.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DocumentMask.Builder toBuilder()
Returns
Type Description
DocumentMask.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException