com.tencentcloudapi.gse.v20191112.models

Class SearchGameServerSessionsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.gse.v20191112.models.SearchGameServerSessionsRequest

public class SearchGameServerSessionsRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
SearchGameServerSessionsRequest()
SearchGameServerSessionsRequest(SearchGameServerSessionsRequest 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
String	getAliasId() Get Alias ID
String	getFilterExpression() Get Search filter expression.
String	getFleetId() Get Fleet ID
Long	getLimit() Get Maximum number of entries in a single query
String	getNextToken() Get Pagination offset, which is used for querying the next page.
String	getSortExpression() Get Sorting keyword Valid values: gameServerSessionName: game session name in `String` type gameServerSessionId: game session ID in `String` type maximumSessions: maximum number of player sessions in `Number` type creationTimeMillis: creation time in milliseconds in `Number` type playerSessionCount: current number of player sessions in `Number` type
void	setAliasId(String AliasId) Set Alias ID
void	setFilterExpression(String FilterExpression) Set Search filter expression.
void	setFleetId(String FleetId) Set Fleet ID
void	setLimit(Long Limit) Set Maximum number of entries in a single query
void	setNextToken(String NextToken) Set Pagination offset, which is used for querying the next page.
void	setSortExpression(String SortExpression) Set Sorting keyword Valid values: gameServerSessionName: game session name in `String` type gameServerSessionId: game session ID in `String` type maximumSessions: maximum number of player sessions in `Number` type creationTimeMillis: creation time in milliseconds in `Number` type playerSessionCount: current number of player sessions in `Number` type
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchGameServerSessionsRequest

public SearchGameServerSessionsRequest()

SearchGameServerSessionsRequest

public SearchGameServerSessionsRequest(SearchGameServerSessionsRequest 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

getAliasId

public String getAliasId()

Get Alias ID

Returns:

AliasId Alias ID

setAliasId

public void setAliasId(String AliasId)

Set Alias ID

Parameters:

AliasId - Alias ID

getFleetId

public String getFleetId()

Get Fleet ID

Returns:

FleetId Fleet ID

setFleetId

public void setFleetId(String FleetId)

Set Fleet ID

Parameters:

FleetId - Fleet ID

getLimit

public Long getLimit()

Get Maximum number of entries in a single query

Returns:

Limit Maximum number of entries in a single query

setLimit

public void setLimit(Long Limit)

Set Maximum number of entries in a single query

Parameters:

Limit - Maximum number of entries in a single query

getNextToken

public String getNextToken()

Get Pagination offset, which is used for querying the next page. It should contain 1 to 1024 ASCII characters.

Returns:

NextToken Pagination offset, which is used for querying the next page. It should contain 1 to 1024 ASCII characters.

setNextToken

public void setNextToken(String NextToken)

Set Pagination offset, which is used for querying the next page. It should contain 1 to 1024 ASCII characters.

Parameters:

NextToken - Pagination offset, which is used for querying the next page. It should contain 1 to 1024 ASCII characters.

getFilterExpression

public String getFilterExpression()

Get Search filter expression. Valid values: gameServerSessionName: game session name in `String` type gameServerSessionId: game session ID in `String` type maximumSessions: maximum number of player sessions in `Number` type creationTimeMillis: creation time in milliseconds in `Number` type playerSessionCount: current number of player sessions in `Number` type hasAvailablePlayerSessions: whether there is available player session in `String` type. Valid values: true, false gameServerSessionProperties: game session attributes in `String` type Expressions in `String` type support = and <> for judgment Expressions in `Number` type support =, <>, >, >=, <, and <= for judgment Example: If FilterExpression takes the value: playerSessionCount>=2 AND hasAvailablePlayerSessions=true" It means searching for game sessions that have at least two players and have player sessions available. If FilterExpression takes the value: gameServerSessionProperties.K1 = 'V1' AND gameServerSessionProperties.K2 = 'V2' OR gameServerSessionProperties.K3 = 'V3' it means searching for game sessions that meets the following game server session attributes { "GameProperties":[ { "Key":"K1", "Value":"V1" }, { "Key":"K2", "Value":"V2" }, { "Key":"K3", "Value":"V3" } ] }

Returns:

FilterExpression Search filter expression. Valid values: gameServerSessionName: game session name in `String` type gameServerSessionId: game session ID in `String` type maximumSessions: maximum number of player sessions in `Number` type creationTimeMillis: creation time in milliseconds in `Number` type playerSessionCount: current number of player sessions in `Number` type hasAvailablePlayerSessions: whether there is available player session in `String` type. Valid values: true, false gameServerSessionProperties: game session attributes in `String` type Expressions in `String` type support = and <> for judgment Expressions in `Number` type support =, <>, >, >=, <, and <= for judgment Example: If FilterExpression takes the value: playerSessionCount>=2 AND hasAvailablePlayerSessions=true" It means searching for game sessions that have at least two players and have player sessions available. If FilterExpression takes the value: gameServerSessionProperties.K1 = 'V1' AND gameServerSessionProperties.K2 = 'V2' OR gameServerSessionProperties.K3 = 'V3' it means searching for game sessions that meets the following game server session attributes { "GameProperties":[ { "Key":"K1", "Value":"V1" }, { "Key":"K2", "Value":"V2" }, { "Key":"K3", "Value":"V3" } ] }

setFilterExpression

public void setFilterExpression(String FilterExpression)

Set Search filter expression. Valid values: gameServerSessionName: game session name in `String` type gameServerSessionId: game session ID in `String` type maximumSessions: maximum number of player sessions in `Number` type creationTimeMillis: creation time in milliseconds in `Number` type playerSessionCount: current number of player sessions in `Number` type hasAvailablePlayerSessions: whether there is available player session in `String` type. Valid values: true, false gameServerSessionProperties: game session attributes in `String` type Expressions in `String` type support = and <> for judgment Expressions in `Number` type support =, <>, >, >=, <, and <= for judgment Example: If FilterExpression takes the value: playerSessionCount>=2 AND hasAvailablePlayerSessions=true" It means searching for game sessions that have at least two players and have player sessions available. If FilterExpression takes the value: gameServerSessionProperties.K1 = 'V1' AND gameServerSessionProperties.K2 = 'V2' OR gameServerSessionProperties.K3 = 'V3' it means searching for game sessions that meets the following game server session attributes { "GameProperties":[ { "Key":"K1", "Value":"V1" }, { "Key":"K2", "Value":"V2" }, { "Key":"K3", "Value":"V3" } ] }

Parameters:

FilterExpression - Search filter expression. Valid values: gameServerSessionName: game session name in `String` type gameServerSessionId: game session ID in `String` type maximumSessions: maximum number of player sessions in `Number` type creationTimeMillis: creation time in milliseconds in `Number` type playerSessionCount: current number of player sessions in `Number` type hasAvailablePlayerSessions: whether there is available player session in `String` type. Valid values: true, false gameServerSessionProperties: game session attributes in `String` type Expressions in `String` type support = and <> for judgment Expressions in `Number` type support =, <>, >, >=, <, and <= for judgment Example: If FilterExpression takes the value: playerSessionCount>=2 AND hasAvailablePlayerSessions=true" It means searching for game sessions that have at least two players and have player sessions available. If FilterExpression takes the value: gameServerSessionProperties.K1 = 'V1' AND gameServerSessionProperties.K2 = 'V2' OR gameServerSessionProperties.K3 = 'V3' it means searching for game sessions that meets the following game server session attributes { "GameProperties":[ { "Key":"K1", "Value":"V1" }, { "Key":"K2", "Value":"V2" }, { "Key":"K3", "Value":"V3" } ] }

getSortExpression

public String getSortExpression()

Get Sorting keyword Valid values: gameServerSessionName: game session name in `String` type gameServerSessionId: game session ID in `String` type maximumSessions: maximum number of player sessions in `Number` type creationTimeMillis: creation time in milliseconds in `Number` type playerSessionCount: current number of player sessions in `Number` type

Returns:

SortExpression Sorting keyword Valid values: gameServerSessionName: game session name in `String` type gameServerSessionId: game session ID in `String` type maximumSessions: maximum number of player sessions in `Number` type creationTimeMillis: creation time in milliseconds in `Number` type playerSessionCount: current number of player sessions in `Number` type

setSortExpression

public void setSortExpression(String SortExpression)

Set Sorting keyword Valid values: gameServerSessionName: game session name in `String` type gameServerSessionId: game session ID in `String` type maximumSessions: maximum number of player sessions in `Number` type creationTimeMillis: creation time in milliseconds in `Number` type playerSessionCount: current number of player sessions in `Number` type

Parameters:

SortExpression - Sorting keyword Valid values: gameServerSessionName: game session name in `String` type gameServerSessionId: game session ID in `String` type maximumSessions: maximum number of player sessions in `Number` type creationTimeMillis: creation time in milliseconds in `Number` type playerSessionCount: current number of player sessions in `Number` type

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel