Class DeviceRegistry.Builder (2.44.0)

public static final class DeviceRegistry.Builder extends GeneratedMessageV3.Builder<DeviceRegistry.Builder> implements DeviceRegistryOrBuilder

A container for a group of devices.

Protobuf type google.cloud.iot.v1.DeviceRegistry

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllCredentials(Iterable<? extends RegistryCredential> values)

public DeviceRegistry.Builder addAllCredentials(Iterable<? extends RegistryCredential> values)

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;

Parameter
Name Description
values Iterable<? extends com.google.cloud.iot.v1.RegistryCredential>
Returns
Type Description
DeviceRegistry.Builder

addAllEventNotificationConfigs(Iterable<? extends EventNotificationConfig> values)

public DeviceRegistry.Builder addAllEventNotificationConfigs(Iterable<? extends EventNotificationConfig> values)

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;

Parameter
Name Description
values Iterable<? extends com.google.cloud.iot.v1.EventNotificationConfig>
Returns
Type Description
DeviceRegistry.Builder

addCredentials(RegistryCredential value)

public DeviceRegistry.Builder addCredentials(RegistryCredential value)

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;

Parameter
Name Description
value RegistryCredential
Returns
Type Description
DeviceRegistry.Builder

addCredentials(RegistryCredential.Builder builderForValue)

public DeviceRegistry.Builder addCredentials(RegistryCredential.Builder builderForValue)

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;

Parameter
Name Description
builderForValue RegistryCredential.Builder
Returns
Type Description
DeviceRegistry.Builder

addCredentials(int index, RegistryCredential value)

public DeviceRegistry.Builder addCredentials(int index, RegistryCredential value)

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;

Parameters
Name Description
index int
value RegistryCredential
Returns
Type Description
DeviceRegistry.Builder

addCredentials(int index, RegistryCredential.Builder builderForValue)

