DocumentCollection.TimeToLivePropertyPath Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Documents
Assemblies:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
Packages:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Gets or sets the time to live base timestamp property path.

[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="ttlPropertyPath")]
public string TimeToLivePropertyPath { get; set; }
[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="ttlPropertyPath")>]
member this.TimeToLivePropertyPath : string with get, set
Public Property TimeToLivePropertyPath As String

Property Value

String

It is an optional property. This property should be only present when DefaultTimeToLive is set. When this property is present, time to live for a document is decided based on the value of this property in document. By default, TimeToLivePropertyPath is set to null meaning the time to live is based on the _ts property in document.

Attributes
Newtonsoft.Json.JsonPropertyAttribute

Applies to