File: device_common.proto

package info (click to toggle)
fwupd 2.0.19-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 32,340 kB
  • sloc: ansic: 274,440; python: 11,468; xml: 9,432; sh: 1,625; makefile: 167; cpp: 19; asm: 11; javascript: 9
file content (48 lines) | stat: -rw-r--r-- 1,203 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
/*
 * Copyright 1999-2023 Logitech, Inc.
 * All Rights Reserved
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

syntax = "proto3";

package logi.device.proto;

option java_package = "com.logitech.vc.proto";

/**
 * This error messages describe a failure that was encountered
 * by the Sync service and primarily consist of an error code
 * and a short, human-readable message. Therefore, if a client
 * receives a message with a field reserved for Error messages,
 * it is prudent that the application first check if there are
 * errors before doing any further processing of the message.
 */
message Error
{
	/**
	 * (REQUIRED) Error code.
	 */
	uint32 error_code = 1;

	/**
	 * (OPTIONAL) Short, human-readable error message. If no
	 * message is available, then this will be an empty string.
	 */
	string error_message = 2;

	/**
	 * (OPTIONAL) A URI to a log file or some other document
	 * that contains more detailed information about the error.
	 * If such a file is not available, this will be an empty
	 * string.
	 */
	string error_log_uri = 3;

	/**
	 * (OPTIONAL) An optional JSON string with additional
	 * metadata that may be useful to the client.
	 */
	string json_metadata = 4;
}