Google Cloud Device Streaming V1 Client - Class DeviceSession (0.1.1)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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`	`Google\Protobuf\Timestamp` Output only. The time that the Session was created.
`↳ active_start_time`	`Google\Protobuf\Timestamp` Output only. The timestamp that the session first became ACTIVE.
`↳ android_device`	`AndroidDevice` Required. The requested device

getName

Optional. Name of the DeviceSession, e.g.

"projects/{project_id}/deviceSessions/{session_id}"

Returns
Type	Description
`string`

setName

Optional. Name of the DeviceSession, e.g.

"projects/{project_id}/deviceSessions/{session_id}"

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Output only. The title of the DeviceSession to be presented in the UI.

Returns
Type	Description
`string`

setDisplayName

Output only. The title of the DeviceSession to be presented in the UI.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getState

Output only. Current state of the DeviceSession.

Returns
Type	Description
`int`

setState

Output only. Current state of the DeviceSession.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getStateHistories

Output only. The historical state transitions of the session_state message including the current session state.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setStateHistories

Output only. The historical state transitions of the session_state message including the current session state.

Parameter
Name	Description
`var`	`array<DeviceSession\SessionStateEvent>`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Protobuf\Duration\|null`

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.

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

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.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getInactivityTimeout

Output only. The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasInactivityTimeout

clearInactivityTimeout

setInactivityTimeout

Output only. The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY.

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`

getCreateTime

Output only. The time that the Session was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime