Blame - docs/dyn/cloudiot_v1.projects.locations.registries.groups.devices.html - platform/external/python/google-api-python-client

2020-07-22 17:02:09 -0700

[diff] [blame^]

78

<code><a href="#list">list(parent, pageToken=None, fieldMask=None, pageSize=None, deviceIds=None, deviceNumIds=None, gatewayListOptions_associationsDeviceId=None, gatewayListOptions_gatewayType=None, gatewayListOptions_associationsGatewayId=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">List devices in a device registry.</p>

80

81

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

82

<p class="firstline">Retrieves the next page of results.</p>

83

<h3>Method Details</h3>

84

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

85

<code class="details" id="list">list(parent, pageToken=None, fieldMask=None, pageSize=None, deviceIds=None, deviceNumIds=None, gatewayListOptions_associationsDeviceId=None, gatewayListOptions_gatewayType=None, gatewayListOptions_associationsGatewayId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

86

<pre>List devices in a device registry.

87

88

Args:

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

89

parent: string, Required. The device registry path. Required. For example,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

90

`projects/my-project/locations/us-central1/registries/my-registry`. (required)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

91

pageToken: string, The value returned by the last `ListDevicesResponse`; indicates

92

that this is a continuation of a prior `ListDevices` call and

93

the system should return the next page of data.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

94

fieldMask: string, The fields of the `Device` resource to be returned in the response. The

95

fields `id` and `num_id` are always returned, along with any

96

other fields specified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

pageSize: integer, The maximum number of devices to return in the response. If this value

98

is zero, the service will select a default size. A call may return fewer

99

objects than requested. A non-empty `next_page_token` in the response

100

indicates that more data is available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

101

deviceIds: string, A list of device string IDs. For example, `['device0', 'device12']`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

102

If empty, this field is ignored. Maximum IDs: 10,000 (repeated)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

103

deviceNumIds: string, A list of device numeric IDs. If empty, this field is ignored. Maximum

104

IDs: 10,000. (repeated)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

105

gatewayListOptions_associationsDeviceId: string, If set, returns only the gateways with which the specified device is

106

associated. The device ID can be numeric (`num_id`) or the user-defined

107

string (`id`). For example, if `456` is specified, returns only the

108

gateways to which the device with `num_id` 456 is bound.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

109

gatewayListOptions_gatewayType: string, If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY`

110

is specified, only non-gateway devices are returned. If

111

`GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.

112

gatewayListOptions_associationsGatewayId: string, If set, only devices associated with the specified gateway are returned.

113

The gateway ID can be numeric (`num_id`) or the user-defined string

114

(`id`). For example, if `123` is specified, only devices bound to the

115

gateway with `num_id` 123 are returned.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

116

x__xgafv: string, V1 error format.

117

Allowed values

118

1 - v1 error format

119

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

120

121

Returns:

122

An object of the form:

123

124

{ # Response for `ListDevices`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

125

"devices": [ # The devices that match the request.

126

{ # The device resource.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

127

"credentials": [ # The credentials used to authenticate this device. To allow credential

128

# rotation without interruption, multiple device credentials can be bound to

129

# this device. No more than 3 credentials can be bound to a single device at

130

# a time. When new credentials are added to a device, they are verified

131

# against the registry credentials. For details, see the description of the

132

# `DeviceRegistry.credentials` field.

133

{ # A server-stored device credential used for authentication.

134

"expirationTime": "A String", # [Optional] The time at which this credential becomes invalid. This

135

# credential will be ignored for new client authentication requests after

136

# this timestamp; however, it will not be automatically deleted.

137

"publicKey": { # A public key format and data. # A public key used to verify the signature of JSON Web Tokens (JWTs).

138

# When adding a new device credential, either via device creation or via

139

# modifications, this public key credential may be required to be signed by

140

# one of the registry level certificates. More specifically, if the

141

# registry contains at least one certificate, any new device credential

142

# must be signed by one of the registry certificates. As a result,

143

# when the registry contains certificates, only X.509 certificates are

144

# accepted as device credentials. However, if the registry does

145

# not contain a certificate, self-signed certificates and public keys will

146

# be accepted. New device credentials must be different from every

147

# registry-level certificate.

148

"key": "A String", # The key data.

149

"format": "A String", # The format of the key.

150

},

151

},

152

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

153

"name": "A String", # The resource path name. For example,

154

# `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or

155

# `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.

156

# When `name` is populated as a response from the service, it always ends

157

# in the device numeric ID.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

158

"lastErrorTime": "A String", # [Output only] The time the most recent error occurred, such as a failure to

159

# publish to Cloud Pub/Sub. This field is the timestamp of

160

# 'last_error_status'.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

161

"logLevel": "A String", # **Beta Feature**

162

#

163

# The logging verbosity for device activity. If unspecified,

164

# DeviceRegistry.log_level will be used.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

165

"metadata": { # The metadata key-value pairs assigned to the device. This metadata is not

166

# interpreted or indexed by Cloud IoT Core. It can be used to add contextual

167

# information for the device.

168

#

169

# Keys must conform to the regular expression a-zA-Z+ and

170

# be less than 128 bytes in length.

171

#

172

# Values are free-form strings. Each value must be less than or equal to 32

173

# KB in size.

174

#

175

# The total size of all keys and values must be less than 256 KB, and the

176

# maximum number of key-value pairs is 500.

177

"a_key": "A String",

178

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

179

"id": "A String", # The user-defined device identifier. The device ID must be unique

180

# within a device registry.

181

"lastConfigAckTime": "A String", # [Output only] The last time a cloud-to-device config version acknowledgment

182

# was received from the device. This field is only for configurations

183

# sent through MQTT.

184

"gatewayConfig": { # Gateway-related configuration and state. # Gateway-related configuration and state.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

185

"gatewayType": "A String", # Indicates whether the device is a gateway.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

186

"lastAccessedGatewayId": "A String", # [Output only] The ID of the gateway the device accessed most recently.

187

"gatewayAuthMethod": "A String", # Indicates how to authorize and/or authenticate devices to access the

188

# gateway.

189

"lastAccessedGatewayTime": "A String", # [Output only] The most recent time at which the device accessed the gateway

190

# specified in `last_accessed_gateway`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

191

},

192

"numId": "A String", # [Output only] A server-defined unique numeric ID for the device. This is a

193

# more compact way to identify devices, and it is globally unique.

194

"blocked": True or False, # If a device is blocked, connections or requests from this device will fail.

195

# Can be used to temporarily prevent the device from connecting if, for

196

# example, the sensor is generating bad data and needs maintenance.

197

"lastHeartbeatTime": "A String", # [Output only] The last time an MQTT `PINGREQ` was received. This field

198

# applies only to devices connecting through MQTT. MQTT clients usually only

199

# send `PINGREQ` messages if the connection is idle, and no other messages

200

# have been sent. Timestamps are periodically collected and written to

201

# storage; they may be stale by a few minutes.

202

"lastEventTime": "A String", # [Output only] The last time a telemetry event was received. Timestamps are

203

# periodically collected and written to storage; they may be stale by a few

204

# minutes.

205

"lastConfigSendTime": "A String", # [Output only] The last time a cloud-to-device config version was sent to

206

# the device.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

207

"lastErrorStatus": { # The `Status` type defines a logical error model that is suitable for # [Output only] The error message of the most recent error, such as a failure

208

# to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this

209

# field. If no errors have occurred, this field has an empty message

210

# and the status code 0 == OK. Otherwise, this field is expected to have a

211

# status code other than OK.

212

# different programming environments, including REST APIs and RPC APIs. It is

213

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

214

# three pieces of data: error code, error message, and error details.

215

#

216

# You can find out more about this error model and how to work with it in the

217

# [API Design Guide](https://cloud.google.com/apis/design/errors).

218

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

219

"message": "A String", # A developer-facing error message, which should be in English. Any

220

# user-facing error message should be localized and sent in the

221

# google.rpc.Status.details field, or localized by the client.

222

"details": [ # A list of messages that carry the error details. There is a common set of

223

# message types for APIs to use.

224

{

225

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

"lastStateTime": "A String", # [Output only] The last time a state event was received. Timestamps are

230

# periodically collected and written to storage; they may be stale by a few

231

# minutes.

232

"state": { # The device state, as reported by the device. # [Output only] The state most recently received from the device. If no state

233

# has been reported, this field is not present.

234

"updateTime": "A String", # [Output only] The time at which this state version was updated in Cloud

235

# IoT Core.

236

"binaryData": "A String", # The device state data.

237

},

238

"config": { # The device configuration. Eventually delivered to devices. # The most recent device configuration, which is eventually sent from

239

# Cloud IoT Core to the device. If not present on creation, the

240

# configuration will be initialized with an empty payload and version value

241

# of `1`. To update this field after creation, use the

242

# `DeviceManager.ModifyCloudToDeviceConfig` method.

243

"version": "A String", # [Output only] The version of this update. The version number is assigned by

244

# the server, and is always greater than 0 after device creation. The

245

# version must be 0 on the `CreateDevice` request if a `config` is

246

# specified; the response of `CreateDevice` will always have a value of 1.

247

"cloudUpdateTime": "A String", # [Output only] The time at which this configuration version was updated in

248

# Cloud IoT Core. This timestamp is set by the server.

249

"deviceAckTime": "A String", # [Output only] The time at which Cloud IoT Core received the

250

# acknowledgment from the device, indicating that the device has received

251

# this configuration version. If this field is not present, the device has

252

# not yet acknowledged that it received this version. Note that when

253

# the config was sent to the device, many config versions may have been

254

# available in Cloud IoT Core while the device was disconnected, and on

255

# connection, only the latest version is sent to the device. Some

256

# versions may never be sent to the device, and therefore are never

257

# acknowledged. This timestamp is set by Cloud IoT Core.

258

"binaryData": "A String", # The device configuration data.

259

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

260

},

261

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

262

"nextPageToken": "A String", # If not empty, indicates that there may be more devices that match the

263

# request; this value should be passed in a new `ListDevicesRequest`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

269

<pre>Retrieves the next page of results.

270

271

Args:

272

previous_request: The request for the previous page. (required)

273

previous_response: The response from the request for the previous page. (required)

274

275

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

276

A request object that you can call 'execute()' on to request the next

Bu Sun Kim