docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html b/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
index 8098575..5986853 100644
--- a/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
+++ b/docs/dyn/androiddeviceprovisioning_v1.partners.devices.html
@@ -126,22 +126,22 @@
# 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.
+ "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).
},
- "customerId": "A String", # Required. The ID of the customer for whom the device is being claimed.
- "sectionType": "A String", # Required. The section type of the device's provisioning record.
"deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Optional. The metadata to attach to the device.
# [Device metadata](/zero-touch/guides/metadata).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
+ "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.
}
x__xgafv: string, V1 error format.
@@ -175,13 +175,8 @@
# of the portal.
"claims": [ # Required. A list of device claims.
{ # Identifies one claim request.
- "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read # Required. The metadata to attach to the device at claim.
- # [Device metadata](/zero-touch/guides/metadata).
- "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. # Required. Device identifier of the device.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
@@ -189,15 +184,20 @@
# 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.
+ "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.
+ "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,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for # This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -219,29 +222,26 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # 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.
},
],
+ "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.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "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.
- "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}`.
}</pre>
</div>
@@ -255,8 +255,6 @@
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. # Required. The device identifier to search for.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
@@ -264,14 +262,16 @@
# 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.
+ "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).
},
+ "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.
}
@@ -284,6 +284,8 @@
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
@@ -294,15 +296,17 @@
# 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.
+ "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).
},
- "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.
"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).
@@ -310,8 +314,7 @@
"a_key": "A String",
},
},
- "name": "A String", # Output only. The API resource name in the format
- # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
+ "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
"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
@@ -323,20 +326,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).
+ "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'.
- "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
},
],
- "configuration": "A String", # Not available to resellers.
},
],
- "nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further
- # results are available.
"totalSize": 42, # The total count of items in the list irrespective of pagination.
}</pre>
</div>
@@ -368,13 +368,13 @@
The object takes the form of:
{ # Request to find devices by customers.
+ "pageToken": "A String", # A token specifying which result page to return.
+ "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.
@@ -396,15 +396,17 @@
# 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.
+ "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).
},
- "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.
"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).
@@ -412,8 +414,7 @@
"a_key": "A String",
},
},
- "name": "A String", # Output only. The API resource name in the format
- # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
+ "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
"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
@@ -425,21 +426,20 @@
# 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).
+ "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'.
- "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
},
],
- "configuration": "A String", # Not available to resellers.
},
],
- "totalSize": 42, # The total count of items in the list irrespective of pagination.
"nextPageToken": "A String", # A token used to access the next page of results.
# Omitted if no further results are available.
+ "totalSize": 42, # The total count of items in the list irrespective of pagination.
}</pre>
</div>
@@ -481,15 +481,17 @@
# 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.
+ "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).
},
- "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.
"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).
@@ -497,8 +499,7 @@
"a_key": "A String",
},
},
- "name": "A String", # Output only. The API resource name in the format
- # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
+ "deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
"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
@@ -510,16 +511,15 @@
# 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).
+ "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'.
- "vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is
- # present iff the device is in 'vacation mode'.
- "ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
},
],
- "configuration": "A String", # Not available to resellers.
}</pre>
</div>
@@ -569,10 +569,6 @@
The object takes the form of:
{ # Request message to unclaim a device.
- "vacationModeDays": 42, # The duration of the vacation unlock starting from when the request is
- # processed. (1 day is treated as 24 hours)
- "vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
- "deviceId": "A String", # The device ID returned by `ClaimDevice`.
"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # The device identifier you used when you claimed this device.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
@@ -580,14 +576,18 @@
# 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.
+ "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).
},
+ "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.
}
@@ -625,8 +625,10 @@
{ # 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
+ # processed. (1 day is treated as 24 hours)
"deviceId": "A String", # Device ID of the device.
- "sectionType": "A String", # Required. The section type of the device's provisioning record.
+ "vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
"deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. # Device identifier of the device.
# To understand requirements on identifier sets, read
# [Identifiers](/zero-touch/guides/identifiers).
@@ -634,17 +636,15 @@
# 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.
+ "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).
},
- "vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
- "vacationModeDays": 42, # The duration of the vacation unlock starting from when the request is
- # processed. (1 day is treated as 24 hours)
+ "sectionType": "A String", # Required. The section type of the device's provisioning record.
},
],
}
@@ -659,6 +659,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for # This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -666,29 +669,26 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # 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.
},
],
+ "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.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "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.
- "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}`.
}</pre>
</div>
@@ -714,21 +714,21 @@
# 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.
+ "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).
},
+ "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",
},
},
- "deviceId": "A String", # Device ID of the device.
},
],
}
@@ -743,6 +743,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for # This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -750,29 +753,26 @@
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # 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.
},
],
+ "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.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
+ "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.
- "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}`.
}</pre>
</div>