Class R2ObjectPage

Namespace

Cloudflare.NET.R2.Models

Assembly

Cloudflare.NET.R2.dll

One page of an R2 prefix listing: the objects this ListObjectsV2 call returned, plus the token that fetches the next page.

public record R2ObjectPage : IEquatable<R2ObjectPage>

Inheritance

object

R2ObjectPage

Implements

IEquatable<R2ObjectPage>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The caller-driven counterpart of ListObjectsAsync(string, string?, CancellationToken), which walks every page internally. A caller that must bound how many pages it reads per run, and resume later, needs one page and a token instead of the whole prefix.

Constructors

R2ObjectPage(IReadOnlyList<S3Object>, string?, bool)

One page of an R2 prefix listing: the objects this ListObjectsV2 call returned, plus the token that fetches the next page.

public R2ObjectPage(IReadOnlyList<S3Object> Objects, string? NextContinuationToken, bool IsTruncated)

Parameters

Objects IReadOnlyList<S3Object>

The objects in this page, in the order R2 returned them (ordinal by key).

NextContinuationToken string

The token to pass on the next call to continue the listing, or null when this page is the last one.

IsTruncated bool

true when R2 has more objects under the prefix than this page carries.

Remarks

The caller-driven counterpart of ListObjectsAsync(string, string?, CancellationToken), which walks every page internally. A caller that must bound how many pages it reads per run, and resume later, needs one page and a token instead of the whole prefix.

Properties

IsTruncated

true when R2 has more objects under the prefix than this page carries.

public bool IsTruncated { get; init; }

Property Value

bool

NextContinuationToken

The token to pass on the next call to continue the listing, or null when this page is the last one.

public string? NextContinuationToken { get; init; }

Property Value

string

Objects

The objects in this page, in the order R2 returned them (ordinal by key).

public IReadOnlyList<S3Object> Objects { get; init; }

Property Value

IReadOnlyList<S3Object>