Docs
You are looking at documentation for an older release. Not what you want? See the current release documentation.
Elasticsearch.Net and NEST: the .NET clients [2.x] » Common Options » Time units
«  Common Options     Distance Units  »

Time unitsedit

Whenever durations need to be specified, eg for a timeout parameter, the duration can be specified as a whole number representing time in milliseconds, or as a time value like 2d for 2 days.

Using Time units in NESTedit

NEST uses Time to strongly type this and there are several ways to construct one.

Constructoredit

The most straight forward way to construct a Time is through its constructor

var unitString = new Time("2d");
var unitComposed = new Time(2, Nest.TimeUnit.Day);
var unitTimeSpan = new Time(TimeSpan.FromDays(2));
var unitMilliseconds = new Time(1000 * 60 * 60 * 24 * 2);

When serializing Time constructed from

  • a string
  • milliseconds (as a double)
  • composition of factor and interval
  • a TimeSpan

the expression will be serialized to a time unit string composed of the factor and interval e.g. 2d

Expect("2d")
    .WhenSerializing(unitString)
    .WhenSerializing(unitComposed)
    .WhenSerializing(unitTimeSpan)
    .WhenSerializing(unitMilliseconds);

The Milliseconds property on Time is calculated even when not using the constructor that takes a double

unitMilliseconds.Milliseconds.Should().Be(1000*60*60*24*2);

unitComposed.Milliseconds.Should().Be(1000*60*60*24*2);
unitTimeSpan.Milliseconds.Should().Be(1000*60*60*24*2);
unitString.Milliseconds.Should().Be(1000*60*60*24*2);

Implicit conversionedit

Alternatively to using the constructor, string, TimeSpan and double can be implicitly converted to Time

Time oneAndHalfYear = "1.5y";

Time twoWeeks = TimeSpan.FromDays(14);

Time twoDays = 1000*60*60*24*2;

Expect("1.5y").WhenSerializing(oneAndHalfYear);

Expect("2w").WhenSerializing(twoWeeks);

Expect("2d").WhenSerializing(twoDays);
Time oneAndHalfYear = "1.5y";

Time twoWeeks = TimeSpan.FromDays(14);

Time twoDays = 1000*60*60*24*2;

Milliseconds are calculated even when values are not passed as long…

twoWeeks.Milliseconds.Should().BeGreaterThan(1);

…except when dealing with years or months, whose millsecond value cannot be calculated accurately, since they are not fixed durations. For instance, 30 vs 31 vs 28 days in a month, or 366 vs 365 days in a year. In this instance, Milliseconds will be -1.

oneAndHalfYear.Milliseconds.Should().Be(-1);

This allows you to do comparisons on the expressions

oneAndHalfYear.Should().BeGreaterThan(twoWeeks);

(oneAndHalfYear > twoWeeks).Should().BeTrue();

(oneAndHalfYear >= twoWeeks).Should().BeTrue();

(twoDays != null).Should().BeTrue();

(twoDays >= new Time("2d")).Should().BeTrue();

twoDays.Should().BeLessThan(twoWeeks);

(twoDays < twoWeeks).Should().BeTrue();

(twoDays <= twoWeeks).Should().BeTrue();

(twoDays <= new Time("2d")).Should().BeTrue();

And assert equality

twoDays.Should().Be(new Time("2d"));

(twoDays == new Time("2d")).Should().BeTrue();

(twoDays != new Time("2.1d")).Should().BeTrue();

(new Time("2.1d") == new Time(TimeSpan.FromDays(2.1))).Should().BeTrue();

(new Time("1") == new Time(1)).Should().BeTrue();

(new Time("-1") == new Time(-1)).Should().BeTrue();

Units of Timeedit

Units of Time are specified as a union of either a DateInterval or Time, both of which implicitly convert to the Union of these two.

Expect("month").WhenSerializing<Union<DateInterval, Time>>(DateInterval.Month);

Expect("day").WhenSerializing<Union<DateInterval, Time>>(DateInterval.Day);

Expect("hour").WhenSerializing<Union<DateInterval, Time>>(DateInterval.Hour);

Expect("minute").WhenSerializing<Union<DateInterval, Time>>(DateInterval.Minute);

Expect("quarter").WhenSerializing<Union<DateInterval, Time>>(DateInterval.Quarter);

Expect("second").WhenSerializing<Union<DateInterval, Time>>(DateInterval.Second);

Expect("week").WhenSerializing<Union<DateInterval, Time>>(DateInterval.Week);

Expect("year").WhenSerializing<Union<DateInterval, Time>>(DateInterval.Year);

Expect("2d").WhenSerializing<Union<DateInterval, Time>>((Time)"2d");

Expect("1.16w").WhenSerializing<Union<DateInterval, Time>>((Time)TimeSpan.FromDays(8.1));
«  Common Options     Distance Units  »