public class SearchMediaRequest extends AbstractModel
skipSign
Constructor and Description |
---|
SearchMediaRequest() |
SearchMediaRequest(SearchMediaRequest source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
Modifier and Type | Method and Description |
---|---|
String[] |
getCategories()
Get File type.
|
Long[] |
getClassIds()
Get Category ID set.
|
TimeRange |
getCreateTime()
Get Matches files created within the time period.
|
String[] |
getDescriptions()
Get File description set.
|
String |
getEndTime()
Get (This is not recommended.
|
TimeRange |
getExpireTime()
Get Files whose expiration time points are within the specified time range will be returned.
|
String[] |
getFileIds()
Get File ID set.
|
String[] |
getFilters()
Get Specifies information entry that needs to be returned for all media files.
|
Long |
getLimit()
Get Number of entries returned by a paged query.
|
String[] |
getMediaTypes()
Get The file formats.
|
String[] |
getNamePrefixes()
Get The file name prefixes to search.
|
String[] |
getNames()
Get The file names to use for fuzzy search, which are sorted by relevance in descending order.
|
Long |
getOffset()
Get Start offset of a paged return.
|
String[] |
getReviewResults()
Get The types of moderation result.
|
SortBy |
getSort()
Get Sorting order.
|
String |
getSourceType()
Get (This is not recommended.
|
String[] |
getSourceTypes()
Get Media file source set.
|
String |
getStartTime()
Get (This is not recommended.
|
String[] |
getStatus()
Get The file statuses.
|
String[] |
getStorageClasses()
Get An array of storage classes.
|
String[] |
getStorageRegions()
Get Regions where media files are stored, such as `ap-chongqing`.
|
String |
getStreamId()
Get (Not recommended.
|
String[] |
getStreamIds()
Get The live stream code array.
|
Long |
getSubAppId()
Get The VOD [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) ID.
|
String[] |
getTags()
Get The tags to search.
|
String |
getText()
Get (This is not recommended.
|
String[] |
getTrtcRoomIds()
Get The TRTC room IDs.
|
Long[] |
getTrtcSdkAppIds()
Get The TRTC application IDs.
|
String |
getVid()
Get This parameter is invalid now.
|
String[] |
getVids()
Get This parameter is invalid now.
|
void |
setCategories(String[] Categories)
Set File type.
|
void |
setClassIds(Long[] ClassIds)
Set Category ID set.
|
void |
setCreateTime(TimeRange CreateTime)
Set Matches files created within the time period.
|
void |
setDescriptions(String[] Descriptions)
Set File description set.
|
void |
setEndTime(String EndTime)
Set (This is not recommended.
|
void |
setExpireTime(TimeRange ExpireTime)
Set Files whose expiration time points are within the specified time range will be returned.
|
void |
setFileIds(String[] FileIds)
Set File ID set.
|
void |
setFilters(String[] Filters)
Set Specifies information entry that needs to be returned for all media files.
|
void |
setLimit(Long Limit)
Set Number of entries returned by a paged query.
|
void |
setMediaTypes(String[] MediaTypes)
Set The file formats.
|
void |
setNamePrefixes(String[] NamePrefixes)
Set The file name prefixes to search.
|
void |
setNames(String[] Names)
Set The file names to use for fuzzy search, which are sorted by relevance in descending order.
|
void |
setOffset(Long Offset)
Set Start offset of a paged return.
|
void |
setReviewResults(String[] ReviewResults)
Set The types of moderation result.
|
void |
setSort(SortBy Sort)
Set Sorting order.
|
void |
setSourceType(String SourceType)
Set (This is not recommended.
|
void |
setSourceTypes(String[] SourceTypes)
Set Media file source set.
|
void |
setStartTime(String StartTime)
Set (This is not recommended.
|
void |
setStatus(String[] Status)
Set The file statuses.
|
void |
setStorageClasses(String[] StorageClasses)
Set An array of storage classes.
|
void |
setStorageRegions(String[] StorageRegions)
Set Regions where media files are stored, such as `ap-chongqing`.
|
void |
setStreamId(String StreamId)
Set (Not recommended.
|
void |
setStreamIds(String[] StreamIds)
Set The live stream code array.
|
void |
setSubAppId(Long SubAppId)
Set The VOD [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) ID.
|
void |
setTags(String[] Tags)
Set The tags to search.
|
void |
setText(String Text)
Set (This is not recommended.
|
void |
setTrtcRoomIds(String[] TrtcRoomIds)
Set The TRTC room IDs.
|
void |
setTrtcSdkAppIds(Long[] TrtcSdkAppIds)
Set The TRTC application IDs.
|
void |
setVid(String Vid)
Set This parameter is invalid now.
|
void |
setVids(String[] Vids)
Set This parameter is invalid now.
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, getMultipartRequestParams, getSkipSign, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public SearchMediaRequest()
public SearchMediaRequest(SearchMediaRequest source)
public Long getSubAppId()
public void setSubAppId(Long SubAppId)
SubAppId
- The VOD [subapplication](https://intl.cloud.tencent.com/document/product/266/14574?from_cn_redirect=1) ID. If you need to access a resource in a subapplication, set this parameter to the subapplication ID; otherwise, leave it empty.public String[] getFileIds()
public void setFileIds(String[] FileIds)
FileIds
- File ID set. Any element in the set can be matched.
public String[] getNames()
public void setNames(String[] Names)
Names
- The file names to use for fuzzy search, which are sorted by relevance in descending order.
public String[] getNamePrefixes()
public void setNamePrefixes(String[] NamePrefixes)
NamePrefixes
- The file name prefixes to search.
public String[] getDescriptions()
public void setDescriptions(String[] Descriptions)
Descriptions
- File description set. Media file descriptions are fuzzily matched. The higher the match rate, the higher-ranked the result.
public Long[] getClassIds()
public void setClassIds(Long[] ClassIds)
ClassIds
- Category ID set. The categories of the specified IDs and all subcategories in the set are matched.
public String[] getTags()
public void setTags(String[] Tags)
Tags
- The tags to search. A file is considered a match if it has any of the tags specified.
public String[] getCategories()
public void setCategories(String[] Categories)
Categories
- File type. Any element in the set can be matched.
public String[] getSourceTypes()
public void setSourceTypes(String[] SourceTypes)
SourceTypes
- Media file source set. For valid values, please see [SourceType](https://intl.cloud.tencent.com/document/product/266/31773?from_cn_redirect=1#MediaSourceData).
public String[] getStreamIds()
public void setStreamIds(String[] StreamIds)
StreamIds
- The live stream code array. A media file will be returned if it matches any element in the array.
public TimeRange getCreateTime()
public void setCreateTime(TimeRange CreateTime)
CreateTime
- Matches files created within the time period.
public TimeRange getExpireTime()
public void setExpireTime(TimeRange ExpireTime)
ExpireTime
- Files whose expiration time points are within the specified time range will be returned. Expired files will not be returned.
public SortBy getSort()
public void setSort(SortBy Sort)
Sort
- Sorting order.
public Long getOffset()
public void setOffset(Long Offset)
Offset
- public Long getLimit()
public void setLimit(Long Limit)
Limit
- public String[] getFilters()
public void setFilters(String[] Filters)
Filters
- Specifies information entry that needs to be returned for all media files. Multiple entries can be specified simultaneously. N starts from 0. If this field is left empty, all information entries will be returned by default. Valid values:
public String[] getStorageRegions()
public void setStorageRegions(String[] StorageRegions)
StorageRegions
- Regions where media files are stored, such as `ap-chongqing`. For more regions, see [Storage Regions](https://intl.cloud.tencent.com/document/product/266/9760?from_cn_redirect=1#.E5.B7.B2.E6.94.AF.E6.8C.81.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8).
public String[] getStorageClasses()
public void setStorageClasses(String[] StorageClasses)
StorageClasses
- An array of storage classes. Valid values:
public String[] getMediaTypes()
public void setMediaTypes(String[] MediaTypes)
MediaTypes
- The file formats.
public String[] getStatus()
public void setStatus(String[] Status)
Status
- The file statuses.
public String[] getReviewResults()
public void setReviewResults(String[] ReviewResults)
ReviewResults
- The types of moderation result.
public Long[] getTrtcSdkAppIds()
public void setTrtcSdkAppIds(Long[] TrtcSdkAppIds)
TrtcSdkAppIds
- The TRTC application IDs. Any file that matches one of the application IDs will be returned.
public String[] getTrtcRoomIds()
public void setTrtcRoomIds(String[] TrtcRoomIds)
TrtcRoomIds
- The TRTC room IDs. Any file that matches one of the room IDs will be returned.
public String getText()
public void setText(String Text)
Text
- (This is not recommended. `Names`, `NamePrefixes`, or `Descriptions` should be used instead)
Search text, which fuzzily matches the media file name or description. The more matching items and the higher the match rate, the higher-ranked the result. It can contain up to 64 characters.public String getSourceType()
public void setSourceType(String SourceType)
SourceType
- (This is not recommended. `SourceTypes` should be used instead)
Media file source. For valid values, please see [SourceType](https://intl.cloud.tencent.com/document/product/266/31773?from_cn_redirect=1#MediaSourceData).public String getStreamId()
public void setStreamId(String StreamId)
StreamId
- (Not recommended. Consider using `StreamIds` instead.)
The live stream code.public String getStartTime()
public void setStartTime(String StartTime)
StartTime
- (This is not recommended. `CreateTime` should be used instead)
Start time in the creation time range.
public String getEndTime()
public void setEndTime(String EndTime)
EndTime
- (This is not recommended. `CreateTime` should be used instead)
End time in the creation time range.
public String[] getVids()
public void setVids(String[] Vids)
Vids
- This parameter is invalid now.public String getVid()
public void setVid(String Vid)
Vid
- This parameter is invalid now.Copyright © 2023. All rights reserved.