REST Resource: projects.deviceSessions

Resource: DeviceSession

Protobuf message describing the device message, used from several RPCs.

JSON representation 
{
  "name": string,
  "displayName": string,
  "state": enum (SessionState),
  "stateHistories": [
    {
      object (SessionStateEvent)
    }
  ],
  "inactivityTimeout": string,
  "createTime": string,
  "activeStartTime": string,
  "androidDevice": {
    object (AndroidDevice)
  },

  // Union field expiration can be only one of the following:
  "ttl": string,
  "expireTime": string
  // End of list of possible types for union field expiration.
}
Fields
name

string

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

string

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

enum (SessionState)

Output only. Current state of the DeviceSession.
stateHistories[]

object (SessionStateEvent)

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

string (Duration format)

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

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
createTime

string (Timestamp format)

Output only. The time that the Session was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
activeStartTime

string (Timestamp format)

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

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
androidDevice

object (AndroidDevice)

Required. The requested device
Union field expiration. The amount of time that a device will be initially allocated for. expiration can be only one of the following:
ttl

string (Duration format)

Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the deviceSessions.patch RPC. Default: 15 minutes.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
expireTime

string (Timestamp format)

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.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

SessionState

The state that the DeviceSession resides.

Enums
SESSION_STATE_UNSPECIFIED Default value. This value is unused.
REQUESTED Initial state of a session request. The session is being validated for correctness and a device is not yet requested.
PENDING The session has been validated and is in the queue for a device.
ACTIVE The session has been granted and the device is accepting connections.
EXPIRED The session duration exceeded the device's reservation time period and timed out automatically.
FINISHED 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.
UNAVAILABLE 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.
ERROR Unable to complete the session for an internal reason, such as an infrastructure failure.

SessionStateEvent

A message encapsulating a series of Session states and the time that the DeviceSession first entered those states.

JSON representation 
{
  "sessionState": enum (SessionState),
  "eventTime": string,
  "stateMessage": string
}
Fields
sessionState

enum (SessionState)

Output only. The sessionState tracked by this event
eventTime

string (Timestamp format)

Output only. The time that the sessionState first encountered that state.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
stateMessage

string

Output only. A human-readable message to explain the state.

AndroidDevice

A single Android device.

JSON representation 
{
  "androidModelId": string,
  "androidVersionId": string,
  "locale": string,
  "orientation": string
}
Fields
androidModelId

string

Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.
androidVersionId

string

Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.
locale

string

Optional. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.
orientation

string

Optional. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.

Methods

cancel

 Cancel a DeviceSession.

create

 Creates a DeviceSession.

get

 Gets a DeviceSession, which documents the allocation status and whether the device is allocated.

list

 Lists DeviceSessions owned by the project user.

patch

 Updates the current DeviceSession to the fields described by the update_mask.