com.tencentcloudapi.tat.v20201028.models

Class DescribeScenesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tat.v20201028.models.DescribeScenesRequest

public class DescribeScenesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeScenesRequest()
DescribeScenesRequest(DescribeScenesRequest 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.

Method Summary

Modifier and Type	Method and Description
Filter[]	getFilters() Get 过滤条件。 - scene-id - String - 是否必填：否 -（过滤条件）按照场景 ID 过滤。 - scene-name - String - 是否必填：否 -（过滤条件）按照场景名称过滤。 - created-by - String - 是否必填：否 -（过滤条件）按照场景创建者过滤，目前仅支持 TAT，代表公共场景。 每次请求的 `Filters` 的上限为10， `Filter.Values` 的上限为5。参数不支持同时指定 `SceneIds` 和 `Filters` 。
Long	getLimit() Get 返回数量，默认为20，最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
Long	getOffset() Get 偏移量，默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
String[]	getSceneIds() Get 场景 ID 数组。 每次请求的上限为 100。 参数不支持同时指定 `SceneIds ` 和 `Filters ` 。
void	setFilters(Filter[] Filters) Set 过滤条件。 - scene-id - String - 是否必填：否 -（过滤条件）按照场景 ID 过滤。 - scene-name - String - 是否必填：否 -（过滤条件）按照场景名称过滤。 - created-by - String - 是否必填：否 -（过滤条件）按照场景创建者过滤，目前仅支持 TAT，代表公共场景。 每次请求的 `Filters` 的上限为10， `Filter.Values` 的上限为5。参数不支持同时指定 `SceneIds` 和 `Filters` 。
void	setLimit(Long Limit) Set 返回数量，默认为20，最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
void	setOffset(Long Offset) Set 偏移量，默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
void	setSceneIds(String[] SceneIds) Set 场景 ID 数组。 每次请求的上限为 100。 参数不支持同时指定 `SceneIds ` 和 `Filters ` 。
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeScenesRequest

public DescribeScenesRequest()

DescribeScenesRequest

public DescribeScenesRequest(DescribeScenesRequest 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.

Method Detail

getSceneIds

public String[] getSceneIds()

Get 场景 ID 数组。 每次请求的上限为 100。 参数不支持同时指定 `SceneIds ` 和 `Filters ` 。

Returns:

SceneIds 场景 ID 数组。 每次请求的上限为 100。 参数不支持同时指定 `SceneIds ` 和 `Filters ` 。

setSceneIds

public void setSceneIds(String[] SceneIds)

Set 场景 ID 数组。 每次请求的上限为 100。 参数不支持同时指定 `SceneIds ` 和 `Filters ` 。

Parameters:

SceneIds - 场景 ID 数组。 每次请求的上限为 100。 参数不支持同时指定 `SceneIds ` 和 `Filters ` 。

getFilters

public Filter[] getFilters()

Get 过滤条件。 - scene-id - String - 是否必填：否 -（过滤条件）按照场景 ID 过滤。 - scene-name - String - 是否必填：否 -（过滤条件）按照场景名称过滤。 - created-by - String - 是否必填：否 -（过滤条件）按照场景创建者过滤，目前仅支持 TAT，代表公共场景。 每次请求的 `Filters` 的上限为10， `Filter.Values` 的上限为5。参数不支持同时指定 `SceneIds` 和 `Filters` 。

Returns:

Filters 过滤条件。 - scene-id - String - 是否必填：否 -（过滤条件）按照场景 ID 过滤。 - scene-name - String - 是否必填：否 -（过滤条件）按照场景名称过滤。 - created-by - String - 是否必填：否 -（过滤条件）按照场景创建者过滤，目前仅支持 TAT，代表公共场景。 每次请求的 `Filters` 的上限为10， `Filter.Values` 的上限为5。参数不支持同时指定 `SceneIds` 和 `Filters` 。

setFilters

public void setFilters(Filter[] Filters)

Set 过滤条件。 - scene-id - String - 是否必填：否 -（过滤条件）按照场景 ID 过滤。 - scene-name - String - 是否必填：否 -（过滤条件）按照场景名称过滤。 - created-by - String - 是否必填：否 -（过滤条件）按照场景创建者过滤，目前仅支持 TAT，代表公共场景。 每次请求的 `Filters` 的上限为10， `Filter.Values` 的上限为5。参数不支持同时指定 `SceneIds` 和 `Filters` 。

Parameters:

Filters - 过滤条件。 - scene-id - String - 是否必填：否 -（过滤条件）按照场景 ID 过滤。 - scene-name - String - 是否必填：否 -（过滤条件）按照场景名称过滤。 - created-by - String - 是否必填：否 -（过滤条件）按照场景创建者过滤，目前仅支持 TAT，代表公共场景。 每次请求的 `Filters` 的上限为10， `Filter.Values` 的上限为5。参数不支持同时指定 `SceneIds` 和 `Filters` 。

getLimit

public Long getLimit()

Get 返回数量，默认为20，最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。

Returns:

Limit 返回数量，默认为20，最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。

setLimit

public void setLimit(Long Limit)

Set 返回数量，默认为20，最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。

Parameters:

Limit - 返回数量，默认为20，最大值为100。关于 `Limit` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。

getOffset

public Long getOffset()

Get 偏移量，默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。

Returns:

Offset 偏移量，默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。

setOffset

public void setOffset(Long Offset)

Set 偏移量，默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。

Parameters:

Offset - 偏移量，默认为0。关于 `Offset` 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.