Class RemoteItemLocation

Namespace

EncDotNet.S100.Collections

Assembly

EncDotNet.S100.Collections.dll

The item's data is available for download.

public sealed record RemoteItemLocation : ItemLocation, IEquatable<ItemLocation>, IEquatable<RemoteItemLocation>

Inheritance

object

ItemLocation

RemoteItemLocation

Implements

IEquatable<ItemLocation>

IEquatable<RemoteItemLocation>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RemoteItemLocation(Uri, long?, DateTimeOffset?, string?, string?, PackageLayout?, RemoteEnvelope?)

The item's data is available for download.

public RemoteItemLocation(Uri Uri, long? SizeBytes = null, DateTimeOffset? LastModified = null, string? DownloadFolder = null, string? Package = null, PackageLayout? Layout = null, RemoteEnvelope? Envelope = null)

Parameters

Uri Uri

The download location.

SizeBytes long?

The download size, if known.

LastModified DateTimeOffset?

When the download was last published, if known.

DownloadFolder string

The managed folder downloads go to, relative to the host's downloads root (e.g. community/ro-ienc), or null to let the host choose by provider.

Package string

For a download that holds several datasets (a package), the name it is saved under; the item is then the dataset named Name within it. null when the download is the item's own cell.

Layout PackageLayout

Where the item's files lie within the download, when the publisher states it (S-100 feeds, issue #680); null to discover the layout.

Envelope RemoteEnvelope?

How the download wraps the data: null when the response is the file itself, Secom for a SECOM Get response (issue #804).

Properties

Accept

The media type to ask for (Accept), e.g. application/geo+json for api.weather.gov; null for any.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Accept { get; init; }

Property Value

string

DownloadFolder

The managed folder downloads go to, relative to the host's downloads root (e.g. community/ro-ienc), or null to let the host choose by provider.

public string? DownloadFolder { get; init; }

Property Value

string

Envelope

How the download wraps the data: null when the response is the file itself, Secom for a SECOM Get response (issue #804).

public RemoteEnvelope? Envelope { get; init; }

Property Value

RemoteEnvelope?

Identity

For a SECOM object (Secom or SecomPost): its source's Identity setting, which the download presents and signs with (#883); null reads as the default.

public string? Identity { get; init; }

Property Value

string

LastModified

When the download was last published, if known.

public DateTimeOffset? LastModified { get; init; }

Property Value

DateTimeOffset?

Layout

Where the item's files lie within the download, when the publisher states it (S-100 feeds, issue #680); null to discover the layout.

public PackageLayout? Layout { get; init; }

Property Value

PackageLayout

Package

For a download that holds several datasets (a package), the name it is saved under; the item is then the dataset named Name within it. null when the download is the item's own cell.

public string? Package { get; init; }

Property Value

string

Parts

For a dataset assembled from several requests (a weather model run, #1075): each request in order, whose responses are appended into the one file Layout names. Uri is then the first part's. null when Uri alone is the download.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IReadOnlyList<RemotePart>? Parts { get; init; }

Property Value

IReadOnlyList<RemotePart>

Revision

An opaque revision of the download, for a publisher that states no LastModified (AMSA's SECOM exchange sets, #916): a copy downloaded at another revision is outdated. null when the publication date says it.

public string? Revision { get; init; }

Property Value

string

SizeBytes

The download size, if known.

public long? SizeBytes { get; init; }

Property Value

long?

Uri

The download location.

public Uri Uri { get; init; }

Property Value

Uri