Package com.algorand.algosdk.v2.client.indexer

Class SearchForBlockHeaders

java.lang.Object

com.algorand.algosdk.v2.client.common.Query

com.algorand.algosdk.v2.client.indexer.SearchForBlockHeaders

public class SearchForBlockHeaders
extends Query

Search for block headers. Block headers are returned in ascending round order. Transactions are not included in the output. /v2/block-headers

Field Summary

Fields inherited from class com.algorand.algosdk.v2.client.common.Query

qd

Constructor Summary

Constructors

Constructor	Description
SearchForBlockHeaders(Client client)

Method Summary

Modifier and Type	Method	Description
SearchForBlockHeaders	absent(List<Address> absent)	Accounts marked as absent in the block header's participation updates.
SearchForBlockHeaders	afterTime(Date afterTime)	Include results after the given time.
SearchForBlockHeaders	beforeTime(Date beforeTime)	Include results before the given time.
Response<BlockHeadersResponse>	execute()	Execute the query.
Response<BlockHeadersResponse>	execute(String[] headers, String[] values)	Execute the query with custom headers, there must be an equal number of keys and values or else an error will be generated.
SearchForBlockHeaders	expired(List<Address> expired)	Accounts marked as expired in the block header's participation updates.
protected QueryData	getRequestString()
SearchForBlockHeaders	limit(Long limit)	Maximum number of results to return.
SearchForBlockHeaders	maxRound(Long maxRound)	Include results at or before the specified max-round.
SearchForBlockHeaders	minRound(Long minRound)	Include results at or after the specified min-round.
SearchForBlockHeaders	next(String next)	The next page of results.
SearchForBlockHeaders	proposers(List<Address> proposers)	Accounts marked as proposer in the block header's participation updates.

Methods inherited from class com.algorand.algosdk.v2.client.common.Query

addPathSegment, addQuery, addToBody, addToBody, baseExecute, baseExecute, getRequestMethod, getRequestUrl, getRequestUrl, resetPathSegment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchForBlockHeaders

public SearchForBlockHeaders(Client client)

Method Detail

absent

public SearchForBlockHeaders absent(List<Address> absent)

Accounts marked as absent in the block header's participation updates. This parameter accepts a comma separated list of addresses.

afterTime

public SearchForBlockHeaders afterTime(Date afterTime)

Include results after the given time. Must be an RFC 3339 formatted string.

beforeTime

public SearchForBlockHeaders beforeTime(Date beforeTime)

Include results before the given time. Must be an RFC 3339 formatted string.

expired

public SearchForBlockHeaders expired(List<Address> expired)

Accounts marked as expired in the block header's participation updates. This parameter accepts a comma separated list of addresses.

limit

public SearchForBlockHeaders limit(Long limit)

Maximum number of results to return. There could be additional pages even if the limit is not reached.

maxRound

public SearchForBlockHeaders maxRound(Long maxRound)

Include results at or before the specified max-round.

minRound

public SearchForBlockHeaders minRound(Long minRound)

Include results at or after the specified min-round.

next

public SearchForBlockHeaders next(String next)

The next page of results. Use the next token provided by the previous results.

proposers

public SearchForBlockHeaders proposers(List<Address> proposers)

Accounts marked as proposer in the block header's participation updates. This parameter accepts a comma separated list of addresses.

execute

public Response<BlockHeadersResponse> execute()
                                       throws Exception

Execute the query.

Specified by:

execute in class Query

Returns:

the query response object.

Throws:

Exception

execute

public Response<BlockHeadersResponse> execute(String[] headers,
                                              String[] values)
                                       throws Exception

Execute the query with custom headers, there must be an equal number of keys and values or else an error will be generated.

Specified by:

execute in class Query

Parameters:

headers - an array of header keys

values - an array of header values

Returns:

the query response object.

Throws:

Exception

getRequestString

protected QueryData getRequestString()

Specified by:

getRequestString in class Query