docs: update generated docs (#981)
diff --git a/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html b/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
index 5986853..c8a0cff 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.
- "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).
- "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).
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "meid": "A String", # The device’s MEID number.
- "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.
"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).
+ # [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
"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. 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).
+ "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).
+ },
}
x__xgafv: string, V1 error format.
@@ -153,9 +153,9 @@
An object of the form:
{ # Response message containing device id of the claim.
- "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>
@@ -175,29 +175,29 @@
# of the portal.
"claims": [ # Required. A list of device claims.
{ # Identifies one claim request.
- "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 # Required. The metadata to attach to the device at claim.
+ # [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
+ "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.
- "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. Required. Device identifier of the device.
# To understand requirements on identifier sets, read
- # [Identifiers](/zero-touch/guides/identifiers).
+ # [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).
- "imei": "A String", # The device’s IMEI number. Validated on input.
"meid": "A String", # The device’s MEID number.
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
+ "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).
},
- "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",
- },
- },
},
],
}
@@ -212,6 +212,15 @@
{ # 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.
},
@@ -222,26 +231,17 @@
#
# 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).
+ "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.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
},
- "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.
- "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}`.
}</pre>
</div>
@@ -255,24 +255,24 @@
The object takes the form of:
{ # Request to find devices.
- "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.
+ "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](/zero-touch/guides/identifiers).
+ # [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).
- "imei": "A String", # The device’s IMEI number. Validated on input.
"meid": "A String", # The device’s MEID number.
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
+ "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).
},
- "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,37 +284,34 @@
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.
- "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).
- "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).
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "meid": "A String", # The device’s MEID number.
- "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
- # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- "configuration": "A String", # Not available to resellers.
"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).
+ # learn more, read [Device
+ # metadata](https://developers.google.com/zero-touch/guides/metadata).
+ # [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
@@ -326,17 +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'.
+ "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.
- "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'.
},
],
+ "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>
@@ -368,13 +369,13 @@
The object takes the form of:
{ # Request to find devices by customers.
- "pageToken": "A String", # A token specifying which result page to return.
- "sectionType": "A String", # Required. The section type of the device's provisioning record.
"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.
@@ -388,33 +389,32 @@
{ # Response containing found 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
- # [Identifiers](/zero-touch/guides/identifiers).
- # To understand requirements on identifier sets, read
- # [Identifiers](/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).
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "meid": "A String", # The device’s MEID number.
- "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
- # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- "configuration": "A String", # Not available to resellers.
"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).
+ # learn more, read [Device
+ # metadata](https://developers.google.com/zero-touch/guides/metadata).
+ # [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
@@ -426,20 +426,22 @@
# 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.
- "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'.
},
],
+ "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.
- "totalSize": 42, # The total count of items in the list irrespective of pagination.
}</pre>
</div>
@@ -473,33 +475,32 @@
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
- # [Identifiers](/zero-touch/guides/identifiers).
- # To understand requirements on identifier sets, read
- # [Identifiers](/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).
- "imei": "A String", # The device’s IMEI number. Validated on input.
- "meid": "A String", # The device’s MEID number.
- "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
- # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- "configuration": "A String", # Not available to resellers.
"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).
+ # learn more, read [Device
+ # metadata](https://developers.google.com/zero-touch/guides/metadata).
+ # [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
@@ -511,15 +512,17 @@
# 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.
- "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'.
},
],
+ "name": "A String", # Output only. The API resource name in the format
+ # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
}</pre>
</div>
@@ -535,7 +538,7 @@
{ # 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](/zero-touch/guides/metadata).
+ # [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
@@ -551,7 +554,7 @@
An object of the form:
{ # Metadata entries that can be attached to a `Device`. To learn more, read
- # [Device metadata](/zero-touch/guides/metadata).
+ # [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
@@ -569,26 +572,26 @@
The object takes the form of:
{ # Request message to unclaim a device.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The device identifier you used when you claimed this device.
+ "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](/zero-touch/guides/identifiers).
+ # [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).
- "imei": "A String", # The device’s IMEI number. Validated on input.
"meid": "A String", # The device’s MEID number.
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
+ "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).
},
- "vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
- "deviceId": "A String", # The device ID returned by `ClaimDevice`.
"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.
}
x__xgafv: string, V1 error format.
@@ -625,26 +628,26 @@
{ # Request to unclaim devices asynchronously in batch.
"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
+ "vacationModeDays": 42, # Optional. The duration of the vacation unlock starting from when the request is
# processed. (1 day is treated as 24 hours)
- "deviceId": "A String", # Device ID of the device.
- "vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
- "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Device identifier of the device.
+ "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).
+ # [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).
- "imei": "A String", # The device’s IMEI number. Validated on input.
"meid": "A String", # The device’s MEID number.
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
+ "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).
},
+ "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.
},
],
}
@@ -659,6 +662,15 @@
{ # 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.
},
@@ -669,26 +681,17 @@
#
# 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).
+ "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.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
},
- "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.
- "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}`.
}</pre>
</div>
@@ -707,28 +710,28 @@
{ # Request to update device metadata in batch.
"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.
+ "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).
+ "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](/zero-touch/guides/identifiers).
+ # [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).
- "imei": "A String", # The device’s IMEI number. Validated on input.
"meid": "A String", # The device’s MEID number.
- "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be
- # unique across different device models.
+ "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", # 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](/zero-touch/guides/metadata).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
- },
},
],
}
@@ -743,6 +746,15 @@
{ # 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.
},
@@ -753,26 +765,17 @@
#
# 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).
+ "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.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
},
- "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.
- "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}`.
}</pre>
</div>