Blame - docs/dyn/cloudidentity_v1beta1.devices.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

91

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

92

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

93

<p class="firstline">Deletes the specified device.</p>

94

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

95

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

96

<p class="firstline">Retrieves the specified device.</p>

97

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

98

<code><a href="#list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

99

<p class="firstline">Lists/Searches devices.</p>

100

101

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

102

<p class="firstline">Retrieves the next page of results.</p>

103

104

<code><a href="#wipe">wipe(name, body=None, x__xgafv=None)</a></code></p>

105

<p class="firstline">Wipes all data on the specified device.</p>

106

<h3>Method Details</h3>

107

108

<code class="details" id="cancelWipe">cancelWipe(name, body=None, x__xgafv=None)</code>

109

<pre>Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped.

110

111

Args:

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

112

name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the Device. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

113

body: object, The request body.

114

The object takes the form of:

115

116

{ # Request message for cancelling an unfinished device wipe.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

117

}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

118

119

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

126

127

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

128

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

129

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

130

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

131

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

132

{

133

"a_key": "", # Properties of the object. Contains field @type with type URL.

134

},

135

],

136

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

137

},

138

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

139

"a_key": "", # Properties of the object. Contains field @type with type URL.

140

},

141

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

142

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

143

"a_key": "", # Properties of the object. Contains field @type with type URL.

144

},

145

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<code class="details" id="close">close()</code>

150

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(body=None, x__xgafv=None)</code>

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

155

<pre>Creates a device. Only company-owned device may be created. **Note**: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

156

157

Args:

158

body: object, The request body.

159

The object takes the form of:

160

161

{ # Request message for creating a Company Owned device.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

162

"device": { # A Device within the Cloud Identity Devices API. Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user. # Required. The device to be created. The name field within this device is ignored in the create method. A new name is created by the method, and returned within the response. Only the fields `device_type`, `serial_number` and `asset_tag` (if present) are used to create the device. All other fields are ignored. The `device_type` and `serial_number` fields are required.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

163

"androidSpecificAttributes": { # Resource representing the Android specific attributes of a Device. # Output only. Attributes specific to Android devices.

164

"enabledUnknownSources": True or False, # Whether applications from unknown sources can be installed on device.

165

"ownerProfileAccount": True or False, # Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.

166

"ownershipPrivilege": "A String", # Ownership privileges on device.

167

"supportsWorkProfile": True or False, # Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

168

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

169

"assetTag": "A String", # Asset tag of the device.

170

"basebandVersion": "A String", # Output only. Baseband version of the device.

171

"bootloaderVersion": "A String", # Output only. Device bootloader version. Example: 0.6.7.

172

"brand": "A String", # Output only. Device brand. Example: Samsung.

173

"buildNumber": "A String", # Output only. Build number of the device.

174

"compromisedState": "A String", # Output only. Represents whether the Device is compromised.

175

"createTime": "A String", # Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.

176

"deviceType": "A String", # Output only. Type of device.

177

"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device.

178

"enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device.

179

"encryptionState": "A String", # Output only. Device encryption state.

180

"imei": "A String", # Output only. IMEI number of device if GSM device; empty otherwise.

181

"kernelVersion": "A String", # Output only. Kernel version of the device.

182

"lastSyncTime": "A String", # Most recent time when device synced with this service.

183

"managementState": "A String", # Output only. Management state of the device

184

"manufacturer": "A String", # Output only. Device manufacturer. Example: Motorola.

185

"meid": "A String", # Output only. MEID number of device if CDMA device; empty otherwise.

186

"model": "A String", # Output only. Model name of device. Example: Pixel 3.

187

"name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique id assigned to the Device.

188

"networkOperator": "A String", # Output only. Mobile or network operator of device, if available.

189

"osVersion": "A String", # Output only. OS version of the device. Example: Android 8.1.0.

190

"otherAccounts": [ # Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".

191

"A String",

192

],

193

"ownerType": "A String", # Output only. Whether the device is owned by the company or an individual

194

"releaseVersion": "A String", # Output only. OS release version. Example: 6.0.

195

"securityPatchTime": "A String", # Output only. OS security patch update time on device.

196

"serialNumber": "A String", # Serial Number of device. Example: HT82V1A01076.

197

"wifiMacAddresses": [ # WiFi MAC addresses of device.

"A String",

],

},

}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

202

203

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

210

211

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

212

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

213

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

214

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

215

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

216

{

217

"a_key": "", # Properties of the object. Contains field @type with type URL.

218

},

219

],

