REST Resource: projects.deviceSessions

Recurso: DeviceSession

Mensagem do protobuf que descreve a mensagem do dispositivo, usada a partir de vários RPCs.

Representação JSON 
{
  "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.
}
Campos
name

string

Opcional. Nome da DeviceSession, por exemplo, "projects/{projectId}/deviceSessions/{session_id}"
displayName

string

Apenas saída. O título da DeviceSession a ser apresentada na interface.
state

enum (SessionState)

Apenas saída. Estado atual da DeviceSession.
stateHistories[]

object (SessionStateEvent)

Apenas saída. As transições de estado histórico da mensagem sessionState, incluindo o estado atual da sessão.
inactivityTimeout

string (Duration format)

Apenas saída. O intervalo de tempo em que o dispositivo precisa interagir antes de fazer a transição de ACTIVE para TIMEOUT_INACTIVITY.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
createTime

string (Timestamp format)

Apenas saída. A hora em que a sessão foi criada.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
activeStartTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que a sessão se tornou ACTIVE pela primeira vez.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
androidDevice

object (AndroidDevice)

Obrigatório. O dispositivo solicitado

Campo de união expiration.

expiration pode ser apenas de um dos tipos a seguir:
ttl

string (Duration format)

Opcional. O tempo inicialmente alocado para um dispositivo. Isso pode ser estendido com a RPC deviceSessions.patch. Padrão: 15 minutos.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
expireTime

string (Timestamp format)

Opcional. Se o dispositivo ainda estiver em uso, todas as conexões serão encerradas, e o SessionState fará a transição de ACTIVE para FINISHED.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Estado da sessão

O estado em que a sessão do dispositivo reside.

Enums
SESSION_STATE_UNSPECIFIED Valor padrão. Esse valor não é usado.
REQUESTED Estado inicial de uma solicitação de sessão. A sessão está sendo validada quanto à correção, e um dispositivo ainda não foi solicitado.
PENDING A sessão foi validada e está na fila de um dispositivo.
ACTIVE A sessão foi concedida e o dispositivo está aceitando conexões.
EXPIRED A duração da sessão excedeu o período de reserva do dispositivo e expirou automaticamente.
FINISHED O usuário terminou a sessão e ela foi cancelada enquanto a solicitação ainda estava sendo alocada ou após a alocação e durante o período de uso do dispositivo.
UNAVAILABLE Não foi possível concluir a sessão porque o dispositivo não estava disponível nem foi alocado pelo programador. Por exemplo, um dispositivo que não está no catálogo foi solicitado ou a solicitação expirou na fila de alocação.
ERROR Não foi possível concluir a sessão por um motivo interno, como uma falha na infraestrutura.

SessionStateEvent

Uma mensagem encapsulando uma série de estados de sessão e o horário em que o DeviceSession entrou pela primeira vez nesses estados.

Representação JSON 
{
  "sessionState": enum (SessionState),
  "eventTime": string,
  "stateMessage": string
}
Campos
sessionState

enum (SessionState)

Apenas saída. O sessionState acompanhado por esse evento.
eventTime

string (Timestamp format)

Apenas saída. A hora em que o sessionState encontrou esse estado pela primeira vez.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
stateMessage

string

Apenas saída. Uma mensagem legível para explicar o estado.

Métodos

cancel

 POST /v1/projects/{project_id}/deviceSessions/{device_session_id}:cancel muda a DeviceSession para o estado FINISHED e encerra todas as conexões.

create

 POSTAR /v1/projects/{project_id}/deviceSessions

get

 GET /v1/projects/{project_id}/deviceSessions/{device_session_id} retorna uma DeviceSession, que documenta o status da alocação e se o dispositivo está alocado.

list

 GET /v1/projects/{project_id}/deviceSessions lista as sessões do dispositivo que pertencem ao usuário do projeto.

patch

 PATCH /v1/projects/{projectId}/deviceSessions/deviceSessionId}:updateDeviceSession Atualiza a sessão atual do dispositivo para os campos descritos pela update_mask.