Language

Pageable Class

Definition

Namespace:
Azure
Assembly:
Azure.Core.dll
Package:
Azure.Core v1.63.0
Source:
Pageable.cs

A collection of values that may take multiple service requests to iterate over.

public abstract class Pageable : System.Collections.Generic.IEnumerable
type Pageable<'T> = class
    interface seq<'T>
    interface IEnumerable
Public MustInherit Class Pageable(Of T)
Implements IEnumerable(Of T)

Type Parameters

T

The type of the values.

Inheritance
Object
Pageable
Implements
IEnumerable IEnumerable

Constructors

Name Description
Pageable()

Initializes a new instance of the Pageable class for mocking.
Pageable(CancellationToken)

Initializes a new instance of the Pageable class.

Properties

Name Description
CancellationToken

Gets a CancellationToken used for requests made while enumerating asynchronously.

Methods

Name Description
AsPages(String, Nullable)

Enumerate the values a Page at a time. This may make multiple service requests.
FromPages(IEnumerable>)

Creates an instance of Pageable using the provided pages.
GetEnumerator()

Enumerate the values in the collection. This may make multiple service requests.

Explicit Interface Implementations

Name Description
IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

Extension Methods

Name Description
ArrayContainsAll(IEnumerable, Object[])

Returns whether all values are present in the array.
ArrayContainsAny(IEnumerable, Object[])

Returns whether any values are present in the array.

Applies to