com.tencentcloudapi.gse.v20191112.models

Class PlayerSession

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.gse.v20191112.models.PlayerSession

public class PlayerSession
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
PlayerSession()
PlayerSession(PlayerSession 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	getCreationTime() Get Player session creation time
String	getDnsName() Get ID of the DNS where the game server session is running Note: this field may return null, indicating that no valid values can be obtained.
String	getFleetId() Get Fleet ID
String	getGameServerSessionId() Get Game server session ID.
String	getIpAddress() Get Address of the CVM instance where the game server session is running
String	getPlayerData() Get Player custom data.
String	getPlayerId() Get Player ID.
String	getPlayerSessionId() Get Player session ID
Long	getPort() Get Port number.
String	getStatus() Get Player session status.
String	getTerminationTime() Get Player session termination time Note: this field may return null, indicating that no valid values can be obtained.
void	setCreationTime(String CreationTime) Set Player session creation time
void	setDnsName(String DnsName) Set ID of the DNS where the game server session is running Note: this field may return null, indicating that no valid values can be obtained.
void	setFleetId(String FleetId) Set Fleet ID
void	setGameServerSessionId(String GameServerSessionId) Set Game server session ID.
void	setIpAddress(String IpAddress) Set Address of the CVM instance where the game server session is running
void	setPlayerData(String PlayerData) Set Player custom data.
void	setPlayerId(String PlayerId) Set Player ID.
void	setPlayerSessionId(String PlayerSessionId) Set Player session ID
void	setPort(Long Port) Set Port number.
void	setStatus(String Status) Set Player session status.
void	setTerminationTime(String TerminationTime) Set Player session termination time Note: this field may return null, indicating that no valid values can be obtained.
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

PlayerSession

public PlayerSession()

PlayerSession

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

getCreationTime

public String getCreationTime()

Get Player session creation time

Returns:

CreationTime Player session creation time

setCreationTime

public void setCreationTime(String CreationTime)

Set Player session creation time

Parameters:

CreationTime - Player session creation time

getDnsName

public String getDnsName()

Get ID of the DNS where the game server session is running Note: this field may return null, indicating that no valid values can be obtained.

Returns:

DnsName ID of the DNS where the game server session is running Note: this field may return null, indicating that no valid values can be obtained.

setDnsName

public void setDnsName(String DnsName)

Set ID of the DNS where the game server session is running Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

DnsName - ID of the DNS where the game server session is running Note: this field may return null, indicating that no valid values can be obtained.

getFleetId

public String getFleetId()

Get Fleet ID

Returns:

FleetId Fleet ID

setFleetId

public void setFleetId(String FleetId)

Set Fleet ID

Parameters:

FleetId - Fleet ID

getGameServerSessionId

public String getGameServerSessionId()

Get Game server session ID. It should contain 1 to 256 ASCII characters.

Returns:

GameServerSessionId Game server session ID. It should contain 1 to 256 ASCII characters.

setGameServerSessionId

public void setGameServerSessionId(String GameServerSessionId)

Set Game server session ID. It should contain 1 to 256 ASCII characters.

Parameters:

GameServerSessionId - Game server session ID. It should contain 1 to 256 ASCII characters.

getIpAddress

public String getIpAddress()

Get Address of the CVM instance where the game server session is running

Returns:

IpAddress Address of the CVM instance where the game server session is running

setIpAddress

public void setIpAddress(String IpAddress)

Set Address of the CVM instance where the game server session is running

Parameters:

IpAddress - Address of the CVM instance where the game server session is running

getPlayerData

public String getPlayerData()

Get Player custom data. Up to 2048 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

Returns:

PlayerData Player custom data. Up to 2048 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

setPlayerData

public void setPlayerData(String PlayerData)

Set Player custom data. Up to 2048 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

Parameters:

PlayerData - Player custom data. Up to 2048 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

getPlayerId

public String getPlayerId()

Get Player ID. Up to 1024 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

Returns:

PlayerId Player ID. Up to 1024 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

setPlayerId

public void setPlayerId(String PlayerId)

Set Player ID. Up to 1024 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

Parameters:

PlayerId - Player ID. Up to 1024 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

getPlayerSessionId

public String getPlayerSessionId()

Get Player session ID

Returns:

PlayerSessionId Player session ID

setPlayerSessionId

public void setPlayerSessionId(String PlayerSessionId)

Set Player session ID

Parameters:

PlayerSessionId - Player session ID

getPort

public Long getPort()

Get Port number. It should be a value between 1 to 60000.

Returns:

Port Port number. It should be a value between 1 to 60000.

setPort

public void setPort(Long Port)

Set Port number. It should be a value between 1 to 60000.

Parameters:

Port - Port number. It should be a value between 1 to 60000.

getStatus

public String getStatus()

Get Player session status. Valid values: RESERVED = 1, ACTIVE = 2, COMPLETED =3, TIMEDOUT = 4

Returns:

Status Player session status. Valid values: RESERVED = 1, ACTIVE = 2, COMPLETED =3, TIMEDOUT = 4

setStatus

public void setStatus(String Status)

Set Player session status. Valid values: RESERVED = 1, ACTIVE = 2, COMPLETED =3, TIMEDOUT = 4

Parameters:

Status - Player session status. Valid values: RESERVED = 1, ACTIVE = 2, COMPLETED =3, TIMEDOUT = 4

getTerminationTime

public String getTerminationTime()

Get Player session termination time Note: this field may return null, indicating that no valid values can be obtained.

Returns:

TerminationTime Player session termination time Note: this field may return null, indicating that no valid values can be obtained.

setTerminationTime

public void setTerminationTime(String TerminationTime)

Set Player session termination time Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

TerminationTime - Player session termination time Note: this field may return null, indicating that no valid values can be obtained.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel