com.aliyun.sdk.service.vod20170321.models

类 SearchMediaRequest.Builder

java.lang.Object

com.aliyun.sdk.service.vod20170321.models.SearchMediaRequest.Builder

所有已实现的接口:

darabonba.core.RequestModel.Builder<SearchMediaRequest,SearchMediaRequest.Builder>

封闭类:

SearchMediaRequest

public static final class SearchMediaRequest.Builder
extends Object

方法概要

限定符和类型	方法和说明
SearchMediaRequest	build()
SearchMediaRequest.Builder	fields(String fields) The media asset fields to return in the query results.
SearchMediaRequest.Builder	match(String match) The filter condition.
SearchMediaRequest.Builder	pageNo(Integer pageNo) The number of the page to return.
SearchMediaRequest.Builder	pageSize(Integer pageSize) The number of entries to return on each page.
SearchMediaRequest.Builder	scrollToken(String scrollToken) The pagination identifier.
SearchMediaRequest.Builder	searchType(String searchType) The type of the media asset that you want to query.
SearchMediaRequest.Builder	sortBy(String sortBy) The sort field and order.

从类继承的方法 java.lang.Object

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

方法详细资料

fields

public SearchMediaRequest.Builder fields(String fields)

The media asset fields to return in the query results.

By default, only the basic media asset fields are returned. You can specify additional media asset fields that need to be returned in the request. For more information, see the "API examples" section of the [Search for media asset information](~~99179~~) topic.

match

public SearchMediaRequest.Builder match(String match)

The filter condition. For more information about the syntax, see [Protocol for media asset search](~~86991~~).

pageNo

public SearchMediaRequest.Builder pageNo(Integer pageNo)

The number of the page to return. Default value: **1**.

> If the value of this parameter exceeds **200**, we recommend that you set the ScrollToken parameter as well.

pageSize

public SearchMediaRequest.Builder pageSize(Integer pageSize)

The number of entries to return on each page. Default value: **10**. Maximum value: **100**.

scrollToken

public SearchMediaRequest.Builder scrollToken(String scrollToken)

The pagination identifier. The password must be 32 characters in length The first time you call this operation for each new search, you do not need to specify this parameter. The value of this parameter is returned each time data records that meet the specified filter condition are found. The value is used to record the current position of queried data. Record the returned parameter value and set this parameter according to the following requirements during the next search:

* If SearchType is set to **video** or **audio** and you need to traverse all data that meets the filter criteria, you must set the ScrollToken parameter. * If the value of the PageNo parameter exceeds **200**, we recommend that you set this parameter to optimize search performance.

searchType

public SearchMediaRequest.Builder searchType(String searchType)

The type of the media asset that you want to query. Default value: video. Valid values:

* **video** * **audio** * **image** * **attached** > If this parameter is set to **video** or **audio** and you want to traverse all data that meets the filter criteria, you must set the ScrollToken parameter.

sortBy

public SearchMediaRequest.Builder sortBy(String sortBy)

The sort field and order. Separate multiple values with commas (,). Default value: CreationTime:Desc. Valid values:

* **CreationTime:Desc**: The results are sorted in reverse chronological order based on the creation time. * **CreationTime:Asc**: The results are sorted in chronological order based on the creation time. > * For more information about the sort field, see "Sort field" in the [Search for media asset information](~~99179~~) topic. > * To obtain the first 5,000 data records that meet the specified filter criteria, you can specify a maximum of three sort fields. > * To obtain all the data records that meet the specified filter criteria, you can specify only one sort field.

build

public SearchMediaRequest build()