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/device_manager.proto 18 19 package com.google.cloud.iot.v1; 20 21 public interface ListDevicesRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.iot.v1.ListDevicesRequest) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The device registry path. Required. For example, 31 * `projects/my-project/locations/us-central1/registries/my-registry`. 32 * </pre> 33 * 34 * <code> 35 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 36 * </code> 37 * 38 * @return The parent. 39 */ getParent()40 java.lang.String getParent(); 41 /** 42 * 43 * 44 * <pre> 45 * Required. The device registry path. Required. For example, 46 * `projects/my-project/locations/us-central1/registries/my-registry`. 47 * </pre> 48 * 49 * <code> 50 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 51 * </code> 52 * 53 * @return The bytes for parent. 54 */ getParentBytes()55 com.google.protobuf.ByteString getParentBytes(); 56 57 /** 58 * 59 * 60 * <pre> 61 * A list of device numeric IDs. If empty, this field is ignored. Maximum 62 * IDs: 10,000. 63 * </pre> 64 * 65 * <code>repeated uint64 device_num_ids = 2;</code> 66 * 67 * @return A list containing the deviceNumIds. 68 */ getDeviceNumIdsList()69 java.util.List<java.lang.Long> getDeviceNumIdsList(); 70 /** 71 * 72 * 73 * <pre> 74 * A list of device numeric IDs. If empty, this field is ignored. Maximum 75 * IDs: 10,000. 76 * </pre> 77 * 78 * <code>repeated uint64 device_num_ids = 2;</code> 79 * 80 * @return The count of deviceNumIds. 81 */ getDeviceNumIdsCount()82 int getDeviceNumIdsCount(); 83 /** 84 * 85 * 86 * <pre> 87 * A list of device numeric IDs. If empty, this field is ignored. Maximum 88 * IDs: 10,000. 89 * </pre> 90 * 91 * <code>repeated uint64 device_num_ids = 2;</code> 92 * 93 * @param index The index of the element to return. 94 * @return The deviceNumIds at the given index. 95 */ getDeviceNumIds(int index)96 long getDeviceNumIds(int index); 97 98 /** 99 * 100 * 101 * <pre> 102 * A list of device string IDs. For example, `['device0', 'device12']`. 103 * If empty, this field is ignored. Maximum IDs: 10,000 104 * </pre> 105 * 106 * <code>repeated string device_ids = 3;</code> 107 * 108 * @return A list containing the deviceIds. 109 */ getDeviceIdsList()110 java.util.List<java.lang.String> getDeviceIdsList(); 111 /** 112 * 113 * 114 * <pre> 115 * A list of device string IDs. For example, `['device0', 'device12']`. 116 * If empty, this field is ignored. Maximum IDs: 10,000 117 * </pre> 118 * 119 * <code>repeated string device_ids = 3;</code> 120 * 121 * @return The count of deviceIds. 122 */ getDeviceIdsCount()123 int getDeviceIdsCount(); 124 /** 125 * 126 * 127 * <pre> 128 * A list of device string IDs. For example, `['device0', 'device12']`. 129 * If empty, this field is ignored. Maximum IDs: 10,000 130 * </pre> 131 * 132 * <code>repeated string device_ids = 3;</code> 133 * 134 * @param index The index of the element to return. 135 * @return The deviceIds at the given index. 136 */ getDeviceIds(int index)137 java.lang.String getDeviceIds(int index); 138 /** 139 * 140 * 141 * <pre> 142 * A list of device string IDs. For example, `['device0', 'device12']`. 143 * If empty, this field is ignored. Maximum IDs: 10,000 144 * </pre> 145 * 146 * <code>repeated string device_ids = 3;</code> 147 * 148 * @param index The index of the value to return. 149 * @return The bytes of the deviceIds at the given index. 150 */ getDeviceIdsBytes(int index)151 com.google.protobuf.ByteString getDeviceIdsBytes(int index); 152 153 /** 154 * 155 * 156 * <pre> 157 * The fields of the `Device` resource to be returned in the response. The 158 * fields `id` and `num_id` are always returned, along with any 159 * other fields specified in snake_case format, for example: 160 * `last_heartbeat_time`. 161 * </pre> 162 * 163 * <code>.google.protobuf.FieldMask field_mask = 4;</code> 164 * 165 * @return Whether the fieldMask field is set. 166 */ hasFieldMask()167 boolean hasFieldMask(); 168 /** 169 * 170 * 171 * <pre> 172 * The fields of the `Device` resource to be returned in the response. The 173 * fields `id` and `num_id` are always returned, along with any 174 * other fields specified in snake_case format, for example: 175 * `last_heartbeat_time`. 176 * </pre> 177 * 178 * <code>.google.protobuf.FieldMask field_mask = 4;</code> 179 * 180 * @return The fieldMask. 181 */ getFieldMask()182 com.google.protobuf.FieldMask getFieldMask(); 183 /** 184 * 185 * 186 * <pre> 187 * The fields of the `Device` resource to be returned in the response. The 188 * fields `id` and `num_id` are always returned, along with any 189 * other fields specified in snake_case format, for example: 190 * `last_heartbeat_time`. 191 * </pre> 192 * 193 * <code>.google.protobuf.FieldMask field_mask = 4;</code> 194 */ getFieldMaskOrBuilder()195 com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder(); 196 197 /** 198 * 199 * 200 * <pre> 201 * Options related to gateways. 202 * </pre> 203 * 204 * <code>.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;</code> 205 * 206 * @return Whether the gatewayListOptions field is set. 207 */ hasGatewayListOptions()208 boolean hasGatewayListOptions(); 209 /** 210 * 211 * 212 * <pre> 213 * Options related to gateways. 214 * </pre> 215 * 216 * <code>.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;</code> 217 * 218 * @return The gatewayListOptions. 219 */ getGatewayListOptions()220 com.google.cloud.iot.v1.GatewayListOptions getGatewayListOptions(); 221 /** 222 * 223 * 224 * <pre> 225 * Options related to gateways. 226 * </pre> 227 * 228 * <code>.google.cloud.iot.v1.GatewayListOptions gateway_list_options = 6;</code> 229 */ getGatewayListOptionsOrBuilder()230 com.google.cloud.iot.v1.GatewayListOptionsOrBuilder getGatewayListOptionsOrBuilder(); 231 232 /** 233 * 234 * 235 * <pre> 236 * The maximum number of devices to return in the response. If this value 237 * is zero, the service will select a default size. A call may return fewer 238 * objects than requested. A non-empty `next_page_token` in the response 239 * indicates that more data is available. 240 * </pre> 241 * 242 * <code>int32 page_size = 100;</code> 243 * 244 * @return The pageSize. 245 */ getPageSize()246 int getPageSize(); 247 248 /** 249 * 250 * 251 * <pre> 252 * The value returned by the last `ListDevicesResponse`; indicates 253 * that this is a continuation of a prior `ListDevices` call and 254 * the system should return the next page of data. 255 * </pre> 256 * 257 * <code>string page_token = 101;</code> 258 * 259 * @return The pageToken. 260 */ getPageToken()261 java.lang.String getPageToken(); 262 /** 263 * 264 * 265 * <pre> 266 * The value returned by the last `ListDevicesResponse`; indicates 267 * that this is a continuation of a prior `ListDevices` call and 268 * the system should return the next page of data. 269 * </pre> 270 * 271 * <code>string page_token = 101;</code> 272 * 273 * @return The bytes for pageToken. 274 */ getPageTokenBytes()275 com.google.protobuf.ByteString getPageTokenBytes(); 276 } 277