Skip to content

Documentation: Fixes AnalyticalStoreTimeToLiveInSeconds API documentation to list correct values #4638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 12, 2024
Merged

Documentation: Fixes AnalyticalStoreTimeToLiveInSeconds API documentation to list correct values #4638

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f149da3
Updating API doc
ealsur Aug 12, 2024
646f915
Wording
ealsur Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions Microsoft.Azure.Cosmos/src/Resource/Settings/ContainerProperties.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -558,17 +558,17 @@ public IReadOnlyList<string> PartitionKeyPaths
/// It is an optional property.
///
/// The unit of measurement is seconds. The maximum allowed value is 2147483647.
/// A valid value must be either a nonzero positive integer, '-1' or <c>null</c>.
/// When updating this property, a valid value must be either a positive integer or '-1'.
///
/// By default, AnalyticalStoreTimeToLiveInSeconds is set to null meaning analytical store is turned-off.
/// By default, AnalyticalStoreTimeToLiveInSeconds is <c>null</c> meaning analytical store is turned-off.
/// </value>
/// <remarks>
/// <para>
/// The <see cref="AnalyticalStoreTimeToLiveInSeconds"/> is applicable to all the item changes in the container.
/// It cannot be overriden or customizable per item.
/// </para>
/// <para>
/// When the <see cref="AnalyticalStoreTimeToLiveInSeconds"/> is <c>null</c> analytical store is turned-off.
/// When the <see cref="AnalyticalStoreTimeToLiveInSeconds"/> is 0 analytical store is turned-off.
/// It means all the item changes in the container are disregarded.
/// </para>
/// <para>
Expand All @@ -581,10 +581,10 @@ public IReadOnlyList<string> PartitionKeyPaths
/// </para>
/// </remarks>
/// <example>
/// The example below disables analytical store on a container.
/// The example below disables analytical store on a container if previously enabled.
/// <code language="c#">
/// <![CDATA[
/// container.AnalyticalStoreTimeToLiveInSeconds = null;
/// container.AnalyticalStoreTimeToLiveInSeconds = 0;
/// ]]>
/// </code>
/// </example>
Expand Down