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/speech/v2/cloud_speech.proto 18 19 package com.google.cloud.speech.v2; 20 21 public interface RecognizerOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.speech.v2.Recognizer) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Output only. The resource name of the Recognizer. 31 * Format: `projects/{project}/locations/{location}/recognizers/{recognizer}`. 32 * </pre> 33 * 34 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 35 * 36 * @return The name. 37 */ getName()38 java.lang.String getName(); 39 /** 40 * 41 * 42 * <pre> 43 * Output only. The resource name of the Recognizer. 44 * Format: `projects/{project}/locations/{location}/recognizers/{recognizer}`. 45 * </pre> 46 * 47 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 48 * 49 * @return The bytes for name. 50 */ getNameBytes()51 com.google.protobuf.ByteString getNameBytes(); 52 53 /** 54 * 55 * 56 * <pre> 57 * Output only. System-assigned unique identifier for the Recognizer. 58 * </pre> 59 * 60 * <code>string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 61 * 62 * @return The uid. 63 */ getUid()64 java.lang.String getUid(); 65 /** 66 * 67 * 68 * <pre> 69 * Output only. System-assigned unique identifier for the Recognizer. 70 * </pre> 71 * 72 * <code>string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 73 * 74 * @return The bytes for uid. 75 */ getUidBytes()76 com.google.protobuf.ByteString getUidBytes(); 77 78 /** 79 * 80 * 81 * <pre> 82 * User-settable, human-readable name for the Recognizer. Must be 63 83 * characters or less. 84 * </pre> 85 * 86 * <code>string display_name = 3;</code> 87 * 88 * @return The displayName. 89 */ getDisplayName()90 java.lang.String getDisplayName(); 91 /** 92 * 93 * 94 * <pre> 95 * User-settable, human-readable name for the Recognizer. Must be 63 96 * characters or less. 97 * </pre> 98 * 99 * <code>string display_name = 3;</code> 100 * 101 * @return The bytes for displayName. 102 */ getDisplayNameBytes()103 com.google.protobuf.ByteString getDisplayNameBytes(); 104 105 /** 106 * 107 * 108 * <pre> 109 * Required. Which model to use for recognition requests. Select the model 110 * best suited to your domain to get best results. 111 * Guidance for choosing which model to use can be found in the [Transcription 112 * Models 113 * Documentation](https://cloud.google.com/speech-to-text/v2/docs/transcription-model) 114 * and the models supported in each region can be found in the [Table Of 115 * Supported 116 * Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages). 117 * </pre> 118 * 119 * <code>string model = 4 [(.google.api.field_behavior) = REQUIRED];</code> 120 * 121 * @return The model. 122 */ getModel()123 java.lang.String getModel(); 124 /** 125 * 126 * 127 * <pre> 128 * Required. Which model to use for recognition requests. Select the model 129 * best suited to your domain to get best results. 130 * Guidance for choosing which model to use can be found in the [Transcription 131 * Models 132 * Documentation](https://cloud.google.com/speech-to-text/v2/docs/transcription-model) 133 * and the models supported in each region can be found in the [Table Of 134 * Supported 135 * Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages). 136 * </pre> 137 * 138 * <code>string model = 4 [(.google.api.field_behavior) = REQUIRED];</code> 139 * 140 * @return The bytes for model. 141 */ getModelBytes()142 com.google.protobuf.ByteString getModelBytes(); 143 144 /** 145 * 146 * 147 * <pre> 148 * Required. The language of the supplied audio as a 149 * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. 150 * Supported languages for each model are listed in the [Table of Supported 151 * Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages). 152 * If additional languages are provided, recognition result will contain 153 * recognition in the most likely language detected. The recognition result 154 * will include the language tag of the language detected in the audio. 155 * When you create or update a Recognizer, these values are 156 * stored in normalized BCP-47 form. For example, "en-us" is stored as 157 * "en-US". 158 * </pre> 159 * 160 * <code>repeated string language_codes = 17 [(.google.api.field_behavior) = REQUIRED];</code> 161 * 162 * @return A list containing the languageCodes. 163 */ getLanguageCodesList()164 java.util.List<java.lang.String> getLanguageCodesList(); 165 /** 166 * 167 * 168 * <pre> 169 * Required. The language of the supplied audio as a 170 * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. 171 * Supported languages for each model are listed in the [Table of Supported 172 * Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages). 173 * If additional languages are provided, recognition result will contain 174 * recognition in the most likely language detected. The recognition result 175 * will include the language tag of the language detected in the audio. 176 * When you create or update a Recognizer, these values are 177 * stored in normalized BCP-47 form. For example, "en-us" is stored as 178 * "en-US". 179 * </pre> 180 * 181 * <code>repeated string language_codes = 17 [(.google.api.field_behavior) = REQUIRED];</code> 182 * 183 * @return The count of languageCodes. 184 */ getLanguageCodesCount()185 int getLanguageCodesCount(); 186 /** 187 * 188 * 189 * <pre> 190 * Required. The language of the supplied audio as a 191 * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. 192 * Supported languages for each model are listed in the [Table of Supported 193 * Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages). 194 * If additional languages are provided, recognition result will contain 195 * recognition in the most likely language detected. The recognition result 196 * will include the language tag of the language detected in the audio. 197 * When you create or update a Recognizer, these values are 198 * stored in normalized BCP-47 form. For example, "en-us" is stored as 199 * "en-US". 200 * </pre> 201 * 202 * <code>repeated string language_codes = 17 [(.google.api.field_behavior) = REQUIRED];</code> 203 * 204 * @param index The index of the element to return. 205 * @return The languageCodes at the given index. 206 */ getLanguageCodes(int index)207 java.lang.String getLanguageCodes(int index); 208 /** 209 * 210 * 211 * <pre> 212 * Required. The language of the supplied audio as a 213 * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. 214 * Supported languages for each model are listed in the [Table of Supported 215 * Models](https://cloud.google.com/speech-to-text/v2/docs/speech-to-text-supported-languages). 216 * If additional languages are provided, recognition result will contain 217 * recognition in the most likely language detected. The recognition result 218 * will include the language tag of the language detected in the audio. 219 * When you create or update a Recognizer, these values are 220 * stored in normalized BCP-47 form. For example, "en-us" is stored as 221 * "en-US". 222 * </pre> 223 * 224 * <code>repeated string language_codes = 17 [(.google.api.field_behavior) = REQUIRED];</code> 225 * 226 * @param index The index of the value to return. 227 * @return The bytes of the languageCodes at the given index. 228 */ getLanguageCodesBytes(int index)229 com.google.protobuf.ByteString getLanguageCodesBytes(int index); 230 231 /** 232 * 233 * 234 * <pre> 235 * Default configuration to use for requests with this Recognizer. 236 * This can be overwritten by inline configuration in the 237 * [RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config] 238 * field. 239 * </pre> 240 * 241 * <code>.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;</code> 242 * 243 * @return Whether the defaultRecognitionConfig field is set. 244 */ hasDefaultRecognitionConfig()245 boolean hasDefaultRecognitionConfig(); 246 /** 247 * 248 * 249 * <pre> 250 * Default configuration to use for requests with this Recognizer. 251 * This can be overwritten by inline configuration in the 252 * [RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config] 253 * field. 254 * </pre> 255 * 256 * <code>.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;</code> 257 * 258 * @return The defaultRecognitionConfig. 259 */ getDefaultRecognitionConfig()260 com.google.cloud.speech.v2.RecognitionConfig getDefaultRecognitionConfig(); 261 /** 262 * 263 * 264 * <pre> 265 * Default configuration to use for requests with this Recognizer. 266 * This can be overwritten by inline configuration in the 267 * [RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config] 268 * field. 269 * </pre> 270 * 271 * <code>.google.cloud.speech.v2.RecognitionConfig default_recognition_config = 6;</code> 272 */ getDefaultRecognitionConfigOrBuilder()273 com.google.cloud.speech.v2.RecognitionConfigOrBuilder getDefaultRecognitionConfigOrBuilder(); 274 275 /** 276 * 277 * 278 * <pre> 279 * Allows users to store small amounts of arbitrary data. 280 * Both the key and the value must be 63 characters or less each. 281 * At most 100 annotations. 282 * </pre> 283 * 284 * <code>map<string, string> annotations = 7;</code> 285 */ getAnnotationsCount()286 int getAnnotationsCount(); 287 /** 288 * 289 * 290 * <pre> 291 * Allows users to store small amounts of arbitrary data. 292 * Both the key and the value must be 63 characters or less each. 293 * At most 100 annotations. 294 * </pre> 295 * 296 * <code>map<string, string> annotations = 7;</code> 297 */ containsAnnotations(java.lang.String key)298 boolean containsAnnotations(java.lang.String key); 299 /** Use {@link #getAnnotationsMap()} instead. */ 300 @java.lang.Deprecated getAnnotations()301 java.util.Map<java.lang.String, java.lang.String> getAnnotations(); 302 /** 303 * 304 * 305 * <pre> 306 * Allows users to store small amounts of arbitrary data. 307 * Both the key and the value must be 63 characters or less each. 308 * At most 100 annotations. 309 * </pre> 310 * 311 * <code>map<string, string> annotations = 7;</code> 312 */ getAnnotationsMap()313 java.util.Map<java.lang.String, java.lang.String> getAnnotationsMap(); 314 /** 315 * 316 * 317 * <pre> 318 * Allows users to store small amounts of arbitrary data. 319 * Both the key and the value must be 63 characters or less each. 320 * At most 100 annotations. 321 * </pre> 322 * 323 * <code>map<string, string> annotations = 7;</code> 324 */ 325 /* nullable */ getAnnotationsOrDefault( java.lang.String key, java.lang.String defaultValue)326 java.lang.String getAnnotationsOrDefault( 327 java.lang.String key, 328 /* nullable */ 329 java.lang.String defaultValue); 330 /** 331 * 332 * 333 * <pre> 334 * Allows users to store small amounts of arbitrary data. 335 * Both the key and the value must be 63 characters or less each. 336 * At most 100 annotations. 337 * </pre> 338 * 339 * <code>map<string, string> annotations = 7;</code> 340 */ getAnnotationsOrThrow(java.lang.String key)341 java.lang.String getAnnotationsOrThrow(java.lang.String key); 342 343 /** 344 * 345 * 346 * <pre> 347 * Output only. The Recognizer lifecycle state. 348 * </pre> 349 * 350 * <code> 351 * .google.cloud.speech.v2.Recognizer.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; 352 * </code> 353 * 354 * @return The enum numeric value on the wire for state. 355 */ getStateValue()356 int getStateValue(); 357 /** 358 * 359 * 360 * <pre> 361 * Output only. The Recognizer lifecycle state. 362 * </pre> 363 * 364 * <code> 365 * .google.cloud.speech.v2.Recognizer.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; 366 * </code> 367 * 368 * @return The state. 369 */ getState()370 com.google.cloud.speech.v2.Recognizer.State getState(); 371 372 /** 373 * 374 * 375 * <pre> 376 * Output only. Creation time. 377 * </pre> 378 * 379 * <code>.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; 380 * </code> 381 * 382 * @return Whether the createTime field is set. 383 */ hasCreateTime()384 boolean hasCreateTime(); 385 /** 386 * 387 * 388 * <pre> 389 * Output only. Creation time. 390 * </pre> 391 * 392 * <code>.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; 393 * </code> 394 * 395 * @return The createTime. 396 */ getCreateTime()397 com.google.protobuf.Timestamp getCreateTime(); 398 /** 399 * 400 * 401 * <pre> 402 * Output only. Creation time. 403 * </pre> 404 * 405 * <code>.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; 406 * </code> 407 */ getCreateTimeOrBuilder()408 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 409 410 /** 411 * 412 * 413 * <pre> 414 * Output only. The most recent time this Recognizer was modified. 415 * </pre> 416 * 417 * <code>.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 418 * </code> 419 * 420 * @return Whether the updateTime field is set. 421 */ hasUpdateTime()422 boolean hasUpdateTime(); 423 /** 424 * 425 * 426 * <pre> 427 * Output only. The most recent time this Recognizer was modified. 428 * </pre> 429 * 430 * <code>.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 431 * </code> 432 * 433 * @return The updateTime. 434 */ getUpdateTime()435 com.google.protobuf.Timestamp getUpdateTime(); 436 /** 437 * 438 * 439 * <pre> 440 * Output only. The most recent time this Recognizer was modified. 441 * </pre> 442 * 443 * <code>.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 444 * </code> 445 */ getUpdateTimeOrBuilder()446 com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); 447 448 /** 449 * 450 * 451 * <pre> 452 * Output only. The time at which this Recognizer was requested for deletion. 453 * </pre> 454 * 455 * <code>.google.protobuf.Timestamp delete_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; 456 * </code> 457 * 458 * @return Whether the deleteTime field is set. 459 */ hasDeleteTime()460 boolean hasDeleteTime(); 461 /** 462 * 463 * 464 * <pre> 465 * Output only. The time at which this Recognizer was requested for deletion. 466 * </pre> 467 * 468 * <code>.google.protobuf.Timestamp delete_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; 469 * </code> 470 * 471 * @return The deleteTime. 472 */ getDeleteTime()473 com.google.protobuf.Timestamp getDeleteTime(); 474 /** 475 * 476 * 477 * <pre> 478 * Output only. The time at which this Recognizer was requested for deletion. 479 * </pre> 480 * 481 * <code>.google.protobuf.Timestamp delete_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; 482 * </code> 483 */ getDeleteTimeOrBuilder()484 com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder(); 485 486 /** 487 * 488 * 489 * <pre> 490 * Output only. The time at which this Recognizer will be purged. 491 * </pre> 492 * 493 * <code>.google.protobuf.Timestamp expire_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; 494 * </code> 495 * 496 * @return Whether the expireTime field is set. 497 */ hasExpireTime()498 boolean hasExpireTime(); 499 /** 500 * 501 * 502 * <pre> 503 * Output only. The time at which this Recognizer will be purged. 504 * </pre> 505 * 506 * <code>.google.protobuf.Timestamp expire_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; 507 * </code> 508 * 509 * @return The expireTime. 510 */ getExpireTime()511 com.google.protobuf.Timestamp getExpireTime(); 512 /** 513 * 514 * 515 * <pre> 516 * Output only. The time at which this Recognizer will be purged. 517 * </pre> 518 * 519 * <code>.google.protobuf.Timestamp expire_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; 520 * </code> 521 */ getExpireTimeOrBuilder()522 com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder(); 523 524 /** 525 * 526 * 527 * <pre> 528 * Output only. This checksum is computed by the server based on the value of 529 * other fields. This may be sent on update, undelete, and delete requests to 530 * ensure the client has an up-to-date value before proceeding. 531 * </pre> 532 * 533 * <code>string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 534 * 535 * @return The etag. 536 */ getEtag()537 java.lang.String getEtag(); 538 /** 539 * 540 * 541 * <pre> 542 * Output only. This checksum is computed by the server based on the value of 543 * other fields. This may be sent on update, undelete, and delete requests to 544 * ensure the client has an up-to-date value before proceeding. 545 * </pre> 546 * 547 * <code>string etag = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 548 * 549 * @return The bytes for etag. 550 */ getEtagBytes()551 com.google.protobuf.ByteString getEtagBytes(); 552 553 /** 554 * 555 * 556 * <pre> 557 * Output only. Whether or not this Recognizer is in the process of being 558 * updated. 559 * </pre> 560 * 561 * <code>bool reconciling = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 562 * 563 * @return The reconciling. 564 */ getReconciling()565 boolean getReconciling(); 566 567 /** 568 * 569 * 570 * <pre> 571 * Output only. The [KMS key 572 * name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which 573 * the Recognizer is encrypted. The expected format is 574 * `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. 575 * </pre> 576 * 577 * <code> 578 * string kms_key_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 579 * </code> 580 * 581 * @return The kmsKeyName. 582 */ getKmsKeyName()583 java.lang.String getKmsKeyName(); 584 /** 585 * 586 * 587 * <pre> 588 * Output only. The [KMS key 589 * name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which 590 * the Recognizer is encrypted. The expected format is 591 * `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. 592 * </pre> 593 * 594 * <code> 595 * string kms_key_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 596 * </code> 597 * 598 * @return The bytes for kmsKeyName. 599 */ getKmsKeyNameBytes()600 com.google.protobuf.ByteString getKmsKeyNameBytes(); 601 602 /** 603 * 604 * 605 * <pre> 606 * Output only. The [KMS key version 607 * name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) 608 * with which the Recognizer is encrypted. The expected format is 609 * `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`. 610 * </pre> 611 * 612 * <code> 613 * string kms_key_version_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 614 * </code> 615 * 616 * @return The kmsKeyVersionName. 617 */ getKmsKeyVersionName()618 java.lang.String getKmsKeyVersionName(); 619 /** 620 * 621 * 622 * <pre> 623 * Output only. The [KMS key version 624 * name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) 625 * with which the Recognizer is encrypted. The expected format is 626 * `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`. 627 * </pre> 628 * 629 * <code> 630 * string kms_key_version_name = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 631 * </code> 632 * 633 * @return The bytes for kmsKeyVersionName. 634 */ getKmsKeyVersionNameBytes()635 com.google.protobuf.ByteString getKmsKeyVersionNameBytes(); 636 } 637