Package com.google.cloud.iot.v1

Interface DeviceRegistryOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    DeviceRegistry, DeviceRegistry.Builder
    public interface DeviceRegistryOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getId

        String getId()
         The identifier of this device registry. For example, `myRegistry`.
        string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         The identifier of this device registry. For example, `myRegistry`.
        string id = 1;
        Returns:
        The bytes for id.

      • getName

        String getName()
         The resource path name. For example,
 `projects/example-project/locations/us-central1/registries/my-registry`.
        string name = 2;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The resource path name. For example,
 `projects/example-project/locations/us-central1/registries/my-registry`.
        string name = 2;
        Returns:
        The bytes for name.

      • getEventNotificationConfigsList

        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;

      • getEventNotificationConfigs

        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;

      • getEventNotificationConfigsCount

        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;

      • getEventNotificationConfigsOrBuilderList

        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;

      • getEventNotificationConfigsOrBuilder

        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;

      • hasStateNotificationConfig

        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:
        Whether the stateNotificationConfig field is set.

      • getStateNotificationConfig

        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:
        The stateNotificationConfig.

      • getStateNotificationConfigOrBuilder

        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;

      • hasMqttConfig

        boolean hasMqttConfig()
         The MQTT configuration for this device registry.
        .google.cloud.iot.v1.MqttConfig mqtt_config = 4;
        Returns:
        Whether the mqttConfig field is set.

      • getMqttConfig

        MqttConfig getMqttConfig()
         The MQTT configuration for this device registry.
        .google.cloud.iot.v1.MqttConfig mqtt_config = 4;
        Returns:
        The mqttConfig.

      • getMqttConfigOrBuilder

        MqttConfigOrBuilder getMqttConfigOrBuilder()
         The MQTT configuration for this device registry.
        .google.cloud.iot.v1.MqttConfig mqtt_config = 4;

      • hasHttpConfig

        boolean hasHttpConfig()
         The DeviceService (HTTP) configuration for this device registry.
        .google.cloud.iot.v1.HttpConfig http_config = 9;
        Returns:
        Whether the httpConfig field is set.

      • getHttpConfig

        HttpConfig getHttpConfig()
         The DeviceService (HTTP) configuration for this device registry.
        .google.cloud.iot.v1.HttpConfig http_config = 9;
        Returns:
        The httpConfig.

      • getHttpConfigOrBuilder

        HttpConfigOrBuilder getHttpConfigOrBuilder()
         The DeviceService (HTTP) configuration for this device registry.
        .google.cloud.iot.v1.HttpConfig http_config = 9;

      • getLogLevelValue

        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:
        The enum numeric value on the wire for logLevel.

      • getLogLevel

        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:
        The logLevel.

      • getCredentialsList

        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;

      • getCredentials

        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;

      • getCredentialsCount

        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;

      • getCredentialsOrBuilderList

        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;

      • getCredentialsOrBuilder

        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;