REST Resource: projects.deviceSessions

Tài nguyên: DeviceSession

Thông báo Protobuf mô tả thông báo trên thiết bị, được dùng trong một số RPC.

Biểu diễn dưới dạng 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.
}
Trường
name

string

Không bắt buộc. Tên của DeviceSession, ví dụ: "projects/{projectId}/deviceSessions/{session_id}"

displayName

string

Chỉ có đầu ra. Tiêu đề của DeviceSession xuất hiện trong giao diện người dùng.

state

enum (SessionState)

Chỉ có đầu ra. Trạng thái hiện tại của DeviceSession.

stateHistories[]

object (SessionStateEvent)

Chỉ có đầu ra. Trạng thái chuyển đổi trước đây của thông báo sessionState bao gồm cả trạng thái phiên hiện tại.

inactivityTimeout

string (Duration format)

Chỉ có đầu ra. Khoảng thời gian mà thiết bị này phải được tương tác trước khi chuyển đổi từ ACTIVE sang TIMEOUT_INACTIVITY.

Thời lượng tính bằng giây với tối đa 9 chữ số phân số, kết thúc bằng "s". Ví dụ: "3.5s".

createTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian tạo Phiên.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

activeStartTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian mà phiên đầu tiên bắt đầu HOẠT ĐỘNG.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

androidDevice

object (AndroidDevice)

Bắt buộc. Thiết bị được yêu cầu

Trường kết hợp expiration.

expiration chỉ có thể là một trong những trạng thái sau đây:

ttl

string (Duration format)

Không bắt buộc. Khoảng thời gian mà một thiết bị sẽ được phân bổ ban đầu. Cuối cùng, bạn có thể mở rộng quá trình này bằng deviceSessions.patch RPC. Mặc định: 15 phút.

Thời lượng tính bằng giây với tối đa 9 chữ số phân số, kết thúc bằng "s". Ví dụ: "3.5s".

expireTime

string (Timestamp format)

Không bắt buộc. Nếu thiết bị vẫn đang được sử dụng vào thời điểm này, mọi kết nối sẽ bị kết thúc và SessionState sẽ chuyển từ trạng thái ACTIVE sang COMPLETEDED.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

Trạng thái phiên

Trạng thái của phiên thiết bị.

Enum
SESSION_STATE_UNSPECIFIED Giá trị mặc định. Giá trị này chưa được sử dụng.
REQUESTED Trạng thái ban đầu của yêu cầu phiên. Phiên này đang được xác thực để đảm bảo tính chính xác và chưa yêu cầu thiết bị.
PENDING Phiên này đã được xác thực và đang nằm trong hàng đợi cho một thiết bị.
ACTIVE Phiên đã được cấp và thiết bị đang chấp nhận kết nối.
EXPIRED Thời lượng phiên vượt quá khoảng thời gian đặt trước của thiết bị và hết thời gian tự động.
FINISHED Người dùng kết thúc phiên và phiên đó đã bị người dùng huỷ trong khi yêu cầu vẫn đang được phân bổ hoặc sau khi phân bổ và trong kỳ sử dụng thiết bị.
UNAVAILABLE Không thể hoàn tất phiên vì thiết bị không hoạt động và không thể phân bổ thông qua trình lập lịch biểu. Ví dụ: Một thiết bị không có trong danh mục được yêu cầu hoặc yêu cầu đó đã hết hạn trong hàng đợi phân bổ.
ERROR Không thể hoàn tất phiên vì lý do nội bộ, chẳng hạn như lỗi cơ sở hạ tầng.

Sự kiện trạng thái phiên

Một thông báo tóm tắt một loạt trạng thái của Phiên và thời gian mà DeviceSession nhập các trạng thái đó lần đầu tiên.

Biểu diễn dưới dạng JSON
{
  "sessionState": enum (SessionState),
  "eventTime": string,
  "stateMessage": string
}
Trường
sessionState

enum (SessionState)

Chỉ có đầu ra. Trạng thái phiên mà sự kiện này theo dõi

eventTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian mà sessionState lần đầu gặp trạng thái đó.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

stateMessage

string

Chỉ có đầu ra. Thông báo mà con người có thể đọc được để giải thích trạng thái.

Phương thức

cancel

POST /v1/projects/{project_id}/deviceSessions/{device_session_id}:huỷ Thay đổi DeviceSession thành trạng thái tan cùng và chấm dứt tất cả các kết nối.

create

POST /v1/projects/{project_id}/deviceSessions

get

GET /v1/projects/{project_id}/deviceSessions/{device_session_id} Trả về một DeviceSession, cho biết trạng thái phân bổ và việc thiết bị có được phân bổ hay không.

list

GET /v1/projects/{project_id}/deviceSessions liệt kê các Phiên trên thiết bị do người dùng dự án sở hữu.

patch

PATCH /v1/projects/{projectId}/deviceSessions/deviceSessionId}:updateDeviceSession Cập nhật phiên hoạt động hiện tại trên thiết bị vào các trường mà update_mask mô tả.