File: admin_directory_v1.customer.devices.chromeos.commands.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (121 lines) | stat: -rw-r--r-- 4,448 bytes parent folder | download
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="admin_directory_v1.html">Admin SDK API</a> . <a href="admin_directory_v1.customer.html">customer</a> . <a href="admin_directory_v1.customer.devices.html">devices</a> . <a href="admin_directory_v1.customer.devices.chromeos.html">chromeos</a> . <a href="admin_directory_v1.customer.devices.chromeos.commands.html">commands</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(customerId, deviceId, commandId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets command data a specific command issued to the device.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(customerId, deviceId, commandId, x__xgafv=None)</code>
  <pre>Gets command data a specific command issued to the device.

Args:
  customerId: string, Immutable. ID of the Google Workspace account. (required)
  deviceId: string, Immutable. ID of Chrome OS Device. (required)
  commandId: string, Immutable. ID of Chrome OS Device Command. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Information regarding a command that was issued to a device.
  &quot;commandExpireTime&quot;: &quot;A String&quot;, # The time at which the command will expire. If the device doesn&#x27;t execute the command within this time the command will become expired.
  &quot;commandId&quot;: &quot;A String&quot;, # Unique ID of a device command.
  &quot;commandResult&quot;: { # The result of executing a command. # The result of the command execution.
    &quot;commandResultPayload&quot;: &quot;A String&quot;, # The payload for the command result. The following commands respond with a payload: * `DEVICE_START_CRD_SESSION`: Payload is a stringified JSON object in the form: { &quot;url&quot;: url }. The provided URL links to the Chrome Remote Desktop session and requires authentication using only the `email` associated with the command&#x27;s issuance. * `FETCH_CRD_AVAILABILITY_INFO`: Payload is a stringified JSON object in the form: { &quot;deviceIdleTimeInSeconds&quot;: number, &quot;userSessionType&quot;: string, &quot;remoteSupportAvailability&quot;: string, &quot;remoteAccessAvailability&quot;: string }. The &quot;remoteSupportAvailability&quot; field is set to &quot;AVAILABLE&quot; if `shared` CRD session to the device is available. The &quot;remoteAccessAvailability&quot; field is set to &quot;AVAILABLE&quot; if `private` CRD session to the device is available.
    &quot;errorMessage&quot;: &quot;A String&quot;, # The error message with a short explanation as to why the command failed. Only present if the command failed.
    &quot;executeTime&quot;: &quot;A String&quot;, # The time at which the command was executed or failed to execute.
    &quot;result&quot;: &quot;A String&quot;, # The result of the command.
  },
  &quot;issueTime&quot;: &quot;A String&quot;, # The timestamp when the command was issued by the admin.
  &quot;payload&quot;: &quot;A String&quot;, # The payload that the command specified, if any.
  &quot;state&quot;: &quot;A String&quot;, # Indicates the command state.
  &quot;type&quot;: &quot;A String&quot;, # The type of the command.
}</pre>
</div>

</body></html>