Reference documentation and code samples for the Google Cloud Device Streaming V1 Client class SessionState.
The state that the DeviceSession resides.
Protobuf type google.cloud.devicestreaming.v1.DeviceSession.SessionState
Namespace
Google \ Cloud \ DeviceStreaming \ V1 \ DeviceSession
Methods
static::name
Parameter
Name
Description
value
mixed
static::value
Parameter
Name
Description
name
mixed
Constants
SESSION_STATE_UNSPECIFIED
Value: 0
Default value. This value is unused.
Generated from protobuf enum SESSION_STATE_UNSPECIFIED = 0;
REQUESTED
Value: 1
Initial state of a session request. The session is being validated for
correctness and a device is not yet requested.
Generated from protobuf enum REQUESTED = 1;
PENDING
Value: 2
The session has been validated and is in the queue for a device.
Generated from protobuf enum PENDING = 2;
ACTIVE
Value: 3
The session has been granted and the device is accepting
connections.
Generated from protobuf enum ACTIVE = 3;
EXPIRED
Value: 4
The session duration exceeded the device's reservation time period and
timed out automatically.
Generated from protobuf enum EXPIRED = 4;
FINISHED
Value: 5
The user is finished with the session and it was canceled by the user
while the request was still getting allocated or after allocation and
during device usage period.
Generated from protobuf enum FINISHED = 5;
UNAVAILABLE
Value: 6
Unable to complete the session because the device was unavailable and
it failed to allocate through the scheduler. For example, a device not
in the catalog was requested or the request expired in the allocation
queue.
Generated from protobuf enum UNAVAILABLE = 6;
ERROR
Value: 7
Unable to complete the session for an internal reason, such as an
infrastructure failure.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Device Streaming V1 Client - Class SessionState (0.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.1.1 (latest)](/php/docs/reference/cloud-devicestreaming/latest/V1.DeviceSession.SessionState)\n- [0.1.0](/php/docs/reference/cloud-devicestreaming/0.1.0/V1.DeviceSession.SessionState) \nReference documentation and code samples for the Google Cloud Device Streaming V1 Client class SessionState.\n\nThe state that the DeviceSession resides.\n\nProtobuf type `google.cloud.devicestreaming.v1.DeviceSession.SessionState`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DeviceStreaming \\\\ V1 \\\\ DeviceSession\n\nMethods\n-------\n\n### static::name\n\n### static::value\n\nConstants\n---------\n\n### SESSION_STATE_UNSPECIFIED\n\n Value: 0\n\nDefault value. This value is unused.\n\nGenerated from protobuf enum `SESSION_STATE_UNSPECIFIED = 0;`\n\n### REQUESTED\n\n Value: 1\n\nInitial state of a session request. The session is being validated for\ncorrectness and a device is not yet requested.\n\nGenerated from protobuf enum `REQUESTED = 1;`\n\n### PENDING\n\n Value: 2\n\nThe session has been validated and is in the queue for a device.\n\nGenerated from protobuf enum `PENDING = 2;`\n\n### ACTIVE\n\n Value: 3\n\nThe session has been granted and the device is accepting\nconnections.\n\nGenerated from protobuf enum `ACTIVE = 3;`\n\n### EXPIRED\n\n Value: 4\n\nThe session duration exceeded the device's reservation time period and\ntimed out automatically.\n\nGenerated from protobuf enum `EXPIRED = 4;`\n\n### FINISHED\n\n Value: 5\n\nThe user is finished with the session and it was canceled by the user\nwhile the request was still getting allocated or after allocation and\nduring device usage period.\n\nGenerated from protobuf enum `FINISHED = 5;`\n\n### UNAVAILABLE\n\n Value: 6\n\nUnable to complete the session because the device was unavailable and\nit failed to allocate through the scheduler. For example, a device not\nin the catalog was requested or the request expired in the allocation\nqueue.\n\nGenerated from protobuf enum `UNAVAILABLE = 6;`\n\n### ERROR\n\n Value: 7\n\nUnable to complete the session for an internal reason, such as an\ninfrastructure failure.\n\nGenerated from protobuf enum `ERROR = 7;`"]]
