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

blob: a1b82d946322f4b6a85fa393701071e8f2af789f [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="androiddeviceprovisioning_v1.html">Android Device Provisioning Partner API</a> . <a href="androiddeviceprovisioning_v1.partners.html">partners</a> . <a href="androiddeviceprovisioning_v1.partners.devices.html">devices</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#claim">claim(partnerId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	79	<p class="firstline">Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#claimAsync">claimAsync(partnerId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	82	<p class="firstline">Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).</p>
				83	<p class="toc_element">
				84	<code><a href="#close">close()</a></code></p>
				85	<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#findByIdentifier">findByIdentifier(partnerId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Finds devices by hardware identifiers, such as IMEI.</p>
				89	<p class="toc_element">
				90	<code><a href="#findByIdentifier_next">findByIdentifier_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	93	<code><a href="#findByOwner">findByOwner(partnerId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	94	<p class="firstline">Finds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the `partnerId` argument. The customer's devices purchased from other resellers don't appear in the results.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	95	<p class="toc_element">
				96	<code><a href="#findByOwner_next">findByOwner_next(previous_request, previous_response)</a></code></p>
				97	<p class="firstline">Retrieves the next page of results.</p>
				98	<p class="toc_element">
				99	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				100	<p class="firstline">Gets a device.</p>
				101	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	102	<code><a href="#metadata">metadata(metadataOwnerId, deviceId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103	<p class="firstline">Updates reseller metadata associated with the device.</p>
				104	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	105	<code><a href="#unclaim">unclaim(partnerId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	106	<p class="firstline">Unclaims a device from a customer and removes it from zero-touch enrollment.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	107	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	108	<code><a href="#unclaimAsync">unclaimAsync(partnerId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	109	<p class="firstline">Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	110	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	111	<code><a href="#updateMetadataAsync">updateMetadataAsync(partnerId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	112	<p class="firstline">Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	113	<h3>Method Details</h3>
				114	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	115	<code class="details" id="claim">claim(partnerId, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	116	<pre>Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	117
				118	Args:
				119	partnerId: string, Required. The ID of the reseller partner. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	120	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	121	The object takes the form of:
				122
				123	{ # Request message to claim a device on behalf of a customer.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	124	"customerId": "A String", # Required. The ID of the customer for whom the device is being claimed.
				125	"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. Required. The device identifier of the device to claim.
				126	"imei": "A String", # The device’s IMEI number. Validated on input.
				127	"manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
				128	"meid": "A String", # The device’s MEID number.
				129	"model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
				130	"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
				131	},
				132	"deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # Optional. The metadata to attach to the device.
				133	"entries": { # Metadata entries recorded as key-value pairs.
				134	"a_key": "A String",
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	135	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	136	},
				137	"sectionType": "A String", # Required. The section type of the device's provisioning record.
				138	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	139
				140	x__xgafv: string, V1 error format.
				141	Allowed values
				142	1 - v1 error format
				143	2 - v2 error format
				144
				145	Returns:
				146	An object of the form:
				147
				148	{ # Response message containing device id of the claim.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	149	"deviceId": "A String", # The device ID of the claimed device.
				150	"deviceName": "A String", # The resource name of the device in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
				151	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	152	</div>
				153
				154	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	155	<code class="details" id="claimAsync">claimAsync(partnerId, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	156	<pre>Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	157
				158	Args:
				159	partnerId: string, Required. The ID of the reseller partner. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	160	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	161	The object takes the form of:
				162
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	163	{ # Request to claim devices asynchronously in batch. Claiming a device adds the device to zero-touch enrollment and shows the device in the customer's view of the portal.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	164	"claims": [ # Required. A list of device claims.
				165	{ # Identifies one claim request.
				166	"customerId": "A String", # Required. The ID of the customer for whom the device is being claimed.
				167	"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. Required. Device identifier of the device.
				168	"imei": "A String", # The device’s IMEI number. Validated on input.
				169	"manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
				170	"meid": "A String", # The device’s MEID number.
				171	"model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
				172	"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	173	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	174	"deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # Required. The metadata to attach to the device at claim.
				175	"entries": { # Metadata entries recorded as key-value pairs.
				176	"a_key": "A String",
				177	},
				178	},
				179	"sectionType": "A String", # Required. The section type of the device's provisioning record.
				180	},
				181	],
				182	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	183
				184	x__xgafv: string, V1 error format.
				185	Allowed values
				186	1 - v1 error format
				187	2 - v2 error format
				188
				189	Returns:
				190	An object of the form:
				191
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	192	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	193	"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.
				194	"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). # This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.
				195	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				196	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				197	{
				198	"a_key": "", # Properties of the object. Contains field @type with type URL.
				199	},
				200	],
				201	"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.
				202	},
				203	"metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
				204	"a_key": "", # Properties of the object. Contains field @type with type URL.
				205	},
				206	"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}`.
				207	"response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
				208	"a_key": "", # Properties of the object. Contains field @type with type URL.
				209	},
				210	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	211	</div>
				212
				213	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	214	<code class="details" id="close">close()</code>
				215	<pre>Close httplib2 connections.</pre>
				216	</div>
				217
				218	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	219	<code class="details" id="findByIdentifier">findByIdentifier(partnerId, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	220	<pre>Finds devices by hardware identifiers, such as IMEI.
				221
				222	Args:
				223	partnerId: string, Required. The ID of the reseller partner. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	224	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	225	The object takes the form of:
				226
				227	{ # Request to find devices.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	228	"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. Required. The device identifier to search for.
				229	"imei": "A String", # The device’s IMEI number. Validated on input.
				230	"manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
				231	"meid": "A String", # The device’s MEID number.
				232	"model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
				233	"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
				234	},
				235	"limit": "A String", # Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
				236	"pageToken": "A String", # A token specifying which result page to return.
				237	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	238
				239	x__xgafv: string, V1 error format.
				240	Allowed values
				241	1 - v1 error format
				242	2 - v2 error format
				243
				244	Returns:
				245	An object of the form:
				246
				247	{ # Response containing found devices.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	248	"devices": [ # Found devices.
				249	{ # An Android device registered for zero-touch enrollment.
				250	"claims": [ # Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.
				251	{ # A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	252	"additionalService": "A String", # The Additional service registered for the device.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	253	"ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
				254	"resellerId": "A String", # The ID of the reseller that claimed the device.
				255	"sectionType": "A String", # Output only. The type of claim made on the device.
				256	"vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
				257	"vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	258	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	259	],
				260	"configuration": "A String", # Not available to resellers.
				261	"deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
				262	"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
				263	"imei": "A String", # The device’s IMEI number. Validated on input.
				264	"manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
				265	"meid": "A String", # The device’s MEID number.
				266	"model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
				267	"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	268	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	269	"deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
				270	"entries": { # Metadata entries recorded as key-value pairs.
				271	"a_key": "A String",
				272	},
				273	},
				274	"name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
				275	},
				276	],
				277	"nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further results are available.
				278	"totalSize": 42, # The total count of items in the list irrespective of pagination.
				279	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	280	</div>
				281
				282	<div class="method">
				283	<code class="details" id="findByIdentifier_next">findByIdentifier_next(previous_request, previous_response)</code>
				284	<pre>Retrieves the next page of results.
				285
				286	Args:
				287	previous_request: The request for the previous page. (required)
				288	previous_response: The response from the request for the previous page. (required)
				289
				290	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	291	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	292	page. Returns None if there are no more items in the collection.
				293	</pre>
				294	</div>
				295
				296	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	297	<code class="details" id="findByOwner">findByOwner(partnerId, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	298	<pre>Finds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the `partnerId` argument. The customer's devices purchased from other resellers don't appear in the results.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	299
				300	Args:
				301	partnerId: string, Required. The ID of the reseller partner. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	302	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	303	The object takes the form of:
				304
				305	{ # Request to find devices by customers.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	306	"customerId": [ # Required. The list of customer IDs to search for.
				307	"A String",
				308	],
				309	"limit": "A String", # Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
				310	"pageToken": "A String", # A token specifying which result page to return.
				311	"sectionType": "A String", # Required. The section type of the device's provisioning record.
				312	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	313
				314	x__xgafv: string, V1 error format.
				315	Allowed values
				316	1 - v1 error format
				317	2 - v2 error format
				318
				319	Returns:
				320	An object of the form:
				321
				322	{ # Response containing found devices.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	323	"devices": [ # The customer's devices.
				324	{ # An Android device registered for zero-touch enrollment.
				325	"claims": [ # Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.
				326	{ # A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	327	"additionalService": "A String", # The Additional service registered for the device.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	328	"ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
				329	"resellerId": "A String", # The ID of the reseller that claimed the device.
				330	"sectionType": "A String", # Output only. The type of claim made on the device.
				331	"vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
				332	"vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	333	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	334	],
				335	"configuration": "A String", # Not available to resellers.
				336	"deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
				337	"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
				338	"imei": "A String", # The device’s IMEI number. Validated on input.
				339	"manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
				340	"meid": "A String", # The device’s MEID number.
				341	"model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
				342	"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	343	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	344	"deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
				345	"entries": { # Metadata entries recorded as key-value pairs.
				346	"a_key": "A String",
				347	},
				348	},
				349	"name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
				350	},
				351	],
				352	"nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further results are available.
				353	"totalSize": 42, # The total count of items in the list irrespective of pagination.
				354	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	355	</div>
				356
				357	<div class="method">
				358	<code class="details" id="findByOwner_next">findByOwner_next(previous_request, previous_response)</code>
				359	<pre>Retrieves the next page of results.
				360
				361	Args:
				362	previous_request: The request for the previous page. (required)
				363	previous_response: The response from the request for the previous page. (required)
				364
				365	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	366	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	367	page. Returns None if there are no more items in the collection.
				368	</pre>
				369	</div>
				370
				371	<div class="method">
				372	<code class="details" id="get">get(name, x__xgafv=None)</code>
				373	<pre>Gets a device.
				374
				375	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	376	name: string, Required. The device API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	377	x__xgafv: string, V1 error format.
				378	Allowed values
				379	1 - v1 error format
				380	2 - v2 error format
				381
				382	Returns:
				383	An object of the form:
				384
				385	{ # An Android device registered for zero-touch enrollment.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	386	"claims": [ # Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.
				387	{ # A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	388	"additionalService": "A String", # The Additional service registered for the device.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	389	"ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
				390	"resellerId": "A String", # The ID of the reseller that claimed the device.
				391	"sectionType": "A String", # Output only. The type of claim made on the device.
				392	"vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
				393	"vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	394	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	395	],
				396	"configuration": "A String", # Not available to resellers.
				397	"deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
				398	"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
				399	"imei": "A String", # The device’s IMEI number. Validated on input.
				400	"manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
				401	"meid": "A String", # The device’s MEID number.
				402	"model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
				403	"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
				404	},
				405	"deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
				406	"entries": { # Metadata entries recorded as key-value pairs.
				407	"a_key": "A String",
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	408	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	409	},
				410	"name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
				411	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	412	</div>
				413
				414	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	415	<code class="details" id="metadata">metadata(metadataOwnerId, deviceId, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	416	<pre>Updates reseller metadata associated with the device.
				417
				418	Args:
				419	metadataOwnerId: string, Required. The owner of the newly set metadata. Set this to the partner ID. (required)
				420	deviceId: string, Required. The ID of the device. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	421	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	422	The object takes the form of:
				423
				424	{ # Request to set metadata for a device.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	425	"deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # Required. The metadata to attach to the device.
				426	"entries": { # Metadata entries recorded as key-value pairs.
				427	"a_key": "A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	428	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	429	},
				430	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	431
				432	x__xgafv: string, V1 error format.
				433	Allowed values
				434	1 - v1 error format
				435	2 - v2 error format
				436
				437	Returns:
				438	An object of the form:
				439
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	440	{ # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	441	"entries": { # Metadata entries recorded as key-value pairs.
				442	"a_key": "A String",
				443	},
				444	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	445	</div>
				446
				447	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	448	<code class="details" id="unclaim">unclaim(partnerId, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	449	<pre>Unclaims a device from a customer and removes it from zero-touch enrollment.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	450
				451	Args:
				452	partnerId: string, Required. The ID of the reseller partner. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	453	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	454	The object takes the form of:
				455
				456	{ # Request message to unclaim a device.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	457	"deviceId": "A String", # Required. The device ID returned by `ClaimDevice`.
				458	"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device identifier you used when you claimed this device.
				459	"imei": "A String", # The device’s IMEI number. Validated on input.
				460	"manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
				461	"meid": "A String", # The device’s MEID number.
				462	"model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
				463	"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
				464	},
				465	"sectionType": "A String", # Required. The section type of the device's provisioning record.
				466	"vacationModeDays": 42, # The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)
				467	"vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
				468	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	469
				470	x__xgafv: string, V1 error format.
				471	Allowed values
				472	1 - v1 error format
				473	2 - v2 error format
				474
				475	Returns:
				476	An object of the form:
				477
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	478	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	479	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	480	</div>
				481
				482	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	483	<code class="details" id="unclaimAsync">unclaimAsync(partnerId, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	484	<pre>Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	485
				486	Args:
				487	partnerId: string, Required. The reseller partner ID. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	488	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	489	The object takes the form of:
				490
				491	{ # Request to unclaim devices asynchronously in batch.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	492	"unclaims": [ # Required. The list of devices to unclaim.
				493	{ # Identifies one unclaim request.
				494	"deviceId": "A String", # Required. Device ID of the device.
				495	"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. Device identifier of the device.
				496	"imei": "A String", # The device’s IMEI number. Validated on input.
				497	"manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
				498	"meid": "A String", # The device’s MEID number.
				499	"model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
				500	"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	501	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	502	"sectionType": "A String", # Required. The section type of the device's provisioning record.
				503	"vacationModeDays": 42, # Optional. The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)
				504	"vacationModeExpireTime": "A String", # Optional. The expiration time of the vacation unlock.
				505	},
				506	],
				507	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	508
				509	x__xgafv: string, V1 error format.
				510	Allowed values
				511	1 - v1 error format
				512	2 - v2 error format
				513
				514	Returns:
				515	An object of the form:
				516
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	517	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	518	"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.
				519	"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). # This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.
				520	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				521	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				522	{
				523	"a_key": "", # Properties of the object. Contains field @type with type URL.
				524	},
				525	],
				526	"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.
				527	},
				528	"metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
				529	"a_key": "", # Properties of the object. Contains field @type with type URL.
				530	},
				531	"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}`.
				532	"response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
				533	"a_key": "", # Properties of the object. Contains field @type with type URL.
				534	},
				535	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	536	</div>
				537
				538	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	539	<code class="details" id="updateMetadataAsync">updateMetadataAsync(partnerId, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	540	<pre>Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	541
				542	Args:
				543	partnerId: string, Required. The reseller partner ID. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	544	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	545	The object takes the form of:
				546
				547	{ # Request to update device metadata in batch.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	548	"updates": [ # Required. The list of metadata updates.
				549	{ # Identifies metadata updates to one device.
				550	"deviceId": "A String", # Required. Device ID of the device.
				551	"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. Device identifier.
				552	"imei": "A String", # The device’s IMEI number. Validated on input.
				553	"manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
				554	"meid": "A String", # The device’s MEID number.
				555	"model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).
				556	"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
				557	},
				558	"deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # Required. The metadata to update.
				559	"entries": { # Metadata entries recorded as key-value pairs.
				560	"a_key": "A String",
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	561	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	562	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	563	},
				564	],
				565	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	566
				567	x__xgafv: string, V1 error format.
				568	Allowed values
				569	1 - v1 error format
				570	2 - v2 error format
				571
				572	Returns:
				573	An object of the form:
				574
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	575	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	576	"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.
				577	"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). # This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.
				578	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				579	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				580	{
				581	"a_key": "", # Properties of the object. Contains field @type with type URL.
				582	},
				583	],
				584	"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.
				585	},
				586	"metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
				587	"a_key": "", # Properties of the object. Contains field @type with type URL.
				588	},
				589	"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}`.
				590	"response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
				591	"a_key": "", # Properties of the object. Contains field @type with type URL.
				592	},
				593	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	594	</div>
				595
				596	</body></html>