ContainerProperties.DefaultTimeToLive Propriedade

Definição

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Pacote:

Microsoft.Azure.Cosmos v3.39.0

Origem:

ContainerProperties.cs

Obtém ou define o tempo de vida padrão em segundos para o item em um contêiner do serviço do Azure Cosmos.

[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="defaultTtl")]
public int? DefaultTimeToLive { get; set; }

[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="defaultTtl")>]
member this.DefaultTimeToLive : Nullable<int> with get, set

Public Property DefaultTimeToLive As Nullable(Of Integer)

Valor da propriedade

Nullable<Int32>

É uma propriedade opcional.

A unidade de medida é de segundos. O valor máximo permitido é 2147483647. Um valor válido deve ser um inteiro positivo diferente de zero, '-1' ou null.

Por padrão, DefaultTimeToLive é definido como nulo, o que significa que a vida útil está desativada para o contêiner.

Atributos

Newtonsoft.Json.JsonPropertyAttribute

Exemplos

O exemplo a seguir desabilita a vida útil em um contêiner.

container.DefaultTimeToLive = null;

O exemplo a seguir habilita a vida útil em um contêiner. Por padrão, todos os itens nunca expiram.

container.DefaultTimeToLive = -1;

O exemplo a seguir habilita a vida útil em um contêiner. Por padrão, o item expirará após 1000 segundos desde o último tempo de gravação.

container.DefaultTimeToLive = 1000;

Comentários

O DefaultTimeToLive será aplicado a todos os itens no contêiner como a política de vida útil padrão. O item individual pode substituir a política de vida útil padrão definindo sua vida útil.

Quando for DefaultTimeToLivenull, a vida útil será desativada para o contêiner. Isso significa que todos os itens nunca expirarão. O tempo de vida do item individual será desconsiderado.

Quando o DefaultTimeToLive for '-1', a vida útil será ativada para o contêiner. Por padrão, todos os itens nunca expirarão. O item individual pode receber um valor específico de vida útil definindo sua vida útil. A vida útil do item será respeitada e os itens expirados serão excluídos em segundo plano.

Quando o DefaultTimeToLive for um inteiro positivo diferente de zero, o tempo de vida será ativado para o contêiner. E um tempo de vida padrão em segundos será aplicado a todos os itens. Um item expirará após o valor especificado DefaultTimeToLive em segundos desde o último tempo de gravação.