1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/iot/v1/resources.proto 18 19 package com.google.cloud.iot.v1; 20 21 public interface DeviceRegistryOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.iot.v1.DeviceRegistry) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The identifier of this device registry. For example, `myRegistry`. 31 * </pre> 32 * 33 * <code>string id = 1;</code> 34 * 35 * @return The id. 36 */ getId()37 java.lang.String getId(); 38 /** 39 * 40 * 41 * <pre> 42 * The identifier of this device registry. For example, `myRegistry`. 43 * </pre> 44 * 45 * <code>string id = 1;</code> 46 * 47 * @return The bytes for id. 48 */ getIdBytes()49 com.google.protobuf.ByteString getIdBytes(); 50 51 /** 52 * 53 * 54 * <pre> 55 * The resource path name. For example, 56 * `projects/example-project/locations/us-central1/registries/my-registry`. 57 * </pre> 58 * 59 * <code>string name = 2;</code> 60 * 61 * @return The name. 62 */ getName()63 java.lang.String getName(); 64 /** 65 * 66 * 67 * <pre> 68 * The resource path name. For example, 69 * `projects/example-project/locations/us-central1/registries/my-registry`. 70 * </pre> 71 * 72 * <code>string name = 2;</code> 73 * 74 * @return The bytes for name. 75 */ getNameBytes()76 com.google.protobuf.ByteString getNameBytes(); 77 78 /** 79 * 80 * 81 * <pre> 82 * The configuration for notification of telemetry events received from the 83 * device. All telemetry events that were successfully published by the 84 * device and acknowledged by Cloud IoT Core are guaranteed to be 85 * delivered to Cloud Pub/Sub. If multiple configurations match a message, 86 * only the first matching configuration is used. If you try to publish a 87 * device telemetry event using MQTT without specifying a Cloud Pub/Sub topic 88 * for the device's registry, the connection closes automatically. If you try 89 * to do so using an HTTP connection, an error is returned. Up to 10 90 * configurations may be provided. 91 * </pre> 92 * 93 * <code>repeated .google.cloud.iot.v1.EventNotificationConfig event_notification_configs = 10; 94 * </code> 95 */ getEventNotificationConfigsList()96 java.util.List<com.google.cloud.iot.v1.EventNotificationConfig> getEventNotificationConfigsList(); 97 /** 98 * 99 * 100 * <pre> 101 * The configuration for notification of telemetry events received from the 102 * device. All telemetry events that were successfully published by the 103 * device and acknowledged by Cloud IoT Core are guaranteed to be 104 * delivered to Cloud Pub/Sub. If multiple configurations match a message, 105 * only the first matching configuration is used. If you try to publish a 106 * device telemetry event using MQTT without specifying a Cloud Pub/Sub topic 107 * for the device's registry, the connection closes automatically. If you try 108 * to do so using an HTTP connection, an error is returned. Up to 10 109 * configurations may be provided. 110 * </pre> 111 * 112 * <code>repeated .google.cloud.iot.v1.EventNotificationConfig event_notification_configs = 10; 113 * </code> 114 */ getEventNotificationConfigs(int index)115 com.google.cloud.iot.v1.EventNotificationConfig getEventNotificationConfigs(int index); 116 /** 117 * 118 * 119 * <pre> 120 * The configuration for notification of telemetry events received from the 121 * device. All telemetry events that were successfully published by the 122 * device and acknowledged by Cloud IoT Core are guaranteed to be 123 * delivered to Cloud Pub/Sub. If multiple configurations match a message, 124 * only the first matching configuration is used. If you try to publish a 125 * device telemetry event using MQTT without specifying a Cloud Pub/Sub topic 126 * for the device's registry, the connection closes automatically. If you try 127 * to do so using an HTTP connection, an error is returned. Up to 10 128 * configurations may be provided. 129 * </pre> 130 * 131 * <code>repeated .google.cloud.iot.v1.EventNotificationConfig event_notification_configs = 10; 132 * </code> 133 */ getEventNotificationConfigsCount()134 int getEventNotificationConfigsCount(); 135 /** 136 * 137 * 138 * <pre> 139 * The configuration for notification of telemetry events received from the 140 * device. All telemetry events that were successfully published by the 141 * device and acknowledged by Cloud IoT Core are guaranteed to be 142 * delivered to Cloud Pub/Sub. If multiple configurations match a message, 143 * only the first matching configuration is used. If you try to publish a 144 * device telemetry event using MQTT without specifying a Cloud Pub/Sub topic 145 * for the device's registry, the connection closes automatically. If you try 146 * to do so using an HTTP connection, an error is returned. Up to 10 147 * configurations may be provided. 148 * </pre> 149 * 150 * <code>repeated .google.cloud.iot.v1.EventNotificationConfig event_notification_configs = 10; 151 * </code> 152 */ 153 java.util.List<? extends com.google.cloud.iot.v1.EventNotificationConfigOrBuilder> getEventNotificationConfigsOrBuilderList()154 getEventNotificationConfigsOrBuilderList(); 155 /** 156 * 157 * 158 * <pre> 159 * The configuration for notification of telemetry events received from the 160 * device. All telemetry events that were successfully published by the 161 * device and acknowledged by Cloud IoT Core are guaranteed to be 162 * delivered to Cloud Pub/Sub. If multiple configurations match a message, 163 * only the first matching configuration is used. If you try to publish a 164 * device telemetry event using MQTT without specifying a Cloud Pub/Sub topic 165 * for the device's registry, the connection closes automatically. If you try 166 * to do so using an HTTP connection, an error is returned. Up to 10 167 * configurations may be provided. 168 * </pre> 169 * 170 * <code>repeated .google.cloud.iot.v1.EventNotificationConfig event_notification_configs = 10; 171 * </code> 172 */ getEventNotificationConfigsOrBuilder( int index)173 com.google.cloud.iot.v1.EventNotificationConfigOrBuilder getEventNotificationConfigsOrBuilder( 174 int index); 175 176 /** 177 * 178 * 179 * <pre> 180 * The configuration for notification of new states received from the device. 181 * State updates are guaranteed to be stored in the state history, but 182 * notifications to Cloud Pub/Sub are not guaranteed. For example, if 183 * permissions are misconfigured or the specified topic doesn't exist, no 184 * notification will be published but the state will still be stored in Cloud 185 * IoT Core. 186 * </pre> 187 * 188 * <code>.google.cloud.iot.v1.StateNotificationConfig state_notification_config = 7;</code> 189 * 190 * @return Whether the stateNotificationConfig field is set. 191 */ hasStateNotificationConfig()192 boolean hasStateNotificationConfig(); 193 /** 194 * 195 * 196 * <pre> 197 * The configuration for notification of new states received from the device. 198 * State updates are guaranteed to be stored in the state history, but 199 * notifications to Cloud Pub/Sub are not guaranteed. For example, if 200 * permissions are misconfigured or the specified topic doesn't exist, no 201 * notification will be published but the state will still be stored in Cloud 202 * IoT Core. 203 * </pre> 204 * 205 * <code>.google.cloud.iot.v1.StateNotificationConfig state_notification_config = 7;</code> 206 * 207 * @return The stateNotificationConfig. 208 */ getStateNotificationConfig()209 com.google.cloud.iot.v1.StateNotificationConfig getStateNotificationConfig(); 210 /** 211 * 212 * 213 * <pre> 214 * The configuration for notification of new states received from the device. 215 * State updates are guaranteed to be stored in the state history, but 216 * notifications to Cloud Pub/Sub are not guaranteed. For example, if 217 * permissions are misconfigured or the specified topic doesn't exist, no 218 * notification will be published but the state will still be stored in Cloud 219 * IoT Core. 220 * </pre> 221 * 222 * <code>.google.cloud.iot.v1.StateNotificationConfig state_notification_config = 7;</code> 223 */ getStateNotificationConfigOrBuilder()224 com.google.cloud.iot.v1.StateNotificationConfigOrBuilder getStateNotificationConfigOrBuilder(); 225 226 /** 227 * 228 * 229 * <pre> 230 * The MQTT configuration for this device registry. 231 * </pre> 232 * 233 * <code>.google.cloud.iot.v1.MqttConfig mqtt_config = 4;</code> 234 * 235 * @return Whether the mqttConfig field is set. 236 */ hasMqttConfig()237 boolean hasMqttConfig(); 238 /** 239 * 240 * 241 * <pre> 242 * The MQTT configuration for this device registry. 243 * </pre> 244 * 245 * <code>.google.cloud.iot.v1.MqttConfig mqtt_config = 4;</code> 246 * 247 * @return The mqttConfig. 248 */ getMqttConfig()249 com.google.cloud.iot.v1.MqttConfig getMqttConfig(); 250 /** 251 * 252 * 253 * <pre> 254 * The MQTT configuration for this device registry. 255 * </pre> 256 * 257 * <code>.google.cloud.iot.v1.MqttConfig mqtt_config = 4;</code> 258 */ getMqttConfigOrBuilder()259 com.google.cloud.iot.v1.MqttConfigOrBuilder getMqttConfigOrBuilder(); 260 261 /** 262 * 263 * 264 * <pre> 265 * The DeviceService (HTTP) configuration for this device registry. 266 * </pre> 267 * 268 * <code>.google.cloud.iot.v1.HttpConfig http_config = 9;</code> 269 * 270 * @return Whether the httpConfig field is set. 271 */ hasHttpConfig()272 boolean hasHttpConfig(); 273 /** 274 * 275 * 276 * <pre> 277 * The DeviceService (HTTP) configuration for this device registry. 278 * </pre> 279 * 280 * <code>.google.cloud.iot.v1.HttpConfig http_config = 9;</code> 281 * 282 * @return The httpConfig. 283 */ getHttpConfig()284 com.google.cloud.iot.v1.HttpConfig getHttpConfig(); 285 /** 286 * 287 * 288 * <pre> 289 * The DeviceService (HTTP) configuration for this device registry. 290 * </pre> 291 * 292 * <code>.google.cloud.iot.v1.HttpConfig http_config = 9;</code> 293 */ getHttpConfigOrBuilder()294 com.google.cloud.iot.v1.HttpConfigOrBuilder getHttpConfigOrBuilder(); 295 296 /** 297 * 298 * 299 * <pre> 300 * **Beta Feature** 301 * The default logging verbosity for activity from devices in this registry. 302 * The verbosity level can be overridden by Device.log_level. 303 * </pre> 304 * 305 * <code>.google.cloud.iot.v1.LogLevel log_level = 11;</code> 306 * 307 * @return The enum numeric value on the wire for logLevel. 308 */ getLogLevelValue()309 int getLogLevelValue(); 310 /** 311 * 312 * 313 * <pre> 314 * **Beta Feature** 315 * The default logging verbosity for activity from devices in this registry. 316 * The verbosity level can be overridden by Device.log_level. 317 * </pre> 318 * 319 * <code>.google.cloud.iot.v1.LogLevel log_level = 11;</code> 320 * 321 * @return The logLevel. 322 */ getLogLevel()323 com.google.cloud.iot.v1.LogLevel getLogLevel(); 324 325 /** 326 * 327 * 328 * <pre> 329 * The credentials used to verify the device credentials. No more than 10 330 * credentials can be bound to a single registry at a time. The verification 331 * process occurs at the time of device creation or update. If this field is 332 * empty, no verification is performed. Otherwise, the credentials of a newly 333 * created device or added credentials of an updated device should be signed 334 * with one of these registry credentials. 335 * Note, however, that existing devices will never be affected by 336 * modifications to this list of credentials: after a device has been 337 * successfully created in a registry, it should be able to connect even if 338 * its registry credentials are revoked, deleted, or modified. 339 * </pre> 340 * 341 * <code>repeated .google.cloud.iot.v1.RegistryCredential credentials = 8;</code> 342 */ getCredentialsList()343 java.util.List<com.google.cloud.iot.v1.RegistryCredential> getCredentialsList(); 344 /** 345 * 346 * 347 * <pre> 348 * The credentials used to verify the device credentials. No more than 10 349 * credentials can be bound to a single registry at a time. The verification 350 * process occurs at the time of device creation or update. If this field is 351 * empty, no verification is performed. Otherwise, the credentials of a newly 352 * created device or added credentials of an updated device should be signed 353 * with one of these registry credentials. 354 * Note, however, that existing devices will never be affected by 355 * modifications to this list of credentials: after a device has been 356 * successfully created in a registry, it should be able to connect even if 357 * its registry credentials are revoked, deleted, or modified. 358 * </pre> 359 * 360 * <code>repeated .google.cloud.iot.v1.RegistryCredential credentials = 8;</code> 361 */ getCredentials(int index)362 com.google.cloud.iot.v1.RegistryCredential getCredentials(int index); 363 /** 364 * 365 * 366 * <pre> 367 * The credentials used to verify the device credentials. No more than 10 368 * credentials can be bound to a single registry at a time. The verification 369 * process occurs at the time of device creation or update. If this field is 370 * empty, no verification is performed. Otherwise, the credentials of a newly 371 * created device or added credentials of an updated device should be signed 372 * with one of these registry credentials. 373 * Note, however, that existing devices will never be affected by 374 * modifications to this list of credentials: after a device has been 375 * successfully created in a registry, it should be able to connect even if 376 * its registry credentials are revoked, deleted, or modified. 377 * </pre> 378 * 379 * <code>repeated .google.cloud.iot.v1.RegistryCredential credentials = 8;</code> 380 */ getCredentialsCount()381 int getCredentialsCount(); 382 /** 383 * 384 * 385 * <pre> 386 * The credentials used to verify the device credentials. No more than 10 387 * credentials can be bound to a single registry at a time. The verification 388 * process occurs at the time of device creation or update. If this field is 389 * empty, no verification is performed. Otherwise, the credentials of a newly 390 * created device or added credentials of an updated device should be signed 391 * with one of these registry credentials. 392 * Note, however, that existing devices will never be affected by 393 * modifications to this list of credentials: after a device has been 394 * successfully created in a registry, it should be able to connect even if 395 * its registry credentials are revoked, deleted, or modified. 396 * </pre> 397 * 398 * <code>repeated .google.cloud.iot.v1.RegistryCredential credentials = 8;</code> 399 */ 400 java.util.List<? extends com.google.cloud.iot.v1.RegistryCredentialOrBuilder> getCredentialsOrBuilderList()401 getCredentialsOrBuilderList(); 402 /** 403 * 404 * 405 * <pre> 406 * The credentials used to verify the device credentials. No more than 10 407 * credentials can be bound to a single registry at a time. The verification 408 * process occurs at the time of device creation or update. If this field is 409 * empty, no verification is performed. Otherwise, the credentials of a newly 410 * created device or added credentials of an updated device should be signed 411 * with one of these registry credentials. 412 * Note, however, that existing devices will never be affected by 413 * modifications to this list of credentials: after a device has been 414 * successfully created in a registry, it should be able to connect even if 415 * its registry credentials are revoked, deleted, or modified. 416 * </pre> 417 * 418 * <code>repeated .google.cloud.iot.v1.RegistryCredential credentials = 8;</code> 419 */ getCredentialsOrBuilder(int index)420 com.google.cloud.iot.v1.RegistryCredentialOrBuilder getCredentialsOrBuilder(int index); 421 } 422