Class: Google::Apis::CloudiotV1::Device

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudiot_v1/classes.rb,
generated/google/apis/cloudiot_v1/representations.rb,
generated/google/apis/cloudiot_v1/representations.rb

Overview

The device resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Device

Returns a new instance of Device



245
246
247
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 245

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#blocked ⇒ Boolean Also known as: blocked?

If a device is blocked, connections or requests from this device will fail. Can be used to temporarily prevent the device from connecting if, for example, the sensor is generating bad data and needs maintenance. Corresponds to the JSON property blocked

Returns:

  • (Boolean) 


123
124
125
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 123

def blocked
  @blocked
end

#config ⇒ Google::Apis::CloudiotV1::DeviceConfig

The device configuration. Eventually delivered to devices. Corresponds to the JSON property config

Returns:



129
130
131
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 129

def config
  @config
end

#credentials ⇒ Array<Google::Apis::CloudiotV1::DeviceCredential>

The credentials used to authenticate this device. To allow credential rotation without interruption, multiple device credentials can be bound to this device. No more than 3 credentials can be bound to a single device at a time. When new credentials are added to a device, they are verified against the registry credentials. For details, see the description of the DeviceRegistry.credentials field. Corresponds to the JSON property credentials

Returns:



139
140
141
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 139

def credentials
  @credentials
end

#gateway_config ⇒ Google::Apis::CloudiotV1::GatewayConfig

Gateway-related configuration and state. Corresponds to the JSON property gatewayConfig

Returns:



144
145
146
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 144

def gateway_config
  @gateway_config
end

#id ⇒ String

The user-defined device identifier. The device ID must be unique within a device registry. Corresponds to the JSON property id

Returns:

  • (String) 


150
151
152
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 150

def id
  @id
end

#last_config_ack_time ⇒ String

[Output only] The last time a cloud-to-device config version acknowledgment was received from the device. This field is only for configurations sent through MQTT. Corresponds to the JSON property lastConfigAckTime

Returns:

  • (String) 


157
158
159
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 157

def last_config_ack_time
  @last_config_ack_time
end

#last_config_send_time ⇒ String

[Output only] The last time a cloud-to-device config version was sent to the device. Corresponds to the JSON property lastConfigSendTime

Returns:

  • (String) 


163
164
165
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 163

def last_config_send_time
  @last_config_send_time
end

#last_error_status ⇒ Google::Apis::CloudiotV1::Status

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. 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. Corresponds to the JSON property lastErrorStatus

Returns:



173
174
175
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 173

def last_error_status
  @last_error_status
end

#last_error_time ⇒ String

[Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. This field is the timestamp of 'last_error_status'. Corresponds to the JSON property lastErrorTime

Returns:

  • (String) 


180
181
182
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 180

def last_error_time
  @last_error_time
end

#last_event_time ⇒ String

[Output only] The last time a telemetry event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. Corresponds to the JSON property lastEventTime

Returns:

  • (String) 


187
188
189
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 187

def last_event_time
  @last_event_time
end

#last_heartbeat_time ⇒ String

[Output only] The last time an MQTT PINGREQ was received. This field applies only to devices connecting through MQTT. MQTT clients usually only send PINGREQ messages if the connection is idle, and no other messages have been sent. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. Corresponds to the JSON property lastHeartbeatTime

Returns:

  • (String) 


196
197
198
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 196

def last_heartbeat_time
  @last_heartbeat_time
end

#last_state_time ⇒ String

[Output only] The last time a state event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. Corresponds to the JSON property lastStateTime

Returns:

  • (String) 


203
204
205
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 203

def last_state_time
  @last_state_time
end

#log_level ⇒ String

Beta Feature The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used. Corresponds to the JSON property logLevel

Returns:

  • (String) 


210
211
212
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 210

def log_level
  @log_level
end

#metadata ⇒ Hash<String,String>

The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by Cloud IoT Core. It can be used to add contextual information for the device. Keys must conform to the regular expression a-zA-Z+ and be less than 128 bytes in length. Values are free-form strings. Each value must be less than or equal to 32 KB in size. The total size of all keys and values must be less than 256 KB, and the maximum number of key-value pairs is 500. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,String>) 


223
224
225
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 223

def metadata
  @metadata
end

#name ⇒ String

The resource path name. For example, projects/p1/locations/us-central1/registries/registry0/devices/dev0 or projects/p1/locations/us-central1/registries/registry0/devices/num_id`. Whennameis populated as a response from the service, it always ends in the device numeric ID. Corresponds to the JSON propertyname`

Returns:

  • (String) 


232
233
234
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 232

def name
  @name
end

#num_id ⇒ Fixnum

[Output only] A server-defined unique numeric ID for the device. This is a more compact way to identify devices, and it is globally unique. Corresponds to the JSON property numId

Returns:

  • (Fixnum) 


238
239
240
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 238

def num_id
  @num_id
end

#state ⇒ Google::Apis::CloudiotV1::DeviceState

The device state, as reported by the device. Corresponds to the JSON property state

Returns:



243
244
245
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 243

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 250

def update!(**args)
  @blocked = args[:blocked] if args.key?(:blocked)
  @config = args[:config] if args.key?(:config)
  @credentials = args[:credentials] if args.key?(:credentials)
  @gateway_config = args[:gateway_config] if args.key?(:gateway_config)
  @id = args[:id] if args.key?(:id)
  @last_config_ack_time = args[:last_config_ack_time] if args.key?(:last_config_ack_time)
  @last_config_send_time = args[:last_config_send_time] if args.key?(:last_config_send_time)
  @last_error_status = args[:last_error_status] if args.key?(:last_error_status)
  @last_error_time = args[:last_error_time] if args.key?(:last_error_time)
  @last_event_time = args[:last_event_time] if args.key?(:last_event_time)
  @last_heartbeat_time = args[:last_heartbeat_time] if args.key?(:last_heartbeat_time)
  @last_state_time = args[:last_state_time] if args.key?(:last_state_time)
  @log_level = args[:log_level] if args.key?(:log_level)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @num_id = args[:num_id] if args.key?(:num_id)
  @state = args[:state] if args.key?(:state)
end