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/model.proto 18 19 package com.google.cloud.automl.v1; 20 21 public interface ModelOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.automl.v1.Model) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Metadata for translation models. 31 * </pre> 32 * 33 * <code>.google.cloud.automl.v1.TranslationModelMetadata translation_model_metadata = 15;</code> 34 * 35 * @return Whether the translationModelMetadata field is set. 36 */ hasTranslationModelMetadata()37 boolean hasTranslationModelMetadata(); 38 /** 39 * 40 * 41 * <pre> 42 * Metadata for translation models. 43 * </pre> 44 * 45 * <code>.google.cloud.automl.v1.TranslationModelMetadata translation_model_metadata = 15;</code> 46 * 47 * @return The translationModelMetadata. 48 */ getTranslationModelMetadata()49 com.google.cloud.automl.v1.TranslationModelMetadata getTranslationModelMetadata(); 50 /** 51 * 52 * 53 * <pre> 54 * Metadata for translation models. 55 * </pre> 56 * 57 * <code>.google.cloud.automl.v1.TranslationModelMetadata translation_model_metadata = 15;</code> 58 */ 59 com.google.cloud.automl.v1.TranslationModelMetadataOrBuilder getTranslationModelMetadataOrBuilder()60 getTranslationModelMetadataOrBuilder(); 61 62 /** 63 * 64 * 65 * <pre> 66 * Metadata for image classification models. 67 * </pre> 68 * 69 * <code> 70 * .google.cloud.automl.v1.ImageClassificationModelMetadata image_classification_model_metadata = 13; 71 * </code> 72 * 73 * @return Whether the imageClassificationModelMetadata field is set. 74 */ hasImageClassificationModelMetadata()75 boolean hasImageClassificationModelMetadata(); 76 /** 77 * 78 * 79 * <pre> 80 * Metadata for image classification models. 81 * </pre> 82 * 83 * <code> 84 * .google.cloud.automl.v1.ImageClassificationModelMetadata image_classification_model_metadata = 13; 85 * </code> 86 * 87 * @return The imageClassificationModelMetadata. 88 */ getImageClassificationModelMetadata()89 com.google.cloud.automl.v1.ImageClassificationModelMetadata getImageClassificationModelMetadata(); 90 /** 91 * 92 * 93 * <pre> 94 * Metadata for image classification models. 95 * </pre> 96 * 97 * <code> 98 * .google.cloud.automl.v1.ImageClassificationModelMetadata image_classification_model_metadata = 13; 99 * </code> 100 */ 101 com.google.cloud.automl.v1.ImageClassificationModelMetadataOrBuilder getImageClassificationModelMetadataOrBuilder()102 getImageClassificationModelMetadataOrBuilder(); 103 104 /** 105 * 106 * 107 * <pre> 108 * Metadata for text classification models. 109 * </pre> 110 * 111 * <code> 112 * .google.cloud.automl.v1.TextClassificationModelMetadata text_classification_model_metadata = 14; 113 * </code> 114 * 115 * @return Whether the textClassificationModelMetadata field is set. 116 */ hasTextClassificationModelMetadata()117 boolean hasTextClassificationModelMetadata(); 118 /** 119 * 120 * 121 * <pre> 122 * Metadata for text classification models. 123 * </pre> 124 * 125 * <code> 126 * .google.cloud.automl.v1.TextClassificationModelMetadata text_classification_model_metadata = 14; 127 * </code> 128 * 129 * @return The textClassificationModelMetadata. 130 */ getTextClassificationModelMetadata()131 com.google.cloud.automl.v1.TextClassificationModelMetadata getTextClassificationModelMetadata(); 132 /** 133 * 134 * 135 * <pre> 136 * Metadata for text classification models. 137 * </pre> 138 * 139 * <code> 140 * .google.cloud.automl.v1.TextClassificationModelMetadata text_classification_model_metadata = 14; 141 * </code> 142 */ 143 com.google.cloud.automl.v1.TextClassificationModelMetadataOrBuilder getTextClassificationModelMetadataOrBuilder()144 getTextClassificationModelMetadataOrBuilder(); 145 146 /** 147 * 148 * 149 * <pre> 150 * Metadata for image object detection models. 151 * </pre> 152 * 153 * <code> 154 * .google.cloud.automl.v1.ImageObjectDetectionModelMetadata image_object_detection_model_metadata = 20; 155 * </code> 156 * 157 * @return Whether the imageObjectDetectionModelMetadata field is set. 158 */ hasImageObjectDetectionModelMetadata()159 boolean hasImageObjectDetectionModelMetadata(); 160 /** 161 * 162 * 163 * <pre> 164 * Metadata for image object detection models. 165 * </pre> 166 * 167 * <code> 168 * .google.cloud.automl.v1.ImageObjectDetectionModelMetadata image_object_detection_model_metadata = 20; 169 * </code> 170 * 171 * @return The imageObjectDetectionModelMetadata. 172 */ 173 com.google.cloud.automl.v1.ImageObjectDetectionModelMetadata getImageObjectDetectionModelMetadata()174 getImageObjectDetectionModelMetadata(); 175 /** 176 * 177 * 178 * <pre> 179 * Metadata for image object detection models. 180 * </pre> 181 * 182 * <code> 183 * .google.cloud.automl.v1.ImageObjectDetectionModelMetadata image_object_detection_model_metadata = 20; 184 * </code> 185 */ 186 com.google.cloud.automl.v1.ImageObjectDetectionModelMetadataOrBuilder getImageObjectDetectionModelMetadataOrBuilder()187 getImageObjectDetectionModelMetadataOrBuilder(); 188 189 /** 190 * 191 * 192 * <pre> 193 * Metadata for text extraction models. 194 * </pre> 195 * 196 * <code>.google.cloud.automl.v1.TextExtractionModelMetadata text_extraction_model_metadata = 19; 197 * </code> 198 * 199 * @return Whether the textExtractionModelMetadata field is set. 200 */ hasTextExtractionModelMetadata()201 boolean hasTextExtractionModelMetadata(); 202 /** 203 * 204 * 205 * <pre> 206 * Metadata for text extraction models. 207 * </pre> 208 * 209 * <code>.google.cloud.automl.v1.TextExtractionModelMetadata text_extraction_model_metadata = 19; 210 * </code> 211 * 212 * @return The textExtractionModelMetadata. 213 */ getTextExtractionModelMetadata()214 com.google.cloud.automl.v1.TextExtractionModelMetadata getTextExtractionModelMetadata(); 215 /** 216 * 217 * 218 * <pre> 219 * Metadata for text extraction models. 220 * </pre> 221 * 222 * <code>.google.cloud.automl.v1.TextExtractionModelMetadata text_extraction_model_metadata = 19; 223 * </code> 224 */ 225 com.google.cloud.automl.v1.TextExtractionModelMetadataOrBuilder getTextExtractionModelMetadataOrBuilder()226 getTextExtractionModelMetadataOrBuilder(); 227 228 /** 229 * 230 * 231 * <pre> 232 * Metadata for text sentiment models. 233 * </pre> 234 * 235 * <code>.google.cloud.automl.v1.TextSentimentModelMetadata text_sentiment_model_metadata = 22; 236 * </code> 237 * 238 * @return Whether the textSentimentModelMetadata field is set. 239 */ hasTextSentimentModelMetadata()240 boolean hasTextSentimentModelMetadata(); 241 /** 242 * 243 * 244 * <pre> 245 * Metadata for text sentiment models. 246 * </pre> 247 * 248 * <code>.google.cloud.automl.v1.TextSentimentModelMetadata text_sentiment_model_metadata = 22; 249 * </code> 250 * 251 * @return The textSentimentModelMetadata. 252 */ getTextSentimentModelMetadata()253 com.google.cloud.automl.v1.TextSentimentModelMetadata getTextSentimentModelMetadata(); 254 /** 255 * 256 * 257 * <pre> 258 * Metadata for text sentiment models. 259 * </pre> 260 * 261 * <code>.google.cloud.automl.v1.TextSentimentModelMetadata text_sentiment_model_metadata = 22; 262 * </code> 263 */ 264 com.google.cloud.automl.v1.TextSentimentModelMetadataOrBuilder getTextSentimentModelMetadataOrBuilder()265 getTextSentimentModelMetadataOrBuilder(); 266 267 /** 268 * 269 * 270 * <pre> 271 * Output only. Resource name of the model. 272 * Format: `projects/{project_id}/locations/{location_id}/models/{model_id}` 273 * </pre> 274 * 275 * <code>string name = 1;</code> 276 * 277 * @return The name. 278 */ getName()279 java.lang.String getName(); 280 /** 281 * 282 * 283 * <pre> 284 * Output only. Resource name of the model. 285 * Format: `projects/{project_id}/locations/{location_id}/models/{model_id}` 286 * </pre> 287 * 288 * <code>string name = 1;</code> 289 * 290 * @return The bytes for name. 291 */ getNameBytes()292 com.google.protobuf.ByteString getNameBytes(); 293 294 /** 295 * 296 * 297 * <pre> 298 * Required. The name of the model to show in the interface. The name can be 299 * up to 32 characters long and can consist only of ASCII Latin letters A-Z 300 * and a-z, underscores 301 * (_), and ASCII digits 0-9. It must start with a letter. 302 * </pre> 303 * 304 * <code>string display_name = 2;</code> 305 * 306 * @return The displayName. 307 */ getDisplayName()308 java.lang.String getDisplayName(); 309 /** 310 * 311 * 312 * <pre> 313 * Required. The name of the model to show in the interface. The name can be 314 * up to 32 characters long and can consist only of ASCII Latin letters A-Z 315 * and a-z, underscores 316 * (_), and ASCII digits 0-9. It must start with a letter. 317 * </pre> 318 * 319 * <code>string display_name = 2;</code> 320 * 321 * @return The bytes for displayName. 322 */ getDisplayNameBytes()323 com.google.protobuf.ByteString getDisplayNameBytes(); 324 325 /** 326 * 327 * 328 * <pre> 329 * Required. The resource ID of the dataset used to create the model. The dataset must 330 * come from the same ancestor project and location. 331 * </pre> 332 * 333 * <code>string dataset_id = 3;</code> 334 * 335 * @return The datasetId. 336 */ getDatasetId()337 java.lang.String getDatasetId(); 338 /** 339 * 340 * 341 * <pre> 342 * Required. The resource ID of the dataset used to create the model. The dataset must 343 * come from the same ancestor project and location. 344 * </pre> 345 * 346 * <code>string dataset_id = 3;</code> 347 * 348 * @return The bytes for datasetId. 349 */ getDatasetIdBytes()350 com.google.protobuf.ByteString getDatasetIdBytes(); 351 352 /** 353 * 354 * 355 * <pre> 356 * Output only. Timestamp when the model training finished and can be used for prediction. 357 * </pre> 358 * 359 * <code>.google.protobuf.Timestamp create_time = 7;</code> 360 * 361 * @return Whether the createTime field is set. 362 */ hasCreateTime()363 boolean hasCreateTime(); 364 /** 365 * 366 * 367 * <pre> 368 * Output only. Timestamp when the model training finished and can be used for prediction. 369 * </pre> 370 * 371 * <code>.google.protobuf.Timestamp create_time = 7;</code> 372 * 373 * @return The createTime. 374 */ getCreateTime()375 com.google.protobuf.Timestamp getCreateTime(); 376 /** 377 * 378 * 379 * <pre> 380 * Output only. Timestamp when the model training finished and can be used for prediction. 381 * </pre> 382 * 383 * <code>.google.protobuf.Timestamp create_time = 7;</code> 384 */ getCreateTimeOrBuilder()385 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 386 387 /** 388 * 389 * 390 * <pre> 391 * Output only. Timestamp when this model was last updated. 392 * </pre> 393 * 394 * <code>.google.protobuf.Timestamp update_time = 11;</code> 395 * 396 * @return Whether the updateTime field is set. 397 */ hasUpdateTime()398 boolean hasUpdateTime(); 399 /** 400 * 401 * 402 * <pre> 403 * Output only. Timestamp when this model was last updated. 404 * </pre> 405 * 406 * <code>.google.protobuf.Timestamp update_time = 11;</code> 407 * 408 * @return The updateTime. 409 */ getUpdateTime()410 com.google.protobuf.Timestamp getUpdateTime(); 411 /** 412 * 413 * 414 * <pre> 415 * Output only. Timestamp when this model was last updated. 416 * </pre> 417 * 418 * <code>.google.protobuf.Timestamp update_time = 11;</code> 419 */ getUpdateTimeOrBuilder()420 com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); 421 422 /** 423 * 424 * 425 * <pre> 426 * Output only. Deployment state of the model. A model can only serve 427 * prediction requests after it gets deployed. 428 * </pre> 429 * 430 * <code>.google.cloud.automl.v1.Model.DeploymentState deployment_state = 8;</code> 431 * 432 * @return The enum numeric value on the wire for deploymentState. 433 */ getDeploymentStateValue()434 int getDeploymentStateValue(); 435 /** 436 * 437 * 438 * <pre> 439 * Output only. Deployment state of the model. A model can only serve 440 * prediction requests after it gets deployed. 441 * </pre> 442 * 443 * <code>.google.cloud.automl.v1.Model.DeploymentState deployment_state = 8;</code> 444 * 445 * @return The deploymentState. 446 */ getDeploymentState()447 com.google.cloud.automl.v1.Model.DeploymentState getDeploymentState(); 448 449 /** 450 * 451 * 452 * <pre> 453 * Used to perform a consistent read-modify-write updates. If not set, a blind 454 * "overwrite" update happens. 455 * </pre> 456 * 457 * <code>string etag = 10;</code> 458 * 459 * @return The etag. 460 */ getEtag()461 java.lang.String getEtag(); 462 /** 463 * 464 * 465 * <pre> 466 * Used to perform a consistent read-modify-write updates. If not set, a blind 467 * "overwrite" update happens. 468 * </pre> 469 * 470 * <code>string etag = 10;</code> 471 * 472 * @return The bytes for etag. 473 */ getEtagBytes()474 com.google.protobuf.ByteString getEtagBytes(); 475 476 /** 477 * 478 * 479 * <pre> 480 * Optional. The labels with user-defined metadata to organize your model. 481 * Label keys and values can be no longer than 64 characters 482 * (Unicode codepoints), can only contain lowercase letters, numeric 483 * characters, underscores and dashes. International characters are allowed. 484 * Label values are optional. Label keys must start with a letter. 485 * See https://goo.gl/xmQnxf for more information on and examples of labels. 486 * </pre> 487 * 488 * <code>map<string, string> labels = 34;</code> 489 */ getLabelsCount()490 int getLabelsCount(); 491 /** 492 * 493 * 494 * <pre> 495 * Optional. The labels with user-defined metadata to organize your model. 496 * Label keys and values can be no longer than 64 characters 497 * (Unicode codepoints), can only contain lowercase letters, numeric 498 * characters, underscores and dashes. International characters are allowed. 499 * Label values are optional. Label keys must start with a letter. 500 * See https://goo.gl/xmQnxf for more information on and examples of labels. 501 * </pre> 502 * 503 * <code>map<string, string> labels = 34;</code> 504 */ containsLabels(java.lang.String key)505 boolean containsLabels(java.lang.String key); 506 /** Use {@link #getLabelsMap()} instead. */ 507 @java.lang.Deprecated getLabels()508 java.util.Map<java.lang.String, java.lang.String> getLabels(); 509 /** 510 * 511 * 512 * <pre> 513 * Optional. The labels with user-defined metadata to organize your model. 514 * Label keys and values can be no longer than 64 characters 515 * (Unicode codepoints), can only contain lowercase letters, numeric 516 * characters, underscores and dashes. International characters are allowed. 517 * Label values are optional. Label keys must start with a letter. 518 * See https://goo.gl/xmQnxf for more information on and examples of labels. 519 * </pre> 520 * 521 * <code>map<string, string> labels = 34;</code> 522 */ getLabelsMap()523 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 524 /** 525 * 526 * 527 * <pre> 528 * Optional. The labels with user-defined metadata to organize your model. 529 * Label keys and values can be no longer than 64 characters 530 * (Unicode codepoints), can only contain lowercase letters, numeric 531 * characters, underscores and dashes. International characters are allowed. 532 * Label values are optional. Label keys must start with a letter. 533 * See https://goo.gl/xmQnxf for more information on and examples of labels. 534 * </pre> 535 * 536 * <code>map<string, string> labels = 34;</code> 537 */ 538 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)539 java.lang.String getLabelsOrDefault( 540 java.lang.String key, 541 /* nullable */ 542 java.lang.String defaultValue); 543 /** 544 * 545 * 546 * <pre> 547 * Optional. The labels with user-defined metadata to organize your model. 548 * Label keys and values can be no longer than 64 characters 549 * (Unicode codepoints), can only contain lowercase letters, numeric 550 * characters, underscores and dashes. International characters are allowed. 551 * Label values are optional. Label keys must start with a letter. 552 * See https://goo.gl/xmQnxf for more information on and examples of labels. 553 * </pre> 554 * 555 * <code>map<string, string> labels = 34;</code> 556 */ getLabelsOrThrow(java.lang.String key)557 java.lang.String getLabelsOrThrow(java.lang.String key); 558 getModelMetadataCase()559 public com.google.cloud.automl.v1.Model.ModelMetadataCase getModelMetadataCase(); 560 } 561