docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html b/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
index aae89ca..8098575 100644
--- a/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
+++ b/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
@@ -119,29 +119,29 @@
The object takes the form of:
{ # Request message to claim a device on behalf of a customer.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Optional. The metadata to attach to the device.
- # [Device metadata](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
- },
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. The device identifier of the device to claim.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. The device identifier of the device to claim.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "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.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "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.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "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).
},
- "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.
+ "customerId": "A String", # Required. The ID of the customer for whom the device is being claimed.
+ "sectionType": "A String", # Required. The section type of the device's provisioning record.
+ "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Optional. The metadata to attach to the device.
+ # [Device metadata](/zero-touch/guides/metadata).
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
+ },
+ },
}
x__xgafv: string, V1 error format.
@@ -153,9 +153,9 @@
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
+ "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]`.
- "deviceId": "A String", # The device ID of the claimed device.
}</pre>
</div>
@@ -171,33 +171,33 @@
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
+ # device to zero-touch enrollment and shows the device in the customer's view
# of the portal.
- "claims": [ # Required. A list of device claims.
+ "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.
+ "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](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
+ "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 of the device.
+ "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. Device identifier of the device.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "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.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "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.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "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).
},
- "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.
+ "sectionType": "A String", # Required. The section type of the device's provisioning record.
},
],
}
@@ -212,36 +212,36 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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`.
+ "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).
- "message": "A String", # A developer-facing error message, which should be in English. Any
+ "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.
- "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
+ "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.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
- "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
+ "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}`.
+ "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.
+ },
+ "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.
+ "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.
+ },
}</pre>
</div>
@@ -255,24 +255,24 @@
The object takes the form of:
{ # Request to find devices.
- "pageToken": "A String", # A token specifying which result page to return.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. The device identifier to search for.
+ "limit": "A String", # Required. The maximum number of devices to show in a page of results. Must
+ # be between 1 and 100 inclusive.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Required. The device identifier to search for.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "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.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "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.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "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).
},
- "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.
}
x__xgafv: string, V1 error format.
@@ -284,32 +284,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.
- "totalSize": 42, # The total count of items in the list irrespective of pagination.
- "devices": [ # Found devices.
+ "devices": [ # Found devices.
{ # An Android device registered for zero-touch enrollment.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
# [Identifiers](/zero-touch/guides/identifiers).
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "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.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "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.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "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).
},
- "name": "A String", # Output only. The API resource name in the format
+ "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
+ "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](/zero-touch/guides/metadata).
+ # [Device metadata](/zero-touch/guides/metadata).
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
+ },
+ },
+ "name": "A String", # Output only. The API resource name in the format
# `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
- "configuration": "A String", # Not available to resellers.
- "claims": [ # Output only. The provisioning claims for a device. Devices claimed for
+ "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`
@@ -320,24 +323,21 @@
# 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'.
- "resellerId": "A String", # The ID of the reseller that claimed 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'.
- "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.
+ "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.
+ "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'.
+ "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
},
],
- "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](/zero-touch/guides/metadata).
- # [Device metadata](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
- },
+ "configuration": "A String", # Not available to resellers.
},
],
+ "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>
@@ -350,7 +350,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -358,8 +358,8 @@
<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
+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:
@@ -368,13 +368,13 @@
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",
+ "customerId": [ # Required. The list of customer IDs to search for.
+ "A String",
],
- "sectionType": "A String", # Required. The section type of the device's provisioning record.
+ "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.
+ "sectionType": "A String", # Required. The section type of the device's provisioning record.
}
x__xgafv: string, V1 error format.
@@ -386,32 +386,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.
- "totalSize": 42, # The total count of items in the list irrespective of pagination.
- "devices": [ # The customer's devices.
+ "devices": [ # The customer's devices.
{ # An Android device registered for zero-touch enrollment.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
# [Identifiers](/zero-touch/guides/identifiers).
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "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.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "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.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "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).
},
- "name": "A String", # Output only. The API resource name in the format
+ "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
+ "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](/zero-touch/guides/metadata).
+ # [Device metadata](/zero-touch/guides/metadata).
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
+ },
+ },
+ "name": "A String", # Output only. The API resource name in the format
# `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
- "configuration": "A String", # Not available to resellers.
- "claims": [ # Output only. The provisioning claims for a device. Devices claimed for
+ "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`
@@ -422,24 +425,21 @@
# 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'.
- "resellerId": "A String", # The ID of the reseller that claimed 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'.
- "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.
+ "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.
+ "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'.
+ "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
},
],
- "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](/zero-touch/guides/metadata).
- # [Device metadata](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
- },
+ "configuration": "A String", # Not available to resellers.
},
],
+ "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>
@@ -452,7 +452,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -473,27 +473,33 @@
An object of the form:
{ # An Android device registered for zero-touch enrollment.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The hardware IDs that identify a manufactured device. To learn more, read
# [Identifiers](/zero-touch/guides/identifiers).
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "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.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "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.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "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).
},
- "name": "A String", # Output only. The API resource name in the format
+ "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
+ "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](/zero-touch/guides/metadata).
+ # [Device metadata](/zero-touch/guides/metadata).
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
+ },
+ },
+ "name": "A String", # Output only. The API resource name in the format
# `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
- "configuration": "A String", # Not available to resellers.
- "claims": [ # Output only. The provisioning claims for a device. Devices claimed for
+ "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`
@@ -504,22 +510,16 @@
# 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'.
- "resellerId": "A String", # The ID of the reseller that claimed 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'.
- "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.
+ "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.
+ "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'.
+ "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
},
],
- "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](/zero-touch/guides/metadata).
- # [Device metadata](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
- },
+ "configuration": "A String", # Not available to resellers.
}</pre>
</div>
@@ -534,10 +534,10 @@
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.
+ "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to attach to the device.
# [Device metadata](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
},
},
}
@@ -552,8 +552,8 @@
{ # Metadata entries that can be attached to a `Device`. To learn more, read
# [Device metadata](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
},
}</pre>
</div>
@@ -569,26 +569,26 @@
The object takes the form of:
{ # Request message to unclaim a device.
- "vacationModeDays": 42, # The duration of the vacation unlock starting from when the request is
+ "vacationModeDays": 42, # 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. # The device identifier you used when you claimed this device.
+ "vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
+ "deviceId": "A String", # The device ID returned by `ClaimDevice`.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The device identifier you used when you claimed this device.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "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.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "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.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "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).
},
- "vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
- "deviceId": "A String", # The device ID returned by `ClaimDevice`.
- "sectionType": "A String", # Required. The section type of the device's provisioning record.
+ "sectionType": "A String", # Required. The section type of the device's provisioning record.
}
x__xgafv: string, V1 error format.
@@ -623,28 +623,28 @@
The object takes the form of:
{ # Request to unclaim devices asynchronously in batch.
- "unclaims": [ # Required. The list of devices to unclaim.
+ "unclaims": [ # Required. The list of devices to unclaim.
{ # Identifies one unclaim request.
- "vacationModeDays": 42, # 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. # Device identifier of the device.
+ "deviceId": "A String", # Device ID of the device.
+ "sectionType": "A String", # Required. The section type of the device's provisioning record.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Device identifier of the device.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "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.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "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.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "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).
},
- "vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
- "deviceId": "A String", # Device ID of the device.
- "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)
},
],
}
@@ -659,36 +659,36 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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`.
+ "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).
- "message": "A String", # A developer-facing error message, which should be in English. Any
+ "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.
- "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
+ "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.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
- "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
+ "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}`.
+ "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.
+ },
+ "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.
+ "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.
+ },
}</pre>
</div>
@@ -705,30 +705,30 @@
The object takes the form of:
{ # Request to update device metadata in batch.
- "updates": [ # Required. The list of metadata updates.
+ "updates": [ # Required. The list of metadata updates.
{ # Identifies metadata updates to one device.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Device identifier.
+ "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Device identifier.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
- "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.
- "meid": "A String", # The device’s MEID number.
- "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in
+ "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.
+ "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
+ # unique across different device models.
+ "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).
},
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to update.
+ "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to update.
# [Device metadata](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
},
},
- "deviceId": "A String", # Device ID of the device.
+ "deviceId": "A String", # Device ID of the device.
},
],
}
@@ -743,36 +743,36 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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`.
+ "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).
- "message": "A String", # A developer-facing error message, which should be in English. Any
+ "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.
- "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
+ "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.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "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.
- "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
+ "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}`.
+ "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.
+ },
+ "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.
+ "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.
+ },
}</pre>
</div>