public final class DeviceRegistry extends GeneratedMessageV3 implements DeviceRegistryOrBuilder
A container for a group of devices.Protobuf type
google.cloud.iot.v1.DeviceRegistry
Modifier and Type | Class and Description |
---|---|
static class |
DeviceRegistry.Builder
A container for a group of devices.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
CREDENTIALS_FIELD_NUMBER |
static int |
EVENT_NOTIFICATION_CONFIGS_FIELD_NUMBER |
static int |
HTTP_CONFIG_FIELD_NUMBER |
static int |
ID_FIELD_NUMBER |
static int |
LOG_LEVEL_FIELD_NUMBER |
static int |
MQTT_CONFIG_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
STATE_NOTIFICATION_CONFIG_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
RegistryCredential |
getCredentials(int index)
The credentials used to verify the device credentials.
|
int |
getCredentialsCount()
The credentials used to verify the device credentials.
|
List<RegistryCredential> |
getCredentialsList()
The credentials used to verify the device credentials.
|
RegistryCredentialOrBuilder |
getCredentialsOrBuilder(int index)
The credentials used to verify the device credentials.
|
List<? extends RegistryCredentialOrBuilder> |
getCredentialsOrBuilderList()
The credentials used to verify the device credentials.
|
static DeviceRegistry |
getDefaultInstance() |
DeviceRegistry |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
EventNotificationConfig |
getEventNotificationConfigs(int index)
The configuration for notification of telemetry events received from the
device.
|
int |
getEventNotificationConfigsCount()
The configuration for notification of telemetry events received from the
device.
|
List<EventNotificationConfig> |
getEventNotificationConfigsList()
The configuration for notification of telemetry events received from the
device.
|
EventNotificationConfigOrBuilder |
getEventNotificationConfigsOrBuilder(int index)
The configuration for notification of telemetry events received from the
device.
|
List<? extends EventNotificationConfigOrBuilder> |
getEventNotificationConfigsOrBuilderList()
The configuration for notification of telemetry events received from the
device.
|
HttpConfig |
getHttpConfig()
The DeviceService (HTTP) configuration for this device registry.
|
HttpConfigOrBuilder |
getHttpConfigOrBuilder()
The DeviceService (HTTP) configuration for this device registry.
|
String |
getId()
The identifier of this device registry.
|
ByteString |
getIdBytes()
The identifier of this device registry.
|
LogLevel |
getLogLevel()
**Beta Feature**
The default logging verbosity for activity from devices in this registry.
|
int |
getLogLevelValue()
**Beta Feature**
The default logging verbosity for activity from devices in this registry.
|
MqttConfig |
getMqttConfig()
The MQTT configuration for this device registry.
|
MqttConfigOrBuilder |
getMqttConfigOrBuilder()
The MQTT configuration for this device registry.
|
String |
getName()
The resource path name.
|
ByteString |
getNameBytes()
The resource path name.
|
Parser<DeviceRegistry> |
getParserForType() |
int |
getSerializedSize() |
StateNotificationConfig |
getStateNotificationConfig()
The configuration for notification of new states received from the device.
|
StateNotificationConfigOrBuilder |
getStateNotificationConfigOrBuilder()
The configuration for notification of new states received from the device.
|
UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
boolean |
hasHttpConfig()
The DeviceService (HTTP) configuration for this device registry.
|
boolean |
hasMqttConfig()
The MQTT configuration for this device registry.
|
boolean |
hasStateNotificationConfig()
The configuration for notification of new states received from the device.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static DeviceRegistry.Builder |
newBuilder() |
static DeviceRegistry.Builder |
newBuilder(DeviceRegistry prototype) |
DeviceRegistry.Builder |
newBuilderForType() |
protected DeviceRegistry.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) |
static DeviceRegistry |
parseDelimitedFrom(InputStream input) |
static DeviceRegistry |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static DeviceRegistry |
parseFrom(byte[] data) |
static DeviceRegistry |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static DeviceRegistry |
parseFrom(ByteBuffer data) |
static DeviceRegistry |
parseFrom(ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static DeviceRegistry |
parseFrom(ByteString data) |
static DeviceRegistry |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static DeviceRegistry |
parseFrom(CodedInputStream input) |
static DeviceRegistry |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static DeviceRegistry |
parseFrom(InputStream input) |
static DeviceRegistry |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<DeviceRegistry> |
parser() |
DeviceRegistry.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int ID_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
public static final int EVENT_NOTIFICATION_CONFIGS_FIELD_NUMBER
public static final int STATE_NOTIFICATION_CONFIG_FIELD_NUMBER
public static final int MQTT_CONFIG_FIELD_NUMBER
public static final int HTTP_CONFIG_FIELD_NUMBER
public static final int LOG_LEVEL_FIELD_NUMBER
public static final int CREDENTIALS_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public String getId()
The identifier of this device registry. For example, `myRegistry`.
string id = 1;
getId
in interface DeviceRegistryOrBuilder
public ByteString getIdBytes()
The identifier of this device registry. For example, `myRegistry`.
string id = 1;
getIdBytes
in interface DeviceRegistryOrBuilder
public String getName()
The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
string name = 2;
getName
in interface DeviceRegistryOrBuilder
public ByteString getNameBytes()
The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`.
string name = 2;
getNameBytes
in interface DeviceRegistryOrBuilder
public List<EventNotificationConfig> getEventNotificationConfigsList()
The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
repeated .google.cloud.iot.v1.EventNotificationConfig event_notification_configs = 10;
getEventNotificationConfigsList
in interface DeviceRegistryOrBuilder
public List<? extends EventNotificationConfigOrBuilder> getEventNotificationConfigsOrBuilderList()
The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
repeated .google.cloud.iot.v1.EventNotificationConfig event_notification_configs = 10;
getEventNotificationConfigsOrBuilderList
in interface DeviceRegistryOrBuilder
public int getEventNotificationConfigsCount()
The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
repeated .google.cloud.iot.v1.EventNotificationConfig event_notification_configs = 10;
getEventNotificationConfigsCount
in interface DeviceRegistryOrBuilder
public EventNotificationConfig getEventNotificationConfigs(int index)
The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
repeated .google.cloud.iot.v1.EventNotificationConfig event_notification_configs = 10;
getEventNotificationConfigs
in interface DeviceRegistryOrBuilder
public EventNotificationConfigOrBuilder getEventNotificationConfigsOrBuilder(int index)
The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
repeated .google.cloud.iot.v1.EventNotificationConfig event_notification_configs = 10;
getEventNotificationConfigsOrBuilder
in interface DeviceRegistryOrBuilder
public boolean hasStateNotificationConfig()
The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core.
.google.cloud.iot.v1.StateNotificationConfig state_notification_config = 7;
hasStateNotificationConfig
in interface DeviceRegistryOrBuilder
public StateNotificationConfig getStateNotificationConfig()
The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core.
.google.cloud.iot.v1.StateNotificationConfig state_notification_config = 7;
getStateNotificationConfig
in interface DeviceRegistryOrBuilder
public StateNotificationConfigOrBuilder getStateNotificationConfigOrBuilder()
The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core.
.google.cloud.iot.v1.StateNotificationConfig state_notification_config = 7;
getStateNotificationConfigOrBuilder
in interface DeviceRegistryOrBuilder
public boolean hasMqttConfig()
The MQTT configuration for this device registry.
.google.cloud.iot.v1.MqttConfig mqtt_config = 4;
hasMqttConfig
in interface DeviceRegistryOrBuilder
public MqttConfig getMqttConfig()
The MQTT configuration for this device registry.
.google.cloud.iot.v1.MqttConfig mqtt_config = 4;
getMqttConfig
in interface DeviceRegistryOrBuilder
public MqttConfigOrBuilder getMqttConfigOrBuilder()
The MQTT configuration for this device registry.
.google.cloud.iot.v1.MqttConfig mqtt_config = 4;
getMqttConfigOrBuilder
in interface DeviceRegistryOrBuilder
public boolean hasHttpConfig()
The DeviceService (HTTP) configuration for this device registry.
.google.cloud.iot.v1.HttpConfig http_config = 9;
hasHttpConfig
in interface DeviceRegistryOrBuilder
public HttpConfig getHttpConfig()
The DeviceService (HTTP) configuration for this device registry.
.google.cloud.iot.v1.HttpConfig http_config = 9;
getHttpConfig
in interface DeviceRegistryOrBuilder
public HttpConfigOrBuilder getHttpConfigOrBuilder()
The DeviceService (HTTP) configuration for this device registry.
.google.cloud.iot.v1.HttpConfig http_config = 9;
getHttpConfigOrBuilder
in interface DeviceRegistryOrBuilder
public int getLogLevelValue()
**Beta Feature** The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.
.google.cloud.iot.v1.LogLevel log_level = 11;
getLogLevelValue
in interface DeviceRegistryOrBuilder
public LogLevel getLogLevel()
**Beta Feature** The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.
.google.cloud.iot.v1.LogLevel log_level = 11;
getLogLevel
in interface DeviceRegistryOrBuilder
public List<RegistryCredential> getCredentialsList()
The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified.
repeated .google.cloud.iot.v1.RegistryCredential credentials = 8;
getCredentialsList
in interface DeviceRegistryOrBuilder
public List<? extends RegistryCredentialOrBuilder> getCredentialsOrBuilderList()
The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified.
repeated .google.cloud.iot.v1.RegistryCredential credentials = 8;
getCredentialsOrBuilderList
in interface DeviceRegistryOrBuilder
public int getCredentialsCount()
The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified.
repeated .google.cloud.iot.v1.RegistryCredential credentials = 8;
getCredentialsCount
in interface DeviceRegistryOrBuilder
public RegistryCredential getCredentials(int index)
The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified.
repeated .google.cloud.iot.v1.RegistryCredential credentials = 8;
getCredentials
in interface DeviceRegistryOrBuilder
public RegistryCredentialOrBuilder getCredentialsOrBuilder(int index)
The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified.
repeated .google.cloud.iot.v1.RegistryCredential credentials = 8;
getCredentialsOrBuilder
in interface DeviceRegistryOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static DeviceRegistry parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DeviceRegistry parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DeviceRegistry parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DeviceRegistry parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DeviceRegistry parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DeviceRegistry parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static DeviceRegistry parseFrom(InputStream input) throws IOException
IOException
public static DeviceRegistry parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static DeviceRegistry parseDelimitedFrom(InputStream input) throws IOException
IOException
public static DeviceRegistry parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static DeviceRegistry parseFrom(CodedInputStream input) throws IOException
IOException
public static DeviceRegistry parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public DeviceRegistry.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static DeviceRegistry.Builder newBuilder()
public static DeviceRegistry.Builder newBuilder(DeviceRegistry prototype)
public DeviceRegistry.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected DeviceRegistry.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static DeviceRegistry getDefaultInstance()
public static Parser<DeviceRegistry> parser()
public Parser<DeviceRegistry> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public DeviceRegistry getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.