Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.cloudiot/v1.getDevice
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets details about a device.
Using getDevice
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDevice(args: GetDeviceArgs, opts?: InvokeOptions): Promise<GetDeviceResult>
function getDeviceOutput(args: GetDeviceOutputArgs, opts?: InvokeOptions): Output<GetDeviceResult>
def get_device(device_id: Optional[str] = None,
field_mask: Optional[str] = None,
location: Optional[str] = None,
project: Optional[str] = None,
registry_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDeviceResult
def get_device_output(device_id: Optional[pulumi.Input[str]] = None,
field_mask: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
registry_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDeviceResult]
func LookupDevice(ctx *Context, args *LookupDeviceArgs, opts ...InvokeOption) (*LookupDeviceResult, error)
func LookupDeviceOutput(ctx *Context, args *LookupDeviceOutputArgs, opts ...InvokeOption) LookupDeviceResultOutput
> Note: This function is named LookupDevice
in the Go SDK.
public static class GetDevice
{
public static Task<GetDeviceResult> InvokeAsync(GetDeviceArgs args, InvokeOptions? opts = null)
public static Output<GetDeviceResult> Invoke(GetDeviceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDeviceResult> getDevice(GetDeviceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:cloudiot/v1:getDevice
arguments:
# arguments dictionary
The following arguments are supported:
- Device
Id string - Location string
- Registry
Id string - Field
Mask string - Project string
- Device
Id string - Location string
- Registry
Id string - Field
Mask string - Project string
- device
Id String - location String
- registry
Id String - field
Mask String - project String
- device
Id string - location string
- registry
Id string - field
Mask string - project string
- device_
id str - location str
- registry_
id str - field_
mask str - project str
- device
Id String - location String
- registry
Id String - field
Mask String - project String
getDevice Result
The following output properties are available:
- Blocked bool
- 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.
- Config
Pulumi.
Google Native. Cloud Io T. V1. Outputs. Device Config Response - 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 theDeviceManager.ModifyCloudToDeviceConfig
method. - Credentials
List<Pulumi.
Google Native. Cloud Io T. V1. Outputs. Device Credential Response> - 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. - Gateway
Config Pulumi.Google Native. Cloud Io T. V1. Outputs. Gateway Config Response - Gateway-related configuration and state.
- Last
Config stringAck Time - [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.
- Last
Config stringSend Time - [Output only] The last time a cloud-to-device config version was sent to the device.
- Last
Error Pulumi.Status Google Native. Cloud Io T. V1. Outputs. Status Response - [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK.
- Last
Error stringTime - [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'.
- Last
Event stringTime - [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.
- Last
Heartbeat stringTime - [Output only] The last time an MQTT
PINGREQ
was received. This field applies only to devices connecting through MQTT. MQTT clients usually only sendPINGREQ
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. - Last
State stringTime - [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.
- Log
Level string - Beta Feature The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.
- Metadata Dictionary<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.
- Name string
- The resource path name. For example,
projects/p1/locations/us-central1/registries/registry0/devices/dev0
orprojects/p1/locations/us-central1/registries/registry0/devices/{num_id}
. Whenname
is populated as a response from the service, it always ends in the device numeric ID. - Num
Id string - [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.
- State
Pulumi.
Google Native. Cloud Io T. V1. Outputs. Device State Response - [Output only] The state most recently received from the device. If no state has been reported, this field is not present.
- Blocked bool
- 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.
- Config
Device
Config Response - 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 theDeviceManager.ModifyCloudToDeviceConfig
method. - Credentials
[]Device
Credential Response - 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. - Gateway
Config GatewayConfig Response - Gateway-related configuration and state.
- Last
Config stringAck Time - [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.
- Last
Config stringSend Time - [Output only] The last time a cloud-to-device config version was sent to the device.
- Last
Error StatusStatus Response - [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK.
- Last
Error stringTime - [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'.
- Last
Event stringTime - [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.
- Last
Heartbeat stringTime - [Output only] The last time an MQTT
PINGREQ
was received. This field applies only to devices connecting through MQTT. MQTT clients usually only sendPINGREQ
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. - Last
State stringTime - [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.
- Log
Level string - Beta Feature The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.
- Metadata map[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.
- Name string
- The resource path name. For example,
projects/p1/locations/us-central1/registries/registry0/devices/dev0
orprojects/p1/locations/us-central1/registries/registry0/devices/{num_id}
. Whenname
is populated as a response from the service, it always ends in the device numeric ID. - Num
Id string - [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.
- State
Device
State Response - [Output only] The state most recently received from the device. If no state has been reported, this field is not present.
- blocked Boolean
- 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.
- config
Device
Config Response - 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 theDeviceManager.ModifyCloudToDeviceConfig
method. - credentials
List<Device
Credential Response> - 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. - gateway
Config GatewayConfig Response - Gateway-related configuration and state.
- last
Config StringAck Time - [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.
- last
Config StringSend Time - [Output only] The last time a cloud-to-device config version was sent to the device.
- last
Error StatusStatus Response - [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK.
- last
Error StringTime - [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'.
- last
Event StringTime - [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.
- last
Heartbeat StringTime - [Output only] The last time an MQTT
PINGREQ
was received. This field applies only to devices connecting through MQTT. MQTT clients usually only sendPINGREQ
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. - last
State StringTime - [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.
- log
Level String - Beta Feature The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.
- metadata Map<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.
- name String
- The resource path name. For example,
projects/p1/locations/us-central1/registries/registry0/devices/dev0
orprojects/p1/locations/us-central1/registries/registry0/devices/{num_id}
. Whenname
is populated as a response from the service, it always ends in the device numeric ID. - num
Id String - [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.
- state
Device
State Response - [Output only] The state most recently received from the device. If no state has been reported, this field is not present.
- blocked boolean
- 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.
- config
Device
Config Response - 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 theDeviceManager.ModifyCloudToDeviceConfig
method. - credentials
Device
Credential Response[] - 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. - gateway
Config GatewayConfig Response - Gateway-related configuration and state.
- last
Config stringAck Time - [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.
- last
Config stringSend Time - [Output only] The last time a cloud-to-device config version was sent to the device.
- last
Error StatusStatus Response - [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK.
- last
Error stringTime - [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'.
- last
Event stringTime - [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.
- last
Heartbeat stringTime - [Output only] The last time an MQTT
PINGREQ
was received. This field applies only to devices connecting through MQTT. MQTT clients usually only sendPINGREQ
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. - last
State stringTime - [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.
- log
Level string - Beta Feature The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.
- metadata {[key: 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.
- name string
- The resource path name. For example,
projects/p1/locations/us-central1/registries/registry0/devices/dev0
orprojects/p1/locations/us-central1/registries/registry0/devices/{num_id}
. Whenname
is populated as a response from the service, it always ends in the device numeric ID. - num
Id string - [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.
- state
Device
State Response - [Output only] The state most recently received from the device. If no state has been reported, this field is not present.
- blocked bool
- 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.
- config
Device
Config Response - 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 theDeviceManager.ModifyCloudToDeviceConfig
method. - credentials
Sequence[Device
Credential Response] - 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. - gateway_
config GatewayConfig Response - Gateway-related configuration and state.
- last_
config_ strack_ time - [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.
- last_
config_ strsend_ time - [Output only] The last time a cloud-to-device config version was sent to the device.
- last_
error_ Statusstatus Response - [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK.
- last_
error_ strtime - [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'.
- last_
event_ strtime - [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.
- last_
heartbeat_ strtime - [Output only] The last time an MQTT
PINGREQ
was received. This field applies only to devices connecting through MQTT. MQTT clients usually only sendPINGREQ
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. - last_
state_ strtime - [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.
- log_
level str - Beta Feature The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.
- metadata Mapping[str, str]
- 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.
- name str
- The resource path name. For example,
projects/p1/locations/us-central1/registries/registry0/devices/dev0
orprojects/p1/locations/us-central1/registries/registry0/devices/{num_id}
. Whenname
is populated as a response from the service, it always ends in the device numeric ID. - num_
id str - [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.
- state
Device
State Response - [Output only] The state most recently received from the device. If no state has been reported, this field is not present.
- blocked Boolean
- 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.
- config Property Map
- 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 theDeviceManager.ModifyCloudToDeviceConfig
method. - credentials List<Property Map>
- 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. - gateway
Config Property Map - Gateway-related configuration and state.
- last
Config StringAck Time - [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.
- last
Config StringSend Time - [Output only] The last time a cloud-to-device config version was sent to the device.
- last
Error Property MapStatus - [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK.
- last
Error StringTime - [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'.
- last
Event StringTime - [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.
- last
Heartbeat StringTime - [Output only] The last time an MQTT
PINGREQ
was received. This field applies only to devices connecting through MQTT. MQTT clients usually only sendPINGREQ
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. - last
State StringTime - [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.
- log
Level String - Beta Feature The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.
- metadata Map<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.
- name String
- The resource path name. For example,
projects/p1/locations/us-central1/registries/registry0/devices/dev0
orprojects/p1/locations/us-central1/registries/registry0/devices/{num_id}
. Whenname
is populated as a response from the service, it always ends in the device numeric ID. - num
Id String - [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.
- state Property Map
- [Output only] The state most recently received from the device. If no state has been reported, this field is not present.
Supporting Types
DeviceConfigResponse
- Binary
Data string - The device configuration data.
- Cloud
Update stringTime - [Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.
- Device
Ack stringTime - [Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core.
- Version string
- [Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the
CreateDevice
request if aconfig
is specified; the response ofCreateDevice
will always have a value of 1.
- Binary
Data string - The device configuration data.
- Cloud
Update stringTime - [Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.
- Device
Ack stringTime - [Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core.
- Version string
- [Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the
CreateDevice
request if aconfig
is specified; the response ofCreateDevice
will always have a value of 1.
- binary
Data String - The device configuration data.
- cloud
Update StringTime - [Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.
- device
Ack StringTime - [Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core.
- version String
- [Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the
CreateDevice
request if aconfig
is specified; the response ofCreateDevice
will always have a value of 1.
- binary
Data string - The device configuration data.
- cloud
Update stringTime - [Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.
- device
Ack stringTime - [Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core.
- version string
- [Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the
CreateDevice
request if aconfig
is specified; the response ofCreateDevice
will always have a value of 1.
- binary_
data str - The device configuration data.
- cloud_
update_ strtime - [Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.
- device_
ack_ strtime - [Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core.
- version str
- [Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the
CreateDevice
request if aconfig
is specified; the response ofCreateDevice
will always have a value of 1.
- binary
Data String - The device configuration data.
- cloud
Update StringTime - [Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.
- device
Ack StringTime - [Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core.
- version String
- [Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the
CreateDevice
request if aconfig
is specified; the response ofCreateDevice
will always have a value of 1.
DeviceCredentialResponse
- Expiration
Time string - [Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted.
- Public
Key Pulumi.Google Native. Cloud Io T. V1. Inputs. Public Key Credential Response - A public key used to verify the signature of JSON Web Tokens (JWTs). When adding a new device credential, either via device creation or via modifications, this public key credential may be required to be signed by one of the registry level certificates. More specifically, if the registry contains at least one certificate, any new device credential must be signed by one of the registry certificates. As a result, when the registry contains certificates, only X.509 certificates are accepted as device credentials. However, if the registry does not contain a certificate, self-signed certificates and public keys will be accepted. New device credentials must be different from every registry-level certificate.
- Expiration
Time string - [Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted.
- Public
Key PublicKey Credential Response - A public key used to verify the signature of JSON Web Tokens (JWTs). When adding a new device credential, either via device creation or via modifications, this public key credential may be required to be signed by one of the registry level certificates. More specifically, if the registry contains at least one certificate, any new device credential must be signed by one of the registry certificates. As a result, when the registry contains certificates, only X.509 certificates are accepted as device credentials. However, if the registry does not contain a certificate, self-signed certificates and public keys will be accepted. New device credentials must be different from every registry-level certificate.
- expiration
Time String - [Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted.
- public
Key PublicKey Credential Response - A public key used to verify the signature of JSON Web Tokens (JWTs). When adding a new device credential, either via device creation or via modifications, this public key credential may be required to be signed by one of the registry level certificates. More specifically, if the registry contains at least one certificate, any new device credential must be signed by one of the registry certificates. As a result, when the registry contains certificates, only X.509 certificates are accepted as device credentials. However, if the registry does not contain a certificate, self-signed certificates and public keys will be accepted. New device credentials must be different from every registry-level certificate.
- expiration
Time string - [Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted.
- public
Key PublicKey Credential Response - A public key used to verify the signature of JSON Web Tokens (JWTs). When adding a new device credential, either via device creation or via modifications, this public key credential may be required to be signed by one of the registry level certificates. More specifically, if the registry contains at least one certificate, any new device credential must be signed by one of the registry certificates. As a result, when the registry contains certificates, only X.509 certificates are accepted as device credentials. However, if the registry does not contain a certificate, self-signed certificates and public keys will be accepted. New device credentials must be different from every registry-level certificate.
- expiration_
time str - [Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted.
- public_
key PublicKey Credential Response - A public key used to verify the signature of JSON Web Tokens (JWTs). When adding a new device credential, either via device creation or via modifications, this public key credential may be required to be signed by one of the registry level certificates. More specifically, if the registry contains at least one certificate, any new device credential must be signed by one of the registry certificates. As a result, when the registry contains certificates, only X.509 certificates are accepted as device credentials. However, if the registry does not contain a certificate, self-signed certificates and public keys will be accepted. New device credentials must be different from every registry-level certificate.
- expiration
Time String - [Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted.
- public
Key Property Map - A public key used to verify the signature of JSON Web Tokens (JWTs). When adding a new device credential, either via device creation or via modifications, this public key credential may be required to be signed by one of the registry level certificates. More specifically, if the registry contains at least one certificate, any new device credential must be signed by one of the registry certificates. As a result, when the registry contains certificates, only X.509 certificates are accepted as device credentials. However, if the registry does not contain a certificate, self-signed certificates and public keys will be accepted. New device credentials must be different from every registry-level certificate.
DeviceStateResponse
- Binary
Data string - The device state data.
- Update
Time string - [Output only] The time at which this state version was updated in Cloud IoT Core.
- Binary
Data string - The device state data.
- Update
Time string - [Output only] The time at which this state version was updated in Cloud IoT Core.
- binary
Data String - The device state data.
- update
Time String - [Output only] The time at which this state version was updated in Cloud IoT Core.
- binary
Data string - The device state data.
- update
Time string - [Output only] The time at which this state version was updated in Cloud IoT Core.
- binary_
data str - The device state data.
- update_
time str - [Output only] The time at which this state version was updated in Cloud IoT Core.
- binary
Data String - The device state data.
- update
Time String - [Output only] The time at which this state version was updated in Cloud IoT Core.
GatewayConfigResponse
- Gateway
Auth stringMethod - Indicates how to authorize and/or authenticate devices to access the gateway.
- Gateway
Type string - Indicates whether the device is a gateway.
- Last
Accessed stringGateway Id - [Output only] The ID of the gateway the device accessed most recently.
- Last
Accessed stringGateway Time - [Output only] The most recent time at which the device accessed the gateway specified in
last_accessed_gateway
.
- Gateway
Auth stringMethod - Indicates how to authorize and/or authenticate devices to access the gateway.
- Gateway
Type string - Indicates whether the device is a gateway.
- Last
Accessed stringGateway Id - [Output only] The ID of the gateway the device accessed most recently.
- Last
Accessed stringGateway Time - [Output only] The most recent time at which the device accessed the gateway specified in
last_accessed_gateway
.
- gateway
Auth StringMethod - Indicates how to authorize and/or authenticate devices to access the gateway.
- gateway
Type String - Indicates whether the device is a gateway.
- last
Accessed StringGateway Id - [Output only] The ID of the gateway the device accessed most recently.
- last
Accessed StringGateway Time - [Output only] The most recent time at which the device accessed the gateway specified in
last_accessed_gateway
.
- gateway
Auth stringMethod - Indicates how to authorize and/or authenticate devices to access the gateway.
- gateway
Type string - Indicates whether the device is a gateway.
- last
Accessed stringGateway Id - [Output only] The ID of the gateway the device accessed most recently.
- last
Accessed stringGateway Time - [Output only] The most recent time at which the device accessed the gateway specified in
last_accessed_gateway
.
- gateway_
auth_ strmethod - Indicates how to authorize and/or authenticate devices to access the gateway.
- gateway_
type str - Indicates whether the device is a gateway.
- last_
accessed_ strgateway_ id - [Output only] The ID of the gateway the device accessed most recently.
- last_
accessed_ strgateway_ time - [Output only] The most recent time at which the device accessed the gateway specified in
last_accessed_gateway
.
- gateway
Auth StringMethod - Indicates how to authorize and/or authenticate devices to access the gateway.
- gateway
Type String - Indicates whether the device is a gateway.
- last
Accessed StringGateway Id - [Output only] The ID of the gateway the device accessed most recently.
- last
Accessed StringGateway Time - [Output only] The most recent time at which the device accessed the gateway specified in
last_accessed_gateway
.
PublicKeyCredentialResponse
StatusResponse
- Code int
- The status code, which should be an enum value of google.rpc.Code.
- Details
List<Immutable
Dictionary<string, string>> - A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message 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 int
- The status code, which should be an enum value of google.rpc.Code.
- Details []map[string]string
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message 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 Integer
- The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String,String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message 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 number
- The status code, which should be an enum value of google.rpc.Code.
- details {[key: string]: string}[]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message 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 int
- The status code, which should be an enum value of google.rpc.Code.
- details Sequence[Mapping[str, str]]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message str
- 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 Number
- The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message 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.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi