Class BlockNumberFilter

Predicate filter on the block.number query parameter of the /api/v1/blocks and contract-results endpoints. Construct via one of the static factories — the ctor is private so the operator is always explicit at the call site.

Inheritance
object
BlockNumberFilter
Implements
Inherited Members
Namespace: Hiero.Mirror.Filters
Assembly: Hiero.dll
Syntax
public sealed class BlockNumberFilter : IMirrorFilter, IMirrorQueryParameter
Remarks

Mirror REST accepts the six comparison forms — equality (default), gt:, gte:, lt:, lte:, and ne: — on the block.number query parameter. Each factory builds the corresponding wire value. Block numbers are non-negative on the wire (OpenAPI minimum: 0), hence the ulong argument.

Properties

| Edit this page View Source

Name

The query parameter name recognized by the remote mirror node.

Declaration
public string Name { get; }
Property Value
Type Description
string
| Edit this page View Source

Value

The value of the query parameter sent to the mirror node — already includes the operator prefix where applicable.

Declaration
public string Value { get; }
Property Value
Type Description
string

Methods

| Edit this page View Source

After(ulong)

Records whose block number is strictly greater than the given value (gt:).

Declaration
public static BlockNumberFilter After(ulong blockNumber)
Parameters
Type Name Description
ulong blockNumber
Returns
Type Description
BlockNumberFilter
| Edit this page View Source

Before(ulong)

Records whose block number is strictly less than the given value (lt:).

Declaration
public static BlockNumberFilter Before(ulong blockNumber)
Parameters
Type Name Description
ulong blockNumber
Returns
Type Description
BlockNumberFilter
| Edit this page View Source

Is(ulong)

Records whose block number equals the given value.

Declaration
public static BlockNumberFilter Is(ulong blockNumber)
Parameters
Type Name Description
ulong blockNumber
Returns
Type Description
BlockNumberFilter
| Edit this page View Source

NotIs(ulong)

Records whose block number is not equal to the given value (ne:).

Declaration
public static BlockNumberFilter NotIs(ulong blockNumber)
Parameters
Type Name Description
ulong blockNumber
Returns
Type Description
BlockNumberFilter
| Edit this page View Source

OnOrAfter(ulong)

Records whose block number is at or greater than the given value (gte:).

Declaration
public static BlockNumberFilter OnOrAfter(ulong blockNumber)
Parameters
Type Name Description
ulong blockNumber
Returns
Type Description
BlockNumberFilter
| Edit this page View Source

OnOrBefore(ulong)

Records whose block number is at or less than the given value (lte:).

Declaration
public static BlockNumberFilter OnOrBefore(ulong blockNumber)
Parameters
Type Name Description
ulong blockNumber
Returns
Type Description
BlockNumberFilter

Implements