com.tencentcloudapi.gse.v20191112.models

Class GameServerSession

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.gse.v20191112.models.GameServerSession

public class GameServerSession
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
GameServerSession()
GameServerSession(GameServerSession 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	getAvailabilityStatus() Get Session availability status, i.e., whether it is blocked.
String	getCreationTime() Get Game server session creation time
String	getCreatorId() Get Creator ID.
Long	getCurrentCustomCount() Get Current custom count Note: this field may return null, indicating that no valid values can be obtained.
Long	getCurrentPlayerSessionCount() Get The current number of players, which cannot be less than 0.
String	getDnsName() Get CVM DNS ID Note: this field may return null, indicating that no valid values can be obtained.
String	getFleetId() Get Fleet ID
GameProperty[]	getGameProperties() Get Game attributes.
String	getGameServerSessionData() Get The attribute details of game server session.
String	getGameServerSessionId() Get Game server session ID.
String	getInstanceType() Get Instance type.
String	getIpAddress() Get CVM IP address
String	getMatchmakerData() Get Battle progress details.
Long	getMaxCustomCount() Get Maximum custom count Note: this field may return null, indicating that no valid values can be obtained.
Long	getMaximumPlayerSessionCount() Get The maximum number of players, which cannot be less than 0.
String	getName() Get The name of game server session.
String	getPlayerSessionCreationPolicy() Get Player session creation policy.
Long	getPort() Get Port number.
String	getStatus() Get Game server session status.
String	getStatusReason() Get Additional information of game server session status Note: this field may return null, indicating that no valid values can be obtained.
String	getTerminationTime() Get Termination time Note: this field may return null, indicating that no valid values can be obtained.
Long	getWeight() Get Weight Note: this field may return null, indicating that no valid values can be obtained.
void	setAvailabilityStatus(String AvailabilityStatus) Set Session availability status, i.e., whether it is blocked.
void	setCreationTime(String CreationTime) Set Game server session creation time
void	setCreatorId(String CreatorId) Set Creator ID.
void	setCurrentCustomCount(Long CurrentCustomCount) Set Current custom count Note: this field may return null, indicating that no valid values can be obtained.
void	setCurrentPlayerSessionCount(Long CurrentPlayerSessionCount) Set The current number of players, which cannot be less than 0.
void	setDnsName(String DnsName) Set CVM DNS ID Note: this field may return null, indicating that no valid values can be obtained.
void	setFleetId(String FleetId) Set Fleet ID
void	setGameProperties(GameProperty[] GameProperties) Set Game attributes.
void	setGameServerSessionData(String GameServerSessionData) Set The attribute details of game server session.
void	setGameServerSessionId(String GameServerSessionId) Set Game server session ID.
void	setInstanceType(String InstanceType) Set Instance type.
void	setIpAddress(String IpAddress) Set CVM IP address
void	setMatchmakerData(String MatchmakerData) Set Battle progress details.
void	setMaxCustomCount(Long MaxCustomCount) Set Maximum custom count Note: this field may return null, indicating that no valid values can be obtained.
void	setMaximumPlayerSessionCount(Long MaximumPlayerSessionCount) Set The maximum number of players, which cannot be less than 0.
void	setName(String Name) Set The name of game server session.
void	setPlayerSessionCreationPolicy(String PlayerSessionCreationPolicy) Set Player session creation policy.
void	setPort(Long Port) Set Port number.
void	setStatus(String Status) Set Game server session status.
void	setStatusReason(String StatusReason) Set Additional information of game server session status Note: this field may return null, indicating that no valid values can be obtained.
void	setTerminationTime(String TerminationTime) Set Termination time Note: this field may return null, indicating that no valid values can be obtained.
void	setWeight(Long Weight) Set Weight 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

GameServerSession

public GameServerSession()

GameServerSession

public GameServerSession(GameServerSession 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 Game server session creation time

Returns:

CreationTime Game server session creation time

setCreationTime

public void setCreationTime(String CreationTime)

Set Game server session creation time

Parameters:

CreationTime - Game server session creation time

getCreatorId

public String getCreatorId()

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

Returns:

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

setCreatorId

public void setCreatorId(String CreatorId)

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

Parameters:

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

getCurrentPlayerSessionCount

public Long getCurrentPlayerSessionCount()

Get The current number of players, which cannot be less than 0.

Returns:

CurrentPlayerSessionCount The current number of players, which cannot be less than 0.

setCurrentPlayerSessionCount

public void setCurrentPlayerSessionCount(Long CurrentPlayerSessionCount)

Set The current number of players, which cannot be less than 0.

Parameters:

CurrentPlayerSessionCount - The current number of players, which cannot be less than 0.

getDnsName

public String getDnsName()

Get CVM DNS ID Note: this field may return null, indicating that no valid values can be obtained.

Returns:

DnsName CVM DNS ID Note: this field may return null, indicating that no valid values can be obtained.

setDnsName

public void setDnsName(String DnsName)

Set CVM DNS ID Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

DnsName - CVM DNS ID 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

getGameProperties

public GameProperty[] getGameProperties()

Get Game attributes. Up to 16 groups of attributes are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

Returns:

GameProperties Game attributes. Up to 16 groups of attributes are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

setGameProperties

public void setGameProperties(GameProperty[] GameProperties)

Set Game attributes. Up to 16 groups of attributes are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

Parameters:

GameProperties - Game attributes. Up to 16 groups of attributes are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

getGameServerSessionData

public String getGameServerSessionData()

Get The attribute details of game server session. Up to 4096 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

Returns:

GameServerSessionData The attribute details of game server session. Up to 4096 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

setGameServerSessionData

public void setGameServerSessionData(String GameServerSessionData)

Set The attribute details of game server session. Up to 4096 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

Parameters:

GameServerSessionData - The attribute details of game server session. Up to 4096 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

getGameServerSessionId

public String getGameServerSessionId()

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

Returns:

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

setGameServerSessionId

public void setGameServerSessionId(String GameServerSessionId)

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

Parameters:

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

getIpAddress

public String getIpAddress()

Get CVM IP address

Returns:

IpAddress CVM IP address

setIpAddress

public void setIpAddress(String IpAddress)

Set CVM IP address

Parameters:

IpAddress - CVM IP address

getMatchmakerData

public String getMatchmakerData()

Get Battle progress details. Up to 400,000 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

Returns:

MatchmakerData Battle progress details. Up to 400,000 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

setMatchmakerData

public void setMatchmakerData(String MatchmakerData)

Set Battle progress details. Up to 400,000 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

Parameters:

MatchmakerData - Battle progress details. Up to 400,000 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

getMaximumPlayerSessionCount

public Long getMaximumPlayerSessionCount()

Get The maximum number of players, which cannot be less than 0.

Returns:

MaximumPlayerSessionCount The maximum number of players, which cannot be less than 0.

setMaximumPlayerSessionCount

public void setMaximumPlayerSessionCount(Long MaximumPlayerSessionCount)

Set The maximum number of players, which cannot be less than 0.

Parameters:

MaximumPlayerSessionCount - The maximum number of players, which cannot be less than 0.

getName

public String getName()

Get The name of game server session. Up to 1024 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

Returns:

Name The name of game server session. Up to 1024 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

setName

public void setName(String Name)

Set The name of game server session. Up to 1024 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

Parameters:

Name - The name of game server session. Up to 1024 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

getPlayerSessionCreationPolicy

public String getPlayerSessionCreationPolicy()

Get Player session creation policy. Valid values: ACCEPT_ALL, DENY_ALL Note: this field may return `null`, indicating that no valid value is obtained.

Returns:

PlayerSessionCreationPolicy Player session creation policy. Valid values: ACCEPT_ALL, DENY_ALL Note: this field may return `null`, indicating that no valid value is obtained.

setPlayerSessionCreationPolicy

public void setPlayerSessionCreationPolicy(String PlayerSessionCreationPolicy)

Set Player session creation policy. Valid values: ACCEPT_ALL, DENY_ALL Note: this field may return `null`, indicating that no valid value is obtained.

Parameters:

PlayerSessionCreationPolicy - Player session creation policy. Valid values: ACCEPT_ALL, DENY_ALL Note: this field may return `null`, indicating that no valid value is obtained.

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 Game server session status. Valid values: ACTIVE, ACTIVATING, TERMINATED, TERMINATING, ERROR

Returns:

Status Game server session status. Valid values: ACTIVE, ACTIVATING, TERMINATED, TERMINATING, ERROR

setStatus

public void setStatus(String Status)

Set Game server session status. Valid values: ACTIVE, ACTIVATING, TERMINATED, TERMINATING, ERROR

Parameters:

Status - Game server session status. Valid values: ACTIVE, ACTIVATING, TERMINATED, TERMINATING, ERROR

getStatusReason

public String getStatusReason()

Get Additional information of game server session status Note: this field may return null, indicating that no valid values can be obtained.

Returns:

StatusReason Additional information of game server session status Note: this field may return null, indicating that no valid values can be obtained.

setStatusReason

public void setStatusReason(String StatusReason)

Set Additional information of game server session status Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

StatusReason - Additional information of game server session status Note: this field may return null, indicating that no valid values can be obtained.

getTerminationTime

public String getTerminationTime()

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

Returns:

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

setTerminationTime

public void setTerminationTime(String TerminationTime)

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

Parameters:

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

getInstanceType

public String getInstanceType()

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

Returns:

InstanceType Instance type. Up to 128 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

setInstanceType

public void setInstanceType(String InstanceType)

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

Parameters:

InstanceType - Instance type. Up to 128 ASCII characters are allowed. Note: this field may return `null`, indicating that no valid value is obtained.

getCurrentCustomCount

public Long getCurrentCustomCount()

Get Current custom count Note: this field may return null, indicating that no valid values can be obtained.

Returns:

CurrentCustomCount Current custom count Note: this field may return null, indicating that no valid values can be obtained.

setCurrentCustomCount

public void setCurrentCustomCount(Long CurrentCustomCount)

Set Current custom count Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

CurrentCustomCount - Current custom count Note: this field may return null, indicating that no valid values can be obtained.

getMaxCustomCount

public Long getMaxCustomCount()

Get Maximum custom count Note: this field may return null, indicating that no valid values can be obtained.

Returns:

MaxCustomCount Maximum custom count Note: this field may return null, indicating that no valid values can be obtained.

setMaxCustomCount

public void setMaxCustomCount(Long MaxCustomCount)

Set Maximum custom count Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

MaxCustomCount - Maximum custom count Note: this field may return null, indicating that no valid values can be obtained.

getWeight

public Long getWeight()

Get Weight Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Weight Weight Note: this field may return null, indicating that no valid values can be obtained.

setWeight

public void setWeight(Long Weight)

Set Weight Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Weight - Weight Note: this field may return null, indicating that no valid values can be obtained.

getAvailabilityStatus

public String getAvailabilityStatus()

Get Session availability status, i.e., whether it is blocked. Valid value: Enable, Disable Note: this field may return `null`, indicating that no valid value is obtained.

Returns:

AvailabilityStatus Session availability status, i.e., whether it is blocked. Valid value: Enable, Disable Note: this field may return `null`, indicating that no valid value is obtained.

setAvailabilityStatus

public void setAvailabilityStatus(String AvailabilityStatus)

Set Session availability status, i.e., whether it is blocked. Valid value: Enable, Disable Note: this field may return `null`, indicating that no valid value is obtained.

Parameters:

AvailabilityStatus - Session availability status, i.e., whether it is blocked. Valid value: Enable, Disable Note: this field may return `null`, indicating that no valid value is 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