- 2.53.0 (latest)
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.6
- 2.2.1
- 2.1.7
public interface DeviceRegistryOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCredentials(int index)
public abstract 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 | |
getCredentialsCount()
public abstract 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 abstract 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 abstract 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 abstract 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> | |
getEventNotificationConfigs(int index)
public abstract 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 | |
getEventNotificationConfigsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract HttpConfig getHttpConfig()The DeviceService (HTTP) configuration for this device registry.
.google.cloud.iot.v1.HttpConfig http_config = 9;
| Returns | |
|---|---|
| Type | Description |
HttpConfig | The httpConfig. |
getHttpConfigOrBuilder()
public abstract HttpConfigOrBuilder getHttpConfigOrBuilder()The DeviceService (HTTP) configuration for this device registry.
.google.cloud.iot.v1.HttpConfig http_config = 9;
| Returns | |
|---|---|
| Type | Description |
HttpConfigOrBuilder | |
getId()
public abstract String getId() The identifier of this device registry. For example, myRegistry.
string id = 1;
| Returns | |
|---|---|
| Type | Description |
String | The id. |
getIdBytes()
public abstract ByteString getIdBytes() The identifier of this device registry. For example, myRegistry.
string id = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for id. |
getLogLevel()
public abstract 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 abstract 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 abstract MqttConfig getMqttConfig()The MQTT configuration for this device registry.
.google.cloud.iot.v1.MqttConfig mqtt_config = 4;
| Returns | |
|---|---|
| Type | Description |
MqttConfig | The mqttConfig. |
getMqttConfigOrBuilder()
public abstract MqttConfigOrBuilder getMqttConfigOrBuilder()The MQTT configuration for this device registry.
.google.cloud.iot.v1.MqttConfig mqtt_config = 4;
| Returns | |
|---|---|
| Type | Description |
MqttConfigOrBuilder | |
getName()
public abstract 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 abstract 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 abstract 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. |
getStateNotificationConfigOrBuilder()
public abstract 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 abstract 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 abstract 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 abstract 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. |