Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13108877.2 KB
projects

PATCH /v1/projects/{projectId}/deviceSessions/deviceSessionId}:updateDeviceSession Updates the current device session to the fields described by the update_mask.

patch/v1/{+name}

Path parameters

namestring required

Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"

Query parameters

updateMaskstring

Required. The list of fields to update.

Request body

ttlstring google-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.

displayNamestring

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

inactivityTimeoutstring google-duration

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

createTimestring google-datetime

Output only. The time that the Session was created.

activeStartTimestring google-datetime

Output only. The timestamp that the session first became ACTIVE.

state'SESSION_STATE_UNSPECIFIED' | 'REQUESTED' | 'PENDING' | 'ACTIVE' | 'EXPIRED' | 'FINISHED' | 'UNAVAILABLE' | 'ERROR'

Output only. Current state of the DeviceSession.

expireTimestring google-datetime

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.

namestring

Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}"

Response

Successful response