Class Write

A write on a document.

Inheritance

object

Write

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Firestore.v1.Data

Assembly: Google.Apis.Firestore.v1.dll

Syntax

public class Write : IDirectResponseSchema

Properties

CurrentDocument

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

Declaration

[JsonProperty("currentDocument")]
public virtual Precondition CurrentDocument { get; set; }

Property Value

Type	Description
Precondition

Delete

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

Declaration

[JsonProperty("delete")]
public virtual string Delete { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Transform

Applies a transformation to a document.

Declaration

[JsonProperty("transform")]
public virtual DocumentTransform Transform { get; set; }

Property Value

Type	Description
DocumentTransform

Update

A document to write.

Declaration

[JsonProperty("update")]
public virtual Document Update { get; set; }

Property Value

Type	Description
Document

UpdateMask

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.

Declaration

[JsonProperty("updateMask")]
public virtual DocumentMask UpdateMask { get; set; }

Property Value

Type	Description
DocumentMask

UpdateTransforms

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.

Declaration

[JsonProperty("updateTransforms")]
public virtual IList<FieldTransform> UpdateTransforms { get; set; }

Property Value

Type	Description
IList<FieldTransform>

Implements

IDirectResponseSchema