public
final
class
Device
extends
GeneratedMessageV3
implements
DeviceOrBuilder
The device resource.
Protobuf type google.cloud.iot.v1.Device
Static Fields
BLOCKED_FIELD_NUMBER
public
static
final
int
BLOCKED_FIELD_NUMBER
Field Value
CONFIG_FIELD_NUMBER
public
static
final
int
CONFIG_FIELD_NUMBER
Field Value
CREDENTIALS_FIELD_NUMBER
public
static
final
int
CREDENTIALS_FIELD_NUMBER
Field Value
GATEWAY_CONFIG_FIELD_NUMBER
public
static
final
int
GATEWAY_CONFIG_FIELD_NUMBER
Field Value
ID_FIELD_NUMBER
public
static
final
int
ID_FIELD_NUMBER
Field Value
LAST_CONFIG_ACK_TIME_FIELD_NUMBER
public
static
final
int
LAST_CONFIG_ACK_TIME_FIELD_NUMBER
Field Value
LAST_CONFIG_SEND_TIME_FIELD_NUMBER
public
static
final
int
LAST_CONFIG_SEND_TIME_FIELD_NUMBER
Field Value
LAST_ERROR_STATUS_FIELD_NUMBER
public
static
final
int
LAST_ERROR_STATUS_FIELD_NUMBER
Field Value
LAST_ERROR_TIME_FIELD_NUMBER
public
static
final
int
LAST_ERROR_TIME_FIELD_NUMBER
Field Value
LAST_EVENT_TIME_FIELD_NUMBER
public
static
final
int
LAST_EVENT_TIME_FIELD_NUMBER
Field Value
LAST_HEARTBEAT_TIME_FIELD_NUMBER
public
static
final
int
LAST_HEARTBEAT_TIME_FIELD_NUMBER
Field Value
LAST_STATE_TIME_FIELD_NUMBER
public
static
final
int
LAST_STATE_TIME_FIELD_NUMBER
Field Value
LOG_LEVEL_FIELD_NUMBER
public
static
final
int
LOG_LEVEL_FIELD_NUMBER
Field Value
public
static
final
int
METADATA_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
Field Value
NUM_ID_FIELD_NUMBER
public
static
final
int
NUM_ID_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public
static
final
int
STATE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public
static
Device
getDefaultInstance
()
Returns
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
Returns
newBuilder()
public
static
Device
.
Builder
newBuilder
()
Returns
newBuilder(Device prototype)
public
static
Device
.
Builder
newBuilder
(
Device
prototype
)
Parameter
Returns
public
static
Device
parseDelimitedFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
public
static
Device
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public
static
Device
parseFrom
(
byte
[]
data
)
Parameter
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Device
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public
static
Device
parseFrom
(
ByteString
data
)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Device
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
public
static
Device
parseFrom
(
CodedInputStream
input
)
Parameter
Returns
Exceptions
public
static
Device
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
public
static
Device
parseFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
public
static
Device
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public
static
Device
parseFrom
(
ByteBuffer
data
)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Device
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parser()
public
static
Parser<Device>
parser
()
Returns
Methods
public
boolean
containsMetadata
(
String
key
)
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.
map<string, string> metadata = 17;
Parameter
Returns
equals(Object obj)
public
boolean
equals
(
Object
obj
)
Parameter
Returns
Overrides
getBlocked()
public
boolean
getBlocked
()
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.
bool blocked = 19;
Returns
getConfig()
public
DeviceConfig
getConfig
()
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.
.google.cloud.iot.v1.DeviceConfig config = 13;
Returns
getConfigOrBuilder()
public
DeviceConfigOrBuilder
getConfigOrBuilder
()
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.
.google.cloud.iot.v1.DeviceConfig config = 13;
Returns
getCredentials(int index)
public
DeviceCredential
getCredentials
(
int
index
)
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.
repeated .google.cloud.iot.v1.DeviceCredential credentials = 12;
Parameter
Returns
getCredentialsCount()
public
int
getCredentialsCount
()
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.
repeated .google.cloud.iot.v1.DeviceCredential credentials = 12;
Returns
getCredentialsList()
public
List<DeviceCredential>
getCredentialsList
()
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.
repeated .google.cloud.iot.v1.DeviceCredential credentials = 12;
Returns
getCredentialsOrBuilder(int index)
public
DeviceCredentialOrBuilder
getCredentialsOrBuilder
(
int
index
)
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.
repeated .google.cloud.iot.v1.DeviceCredential credentials = 12;
Parameter
Returns
getCredentialsOrBuilderList()
public
List
< ?
extends
DeviceCredentialOrBuilder
>
getCredentialsOrBuilderList
()
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.
repeated .google.cloud.iot.v1.DeviceCredential credentials = 12;
Returns
getDefaultInstanceForType()
public
Device
getDefaultInstanceForType
()
Returns
getGatewayConfig()
public
GatewayConfig
getGatewayConfig
()
Gateway-related configuration and state.
.google.cloud.iot.v1.GatewayConfig gateway_config = 24;
Returns
getGatewayConfigOrBuilder()
public
GatewayConfigOrBuilder
getGatewayConfigOrBuilder
()
Gateway-related configuration and state.
.google.cloud.iot.v1.GatewayConfig gateway_config = 24;
Returns
getId()
The user-defined device identifier. The device ID must be unique
within a device registry.
string id = 1;
Returns
getIdBytes()
public
ByteString
getIdBytes
()
The user-defined device identifier. The device ID must be unique
within a device registry.
string id = 1;
Returns
getLastConfigAckTime()
public
Timestamp
getLastConfigAckTime
()
[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.
.google.protobuf.Timestamp last_config_ack_time = 14;
Returns
getLastConfigAckTimeOrBuilder()
public
TimestampOrBuilder
getLastConfigAckTimeOrBuilder
()
[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.
.google.protobuf.Timestamp last_config_ack_time = 14;
Returns
getLastConfigSendTime()
public
Timestamp
getLastConfigSendTime
()
[Output only] The last time a cloud-to-device config version was sent to
the device.
.google.protobuf.Timestamp last_config_send_time = 18;
Returns | Type |
Description |
| Timestamp
|
The lastConfigSendTime.
|
getLastConfigSendTimeOrBuilder()
public
TimestampOrBuilder
getLastConfigSendTimeOrBuilder
()
[Output only] The last time a cloud-to-device config version was sent to
the device.
.google.protobuf.Timestamp last_config_send_time = 18;
Returns
getLastErrorStatus()
public
Status
getLastErrorStatus
()
[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.
.google.rpc.Status last_error_status = 11;
Returns
getLastErrorStatusOrBuilder()
public
StatusOrBuilder
getLastErrorStatusOrBuilder
()
[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.
.google.rpc.Status last_error_status = 11;
Returns
getLastErrorTime()
public
Timestamp
getLastErrorTime
()
[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'.
.google.protobuf.Timestamp last_error_time = 10;
Returns
getLastErrorTimeOrBuilder()
public
TimestampOrBuilder
getLastErrorTimeOrBuilder
()
[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'.
.google.protobuf.Timestamp last_error_time = 10;
Returns
getLastEventTime()
public
Timestamp
getLastEventTime
()
[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.
.google.protobuf.Timestamp last_event_time = 8;
Returns
getLastEventTimeOrBuilder()
public
TimestampOrBuilder
getLastEventTimeOrBuilder
()
[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.
.google.protobuf.Timestamp last_event_time = 8;
Returns
getLastHeartbeatTime()
public
Timestamp
getLastHeartbeatTime
()
[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.
.google.protobuf.Timestamp last_heartbeat_time = 7;
Returns
getLastHeartbeatTimeOrBuilder()
public
TimestampOrBuilder
getLastHeartbeatTimeOrBuilder
()
[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.
.google.protobuf.Timestamp last_heartbeat_time = 7;
Returns
getLastStateTime()
public
Timestamp
getLastStateTime
()
[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.
.google.protobuf.Timestamp last_state_time = 20;
Returns
getLastStateTimeOrBuilder()
public
TimestampOrBuilder
getLastStateTimeOrBuilder
()
[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.
.google.protobuf.Timestamp last_state_time = 20;
Returns
getLogLevel()
public
LogLevel
getLogLevel
()
Beta FeatureThe logging verbosity for device activity. If unspecified,
DeviceRegistry.log_level will be used.
.google.cloud.iot.v1.LogLevel log_level = 21;
Returns
getLogLevelValue()
public
int
getLogLevelValue
()
Beta FeatureThe logging verbosity for device activity. If unspecified,
DeviceRegistry.log_level will be used.
.google.cloud.iot.v1.LogLevel log_level = 21;
Returns | Type |
Description |
| int
|
The enum numeric value on the wire for logLevel.
|
public
Map<String
,
String
>
getMetadata
()
Returns
public
int
getMetadataCount
()
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.
map<string, string> metadata = 17;
Returns
public
Map<String
,
String
>
getMetadataMap
()
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.
map<string, string> metadata = 17;
Returns
public
String
getMetadataOrDefault
(
String
key
,
String
defaultValue
)
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.
map<string, string> metadata = 17;
Parameters
Returns
public
String
getMetadataOrThrow
(
String
key
)
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.
map<string, string> metadata = 17;
Parameter
Returns
getName()
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.
string name = 2;
Returns
getNameBytes()
public
ByteString
getNameBytes
()
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.
string name = 2;
Returns
getNumId()
[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.
uint64 num_id = 3;
Returns
getParserForType()
public
Parser<Device>
getParserForType
()
Returns
Overrides
getSerializedSize()
public
int
getSerializedSize
()
Returns
Overrides
getState()
public
DeviceState
getState
()
[Output only] The state most recently received from the device. If no state
has been reported, this field is not present.
.google.cloud.iot.v1.DeviceState state = 16;
Returns
getStateOrBuilder()
public
DeviceStateOrBuilder
getStateOrBuilder
()
[Output only] The state most recently received from the device. If no state
has been reported, this field is not present.
.google.cloud.iot.v1.DeviceState state = 16;
Returns
getUnknownFields()
public
final
UnknownFieldSet
getUnknownFields
()
Returns
Overrides
hasConfig()
public
boolean
hasConfig
()
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.
.google.cloud.iot.v1.DeviceConfig config = 13;
Returns | Type |
Description |
| boolean
|
Whether the config field is set.
|
hasGatewayConfig()
public
boolean
hasGatewayConfig
()
Gateway-related configuration and state.
.google.cloud.iot.v1.GatewayConfig gateway_config = 24;
Returns | Type |
Description |
| boolean
|
Whether the gatewayConfig field is set.
|
hasLastConfigAckTime()
public
boolean
hasLastConfigAckTime
()
[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.
.google.protobuf.Timestamp last_config_ack_time = 14;
Returns | Type |
Description |
| boolean
|
Whether the lastConfigAckTime field is set.
|
hasLastConfigSendTime()
public
boolean
hasLastConfigSendTime
()
[Output only] The last time a cloud-to-device config version was sent to
the device.
.google.protobuf.Timestamp last_config_send_time = 18;
Returns | Type |
Description |
| boolean
|
Whether the lastConfigSendTime field is set.
|
hasLastErrorStatus()
public
boolean
hasLastErrorStatus
()
[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.
.google.rpc.Status last_error_status = 11;
Returns | Type |
Description |
| boolean
|
Whether the lastErrorStatus field is set.
|
hasLastErrorTime()
public
boolean
hasLastErrorTime
()
[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'.
.google.protobuf.Timestamp last_error_time = 10;
Returns | Type |
Description |
| boolean
|
Whether the lastErrorTime field is set.
|
hasLastEventTime()
public
boolean
hasLastEventTime
()
[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.
.google.protobuf.Timestamp last_event_time = 8;
Returns | Type |
Description |
| boolean
|
Whether the lastEventTime field is set.
|
hasLastHeartbeatTime()
public
boolean
hasLastHeartbeatTime
()
[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.
.google.protobuf.Timestamp last_heartbeat_time = 7;
Returns | Type |
Description |
| boolean
|
Whether the lastHeartbeatTime field is set.
|
hasLastStateTime()
public
boolean
hasLastStateTime
()
[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.
.google.protobuf.Timestamp last_state_time = 20;
Returns | Type |
Description |
| boolean
|
Whether the lastStateTime field is set.
|
hasState()
public
boolean
hasState
()
[Output only] The state most recently received from the device. If no state
has been reported, this field is not present.
.google.cloud.iot.v1.DeviceState state = 16;
Returns | Type |
Description |
| boolean
|
Whether the state field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
Returns
Overrides
internalGetMapField(int number)
protected
MapField
internalGetMapField
(
int
number
)
Parameter
Returns
Overrides
isInitialized()
public
final
boolean
isInitialized
()
Returns
Overrides
newBuilderForType()
public
Device
.
Builder
newBuilderForType
()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Device
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
Parameter
Returns
Overrides
toBuilder()
public
Device
.
Builder
toBuilder
()
Returns
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
Parameter
Overrides
Exceptions
