Firestore API - Class SetOptions (3.5.1)
bookmark_border Stay organized with collections Save and categorize content based on your preferences.

public sealed class SetOptions

Reference documentation and code samples for the Firestore API class SetOptions.

Immutable class representing options for Set operations.

Inheritance

object > SetOptions

Google.Cloud.Firestore.dll

public IReadOnlyList<FieldPath> FieldMask { get; }

The fields to merge. This property is never null; if the mask is empty, all fields will be merged or overwritten.

Property Value
Type	Description
`IReadOnlyListFieldPath`

public bool Merge { get; }

Whether or not to merge values. If FieldMask is non-empty, this is always true.

Property Value
Type	Description
`bool`

public static SetOptions MergeAll { get; }

Returns an instance that merges all fields.

Property Value
Type	Description
`SetOptions`

public static SetOptions Overwrite { get; }

Returns an instance that overwrites the target object. This is the default when no options are provided.

Property Value
Type	Description
`SetOptions`

public static SetOptions MergeFields(params FieldPath[] fieldMask)

Returns an instance that merges the given fields.

Parameter
Name	Description
`fieldMask`	`FieldPath` The fields to merge. An empty array is equivalent to using MergeAll. Must not be null or contain any null elements.

Returns
Type	Description
`SetOptions`	An instance that merges the given fields.

public static SetOptions MergeFields(params string[] fieldMask)

Returns an instance that merges the given fields.

Parameter
Name	Description
`fieldMask`	`string` The fields to merge. An empty array is equivalent to using MergeAll. Must not be null or contain any empty or null elements. Each field is treated as a dot-separated list of segments.

Returns
Type	Description
`SetOptions`	An instance that merges the given fields.