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

Class SearchForAssets

java.lang.Object

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

com.algorand.algosdk.v2.client.indexer.SearchForAssets

public class SearchForAssets
extends Query

Search for assets. /v2/assets

Field Summary

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

qd

Constructor Summary

Constructors

Constructor	Description
SearchForAssets(Client client)

Method Summary

Modifier and Type	Method	Description
SearchForAssets	assetId(Long assetId)	Asset ID
SearchForAssets	creator(String creator)	Filter just assets with the given creator address.
Response<AssetsResponse>	execute()	Execute the query.
Response<AssetsResponse>	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.
protected QueryData	getRequestString()
SearchForAssets	includeAll(Boolean includeAll)	Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
SearchForAssets	limit(Long limit)	Maximum number of results to return.
SearchForAssets	name(String name)	Filter just assets with the given name.
SearchForAssets	next(String next)	The next page of results.
SearchForAssets	unit(String unit)	Filter just assets with the given unit.

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

SearchForAssets

public SearchForAssets(Client client)

Method Detail

assetId

public SearchForAssets assetId(Long assetId)

Asset ID

creator

public SearchForAssets creator(String creator)

Filter just assets with the given creator address.

includeAll

public SearchForAssets includeAll(Boolean includeAll)

Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.

limit

public SearchForAssets limit(Long limit)

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

name

public SearchForAssets name(String name)

Filter just assets with the given name.

next

public SearchForAssets next(String next)

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

unit

public SearchForAssets unit(String unit)

Filter just assets with the given unit.

execute

public Response<AssetsResponse> execute()
                                 throws Exception

Execute the query.

Specified by:

execute in class Query

Returns:

the query response object.

Throws:

Exception

execute

public Response<AssetsResponse> 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