Firestore v1 API - Class Write (3.5.0)

public sealed class Write : IMessage<Write>, IEquatable<Write>, IDeepCloneable<Write>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class Write.

A write on a document.

Inheritance

object > Write

Implements

IMessage Write, IEquatable Write, IDeepCloneable Write, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

Write()

public Write()

Write(Write)

public Write(Write other)

Parameter
Name	Description
`other`	`Write`

Properties

CurrentDocument

public Precondition CurrentDocument { get; set; }

An optional precondition on the document.

The write will fail if this is set and not met by the target document.

Property Value
Type	Description
`Precondition`

Delete

public string Delete { get; set; }

A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Property Value
Type	Description
`string`

HasDelete

public bool HasDelete { get; }

Gets whether the "delete" field is set

Property Value
Type	Description
`bool`

OperationCase

public Write.OperationOneofCase OperationCase { get; }

Property Value
Type	Description
`WriteOperationOneofCase`

Transform

public DocumentTransform Transform { get; set; }

Applies a transformation to a document.

Property Value
Type	Description
`DocumentTransform`

Update

public Document Update { get; set; }

A document to write.

Property Value
Type	Description
`Document`

UpdateMask

public DocumentMask UpdateMask { get; set; }

The fields to update in this write.

This field can be set only when the operation is update. If the mask is not set for an update and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name.

Property Value
Type	Description
`DocumentMask`

UpdateTransforms

public RepeatedField<DocumentTransform.Types.FieldTransform> UpdateTransforms { get; }

The transforms to perform after update.

This field can be set only when the operation is update. If present, this write is equivalent to performing update and transform to the same document atomically and in order.

Property Value
Type	Description
`RepeatedFieldDocumentTransformTypesFieldTransform`