com.aliyun.vod20170321.models

类 SearchMediaRequest

java.lang.Object

com.aliyun.tea.TeaModel

com.aliyun.vod20170321.models.SearchMediaRequest

public class SearchMediaRequest
extends com.aliyun.tea.TeaModel

字段概要

字段

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

构造器概要

构造器

构造器和说明
SearchMediaRequest()

方法概要

限定符和类型	方法和说明
static SearchMediaRequest	build(Map<String,?> map)
String	getFields()
String	getMatch()
Integer	getPageNo()
Integer	getPageSize()
String	getScrollToken()
String	getSearchType()
String	getSortBy()
SearchMediaRequest	setFields(String fields)
SearchMediaRequest	setMatch(String match)
SearchMediaRequest	setPageNo(Integer pageNo)
SearchMediaRequest	setPageSize(Integer pageSize)
SearchMediaRequest	setScrollToken(String scrollToken)
SearchMediaRequest	setSearchType(String searchType)
SearchMediaRequest	setSortBy(String sortBy)

从类继承的方法 com.aliyun.tea.TeaModel

build, buildMap, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

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

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

字段详细资料

fields

@NameInMap(value="Fields")
public 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

@NameInMap(value="Match")
public String match

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

pageNo

@NameInMap(value="PageNo")
public 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

@NameInMap(value="PageSize")
public Integer pageSize

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

scrollToken

@NameInMap(value="ScrollToken")
public 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

@NameInMap(value="SearchType")
public 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

@NameInMap(value="SortBy")
public 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.

构造器详细资料

SearchMediaRequest

public SearchMediaRequest()

方法详细资料

build

public static SearchMediaRequest build(Map<String,?> map)
                                throws Exception

抛出:

Exception

setFields

public SearchMediaRequest setFields(String fields)

getFields

public String getFields()

setMatch

public SearchMediaRequest setMatch(String match)

getMatch

public String getMatch()

setPageNo

public SearchMediaRequest setPageNo(Integer pageNo)

getPageNo

public Integer getPageNo()

setPageSize

public SearchMediaRequest setPageSize(Integer pageSize)

getPageSize

public Integer getPageSize()

setScrollToken

public SearchMediaRequest setScrollToken(String scrollToken)

getScrollToken

public String getScrollToken()

setSearchType

public SearchMediaRequest setSearchType(String searchType)

getSearchType

public String getSearchType()

setSortBy

public SearchMediaRequest setSortBy(String sortBy)

getSortBy

public String getSortBy()