Class ExportParameters

Namespace

Nexus.Api.V2

Assembly

Nexus.Api.dll

A structure for export parameters.

public record ExportParameters : IEquatable<ExportParameters>

Inheritance

object

ExportParameters

Implements

IEquatable<ExportParameters>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ExportParameters(DateTime, DateTime, TimeSpan, string?, IReadOnlyList<string>, IReadOnlyDictionary<string, JsonElement>?, Precision)

A structure for export parameters.

public ExportParameters(DateTime Begin, DateTime End, TimeSpan FilePeriod, string? Type, IReadOnlyList<string> ResourcePaths, IReadOnlyDictionary<string, JsonElement>? Configuration, Precision Precision)

Parameters

Begin DateTime

The start date/time.

End DateTime

The end date/time.

FilePeriod TimeSpan

The file period.

Type string

The writer type. If null, data will be read (and possibly cached) but not returned. This is useful for data pre-aggregation.

ResourcePaths IReadOnlyList<string>

The resource paths to export.

Configuration IReadOnlyDictionary<string, JsonElement>

The configuration.

Precision Precision

The floating point precision used for exported sample values.

Properties

Begin

The start date/time.

public DateTime Begin { get; init; }

Property Value

DateTime

Configuration

The configuration.

public IReadOnlyDictionary<string, JsonElement>? Configuration { get; init; }

Property Value

IReadOnlyDictionary<string, JsonElement>

End

The end date/time.

public DateTime End { get; init; }

Property Value

DateTime

FilePeriod

The file period.

public TimeSpan FilePeriod { get; init; }

Property Value

TimeSpan

Precision

The floating point precision used for exported sample values.

public Precision Precision { get; init; }

Property Value

Precision

ResourcePaths

The resource paths to export.

public IReadOnlyList<string> ResourcePaths { get; init; }

Property Value

IReadOnlyList<string>

Type

The writer type. If null, data will be read (and possibly cached) but not returned. This is useful for data pre-aggregation.

public string? Type { get; init; }

Property Value

string