http4s-grpc-google-cloud-firestore-v1
3.21.3+0.0.6
API
Generated with
http4s-grpc-google-cloud-firestore-v1/com.google.firestore/com.google.firestore.v1/com.google.firestore.v1.common/DocumentMask

DocumentMask

com.google.firestore.v1.common.DocumentMask
See theDocumentMask companion object
final case class DocumentMask(fieldPaths: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[DocumentMask]

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].

Value parameters

fieldPaths

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

Attributes

Companion
object
Source
DocumentMask.scala
Graph
Supertypes
trait Updatable[DocumentMask]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addAllFieldPaths(`__vs`: Iterable[String]): DocumentMask

Attributes

Source
DocumentMask.scala
def addFieldPaths(`__vs`: String*): DocumentMask

Attributes

Source
DocumentMask.scala
def companion: DocumentMask.type

Attributes

Source
DocumentMask.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
DocumentMask.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
DocumentMask.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
DocumentMask.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
DocumentMask.scala
def withFieldPaths(`__v`: Seq[String]): DocumentMask

Attributes

Source
DocumentMask.scala
def withUnknownFields(`__v`: UnknownFieldSet): DocumentMask

Attributes

Source
DocumentMask.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
DocumentMask.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
def update(ms: (Lens[DocumentMask, DocumentMask]) => () => DocumentMask*): DocumentMask

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
Generated with