docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html b/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
index c8a0cff..2130d0d 100644
--- a/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
+++ b/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
@@ -76,10 +76,13 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#claim">claim(partnerId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Claims a device for a customer and adds it to zero-touch enrollment. If the</p>
+<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>
<p class="toc_element">
<code><a href="#claimAsync">claimAsync(partnerId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Claims a batch of devices for a customer asynchronously. Adds the devices</p>
+<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>
+<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="#findByIdentifier">findByIdentifier(partnerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Finds devices by hardware identifiers, such as IMEI.</p>
@@ -88,7 +91,7 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#findByOwner">findByOwner(partnerId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Finds devices claimed for customers. The results only contain devices</p>
+<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>
<p class="toc_element">
<code><a href="#findByOwner_next">findByOwner_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -100,18 +103,17 @@
<p class="firstline">Updates reseller metadata associated with the device.</p>
<p class="toc_element">
<code><a href="#unclaim">unclaim(partnerId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Unclaims a device from a customer and removes it from zero-touch</p>
+<p class="firstline">Unclaims a device from a customer and removes it from zero-touch enrollment.</p>
<p class="toc_element">
<code><a href="#unclaimAsync">unclaimAsync(partnerId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Unclaims a batch of devices for a customer asynchronously. Removes the</p>
+<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>
<p class="toc_element">
<code><a href="#updateMetadataAsync">updateMetadataAsync(partnerId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates the reseller metadata attached to a batch of devices. This method</p>
+<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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="claim">claim(partnerId, body=None, x__xgafv=None)</code>
- <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.
+ <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.
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
@@ -119,28 +121,19 @@
The object takes the form of:
{ # Request message to claim a device on behalf of a customer.
- "sectionType": "A String", # Required. The section type of the device's provisioning record.
- "customerId": "A String", # Required. The ID of the customer for whom the device is being claimed.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Optional. The metadata to attach to the device.
- # [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
+ "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.
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. Required. The device identifier of the device to claim.
- # To understand requirements on identifier sets, read
- # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "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).
+ "sectionType": "A String", # Required. The section type of the device's provisioning record.
+ "customerId": "A String", # Required. The ID of the customer for whom the device is being claimed.
+ "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.
+ "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).
"meid": "A String", # The device’s MEID number.
"imei": "A String", # The device’s IMEI number. Validated on input.
- "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).
+ "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).
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
},
}
@@ -153,51 +146,37 @@
An object of the form:
{ # Response message containing device id of the claim.
- "deviceName": "A String", # The resource name of the device in the format
- # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
"deviceId": "A String", # The device ID of the claimed device.
+ "deviceName": "A String", # The resource name of the device in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
}</pre>
</div>
<div class="method">
<code class="details" id="claimAsync">claimAsync(partnerId, body=None, x__xgafv=None)</code>
- <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).
+ <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).
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
body: object, The request body.
The object takes the form of:
-{ # 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.
+{ # 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.
"claims": [ # Required. A list of device claims.
{ # Identifies one claim request.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to attach to the device at claim.
- # [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
+ "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.
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
- "sectionType": "A String", # Required. The section type of the device's provisioning record.
"customerId": "A String", # Required. The ID of the customer for whom the device is being claimed.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. Required. Device identifier of the device.
- # To understand requirements on identifier sets, read
- # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "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).
+ "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.
+ "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).
"meid": "A String", # The device’s MEID number.
"imei": "A String", # The device’s IMEI number. Validated on input.
- "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).
+ "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).
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
},
+ "sectionType": "A String", # Required. The section type of the device's provisioning record.
},
],
}
@@ -210,42 +189,33 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}`.
- "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.
- "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "error": { # The `Status` type defines a logical error model that is suitable for # 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`.
- # 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 resource represents a long-running operation that is the result of a network API call.
+ "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`.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "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.
+ "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.
+ },
+ "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}`.
+ "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
+ "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="findByIdentifier">findByIdentifier(partnerId, body=None, x__xgafv=None)</code>
<pre>Finds devices by hardware identifiers, such as IMEI.
@@ -255,24 +225,15 @@
The object takes the form of:
{ # Request to find devices.
- "limit": "A String", # Required. The maximum number of devices to show in a page of results. Must
- # be between 1 and 100 inclusive.
"pageToken": "A String", # A token specifying which result page to return.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. Required. The device identifier to search for.
- # To understand requirements on identifier sets, read
- # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "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).
+ "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.
+ "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).
"meid": "A String", # The device’s MEID number.
"imei": "A String", # The device’s IMEI number. Validated on input.
- "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).
+ "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).
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
},
+ "limit": "A String", # Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
}
x__xgafv: string, V1 error format.
@@ -284,60 +245,35 @@
An object of the form:
{ # Response containing found devices.
+ "nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further results are available.
"devices": [ # Found devices.
{ # An Android device registered for zero-touch enrollment.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # 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).
- # [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
+ "configuration": "A String", # Not available to resellers.
+ "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
+ "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.
+ { # 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).
+ "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
+ "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
+ "resellerId": "A String", # The ID of the reseller that claimed the device.
+ "sectionType": "A String", # Output only. The type of claim made on the device.
+ "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
+ },
+ ],
+ "name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
+ "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).
+ "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).
+ "meid": "A String", # The device’s MEID number.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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).
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
+ },
+ "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).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
- "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
- "configuration": "A String", # Not available to resellers.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
- # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- # To understand requirements on identifier sets, read
- # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "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).
- "meid": "A String", # The device’s MEID number.
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "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).
- },
- "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.
- { # 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).
- "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "sectionType": "A String", # Output only. The type of claim made on the device.
- "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "resellerId": "A String", # The ID of the reseller that claimed the device.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
- },
- ],
- "name": "A String", # Output only. The API resource name in the format
- # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
},
],
- "nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further
- # results are available.
"totalSize": 42, # The total count of items in the list irrespective of pagination.
}</pre>
</div>
@@ -358,10 +294,7 @@
<div class="method">
<code class="details" id="findByOwner">findByOwner(partnerId, body=None, x__xgafv=None)</code>
- <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.
+ <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.
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
@@ -369,13 +302,12 @@
The object takes the form of:
{ # Request to find devices by customers.
+ "pageToken": "A String", # A token specifying which result page to return.
+ "limit": "A String", # Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
"customerId": [ # Required. The list of customer IDs to search for.
"A String",
],
- "limit": "A String", # Required. The maximum number of devices to show in a page of results. Must
- # be between 1 and 100 inclusive.
"sectionType": "A String", # Required. The section type of the device's provisioning record.
- "pageToken": "A String", # A token specifying which result page to return.
}
x__xgafv: string, V1 error format.
@@ -387,61 +319,36 @@
An object of the form:
{ # Response containing found devices.
+ "totalSize": 42, # The total count of items in the list irrespective of pagination.
+ "nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further results are available.
"devices": [ # The customer's devices.
{ # An Android device registered for zero-touch enrollment.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # 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).
- # [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
+ "configuration": "A String", # Not available to resellers.
+ "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
+ "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.
+ { # 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).
+ "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
+ "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
+ "resellerId": "A String", # The ID of the reseller that claimed the device.
+ "sectionType": "A String", # Output only. The type of claim made on the device.
+ "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
+ },
+ ],
+ "name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
+ "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).
+ "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).
+ "meid": "A String", # The device’s MEID number.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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).
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
+ },
+ "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).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
- "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
- "configuration": "A String", # Not available to resellers.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
- # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- # To understand requirements on identifier sets, read
- # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "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).
- "meid": "A String", # The device’s MEID number.
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "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).
- },
- "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.
- { # 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).
- "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "sectionType": "A String", # Output only. The type of claim made on the device.
- "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "resellerId": "A String", # The ID of the reseller that claimed the device.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
- },
- ],
- "name": "A String", # Output only. The API resource name in the format
- # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
},
],
- "totalSize": 42, # The total count of items in the list irrespective of pagination.
- "nextPageToken": "A String", # A token used to access the next page of results.
- # Omitted if no further results are available.
}</pre>
</div>
@@ -464,8 +371,7 @@
<pre>Gets a device.
Args:
- name: string, Required. The device API resource name in the format
-`partners/[PARTNER_ID]/devices/[DEVICE_ID]`. (required)
+ name: string, Required. The device API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -475,54 +381,30 @@
An object of the form:
{ # An Android device registered for zero-touch enrollment.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # 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).
- # [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
+ "configuration": "A String", # Not available to resellers.
+ "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
+ "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.
+ { # 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).
+ "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
+ "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
+ "resellerId": "A String", # The ID of the reseller that claimed the device.
+ "sectionType": "A String", # Output only. The type of claim made on the device.
+ "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
+ },
+ ],
+ "name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
+ "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).
+ "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).
+ "meid": "A String", # The device’s MEID number.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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).
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
+ },
+ "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).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
- "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
- "configuration": "A String", # Not available to resellers.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
- # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- # To understand requirements on identifier sets, read
- # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "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).
- "meid": "A String", # The device’s MEID number.
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "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).
- },
- "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.
- { # 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).
- "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "sectionType": "A String", # Output only. The type of claim made on the device.
- "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "resellerId": "A String", # The ID of the reseller that claimed the device.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
- },
- ],
- "name": "A String", # Output only. The API resource name in the format
- # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
}</pre>
</div>
@@ -537,8 +419,7 @@
The object takes the form of:
{ # Request to set metadata for a device.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to attach to the device.
- # [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
+ "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.
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
@@ -553,8 +434,7 @@
Returns:
An object of the form:
- { # Metadata entries that can be attached to a `Device`. To learn more, read
- # [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
+ { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
@@ -563,8 +443,7 @@
<div class="method">
<code class="details" id="unclaim">unclaim(partnerId, body=None, x__xgafv=None)</code>
- <pre>Unclaims a device from a customer and removes it from zero-touch
-enrollment.
+ <pre>Unclaims a device from a customer and removes it from zero-touch enrollment.
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
@@ -572,26 +451,17 @@
The object takes the form of:
{ # Request message to unclaim a device.
+ "sectionType": "A String", # Required. The section type of the device's provisioning record.
"deviceId": "A String", # Required. The device ID returned by `ClaimDevice`.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. The device identifier you used when you claimed this device.
- # To understand requirements on identifier sets, read
- # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "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).
+ "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.
+ "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).
"meid": "A String", # The device’s MEID number.
"imei": "A String", # The device’s IMEI number. Validated on input.
- "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).
+ "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).
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
},
- "vacationModeDays": 42, # The duration of the vacation unlock starting from when the request is
- # processed. (1 day is treated as 24 hours)
- "sectionType": "A String", # Required. The section type of the device's provisioning record.
"vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
+ "vacationModeDays": 42, # The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)
}
x__xgafv: string, V1 error format.
@@ -602,23 +472,13 @@
Returns:
An object of the form:
- { # 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 `{}`.
+ { # 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 `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="unclaimAsync">unclaimAsync(partnerId, body=None, x__xgafv=None)</code>
- <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).
+ <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).
Args:
partnerId: string, Required. The reseller partner ID. (required)
@@ -628,26 +488,17 @@
{ # Request to unclaim devices asynchronously in batch.
"unclaims": [ # Required. The list of devices to unclaim.
{ # Identifies one unclaim request.
- "vacationModeDays": 42, # Optional. The duration of the vacation unlock starting from when the request is
- # processed. (1 day is treated as 24 hours)
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. Device identifier of the device.
- # To understand requirements on identifier sets, read
- # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "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).
+ "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.
+ "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).
"meid": "A String", # The device’s MEID number.
"imei": "A String", # The device’s IMEI number. Validated on input.
- "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).
+ "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).
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
},
- "vacationModeExpireTime": "A String", # Optional. The expiration time of the vacation unlock.
- "sectionType": "A String", # Required. The section type of the device's provisioning record.
"deviceId": "A String", # Required. Device ID of the device.
+ "sectionType": "A String", # Required. The section type of the device's provisioning record.
+ "vacationModeDays": 42, # Optional. The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)
+ "vacationModeExpireTime": "A String", # Optional. The expiration time of the vacation unlock.
},
],
}
@@ -660,47 +511,30 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}`.
- "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.
- "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "error": { # The `Status` type defines a logical error model that is suitable for # 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`.
- # 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 resource represents a long-running operation that is the result of a network API call.
+ "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`.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "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.
+ "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.
+ },
+ "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}`.
+ "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
+ "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="updateMetadataAsync">updateMetadataAsync(partnerId, body=None, x__xgafv=None)</code>
- <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).
+ <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).
Args:
partnerId: string, Required. The reseller partner ID. (required)
@@ -710,28 +544,19 @@
{ # Request to update device metadata in batch.
"updates": [ # Required. The list of metadata updates.
{ # Identifies metadata updates to one device.
- "deviceId": "A String", # Required. Device ID of the device.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to update.
- # [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
+ "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.
+ "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).
+ "meid": "A String", # The device’s MEID number.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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).
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
+ },
+ "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.
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. Device identifier.
- # To understand requirements on identifier sets, read
- # [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
- "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).
- "meid": "A String", # The device’s MEID number.
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "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).
- },
+ "deviceId": "A String", # Required. Device ID of the device.
},
],
}
@@ -744,37 +569,23 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}`.
- "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.
- "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "error": { # The `Status` type defines a logical error model that is suitable for # 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`.
- # 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 resource represents a long-running operation that is the result of a network API call.
+ "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`.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "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.
+ "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.
+ },
+ "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}`.
+ "response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
+ "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>