220

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

221

},

222

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

223

"a_key": "", # Properties of the object. Contains field @type with type URL.

224

},

225

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

226

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

227

"a_key": "", # Properties of the object. Contains field @type with type URL.

228

},

229

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

233

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

234

<pre>Deletes the specified device.

235

236

Args:

237

name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the Device. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

238

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

245

246

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

247

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

248

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

249

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

250

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

251

{

252

"a_key": "", # Properties of the object. Contains field @type with type URL.

253

},

254

],

255

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

256

},

257

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

258

"a_key": "", # Properties of the object. Contains field @type with type URL.

259

},

260

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

261

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

262

"a_key": "", # Properties of the object. Contains field @type with type URL.

263

},

264

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

268

<code class="details" id="get">get(name, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

269

<pre>Retrieves the specified device.

270

271

Args:

272

name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the Device. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

273

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

280

281

{ # A Device within the Cloud Identity Devices API. Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

282

"androidSpecificAttributes": { # Resource representing the Android specific attributes of a Device. # Output only. Attributes specific to Android devices.

283

"enabledUnknownSources": True or False, # Whether applications from unknown sources can be installed on device.

284

"ownerProfileAccount": True or False, # Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.

285

"ownershipPrivilege": "A String", # Ownership privileges on device.

286

"supportsWorkProfile": True or False, # Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.

287

},

288

"assetTag": "A String", # Asset tag of the device.

289

"basebandVersion": "A String", # Output only. Baseband version of the device.

290

"bootloaderVersion": "A String", # Output only. Device bootloader version. Example: 0.6.7.

291

"brand": "A String", # Output only. Device brand. Example: Samsung.

292

"buildNumber": "A String", # Output only. Build number of the device.

293

"compromisedState": "A String", # Output only. Represents whether the Device is compromised.

294

"createTime": "A String", # Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.

295

"deviceType": "A String", # Output only. Type of device.

296

"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device.

297

"enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device.

298

"encryptionState": "A String", # Output only. Device encryption state.

299

"imei": "A String", # Output only. IMEI number of device if GSM device; empty otherwise.

300

"kernelVersion": "A String", # Output only. Kernel version of the device.

301

"lastSyncTime": "A String", # Most recent time when device synced with this service.

302

"managementState": "A String", # Output only. Management state of the device

303

"manufacturer": "A String", # Output only. Device manufacturer. Example: Motorola.

304

"meid": "A String", # Output only. MEID number of device if CDMA device; empty otherwise.

305

"model": "A String", # Output only. Model name of device. Example: Pixel 3.

306

"name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique id assigned to the Device.

307

"networkOperator": "A String", # Output only. Mobile or network operator of device, if available.

308

"osVersion": "A String", # Output only. OS version of the device. Example: Android 8.1.0.

309

"otherAccounts": [ # Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".

310

"A String",

311

],

312

"ownerType": "A String", # Output only. Whether the device is owned by the company or an individual

313

"releaseVersion": "A String", # Output only. OS release version. Example: 6.0.

314

"securityPatchTime": "A String", # Output only. OS security patch update time on device.

315

"serialNumber": "A String", # Serial Number of device. Example: HT82V1A01076.

316

"wifiMacAddresses": [ # WiFi MAC addresses of device.

317

"A String",

318

],

319

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

323

<code class="details" id="list">list(filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

324

<pre>Lists/Searches devices.

325

326

Args:

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

327

filter: string, Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to [Mobile device search fields](https://developers.google.com/admin-sdk/directory/v1/search-operators). Multiple search fields are separated by the space character.

328

orderBy: string, Optional. Order specification for devices in the response. Only one of the following field names may be used to specify the order: `create_time`, `last_sync_time`, `model`, `os_version`, `device_type` and `serial_number`. `desc` may be specified optionally to specify results to be sorted in descending order. Default order is ascending.

329

pageSize: integer, Optional. The maximum number of Devices to return. If unspecified, at most 20 Devices will be returned. The maximum value is 100; values above 100 will be coerced to 100.

330

pageToken: string, Optional. A page token, received from a previous `ListDevices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDevices` must match the call that provided the page token.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

331

view: string, Optional. The view to use for the List request.

332

Allowed values

333

VIEW_UNSPECIFIED - Default value. The value is unused.

334

COMPANY_INVENTORY - This view contains all devices imported by the company admin. Each device in the response contains all information specified by the company admin when importing the device (i.e. asset tags).

335

USER_ASSIGNED_DEVICES - This view contains all devices with at least one user registered on the device. Each device in the response contains all device information, except for asset tags.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

336

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

343

344

{ # Response message that is returned from the ListDevices method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

345

"devices": [ # Devices meeting the list restrictions.

346

{ # A Device within the Cloud Identity Devices API. Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user.

347

"androidSpecificAttributes": { # Resource representing the Android specific attributes of a Device. # Output only. Attributes specific to Android devices.

348

"enabledUnknownSources": True or False, # Whether applications from unknown sources can be installed on device.

349

"ownerProfileAccount": True or False, # Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.

350

"ownershipPrivilege": "A String", # Ownership privileges on device.

351

"supportsWorkProfile": True or False, # Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

352

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

353

"assetTag": "A String", # Asset tag of the device.

354

"basebandVersion": "A String", # Output only. Baseband version of the device.

355

"bootloaderVersion": "A String", # Output only. Device bootloader version. Example: 0.6.7.

356

"brand": "A String", # Output only. Device brand. Example: Samsung.

357

"buildNumber": "A String", # Output only. Build number of the device.

358

"compromisedState": "A String", # Output only. Represents whether the Device is compromised.

359

"createTime": "A String", # Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.

360

"deviceType": "A String", # Output only. Type of device.

361

"enabledDeveloperOptions": True or False, # Output only. Whether developer options is enabled on device.

362

"enabledUsbDebugging": True or False, # Output only. Whether USB debugging is enabled on device.

363

"encryptionState": "A String", # Output only. Device encryption state.

364

"imei": "A String", # Output only. IMEI number of device if GSM device; empty otherwise.

365

"kernelVersion": "A String", # Output only. Kernel version of the device.

366

"lastSyncTime": "A String", # Most recent time when device synced with this service.

367

"managementState": "A String", # Output only. Management state of the device

368

"manufacturer": "A String", # Output only. Device manufacturer. Example: Motorola.

369

"meid": "A String", # Output only. MEID number of device if CDMA device; empty otherwise.

370

"model": "A String", # Output only. Model name of device. Example: Pixel 3.

371

"name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique id assigned to the Device.

372

"networkOperator": "A String", # Output only. Mobile or network operator of device, if available.

373

"osVersion": "A String", # Output only. OS version of the device. Example: Android 8.1.0.

374

"otherAccounts": [ # Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".

375

"A String",

376

],

377

"ownerType": "A String", # Output only. Whether the device is owned by the company or an individual

378

"releaseVersion": "A String", # Output only. OS release version. Example: 6.0.

379

"securityPatchTime": "A String", # Output only. OS security patch update time on device.

380

"serialNumber": "A String", # Serial Number of device. Example: HT82V1A01076.

381

"wifiMacAddresses": [ # WiFi MAC addresses of device.

"A String",

],

},

],

"nextPageToken": "A String", # Token to retrieve the next page of results. Empty if there are no more results.

387

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

392

<pre>Retrieves the next page of results.

393

394

Args:

395

previous_request: The request for the previous page. (required)

396

previous_response: The response from the request for the previous page. (required)

397

398

Returns:

399

A request object that you can call 'execute()' on to request the next

400

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="wipe">wipe(name, body=None, x__xgafv=None)</code>

406

<pre>Wipes all data on the specified device.

407

408

Args:

409

name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required)

410

body: object, The request body.

411

The object takes the form of:

412

413

{ # Request message for wiping all data on the device.

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame]

414

"removeResetLock": True or False, # Optional. Specifies if a user is able to factory reset a device after a Device Wipe. On iOS, this is called "Activation Lock", while on Android, this is known as "Factory Reset Protection". If true, this protection will be removed from the device, so that a user can successfully factory reset. If false, the setting is untouched on the device.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

415

}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

416

417

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

424

425

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

426

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

427

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

428

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

429

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

430

{

431

"a_key": "", # Properties of the object. Contains field @type with type URL.

432

},

433

],

434

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

435

},

436

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

437

"a_key": "", # Properties of the object. Contains field @type with type URL.

438

},

439

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

440

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

441

"a_key": "", # Properties of the object. Contains field @type with type URL.

442

},

443

}</pre>

Dmitry Frenkel