network.bsky.jetstream.plan_snapshot

class atproto_client.models.network.bsky.jetstream.plan_snapshot.BlockRange

Bases: ModelBase

Definition model for network.bsky.jetstream.planSnapshot.

field first: int [Required]

Index of the first block in the range.

Constraints:

• ge = 0

field last: int [Required]

Index of the last block in the range.

Constraints:

• ge = 0

field py_type: Literal['network.bsky.jetstream.planSnapshot#blockRange'] = 'network.bsky.jetstream.planSnapshot#blockRange'

class atproto_client.models.network.bsky.jetstream.plan_snapshot.Data

Bases: DataModelBase

Input data model for network.bsky.jetstream.planSnapshot.

field after_seq: int | None = None

Constraints:

• ge = 0

field before_seq: int | None = None

Constraints:

• ge = 0

field collections: List[str] | None = None

Constraints:

• max_length = 100

field dids: List[str] | None = None

Constraints:

• max_length = 10000

field kinds: List[Literal['commit', 'identity', 'account', 'sync']] | None = None

Constraints:

• max_length = 4

class atproto_client.models.network.bsky.jetstream.plan_snapshot.DataDict

Bases: TypedDict

after_seq: NotRequired[int | None]

Start after this sequence number. Events at or below it are not included.

before_seq: NotRequired[int | None]

Stop at this sequence number. Events above it are not included.

collections: NotRequired[List[str] | None]

Collection NSIDs or namespace wildcards such as app.bsky.feed.*; constrains commit events only. Non-commit kinds are unaffected, so combine with kinds=commit for a commits-only collection plan. Rejected when kinds is set and excludes commit. Omit or pass an empty array to include all collections.

dids: NotRequired[List[str] | None]

Only include data for these DIDs. Omit this field or pass an empty array to include all DIDs.

kinds: NotRequired[List[Literal['commit', 'identity', 'account', 'sync']] | None]

Event kinds to include. Omit this field or pass an empty array to include all kinds.

class atproto_client.models.network.bsky.jetstream.plan_snapshot.Response

Bases: ResponseModelBase

Output data model for network.bsky.jetstream.planSnapshot.

field planned_through_seq: int [Required]

The last sealed sequence covered by this page. Use this value as afterSeq for the next page. If the response hits the server’s page limit, this is the maxSeq of the last item returned; otherwise it equals sealedTipSeq. Planning is complete when plannedThroughSeq reaches sealedTipSeq.

Constraints:

• ge = 0

field sealed_tip_seq: int [Required]

The end of the sealed archive for this snapshot, capped by beforeSeq when provided. Use this value as beforeSeq on later pages so the snapshot does not move while it is being downloaded.

Constraints:

• ge = 0

field segments: List[models.NetworkBskyJetstreamPlanSnapshot.Segment] [Required]

Segments.

field stats: models.NetworkBskyJetstreamPlanSnapshot.Stats [Required]

Stats.

class atproto_client.models.network.bsky.jetstream.plan_snapshot.Segment

Bases: ModelBase

Definition model for network.bsky.jetstream.planSnapshot.

field blocks: List[models.NetworkBskyJetstreamPlanSnapshot.BlockRange] | None = None

field checksum: str [Required]

The segment’s xxh3 metadata checksum, encoded as 16 hexadecimal characters.

Constraints:

• min_length = 16

• max_length = 16

field index: int [Required]

Zero-based segment index.

Constraints:

• ge = 0

field max_seq: int [Required]

Max seq.

Constraints:

• ge = 0

field min_seq: int [Required]

Min seq.

Constraints:

• ge = 0

field mode: Literal['segment', 'blocks'] | str [Required]

How to download this segment. For segment, download the whole file with getSegment. For blocks, download the ranges listed in blocks with getBlock.

field name: str [Required]

Segment filename to pass to getSegment or getBlock.

field py_type: Literal['network.bsky.jetstream.planSnapshot#segment'] = 'network.bsky.jetstream.planSnapshot#segment'

class atproto_client.models.network.bsky.jetstream.plan_snapshot.Stats

Bases: ModelBase

Definition model for network.bsky.jetstream.planSnapshot.

field blocks_matched: int [Required]

Blocks matched.

Constraints:

• ge = 0

field entries: int [Required]

Number of items counted toward the server’s per-page plan limit.

Constraints:

• ge = 0

field py_type: Literal['network.bsky.jetstream.planSnapshot#stats'] = 'network.bsky.jetstream.planSnapshot#stats'

field segments_examined: int [Required]

Segments examined.

Constraints:

• ge = 0

field segments_matched: int [Required]

Segments matched.

Constraints:

• ge = 0