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