Reference documentation and code samples for the Google Cloud Device Streaming V1 Client class DeviceSession.
Protobuf message describing the device message, used from several RPCs.
Generated from protobuf message google.cloud.devicestreaming.v1.DeviceSession
Namespace
Google \ Cloud \ DeviceStreaming \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"
↳ display_name
string
Output only. The title of the DeviceSession to be presented in the UI.
↳ state
int
Output only. Current state of the DeviceSession.
↳ state_histories
array< DeviceSession\SessionStateEvent
>
Output only. The historical state transitions of the session_state message including the current session state.
↳ ttl
Google\Protobuf\Duration
Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 15 minutes.
↳ expire_time
Google\Protobuf\Timestamp
Optional. If the device is still in use at this time, any connections will be ended and the SessionState will transition from ACTIVE to FINISHED.
↳ inactivity_timeout
Google\Protobuf\Duration
Output only. The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.
↳ create_time
↳ active_start_time
↳ android_device
getName
Optional. Name of the DeviceSession, e.g.
"projects/{project_id}/deviceSessions/{session_id}"
string
setName
Optional. Name of the DeviceSession, e.g.
"projects/{project_id}/deviceSessions/{session_id}"
var
string
$this
getDisplayName
Output only. The title of the DeviceSession to be presented in the UI.
string
setDisplayName
Output only. The title of the DeviceSession to be presented in the UI.
var
string
$this
getState
Output only. Current state of the DeviceSession.
int
setState
Output only. Current state of the DeviceSession.
var
int
$this
getStateHistories
Output only. The historical state transitions of the session_state message including the current session state.
setStateHistories
Output only. The historical state transitions of the session_state message including the current session state.
$this
getTtl
Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC.
Default: 15 minutes.
hasTtl
setTtl
Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC.
Default: 15 minutes.
$this
getExpireTime
Optional. If the device is still in use at this time, any connections will be ended and the SessionState will transition from ACTIVE to FINISHED.
hasExpireTime
setExpireTime
Optional. If the device is still in use at this time, any connections will be ended and the SessionState will transition from ACTIVE to FINISHED.
$this
getInactivityTimeout
Output only. The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.
hasInactivityTimeout
clearInactivityTimeout
setInactivityTimeout
Output only. The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.
$this
getCreateTime
Output only. The time that the Session was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time that the Session was created.
$this
getActiveStartTime
Output only. The timestamp that the session first became ACTIVE.
hasActiveStartTime
clearActiveStartTime
setActiveStartTime
Output only. The timestamp that the session first became ACTIVE.
$this
getAndroidDevice
Required. The requested device
hasAndroidDevice
clearAndroidDevice
setAndroidDevice
Required. The requested device
$this
getExpiration
string
