DeviceArgs

data class DeviceArgs(val blocked: Output<Boolean>? = null, val config: Output<DeviceConfigArgs>? = null, val credentials: Output<List<DeviceCredentialArgs>>? = null, val gatewayConfig: Output<GatewayConfigArgs>? = null, val id: Output<String>? = null, val location: Output<String>? = null, val logLevel: Output<DeviceLogLevel>? = null, val metadata: Output<Map<String, String>>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val registryId: Output<String>? = null) : ConvertibleToJava<DeviceArgs>

Creates a device in a device registry.

Constructors

Link copied to clipboard
fun DeviceArgs(blocked: Output<Boolean>? = null, config: Output<DeviceConfigArgs>? = null, credentials: Output<List<DeviceCredentialArgs>>? = null, gatewayConfig: Output<GatewayConfigArgs>? = null, id: Output<String>? = null, location: Output<String>? = null, logLevel: Output<DeviceLogLevel>? = null, metadata: Output<Map<String, String>>? = null, name: Output<String>? = null, project: Output<String>? = null, registryId: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): DeviceArgs

Properties

Link copied to clipboard
val blocked: Output<Boolean>? = null

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.

Link copied to clipboard
val config: Output<DeviceConfigArgs>? = null

The most recent device configuration, which is eventually sent from Cloud IoT Core to the device. If not present on creation, the configuration will be initialized with an empty payload and version value of 1. To update this field after creation, use the DeviceManager.ModifyCloudToDeviceConfig method.

Link copied to clipboard
val credentials: Output<List<DeviceCredentialArgs>>? = null

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.

Link copied to clipboard
val gatewayConfig: Output<GatewayConfigArgs>? = null

Gateway-related configuration and state.

Link copied to clipboard
val id: Output<String>? = null

The user-defined device identifier. The device ID must be unique within a device registry.

Link copied to clipboard
val location: Output<String>? = null
Link copied to clipboard
val logLevel: Output<DeviceLogLevel>? = null

Beta Feature The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.

Link copied to clipboard
val metadata: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val name: Output<String>? = null

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}. When name is populated as a response from the service, it always ends in the device numeric ID.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val registryId: Output<String>? = null