Class AssetListParams
-
- All Implemented Interfaces:
-
io.imagekit.core.Params
public final class AssetListParams implements Params
This API can list all the uploaded files and folders in your ImageKit.io media library. In addition, you can fine-tune your query by specifying various filters by generating a query string in a Lucene-like syntax and provide this generated string as the value of the
searchQuery.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classAssetListParams.BuilderA builder for AssetListParams.
public final classAssetListParams.FileTypeFilter results by file type.
all— include all file typesimage— include only image filesnon-image— include only non-image files (e.g., JS, CSS, video)
public final classAssetListParams.SortSort the results by one of the supported fields in ascending or descending order.
public final classAssetListParams.TypeFilter results by asset type.
file— returns only filesfile-version— returns specific file versionsfolder— returns only foldersall— returns both files and folders (excludesfile-version)
-
Method Summary
Modifier and Type Method Description final Optional<AssetListParams.FileType>fileType()Filter results by file type. final Optional<Long>limit()The maximum number of results to return in response. final Optional<String>path()Folder path if you want to limit the search within a specific folder. final Optional<String>searchQuery()Query string in a Lucene-like query language e.g. final Optional<Long>skip()The number of results to skip before returning results. final Optional<AssetListParams.Sort>sort()Sort the results by one of the supported fields in ascending or descending order. final Optional<AssetListParams.Type>type()Filter results by asset type. final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final AssetListParams.BuildertoBuilder()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static AssetListParamsnone()final static AssetListParams.Builderbuilder()Returns a mutable builder for constructing an instance of AssetListParams. -
-
Method Detail
-
fileType
final Optional<AssetListParams.FileType> fileType()
Filter results by file type.
all— include all file typesimage— include only image filesnon-image— include only non-image files (e.g., JS, CSS, video)
-
path
final Optional<String> path()
Folder path if you want to limit the search within a specific folder. For example,
/sales-banner/will only search in folder sales-banner.Note : If your use case involves searching within a folder as well as its subfolders, you can use
pathparameter insearchQuerywith appropriate operator. Checkout /docs/api-reference/digital-asset-management-dam/list-and-search-assets#supported-parameters for more information.
-
searchQuery
final Optional<String> searchQuery()
Query string in a Lucene-like query language e.g.
createdAt > "7d".Note : When the searchQuery parameter is present, the following query parameters will have no effect on the result:
tagstypename
/docs/api-reference/digital-asset-management-dam/list-and-search-assets#advanced-search-queries from examples.
-
sort
final Optional<AssetListParams.Sort> sort()
Sort the results by one of the supported fields in ascending or descending order.
-
type
final Optional<AssetListParams.Type> type()
Filter results by asset type.
file— returns only filesfile-version— returns specific file versionsfolder— returns only foldersall— returns both files and folders (excludesfile-version)
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final AssetListParams.Builder toBuilder()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
none
final static AssetListParams none()
-
builder
final static AssetListParams.Builder builder()
Returns a mutable builder for constructing an instance of AssetListParams.
-
-
-
-