Constructor Detail

Method Detail

• fileType

   final AssetListParams.Builder fileType(AssetListParams.FileType fileType)

  Filter results by file type.

  • all — include all file types

  • image — include only image files

  • non-image — include only non-image files (e.g., JS, CSS, video)

• fileType

   final AssetListParams.Builder fileType(Optional<AssetListParams.FileType> fileType)

  Alias for calling Builder.fileType with fileType.orElse(null).

• limit

   final AssetListParams.Builder limit(Long limit)

  The maximum number of results to return in response.

• limit

   final AssetListParams.Builder limit(Long limit)

  Alias for Builder.limit.

  This unboxed primitive overload exists for backwards compatibility.

• limit

   final AssetListParams.Builder limit(Optional<Long> limit)

  Alias for calling Builder.limit with limit.orElse(null).

• path

   final AssetListParams.Builder path(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 path parameter in searchQuery with appropriate operator. Checkout /docs/api-reference/digital-asset-management-dam/list-and-search-assets#supported-parameters for more information.

• path

   final AssetListParams.Builder path(Optional<String> path)

  Alias for calling Builder.path with path.orElse(null).

• searchQuery

   final AssetListParams.Builder searchQuery(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:

  • tags

  • type

  • name

  /docs/api-reference/digital-asset-management-dam/list-and-search-assets#advanced-search-queries from examples.

• searchQuery

   final AssetListParams.Builder searchQuery(Optional<String> searchQuery)

  Alias for calling Builder.searchQuery with searchQuery.orElse(null).

• skip

   final AssetListParams.Builder skip(Long skip)

  The number of results to skip before returning results.

• skip

   final AssetListParams.Builder skip(Long skip)

  Alias for Builder.skip.

  This unboxed primitive overload exists for backwards compatibility.

• skip

   final AssetListParams.Builder skip(Optional<Long> skip)

  Alias for calling Builder.skip with skip.orElse(null).

• sort

   final AssetListParams.Builder sort(AssetListParams.Sort sort)

  Sort the results by one of the supported fields in ascending or descending order.

• sort

   final AssetListParams.Builder sort(Optional<AssetListParams.Sort> sort)

  Alias for calling Builder.sort with sort.orElse(null).

• type

   final AssetListParams.Builder type(AssetListParams.Type type)

  Filter results by asset type.

  • file — returns only files

  • file-version — returns specific file versions

  • folder — returns only folders

  • all — returns both files and folders (excludes file-version)

• type

   final AssetListParams.Builder type(Optional<AssetListParams.Type> type)

  Alias for calling Builder.type with type.orElse(null).

• additionalHeaders

   final AssetListParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final AssetListParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final AssetListParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final AssetListParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final AssetListParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final AssetListParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final AssetListParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final AssetListParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final AssetListParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final AssetListParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final AssetListParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final AssetListParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final AssetListParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final AssetListParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final AssetListParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final AssetListParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final AssetListParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final AssetListParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final AssetListParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final AssetListParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final AssetListParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final AssetListParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final AssetListParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final AssetListParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final AssetListParams build()

  Returns an immutable instance of AssetListParams.

  Further updates to this Builder will not mutate the returned instance.