Class VisualizationView

Namespace

Nexus.Api.V2

Assembly

Nexus.Api.dll

Defines one caller-supplied half-open time viewport and the maximum number of decimated points to return for it.

public record VisualizationView : IEquatable<VisualizationView>

Inheritance

object

VisualizationView

Implements

IEquatable<VisualizationView>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

VisualizationView(string, DateTime, DateTime, int)

Defines one caller-supplied half-open time viewport and the maximum number of decimated points to return for it.

public VisualizationView(string Id, DateTime Begin, DateTime End, int MaxPoints)

Parameters

Id string

The caller-supplied view identifier that is echoed on the corresponding response view.

Begin DateTime

The viewport start.

End DateTime

The exclusive viewport end.

MaxPoints int

The maximum number of points to return for this view (5 through 32768). Aggregate buckets may emit first and last samples, finite minimum and maximum values, and a NaN gap marker; all emitted points count toward this limit.

Properties

Begin

The viewport start.

public DateTime Begin { get; init; }

Property Value

DateTime

End

The exclusive viewport end.

public DateTime End { get; init; }

Property Value

DateTime

Id

The caller-supplied view identifier that is echoed on the corresponding response view.

public string Id { get; init; }

Property Value

string

MaxPoints

The maximum number of points to return for this view (5 through 32768). Aggregate buckets may emit first and last samples, finite minimum and maximum values, and a NaN gap marker; all emitted points count toward this limit.

public int MaxPoints { get; init; }

Property Value

int