Class BatchJobSummary

Namespace

DatabentoDotNet.Historical

Assembly

DatabentoDotNet.Historical.dll

The three fields ListJobsAsync(ListJobsParams?, CancellationToken) returns for each job.

public sealed record BatchJobSummary : IEquatable<BatchJobSummary>

Inheritance

object

BatchJobSummary

Implements

IEquatable<BatchJobSummary>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Port of upstream's BatchJobShort (batch.rs:583-592), named for what it is rather than for how much of it there is. Fetch the rest with GetJobDetailsAsync(string, CancellationToken).

This shape is the API's future, not a convenience. Upstream deprecated list_jobs_full in 0.60.0 with the note that "the batch.list_jobs endpoint will stop returning full job details at a future date" (batch.rs:125-129) — so the full listing is the form that is going away and this is the one that stays. #39 confirmed both still answer today: short=true returns exactly these three fields, and omitting it returns the whole job.

Properties

Id

The job's unique identifier — XNAS-20260825-6T3F5G5TYH.

public required string Id { get; init; }

Property Value

string

ReceivedTimestamp

When Databento received the job.

[JsonPropertyName("ts_received")]
public required Instant ReceivedTimestamp { get; init; }

Property Value

Instant

Remarks

ts_received on the wire. Also the value Since filters on, so a listing can be continued from the last summary it returned.

State

How far the job has got.

public required JobState State { get; init; }

Property Value

JobState