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/automl/v1/dataset.proto 18 19 package com.google.cloud.automl.v1; 20 21 public interface DatasetOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.automl.v1.Dataset) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Metadata for a dataset used for translation. 31 * </pre> 32 * 33 * <code>.google.cloud.automl.v1.TranslationDatasetMetadata translation_dataset_metadata = 23; 34 * </code> 35 * 36 * @return Whether the translationDatasetMetadata field is set. 37 */ hasTranslationDatasetMetadata()38 boolean hasTranslationDatasetMetadata(); 39 /** 40 * 41 * 42 * <pre> 43 * Metadata for a dataset used for translation. 44 * </pre> 45 * 46 * <code>.google.cloud.automl.v1.TranslationDatasetMetadata translation_dataset_metadata = 23; 47 * </code> 48 * 49 * @return The translationDatasetMetadata. 50 */ getTranslationDatasetMetadata()51 com.google.cloud.automl.v1.TranslationDatasetMetadata getTranslationDatasetMetadata(); 52 /** 53 * 54 * 55 * <pre> 56 * Metadata for a dataset used for translation. 57 * </pre> 58 * 59 * <code>.google.cloud.automl.v1.TranslationDatasetMetadata translation_dataset_metadata = 23; 60 * </code> 61 */ 62 com.google.cloud.automl.v1.TranslationDatasetMetadataOrBuilder getTranslationDatasetMetadataOrBuilder()63 getTranslationDatasetMetadataOrBuilder(); 64 65 /** 66 * 67 * 68 * <pre> 69 * Metadata for a dataset used for image classification. 70 * </pre> 71 * 72 * <code> 73 * .google.cloud.automl.v1.ImageClassificationDatasetMetadata image_classification_dataset_metadata = 24; 74 * </code> 75 * 76 * @return Whether the imageClassificationDatasetMetadata field is set. 77 */ hasImageClassificationDatasetMetadata()78 boolean hasImageClassificationDatasetMetadata(); 79 /** 80 * 81 * 82 * <pre> 83 * Metadata for a dataset used for image classification. 84 * </pre> 85 * 86 * <code> 87 * .google.cloud.automl.v1.ImageClassificationDatasetMetadata image_classification_dataset_metadata = 24; 88 * </code> 89 * 90 * @return The imageClassificationDatasetMetadata. 91 */ 92 com.google.cloud.automl.v1.ImageClassificationDatasetMetadata getImageClassificationDatasetMetadata()93 getImageClassificationDatasetMetadata(); 94 /** 95 * 96 * 97 * <pre> 98 * Metadata for a dataset used for image classification. 99 * </pre> 100 * 101 * <code> 102 * .google.cloud.automl.v1.ImageClassificationDatasetMetadata image_classification_dataset_metadata = 24; 103 * </code> 104 */ 105 com.google.cloud.automl.v1.ImageClassificationDatasetMetadataOrBuilder getImageClassificationDatasetMetadataOrBuilder()106 getImageClassificationDatasetMetadataOrBuilder(); 107 108 /** 109 * 110 * 111 * <pre> 112 * Metadata for a dataset used for text classification. 113 * </pre> 114 * 115 * <code> 116 * .google.cloud.automl.v1.TextClassificationDatasetMetadata text_classification_dataset_metadata = 25; 117 * </code> 118 * 119 * @return Whether the textClassificationDatasetMetadata field is set. 120 */ hasTextClassificationDatasetMetadata()121 boolean hasTextClassificationDatasetMetadata(); 122 /** 123 * 124 * 125 * <pre> 126 * Metadata for a dataset used for text classification. 127 * </pre> 128 * 129 * <code> 130 * .google.cloud.automl.v1.TextClassificationDatasetMetadata text_classification_dataset_metadata = 25; 131 * </code> 132 * 133 * @return The textClassificationDatasetMetadata. 134 */ 135 com.google.cloud.automl.v1.TextClassificationDatasetMetadata getTextClassificationDatasetMetadata()136 getTextClassificationDatasetMetadata(); 137 /** 138 * 139 * 140 * <pre> 141 * Metadata for a dataset used for text classification. 142 * </pre> 143 * 144 * <code> 145 * .google.cloud.automl.v1.TextClassificationDatasetMetadata text_classification_dataset_metadata = 25; 146 * </code> 147 */ 148 com.google.cloud.automl.v1.TextClassificationDatasetMetadataOrBuilder getTextClassificationDatasetMetadataOrBuilder()149 getTextClassificationDatasetMetadataOrBuilder(); 150 151 /** 152 * 153 * 154 * <pre> 155 * Metadata for a dataset used for image object detection. 156 * </pre> 157 * 158 * <code> 159 * .google.cloud.automl.v1.ImageObjectDetectionDatasetMetadata image_object_detection_dataset_metadata = 26; 160 * </code> 161 * 162 * @return Whether the imageObjectDetectionDatasetMetadata field is set. 163 */ hasImageObjectDetectionDatasetMetadata()164 boolean hasImageObjectDetectionDatasetMetadata(); 165 /** 166 * 167 * 168 * <pre> 169 * Metadata for a dataset used for image object detection. 170 * </pre> 171 * 172 * <code> 173 * .google.cloud.automl.v1.ImageObjectDetectionDatasetMetadata image_object_detection_dataset_metadata = 26; 174 * </code> 175 * 176 * @return The imageObjectDetectionDatasetMetadata. 177 */ 178 com.google.cloud.automl.v1.ImageObjectDetectionDatasetMetadata getImageObjectDetectionDatasetMetadata()179 getImageObjectDetectionDatasetMetadata(); 180 /** 181 * 182 * 183 * <pre> 184 * Metadata for a dataset used for image object detection. 185 * </pre> 186 * 187 * <code> 188 * .google.cloud.automl.v1.ImageObjectDetectionDatasetMetadata image_object_detection_dataset_metadata = 26; 189 * </code> 190 */ 191 com.google.cloud.automl.v1.ImageObjectDetectionDatasetMetadataOrBuilder getImageObjectDetectionDatasetMetadataOrBuilder()192 getImageObjectDetectionDatasetMetadataOrBuilder(); 193 194 /** 195 * 196 * 197 * <pre> 198 * Metadata for a dataset used for text extraction. 199 * </pre> 200 * 201 * <code> 202 * .google.cloud.automl.v1.TextExtractionDatasetMetadata text_extraction_dataset_metadata = 28; 203 * </code> 204 * 205 * @return Whether the textExtractionDatasetMetadata field is set. 206 */ hasTextExtractionDatasetMetadata()207 boolean hasTextExtractionDatasetMetadata(); 208 /** 209 * 210 * 211 * <pre> 212 * Metadata for a dataset used for text extraction. 213 * </pre> 214 * 215 * <code> 216 * .google.cloud.automl.v1.TextExtractionDatasetMetadata text_extraction_dataset_metadata = 28; 217 * </code> 218 * 219 * @return The textExtractionDatasetMetadata. 220 */ getTextExtractionDatasetMetadata()221 com.google.cloud.automl.v1.TextExtractionDatasetMetadata getTextExtractionDatasetMetadata(); 222 /** 223 * 224 * 225 * <pre> 226 * Metadata for a dataset used for text extraction. 227 * </pre> 228 * 229 * <code> 230 * .google.cloud.automl.v1.TextExtractionDatasetMetadata text_extraction_dataset_metadata = 28; 231 * </code> 232 */ 233 com.google.cloud.automl.v1.TextExtractionDatasetMetadataOrBuilder getTextExtractionDatasetMetadataOrBuilder()234 getTextExtractionDatasetMetadataOrBuilder(); 235 236 /** 237 * 238 * 239 * <pre> 240 * Metadata for a dataset used for text sentiment. 241 * </pre> 242 * 243 * <code> 244 * .google.cloud.automl.v1.TextSentimentDatasetMetadata text_sentiment_dataset_metadata = 30; 245 * </code> 246 * 247 * @return Whether the textSentimentDatasetMetadata field is set. 248 */ hasTextSentimentDatasetMetadata()249 boolean hasTextSentimentDatasetMetadata(); 250 /** 251 * 252 * 253 * <pre> 254 * Metadata for a dataset used for text sentiment. 255 * </pre> 256 * 257 * <code> 258 * .google.cloud.automl.v1.TextSentimentDatasetMetadata text_sentiment_dataset_metadata = 30; 259 * </code> 260 * 261 * @return The textSentimentDatasetMetadata. 262 */ getTextSentimentDatasetMetadata()263 com.google.cloud.automl.v1.TextSentimentDatasetMetadata getTextSentimentDatasetMetadata(); 264 /** 265 * 266 * 267 * <pre> 268 * Metadata for a dataset used for text sentiment. 269 * </pre> 270 * 271 * <code> 272 * .google.cloud.automl.v1.TextSentimentDatasetMetadata text_sentiment_dataset_metadata = 30; 273 * </code> 274 */ 275 com.google.cloud.automl.v1.TextSentimentDatasetMetadataOrBuilder getTextSentimentDatasetMetadataOrBuilder()276 getTextSentimentDatasetMetadataOrBuilder(); 277 278 /** 279 * 280 * 281 * <pre> 282 * Output only. The resource name of the dataset. 283 * Form: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}` 284 * </pre> 285 * 286 * <code>string name = 1;</code> 287 * 288 * @return The name. 289 */ getName()290 java.lang.String getName(); 291 /** 292 * 293 * 294 * <pre> 295 * Output only. The resource name of the dataset. 296 * Form: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}` 297 * </pre> 298 * 299 * <code>string name = 1;</code> 300 * 301 * @return The bytes for name. 302 */ getNameBytes()303 com.google.protobuf.ByteString getNameBytes(); 304 305 /** 306 * 307 * 308 * <pre> 309 * Required. The name of the dataset to show in the interface. The name can be 310 * up to 32 characters long and can consist only of ASCII Latin letters A-Z 311 * and a-z, underscores 312 * (_), and ASCII digits 0-9. 313 * </pre> 314 * 315 * <code>string display_name = 2;</code> 316 * 317 * @return The displayName. 318 */ getDisplayName()319 java.lang.String getDisplayName(); 320 /** 321 * 322 * 323 * <pre> 324 * Required. The name of the dataset to show in the interface. The name can be 325 * up to 32 characters long and can consist only of ASCII Latin letters A-Z 326 * and a-z, underscores 327 * (_), and ASCII digits 0-9. 328 * </pre> 329 * 330 * <code>string display_name = 2;</code> 331 * 332 * @return The bytes for displayName. 333 */ getDisplayNameBytes()334 com.google.protobuf.ByteString getDisplayNameBytes(); 335 336 /** 337 * 338 * 339 * <pre> 340 * User-provided description of the dataset. The description can be up to 341 * 25000 characters long. 342 * </pre> 343 * 344 * <code>string description = 3;</code> 345 * 346 * @return The description. 347 */ getDescription()348 java.lang.String getDescription(); 349 /** 350 * 351 * 352 * <pre> 353 * User-provided description of the dataset. The description can be up to 354 * 25000 characters long. 355 * </pre> 356 * 357 * <code>string description = 3;</code> 358 * 359 * @return The bytes for description. 360 */ getDescriptionBytes()361 com.google.protobuf.ByteString getDescriptionBytes(); 362 363 /** 364 * 365 * 366 * <pre> 367 * Output only. The number of examples in the dataset. 368 * </pre> 369 * 370 * <code>int32 example_count = 21;</code> 371 * 372 * @return The exampleCount. 373 */ getExampleCount()374 int getExampleCount(); 375 376 /** 377 * 378 * 379 * <pre> 380 * Output only. Timestamp when this dataset was created. 381 * </pre> 382 * 383 * <code>.google.protobuf.Timestamp create_time = 14;</code> 384 * 385 * @return Whether the createTime field is set. 386 */ hasCreateTime()387 boolean hasCreateTime(); 388 /** 389 * 390 * 391 * <pre> 392 * Output only. Timestamp when this dataset was created. 393 * </pre> 394 * 395 * <code>.google.protobuf.Timestamp create_time = 14;</code> 396 * 397 * @return The createTime. 398 */ getCreateTime()399 com.google.protobuf.Timestamp getCreateTime(); 400 /** 401 * 402 * 403 * <pre> 404 * Output only. Timestamp when this dataset was created. 405 * </pre> 406 * 407 * <code>.google.protobuf.Timestamp create_time = 14;</code> 408 */ getCreateTimeOrBuilder()409 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 410 411 /** 412 * 413 * 414 * <pre> 415 * Used to perform consistent read-modify-write updates. If not set, a blind 416 * "overwrite" update happens. 417 * </pre> 418 * 419 * <code>string etag = 17;</code> 420 * 421 * @return The etag. 422 */ getEtag()423 java.lang.String getEtag(); 424 /** 425 * 426 * 427 * <pre> 428 * Used to perform consistent read-modify-write updates. If not set, a blind 429 * "overwrite" update happens. 430 * </pre> 431 * 432 * <code>string etag = 17;</code> 433 * 434 * @return The bytes for etag. 435 */ getEtagBytes()436 com.google.protobuf.ByteString getEtagBytes(); 437 438 /** 439 * 440 * 441 * <pre> 442 * Optional. The labels with user-defined metadata to organize your dataset. 443 * Label keys and values can be no longer than 64 characters 444 * (Unicode codepoints), can only contain lowercase letters, numeric 445 * characters, underscores and dashes. International characters are allowed. 446 * Label values are optional. Label keys must start with a letter. 447 * See https://goo.gl/xmQnxf for more information on and examples of labels. 448 * </pre> 449 * 450 * <code>map<string, string> labels = 39;</code> 451 */ getLabelsCount()452 int getLabelsCount(); 453 /** 454 * 455 * 456 * <pre> 457 * Optional. The labels with user-defined metadata to organize your dataset. 458 * Label keys and values can be no longer than 64 characters 459 * (Unicode codepoints), can only contain lowercase letters, numeric 460 * characters, underscores and dashes. International characters are allowed. 461 * Label values are optional. Label keys must start with a letter. 462 * See https://goo.gl/xmQnxf for more information on and examples of labels. 463 * </pre> 464 * 465 * <code>map<string, string> labels = 39;</code> 466 */ containsLabels(java.lang.String key)467 boolean containsLabels(java.lang.String key); 468 /** Use {@link #getLabelsMap()} instead. */ 469 @java.lang.Deprecated getLabels()470 java.util.Map<java.lang.String, java.lang.String> getLabels(); 471 /** 472 * 473 * 474 * <pre> 475 * Optional. The labels with user-defined metadata to organize your dataset. 476 * Label keys and values can be no longer than 64 characters 477 * (Unicode codepoints), can only contain lowercase letters, numeric 478 * characters, underscores and dashes. International characters are allowed. 479 * Label values are optional. Label keys must start with a letter. 480 * See https://goo.gl/xmQnxf for more information on and examples of labels. 481 * </pre> 482 * 483 * <code>map<string, string> labels = 39;</code> 484 */ getLabelsMap()485 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 486 /** 487 * 488 * 489 * <pre> 490 * Optional. The labels with user-defined metadata to organize your dataset. 491 * Label keys and values can be no longer than 64 characters 492 * (Unicode codepoints), can only contain lowercase letters, numeric 493 * characters, underscores and dashes. International characters are allowed. 494 * Label values are optional. Label keys must start with a letter. 495 * See https://goo.gl/xmQnxf for more information on and examples of labels. 496 * </pre> 497 * 498 * <code>map<string, string> labels = 39;</code> 499 */ 500 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)501 java.lang.String getLabelsOrDefault( 502 java.lang.String key, 503 /* nullable */ 504 java.lang.String defaultValue); 505 /** 506 * 507 * 508 * <pre> 509 * Optional. The labels with user-defined metadata to organize your dataset. 510 * Label keys and values can be no longer than 64 characters 511 * (Unicode codepoints), can only contain lowercase letters, numeric 512 * characters, underscores and dashes. International characters are allowed. 513 * Label values are optional. Label keys must start with a letter. 514 * See https://goo.gl/xmQnxf for more information on and examples of labels. 515 * </pre> 516 * 517 * <code>map<string, string> labels = 39;</code> 518 */ getLabelsOrThrow(java.lang.String key)519 java.lang.String getLabelsOrThrow(java.lang.String key); 520 getDatasetMetadataCase()521 public com.google.cloud.automl.v1.Dataset.DatasetMetadataCase getDatasetMetadataCase(); 522 } 523