chore: update docs/dyn (#1162)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/b5e48daa-1759-436b-9fe7-ffce1482b520/targets
- [ ] To automatically regenerate this PR, check this box.
diff --git a/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html b/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
index 5a982e4..6eedf45 100644
--- a/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
+++ b/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
@@ -121,21 +121,21 @@
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 [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",
- },
+ "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.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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). # Optional. The metadata to attach to the device.
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
},
- "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.
- "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.
- "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 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.
- "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.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -146,9 +146,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]`.
- }</pre>
+ "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">
@@ -161,25 +161,25 @@
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.
- "claims": [ # Required. A list of device claims.
- { # Identifies one claim request.
- "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.
- "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 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.
- "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 [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",
- },
- },
- "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.
+ "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.
+ "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.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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 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.
+ },
+ ],
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -190,24 +190,24 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "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}`.
- "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`.
- "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 message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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.
- },
- "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.
- }</pre>
+ "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.
+ "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.
+ {
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+}</pre>
</div>
<div class="method">
@@ -225,16 +225,16 @@
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.
- "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.
- "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 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.
- "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).
- },
- "pageToken": "A String", # A token specifying which result page to return.
- }
+ "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.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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.
+ "pageToken": "A String", # A token specifying which result page to return.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -245,37 +245,37 @@
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.
- { # An Android device registered for zero-touch enrollment.
- "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).
- "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'.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased 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'.
- },
- ],
- "configuration": "A String", # Not available to resellers.
- "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",
- },
+ "devices": [ # Found devices.
+ { # An Android device registered for zero-touch enrollment.
+ "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).
+ "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.
+ "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
+ "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
},
- "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).
- "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 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.
- "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", # Output only. The ID of the device. Assigned by the server.
- "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.
+ "deviceId": "A String", # Output only. The ID of the device. 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).
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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.
},
- ],
- }</pre>
+ "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",
+ },
+ },
+ "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>
<div class="method">
@@ -302,13 +302,13 @@
The object takes the form of:
{ # Request to find devices by customers.
- "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.
- "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.
- }
+ "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.
+ "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.
Allowed values
@@ -319,37 +319,37 @@
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.
- { # An Android device registered for zero-touch enrollment.
- "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).
- "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'.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased 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'.
- },
- ],
- "configuration": "A String", # Not available to resellers.
- "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",
- },
+ "devices": [ # The customer's devices.
+ { # An Android device registered for zero-touch enrollment.
+ "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).
+ "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.
+ "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
+ "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
},
- "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).
- "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 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.
- "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", # Output only. The ID of the device. Assigned by the server.
- "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.
+ "deviceId": "A String", # Output only. The ID of the device. 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).
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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.
},
- ],
- }</pre>
+ "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",
+ },
+ },
+ "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>
<div class="method">
@@ -381,31 +381,31 @@
An object of the form:
{ # An Android device registered for zero-touch enrollment.
- "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).
- "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'.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased 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'.
- },
- ],
- "configuration": "A String", # Not available to resellers.
- "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",
- },
+ "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).
+ "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.
+ "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
+ "vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
},
- "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).
- "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 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.
- "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).
+ ],
+ "configuration": "A String", # Not available to resellers.
+ "deviceId": "A String", # Output only. The ID of the device. 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).
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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.
- "name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
- }</pre>
+ },
+ "name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
+}</pre>
</div>
<div class="method">
@@ -419,12 +419,12 @@
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 [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",
- },
+ "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",
},
- }
+ },
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -435,10 +435,10 @@
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).
- "entries": { # Metadata entries recorded as key-value pairs.
- "a_key": "A String",
- },
- }</pre>
+ "entries": { # Metadata entries recorded as key-value pairs.
+ "a_key": "A String",
+ },
+}</pre>
</div>
<div class="method">
@@ -451,18 +451,18 @@
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. 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.
- "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 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.
- "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).
- },
- "vacationModeDays": 42, # The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)
- "vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
- }
+ "deviceId": "A String", # Required. The device ID returned by `ClaimDevice`.
+ "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.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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.
+ "vacationModeDays": 42, # The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)
+ "vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -473,7 +473,7 @@
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 `{}`.
- }</pre>
+}</pre>
</div>
<div class="method">
@@ -486,22 +486,22 @@
The object takes the form of:
{ # Request to unclaim devices asynchronously in batch.
- "unclaims": [ # Required. The list of devices to unclaim.
- { # Identifies one unclaim request.
- "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.
- "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 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.
- "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.
- "vacationModeDays": 42, # Optional. 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.
- "deviceId": "A String", # Required. Device ID of the device.
+ "unclaims": [ # Required. The list of devices to unclaim.
+ { # Identifies one unclaim request.
+ "deviceId": "A String", # Required. Device ID of the device.
+ "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.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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.
+ "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.
+ },
+ ],
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -512,24 +512,24 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "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}`.
- "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`.
- "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 message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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.
- },
- "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.
- }</pre>
+ "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.
+ "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.
+ {
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+}</pre>
</div>
<div class="method">
@@ -542,24 +542,24 @@
The object takes the form of:
{ # 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 [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. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. Device identifier.
- "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 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.
- "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).
+ "updates": [ # Required. The list of metadata updates.
+ { # Identifies metadata updates to one device.
+ "deviceId": "A String", # Required. Device ID of the device.
+ "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.
+ "imei": "A String", # The device’s IMEI number. Validated on input.
+ "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.
+ "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",
},
},
- ],
- }
+ },
+ ],
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -570,24 +570,24 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "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}`.
- "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`.
- "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 message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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.
- },
- "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.
- }</pre>
+ "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.
+ "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.
+ {
+ "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.
+ },
+ "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.
+ },
+ "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.
+ },
+}</pre>
</div>
</body></html>
\ No newline at end of file