public DeviceRegistry.Builder addCredentials(int index, RegistryCredential.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue RegistryCredential.Builder
Returns
Type Description
DeviceRegistry.Builder

addCredentialsBuilder()

public RegistryCredential.Builder addCredentialsBuilder()

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;

Returns
Type Description
RegistryCredential.Builder

addCredentialsBuilder(int index)

public RegistryCredential.Builder addCredentialsBuilder(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;

Parameter
Name Description
index int
Returns
Type Description
RegistryCredential.Builder

addEventNotificationConfigs(EventNotificationConfig value)

public DeviceRegistry.Builder addEventNotificationConfigs(EventNotificationConfig value)

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;

Parameter
Name Description
value EventNotificationConfig
Returns
Type Description
DeviceRegistry.Builder

addEventNotificationConfigs(EventNotificationConfig.Builder builderForValue)

public DeviceRegistry.Builder addEventNotificationConfigs(EventNotificationConfig.Builder builderForValue)

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;

Parameter
Name Description
builderForValue EventNotificationConfig.Builder
Returns
Type Description
DeviceRegistry.Builder

addEventNotificationConfigs(int index, EventNotificationConfig value)

public DeviceRegistry.Builder addEventNotificationConfigs(int index, EventNotificationConfig value)

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;

Parameters
Name Description
index int
value EventNotificationConfig
Returns
Type Description
DeviceRegistry.Builder

addEventNotificationConfigs(int index, EventNotificationConfig.Builder builderForValue)

public DeviceRegistry.Builder addEventNotificationConfigs(int index, EventNotificationConfig.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue EventNotificationConfig.Builder
Returns
Type Description
DeviceRegistry.Builder

addEventNotificationConfigsBuilder()

public EventNotificationConfig.Builder addEventNotificationConfigsBuilder()

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;

Returns
Type Description
EventNotificationConfig.Builder

addEventNotificationConfigsBuilder(int index)

public EventNotificationConfig.Builder addEventNotificationConfigsBuilder(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;

Parameter
Name Description
index int
Returns
Type Description
EventNotificationConfig.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeviceRegistry.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DeviceRegistry.Builder
Overrides

build()

public DeviceRegistry build()
Returns
Type Description
DeviceRegistry

buildPartial()

public DeviceRegistry buildPartial()
Returns
Type Description
DeviceRegistry

clear()

public DeviceRegistry.Builder clear()
Returns
Type Description
DeviceRegistry.Builder
Overrides

clearCredentials()

public DeviceRegistry.Builder clearCredentials()

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;

Returns
Type Description
DeviceRegistry.Builder

clearEventNotificationConfigs()

public DeviceRegistry.Builder clearEventNotificationConfigs()

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;

Returns
Type Description
DeviceRegistry.Builder

clearField(Descriptors.FieldDescriptor field)

public DeviceRegistry.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DeviceRegistry.Builder
Overrides

clearHttpConfig()

public DeviceRegistry.Builder clearHttpConfig()

The DeviceService (HTTP) configuration for this device registry.

.google.cloud.iot.v1.HttpConfig http_config = 9;

Returns
Type Description
DeviceRegistry.Builder

clearId()

public DeviceRegistry.Builder clearId()

The identifier of this device registry. For example, myRegistry.

string id = 1;

Returns
Type Description
DeviceRegistry.Builder

This builder for chaining.

clearLogLevel()

public DeviceRegistry.Builder clearLogLevel()

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;

Returns
Type Description
DeviceRegistry.Builder

This builder for chaining.

clearMqttConfig()

public DeviceRegistry.Builder clearMqttConfig()

The MQTT configuration for this device registry.

.google.cloud.iot.v1.MqttConfig mqtt_config = 4;

Returns
Type Description
DeviceRegistry.Builder

clearName()

public DeviceRegistry.Builder clearName()

The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.

string name = 2;

Returns
Type Description
DeviceRegistry.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DeviceRegistry.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DeviceRegistry.Builder
Overrides

clearStateNotificationConfig()

public DeviceRegistry.Builder clearStateNotificationConfig()

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;

Returns
Type Description
DeviceRegistry.Builder

clone()

public DeviceRegistry.Builder clone()
Returns
Type Description
DeviceRegistry.Builder
Overrides

getCredentials(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
RegistryCredential

getCredentialsBuilder(int index)

public RegistryCredential.Builder getCredentialsBuilder(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;

Parameter
Name Description
index int
Returns
Type Description
RegistryCredential.Builder

getCredentialsBuilderList()

public List<RegistryCredential.Builder> getCredentialsBuilderList()

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;

Returns
Type Description
List<Builder>

getCredentialsCount()

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;

Returns
Type Description
int

getCredentialsList()

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;

Returns
Type Description
List<RegistryCredential>

getCredentialsOrBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
RegistryCredentialOrBuilder

getCredentialsOrBuilderList()

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;

Returns
Type Description
List<? extends com.google.cloud.iot.v1.RegistryCredentialOrBuilder>

getDefaultInstanceForType()

public DeviceRegistry getDefaultInstanceForType()
Returns
Type Description
DeviceRegistry

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEventNotificationConfigs(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
EventNotificationConfig

getEventNotificationConfigsBuilder(int index)

public EventNotificationConfig.Builder getEventNotificationConfigsBuilder(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;

Parameter
Name Description
index int
Returns
Type Description
EventNotificationConfig.Builder

getEventNotificationConfigsBuilderList()

public List<EventNotificationConfig.Builder> getEventNotificationConfigsBuilderList()

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;

Returns
Type Description
List<Builder>

getEventNotificationConfigsCount()

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;

Returns
Type Description
int

getEventNotificationConfigsList()

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;

Returns
Type Description
List<EventNotificationConfig>

getEventNotificationConfigsOrBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
EventNotificationConfigOrBuilder

getEventNotificationConfigsOrBuilderList()

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;

Returns
Type Description
List<? extends com.google.cloud.iot.v1.EventNotificationConfigOrBuilder>

getHttpConfig()

public HttpConfig getHttpConfig()

The DeviceService (HTTP) configuration for this device registry.

.google.cloud.iot.v1.HttpConfig http_config = 9;

Returns
Type Description
HttpConfig

The httpConfig.

getHttpConfigBuilder()

public HttpConfig.Builder getHttpConfigBuilder()

The DeviceService (HTTP) configuration for this device registry.

.google.cloud.iot.v1.HttpConfig http_config = 9;

Returns
Type Description
HttpConfig.Builder

getHttpConfigOrBuilder()

public HttpConfigOrBuilder getHttpConfigOrBuilder()

The DeviceService (HTTP) configuration for this device registry.

.google.cloud.iot.v1.HttpConfig http_config = 9;

Returns
Type Description
HttpConfigOrBuilder

getId()

public String getId()

The identifier of this device registry. For example, myRegistry.

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

The identifier of this device registry. For example, myRegistry.

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getLogLevel()

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;

Returns
Type Description
LogLevel

The logLevel.

getLogLevelValue()

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;

Returns
Type Description
int

The enum numeric value on the wire for logLevel.

getMqttConfig()

public MqttConfig getMqttConfig()

The MQTT configuration for this device registry.

.google.cloud.iot.v1.MqttConfig mqtt_config = 4;

Returns
Type Description
MqttConfig

The mqttConfig.

getMqttConfigBuilder()

public MqttConfig.Builder getMqttConfigBuilder()

The MQTT configuration for this device registry.

.google.cloud.iot.v1.MqttConfig mqtt_config = 4;

Returns
Type Description
MqttConfig.Builder

getMqttConfigOrBuilder()

public MqttConfigOrBuilder getMqttConfigOrBuilder()

The MQTT configuration for this device registry.

.google.cloud.iot.v1.MqttConfig mqtt_config = 4;

Returns
Type Description
MqttConfigOrBuilder

getName()

public String getName()

The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.

string name = 2;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.

string name = 2;

Returns
Type Description
ByteString

The bytes for name.

getStateNotificationConfig()

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;

Returns
Type Description
StateNotificationConfig

The stateNotificationConfig.

getStateNotificationConfigBuilder()

public StateNotificationConfig.Builder getStateNotificationConfigBuilder()

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;

Returns
Type Description
StateNotificationConfig.Builder

getStateNotificationConfigOrBuilder()

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;

Returns
Type Description
StateNotificationConfigOrBuilder

hasHttpConfig()

public boolean hasHttpConfig()

The DeviceService (HTTP) configuration for this device registry.

.google.cloud.iot.v1.HttpConfig http_config = 9;

Returns
Type Description
boolean

Whether the httpConfig field is set.

hasMqttConfig()

public boolean hasMqttConfig()

The MQTT configuration for this device registry.

.google.cloud.iot.v1.MqttConfig mqtt_config = 4;

Returns
Type Description
boolean

Whether the mqttConfig field is set.

hasStateNotificationConfig()

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;

Returns
Type Description
boolean

Whether the stateNotificationConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DeviceRegistry other)

public DeviceRegistry.Builder mergeFrom(DeviceRegistry other)
Parameter
Name Description
other DeviceRegistry
Returns
Type Description
DeviceRegistry.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeviceRegistry.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeviceRegistry.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DeviceRegistry.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DeviceRegistry.Builder
Overrides

mergeHttpConfig(HttpConfig value)

public DeviceRegistry.Builder mergeHttpConfig(HttpConfig value)

The DeviceService (HTTP) configuration for this device registry.

.google.cloud.iot.v1.HttpConfig http_config = 9;

Parameter
Name Description
value HttpConfig
Returns
Type Description
DeviceRegistry.Builder

mergeMqttConfig(MqttConfig value)

public DeviceRegistry.Builder mergeMqttConfig(MqttConfig value)

The MQTT configuration for this device registry.

.google.cloud.iot.v1.MqttConfig mqtt_config = 4;

Parameter
Name Description
value MqttConfig
Returns
Type Description
DeviceRegistry.Builder

mergeStateNotificationConfig(StateNotificationConfig value)

public DeviceRegistry.Builder mergeStateNotificationConfig(StateNotificationConfig value)

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;

Parameter
Name Description
value StateNotificationConfig
Returns
Type Description
DeviceRegistry.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeviceRegistry.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DeviceRegistry.Builder
Overrides

removeCredentials(int index)

public DeviceRegistry.Builder removeCredentials(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;

Parameter
Name Description
index int
Returns
Type Description
DeviceRegistry.Builder

removeEventNotificationConfigs(int index)

public DeviceRegistry.Builder removeEventNotificationConfigs(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;

Parameter
Name Description
index int
Returns
Type Description
DeviceRegistry.Builder

setCredentials(int index, RegistryCredential value)

public DeviceRegistry.Builder setCredentials(int index, RegistryCredential value)

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;

Parameters
Name Description
index int
value RegistryCredential
Returns
Type Description
DeviceRegistry.Builder

setCredentials(int index, RegistryCredential.Builder builderForValue)

public DeviceRegistry.Builder setCredentials(int index, RegistryCredential.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue RegistryCredential.Builder
Returns
Type Description
DeviceRegistry.Builder

setEventNotificationConfigs(int index, EventNotificationConfig value)

public DeviceRegistry.Builder setEventNotificationConfigs(int index, EventNotificationConfig value)

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;

Parameters
Name Description
index int
value EventNotificationConfig
Returns
Type Description
DeviceRegistry.Builder

setEventNotificationConfigs(int index, EventNotificationConfig.Builder builderForValue)

public DeviceRegistry.Builder setEventNotificationConfigs(int index, EventNotificationConfig.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue EventNotificationConfig.Builder
Returns
Type Description
DeviceRegistry.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DeviceRegistry.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DeviceRegistry.Builder
Overrides

setHttpConfig(HttpConfig value)

public DeviceRegistry.Builder setHttpConfig(HttpConfig value)

The DeviceService (HTTP) configuration for this device registry.

.google.cloud.iot.v1.HttpConfig http_config = 9;

Parameter
Name Description
value HttpConfig
Returns
Type Description
DeviceRegistry.Builder

setHttpConfig(HttpConfig.Builder builderForValue)

public DeviceRegistry.Builder setHttpConfig(HttpConfig.Builder builderForValue)

The DeviceService (HTTP) configuration for this device registry.

.google.cloud.iot.v1.HttpConfig http_config = 9;

Parameter
Name Description
builderForValue HttpConfig.Builder
Returns
Type Description
DeviceRegistry.Builder

setId(String value)

public DeviceRegistry.Builder setId(String value)

The identifier of this device registry. For example, myRegistry.

string id = 1;

Parameter
Name Description
value String

The id to set.

Returns
Type Description
DeviceRegistry.Builder

This builder for chaining.

setIdBytes(ByteString value)

public DeviceRegistry.Builder setIdBytes(ByteString value)

The identifier of this device registry. For example, myRegistry.

string id = 1;

Parameter
Name Description
value ByteString

The bytes for id to set.

Returns
Type Description
DeviceRegistry.Builder

This builder for chaining.

setLogLevel(LogLevel value)

public DeviceRegistry.Builder setLogLevel(LogLevel value)

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;

Parameter
Name Description
value LogLevel

The logLevel to set.

Returns
Type Description
DeviceRegistry.Builder

This builder for chaining.

setLogLevelValue(int value)

public DeviceRegistry.Builder setLogLevelValue(int value)

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;

Parameter
Name Description
value int

The enum numeric value on the wire for logLevel to set.

Returns
Type Description
DeviceRegistry.Builder

This builder for chaining.

setMqttConfig(MqttConfig value)

public DeviceRegistry.Builder setMqttConfig(MqttConfig value)

The MQTT configuration for this device registry.

.google.cloud.iot.v1.MqttConfig mqtt_config = 4;

Parameter
Name Description
value MqttConfig
Returns
Type Description
DeviceRegistry.Builder

setMqttConfig(MqttConfig.Builder builderForValue)

public DeviceRegistry.Builder setMqttConfig(MqttConfig.Builder builderForValue)

The MQTT configuration for this device registry.

.google.cloud.iot.v1.MqttConfig mqtt_config = 4;

Parameter
Name Description
builderForValue MqttConfig.Builder
Returns
Type Description
DeviceRegistry.Builder

setName(String value)

public DeviceRegistry.Builder setName(String value)

The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.

string name = 2;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DeviceRegistry.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DeviceRegistry.Builder setNameBytes(ByteString value)

The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.

string name = 2;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DeviceRegistry.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DeviceRegistry.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DeviceRegistry.Builder
Overrides

setStateNotificationConfig(StateNotificationConfig value)

public DeviceRegistry.Builder setStateNotificationConfig(StateNotificationConfig value)

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;

Parameter
Name Description
value StateNotificationConfig
Returns
Type Description
DeviceRegistry.Builder

setStateNotificationConfig(StateNotificationConfig.Builder builderForValue)

public DeviceRegistry.Builder setStateNotificationConfig(StateNotificationConfig.Builder builderForValue)

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;

Parameter
Name Description
builderForValue StateNotificationConfig.Builder
Returns
Type Description
DeviceRegistry.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final DeviceRegistry.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DeviceRegistry.Builder
Overrides