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/aiplatform/v1/model.proto 18 19 package com.google.cloud.aiplatform.v1; 20 21 public interface ModelOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.aiplatform.v1.Model) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The resource name of the Model. 31 * </pre> 32 * 33 * <code>string name = 1;</code> 34 * 35 * @return The name. 36 */ getName()37 java.lang.String getName(); 38 /** 39 * 40 * 41 * <pre> 42 * The resource name of the Model. 43 * </pre> 44 * 45 * <code>string name = 1;</code> 46 * 47 * @return The bytes for name. 48 */ getNameBytes()49 com.google.protobuf.ByteString getNameBytes(); 50 51 /** 52 * 53 * 54 * <pre> 55 * Output only. Immutable. The version ID of the model. 56 * A new version is committed when a new model version is uploaded or 57 * trained under an existing model id. It is an auto-incrementing decimal 58 * number in string representation. 59 * </pre> 60 * 61 * <code> 62 * string version_id = 28 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY]; 63 * </code> 64 * 65 * @return The versionId. 66 */ getVersionId()67 java.lang.String getVersionId(); 68 /** 69 * 70 * 71 * <pre> 72 * Output only. Immutable. The version ID of the model. 73 * A new version is committed when a new model version is uploaded or 74 * trained under an existing model id. It is an auto-incrementing decimal 75 * number in string representation. 76 * </pre> 77 * 78 * <code> 79 * string version_id = 28 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY]; 80 * </code> 81 * 82 * @return The bytes for versionId. 83 */ getVersionIdBytes()84 com.google.protobuf.ByteString getVersionIdBytes(); 85 86 /** 87 * 88 * 89 * <pre> 90 * User provided version aliases so that a model version can be referenced via 91 * alias (i.e. 92 * `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` 93 * instead of auto-generated version id (i.e. 94 * `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. 95 * The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from 96 * version_id. A default version alias will be created for the first version 97 * of the model, and there must be exactly one default version alias for a 98 * model. 99 * </pre> 100 * 101 * <code>repeated string version_aliases = 29;</code> 102 * 103 * @return A list containing the versionAliases. 104 */ getVersionAliasesList()105 java.util.List<java.lang.String> getVersionAliasesList(); 106 /** 107 * 108 * 109 * <pre> 110 * User provided version aliases so that a model version can be referenced via 111 * alias (i.e. 112 * `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` 113 * instead of auto-generated version id (i.e. 114 * `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. 115 * The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from 116 * version_id. A default version alias will be created for the first version 117 * of the model, and there must be exactly one default version alias for a 118 * model. 119 * </pre> 120 * 121 * <code>repeated string version_aliases = 29;</code> 122 * 123 * @return The count of versionAliases. 124 */ getVersionAliasesCount()125 int getVersionAliasesCount(); 126 /** 127 * 128 * 129 * <pre> 130 * User provided version aliases so that a model version can be referenced via 131 * alias (i.e. 132 * `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` 133 * instead of auto-generated version id (i.e. 134 * `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. 135 * The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from 136 * version_id. A default version alias will be created for the first version 137 * of the model, and there must be exactly one default version alias for a 138 * model. 139 * </pre> 140 * 141 * <code>repeated string version_aliases = 29;</code> 142 * 143 * @param index The index of the element to return. 144 * @return The versionAliases at the given index. 145 */ getVersionAliases(int index)146 java.lang.String getVersionAliases(int index); 147 /** 148 * 149 * 150 * <pre> 151 * User provided version aliases so that a model version can be referenced via 152 * alias (i.e. 153 * `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` 154 * instead of auto-generated version id (i.e. 155 * `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. 156 * The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from 157 * version_id. A default version alias will be created for the first version 158 * of the model, and there must be exactly one default version alias for a 159 * model. 160 * </pre> 161 * 162 * <code>repeated string version_aliases = 29;</code> 163 * 164 * @param index The index of the value to return. 165 * @return The bytes of the versionAliases at the given index. 166 */ getVersionAliasesBytes(int index)167 com.google.protobuf.ByteString getVersionAliasesBytes(int index); 168 169 /** 170 * 171 * 172 * <pre> 173 * Output only. Timestamp when this version was created. 174 * </pre> 175 * 176 * <code> 177 * .google.protobuf.Timestamp version_create_time = 31 [(.google.api.field_behavior) = OUTPUT_ONLY]; 178 * </code> 179 * 180 * @return Whether the versionCreateTime field is set. 181 */ hasVersionCreateTime()182 boolean hasVersionCreateTime(); 183 /** 184 * 185 * 186 * <pre> 187 * Output only. Timestamp when this version was created. 188 * </pre> 189 * 190 * <code> 191 * .google.protobuf.Timestamp version_create_time = 31 [(.google.api.field_behavior) = OUTPUT_ONLY]; 192 * </code> 193 * 194 * @return The versionCreateTime. 195 */ getVersionCreateTime()196 com.google.protobuf.Timestamp getVersionCreateTime(); 197 /** 198 * 199 * 200 * <pre> 201 * Output only. Timestamp when this version was created. 202 * </pre> 203 * 204 * <code> 205 * .google.protobuf.Timestamp version_create_time = 31 [(.google.api.field_behavior) = OUTPUT_ONLY]; 206 * </code> 207 */ getVersionCreateTimeOrBuilder()208 com.google.protobuf.TimestampOrBuilder getVersionCreateTimeOrBuilder(); 209 210 /** 211 * 212 * 213 * <pre> 214 * Output only. Timestamp when this version was most recently updated. 215 * </pre> 216 * 217 * <code> 218 * .google.protobuf.Timestamp version_update_time = 32 [(.google.api.field_behavior) = OUTPUT_ONLY]; 219 * </code> 220 * 221 * @return Whether the versionUpdateTime field is set. 222 */ hasVersionUpdateTime()223 boolean hasVersionUpdateTime(); 224 /** 225 * 226 * 227 * <pre> 228 * Output only. Timestamp when this version was most recently updated. 229 * </pre> 230 * 231 * <code> 232 * .google.protobuf.Timestamp version_update_time = 32 [(.google.api.field_behavior) = OUTPUT_ONLY]; 233 * </code> 234 * 235 * @return The versionUpdateTime. 236 */ getVersionUpdateTime()237 com.google.protobuf.Timestamp getVersionUpdateTime(); 238 /** 239 * 240 * 241 * <pre> 242 * Output only. Timestamp when this version was most recently updated. 243 * </pre> 244 * 245 * <code> 246 * .google.protobuf.Timestamp version_update_time = 32 [(.google.api.field_behavior) = OUTPUT_ONLY]; 247 * </code> 248 */ getVersionUpdateTimeOrBuilder()249 com.google.protobuf.TimestampOrBuilder getVersionUpdateTimeOrBuilder(); 250 251 /** 252 * 253 * 254 * <pre> 255 * Required. The display name of the Model. 256 * The name can be up to 128 characters long and can consist of any UTF-8 257 * characters. 258 * </pre> 259 * 260 * <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code> 261 * 262 * @return The displayName. 263 */ getDisplayName()264 java.lang.String getDisplayName(); 265 /** 266 * 267 * 268 * <pre> 269 * Required. The display name of the Model. 270 * The name can be up to 128 characters long and can consist of any UTF-8 271 * characters. 272 * </pre> 273 * 274 * <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code> 275 * 276 * @return The bytes for displayName. 277 */ getDisplayNameBytes()278 com.google.protobuf.ByteString getDisplayNameBytes(); 279 280 /** 281 * 282 * 283 * <pre> 284 * The description of the Model. 285 * </pre> 286 * 287 * <code>string description = 3;</code> 288 * 289 * @return The description. 290 */ getDescription()291 java.lang.String getDescription(); 292 /** 293 * 294 * 295 * <pre> 296 * The description of the Model. 297 * </pre> 298 * 299 * <code>string description = 3;</code> 300 * 301 * @return The bytes for description. 302 */ getDescriptionBytes()303 com.google.protobuf.ByteString getDescriptionBytes(); 304 305 /** 306 * 307 * 308 * <pre> 309 * The description of this version. 310 * </pre> 311 * 312 * <code>string version_description = 30;</code> 313 * 314 * @return The versionDescription. 315 */ getVersionDescription()316 java.lang.String getVersionDescription(); 317 /** 318 * 319 * 320 * <pre> 321 * The description of this version. 322 * </pre> 323 * 324 * <code>string version_description = 30;</code> 325 * 326 * @return The bytes for versionDescription. 327 */ getVersionDescriptionBytes()328 com.google.protobuf.ByteString getVersionDescriptionBytes(); 329 330 /** 331 * 332 * 333 * <pre> 334 * The schemata that describe formats of the Model's predictions and 335 * explanations as given and returned via 336 * [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 337 * and 338 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. 339 * </pre> 340 * 341 * <code>.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 4;</code> 342 * 343 * @return Whether the predictSchemata field is set. 344 */ hasPredictSchemata()345 boolean hasPredictSchemata(); 346 /** 347 * 348 * 349 * <pre> 350 * The schemata that describe formats of the Model's predictions and 351 * explanations as given and returned via 352 * [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 353 * and 354 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. 355 * </pre> 356 * 357 * <code>.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 4;</code> 358 * 359 * @return The predictSchemata. 360 */ getPredictSchemata()361 com.google.cloud.aiplatform.v1.PredictSchemata getPredictSchemata(); 362 /** 363 * 364 * 365 * <pre> 366 * The schemata that describe formats of the Model's predictions and 367 * explanations as given and returned via 368 * [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 369 * and 370 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. 371 * </pre> 372 * 373 * <code>.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 4;</code> 374 */ getPredictSchemataOrBuilder()375 com.google.cloud.aiplatform.v1.PredictSchemataOrBuilder getPredictSchemataOrBuilder(); 376 377 /** 378 * 379 * 380 * <pre> 381 * Immutable. Points to a YAML file stored on Google Cloud Storage describing 382 * additional information about the Model, that is specific to it. Unset if 383 * the Model does not have any additional information. The schema is defined 384 * as an OpenAPI 3.0.2 [Schema 385 * Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 386 * AutoML Models always have this field populated by Vertex AI, if no 387 * additional metadata is needed, this field is set to an empty string. 388 * Note: The URI given on output will be immutable and probably different, 389 * including the URI scheme, than the one given on input. The output URI will 390 * point to a location where the user only has a read access. 391 * </pre> 392 * 393 * <code>string metadata_schema_uri = 5 [(.google.api.field_behavior) = IMMUTABLE];</code> 394 * 395 * @return The metadataSchemaUri. 396 */ getMetadataSchemaUri()397 java.lang.String getMetadataSchemaUri(); 398 /** 399 * 400 * 401 * <pre> 402 * Immutable. Points to a YAML file stored on Google Cloud Storage describing 403 * additional information about the Model, that is specific to it. Unset if 404 * the Model does not have any additional information. The schema is defined 405 * as an OpenAPI 3.0.2 [Schema 406 * Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 407 * AutoML Models always have this field populated by Vertex AI, if no 408 * additional metadata is needed, this field is set to an empty string. 409 * Note: The URI given on output will be immutable and probably different, 410 * including the URI scheme, than the one given on input. The output URI will 411 * point to a location where the user only has a read access. 412 * </pre> 413 * 414 * <code>string metadata_schema_uri = 5 [(.google.api.field_behavior) = IMMUTABLE];</code> 415 * 416 * @return The bytes for metadataSchemaUri. 417 */ getMetadataSchemaUriBytes()418 com.google.protobuf.ByteString getMetadataSchemaUriBytes(); 419 420 /** 421 * 422 * 423 * <pre> 424 * Immutable. An additional information about the Model; the schema of the 425 * metadata can be found in 426 * [metadata_schema][google.cloud.aiplatform.v1.Model.metadata_schema_uri]. 427 * Unset if the Model does not have any additional information. 428 * </pre> 429 * 430 * <code>.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = IMMUTABLE];</code> 431 * 432 * @return Whether the metadata field is set. 433 */ hasMetadata()434 boolean hasMetadata(); 435 /** 436 * 437 * 438 * <pre> 439 * Immutable. An additional information about the Model; the schema of the 440 * metadata can be found in 441 * [metadata_schema][google.cloud.aiplatform.v1.Model.metadata_schema_uri]. 442 * Unset if the Model does not have any additional information. 443 * </pre> 444 * 445 * <code>.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = IMMUTABLE];</code> 446 * 447 * @return The metadata. 448 */ getMetadata()449 com.google.protobuf.Value getMetadata(); 450 /** 451 * 452 * 453 * <pre> 454 * Immutable. An additional information about the Model; the schema of the 455 * metadata can be found in 456 * [metadata_schema][google.cloud.aiplatform.v1.Model.metadata_schema_uri]. 457 * Unset if the Model does not have any additional information. 458 * </pre> 459 * 460 * <code>.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = IMMUTABLE];</code> 461 */ getMetadataOrBuilder()462 com.google.protobuf.ValueOrBuilder getMetadataOrBuilder(); 463 464 /** 465 * 466 * 467 * <pre> 468 * Output only. The formats in which this Model may be exported. If empty, 469 * this Model is not available for export. 470 * </pre> 471 * 472 * <code> 473 * repeated .google.cloud.aiplatform.v1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; 474 * </code> 475 */ getSupportedExportFormatsList()476 java.util.List<com.google.cloud.aiplatform.v1.Model.ExportFormat> getSupportedExportFormatsList(); 477 /** 478 * 479 * 480 * <pre> 481 * Output only. The formats in which this Model may be exported. If empty, 482 * this Model is not available for export. 483 * </pre> 484 * 485 * <code> 486 * repeated .google.cloud.aiplatform.v1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; 487 * </code> 488 */ getSupportedExportFormats(int index)489 com.google.cloud.aiplatform.v1.Model.ExportFormat getSupportedExportFormats(int index); 490 /** 491 * 492 * 493 * <pre> 494 * Output only. The formats in which this Model may be exported. If empty, 495 * this Model is not available for export. 496 * </pre> 497 * 498 * <code> 499 * repeated .google.cloud.aiplatform.v1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; 500 * </code> 501 */ getSupportedExportFormatsCount()502 int getSupportedExportFormatsCount(); 503 /** 504 * 505 * 506 * <pre> 507 * Output only. The formats in which this Model may be exported. If empty, 508 * this Model is not available for export. 509 * </pre> 510 * 511 * <code> 512 * repeated .google.cloud.aiplatform.v1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; 513 * </code> 514 */ 515 java.util.List<? extends com.google.cloud.aiplatform.v1.Model.ExportFormatOrBuilder> getSupportedExportFormatsOrBuilderList()516 getSupportedExportFormatsOrBuilderList(); 517 /** 518 * 519 * 520 * <pre> 521 * Output only. The formats in which this Model may be exported. If empty, 522 * this Model is not available for export. 523 * </pre> 524 * 525 * <code> 526 * repeated .google.cloud.aiplatform.v1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY]; 527 * </code> 528 */ getSupportedExportFormatsOrBuilder( int index)529 com.google.cloud.aiplatform.v1.Model.ExportFormatOrBuilder getSupportedExportFormatsOrBuilder( 530 int index); 531 532 /** 533 * 534 * 535 * <pre> 536 * Output only. The resource name of the TrainingPipeline that uploaded this 537 * Model, if any. 538 * </pre> 539 * 540 * <code> 541 * string training_pipeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 542 * </code> 543 * 544 * @return The trainingPipeline. 545 */ getTrainingPipeline()546 java.lang.String getTrainingPipeline(); 547 /** 548 * 549 * 550 * <pre> 551 * Output only. The resource name of the TrainingPipeline that uploaded this 552 * Model, if any. 553 * </pre> 554 * 555 * <code> 556 * string training_pipeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 557 * </code> 558 * 559 * @return The bytes for trainingPipeline. 560 */ getTrainingPipelineBytes()561 com.google.protobuf.ByteString getTrainingPipelineBytes(); 562 563 /** 564 * 565 * 566 * <pre> 567 * Input only. The specification of the container that is to be used when 568 * deploying this Model. The specification is ingested upon 569 * [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel], 570 * and all binaries it contains are copied and stored internally by Vertex AI. 571 * Not present for AutoML Models or Large Models. 572 * </pre> 573 * 574 * <code> 575 * .google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 9 [(.google.api.field_behavior) = INPUT_ONLY]; 576 * </code> 577 * 578 * @return Whether the containerSpec field is set. 579 */ hasContainerSpec()580 boolean hasContainerSpec(); 581 /** 582 * 583 * 584 * <pre> 585 * Input only. The specification of the container that is to be used when 586 * deploying this Model. The specification is ingested upon 587 * [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel], 588 * and all binaries it contains are copied and stored internally by Vertex AI. 589 * Not present for AutoML Models or Large Models. 590 * </pre> 591 * 592 * <code> 593 * .google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 9 [(.google.api.field_behavior) = INPUT_ONLY]; 594 * </code> 595 * 596 * @return The containerSpec. 597 */ getContainerSpec()598 com.google.cloud.aiplatform.v1.ModelContainerSpec getContainerSpec(); 599 /** 600 * 601 * 602 * <pre> 603 * Input only. The specification of the container that is to be used when 604 * deploying this Model. The specification is ingested upon 605 * [ModelService.UploadModel][google.cloud.aiplatform.v1.ModelService.UploadModel], 606 * and all binaries it contains are copied and stored internally by Vertex AI. 607 * Not present for AutoML Models or Large Models. 608 * </pre> 609 * 610 * <code> 611 * .google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 9 [(.google.api.field_behavior) = INPUT_ONLY]; 612 * </code> 613 */ getContainerSpecOrBuilder()614 com.google.cloud.aiplatform.v1.ModelContainerSpecOrBuilder getContainerSpecOrBuilder(); 615 616 /** 617 * 618 * 619 * <pre> 620 * Immutable. The path to the directory containing the Model artifact and any 621 * of its supporting files. Not present for AutoML Models or Large Models. 622 * </pre> 623 * 624 * <code>string artifact_uri = 26 [(.google.api.field_behavior) = IMMUTABLE];</code> 625 * 626 * @return The artifactUri. 627 */ getArtifactUri()628 java.lang.String getArtifactUri(); 629 /** 630 * 631 * 632 * <pre> 633 * Immutable. The path to the directory containing the Model artifact and any 634 * of its supporting files. Not present for AutoML Models or Large Models. 635 * </pre> 636 * 637 * <code>string artifact_uri = 26 [(.google.api.field_behavior) = IMMUTABLE];</code> 638 * 639 * @return The bytes for artifactUri. 640 */ getArtifactUriBytes()641 com.google.protobuf.ByteString getArtifactUriBytes(); 642 643 /** 644 * 645 * 646 * <pre> 647 * Output only. When this Model is deployed, its prediction resources are 648 * described by the `prediction_resources` field of the 649 * [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] 650 * object. Because not all Models support all resource configuration types, 651 * the configuration types this Model supports are listed here. If no 652 * configuration types are listed, the Model cannot be deployed to an 653 * [Endpoint][google.cloud.aiplatform.v1.Endpoint] and does not support 654 * online predictions 655 * ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 656 * or 657 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). 658 * Such a Model can serve predictions by using a 659 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it 660 * has at least one entry each in 661 * [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] 662 * and 663 * [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats]. 664 * </pre> 665 * 666 * <code> 667 * repeated .google.cloud.aiplatform.v1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 668 * </code> 669 * 670 * @return A list containing the supportedDeploymentResourcesTypes. 671 */ 672 java.util.List<com.google.cloud.aiplatform.v1.Model.DeploymentResourcesType> getSupportedDeploymentResourcesTypesList()673 getSupportedDeploymentResourcesTypesList(); 674 /** 675 * 676 * 677 * <pre> 678 * Output only. When this Model is deployed, its prediction resources are 679 * described by the `prediction_resources` field of the 680 * [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] 681 * object. Because not all Models support all resource configuration types, 682 * the configuration types this Model supports are listed here. If no 683 * configuration types are listed, the Model cannot be deployed to an 684 * [Endpoint][google.cloud.aiplatform.v1.Endpoint] and does not support 685 * online predictions 686 * ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 687 * or 688 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). 689 * Such a Model can serve predictions by using a 690 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it 691 * has at least one entry each in 692 * [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] 693 * and 694 * [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats]. 695 * </pre> 696 * 697 * <code> 698 * repeated .google.cloud.aiplatform.v1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 699 * </code> 700 * 701 * @return The count of supportedDeploymentResourcesTypes. 702 */ getSupportedDeploymentResourcesTypesCount()703 int getSupportedDeploymentResourcesTypesCount(); 704 /** 705 * 706 * 707 * <pre> 708 * Output only. When this Model is deployed, its prediction resources are 709 * described by the `prediction_resources` field of the 710 * [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] 711 * object. Because not all Models support all resource configuration types, 712 * the configuration types this Model supports are listed here. If no 713 * configuration types are listed, the Model cannot be deployed to an 714 * [Endpoint][google.cloud.aiplatform.v1.Endpoint] and does not support 715 * online predictions 716 * ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 717 * or 718 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). 719 * Such a Model can serve predictions by using a 720 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it 721 * has at least one entry each in 722 * [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] 723 * and 724 * [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats]. 725 * </pre> 726 * 727 * <code> 728 * repeated .google.cloud.aiplatform.v1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 729 * </code> 730 * 731 * @param index The index of the element to return. 732 * @return The supportedDeploymentResourcesTypes at the given index. 733 */ getSupportedDeploymentResourcesTypes( int index)734 com.google.cloud.aiplatform.v1.Model.DeploymentResourcesType getSupportedDeploymentResourcesTypes( 735 int index); 736 /** 737 * 738 * 739 * <pre> 740 * Output only. When this Model is deployed, its prediction resources are 741 * described by the `prediction_resources` field of the 742 * [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] 743 * object. Because not all Models support all resource configuration types, 744 * the configuration types this Model supports are listed here. If no 745 * configuration types are listed, the Model cannot be deployed to an 746 * [Endpoint][google.cloud.aiplatform.v1.Endpoint] and does not support 747 * online predictions 748 * ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 749 * or 750 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). 751 * Such a Model can serve predictions by using a 752 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it 753 * has at least one entry each in 754 * [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] 755 * and 756 * [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats]. 757 * </pre> 758 * 759 * <code> 760 * repeated .google.cloud.aiplatform.v1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 761 * </code> 762 * 763 * @return A list containing the enum numeric values on the wire for 764 * supportedDeploymentResourcesTypes. 765 */ getSupportedDeploymentResourcesTypesValueList()766 java.util.List<java.lang.Integer> getSupportedDeploymentResourcesTypesValueList(); 767 /** 768 * 769 * 770 * <pre> 771 * Output only. When this Model is deployed, its prediction resources are 772 * described by the `prediction_resources` field of the 773 * [Endpoint.deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] 774 * object. Because not all Models support all resource configuration types, 775 * the configuration types this Model supports are listed here. If no 776 * configuration types are listed, the Model cannot be deployed to an 777 * [Endpoint][google.cloud.aiplatform.v1.Endpoint] and does not support 778 * online predictions 779 * ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 780 * or 781 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). 782 * Such a Model can serve predictions by using a 783 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it 784 * has at least one entry each in 785 * [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] 786 * and 787 * [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats]. 788 * </pre> 789 * 790 * <code> 791 * repeated .google.cloud.aiplatform.v1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 792 * </code> 793 * 794 * @param index The index of the value to return. 795 * @return The enum numeric value on the wire of supportedDeploymentResourcesTypes at the given 796 * index. 797 */ getSupportedDeploymentResourcesTypesValue(int index)798 int getSupportedDeploymentResourcesTypesValue(int index); 799 800 /** 801 * 802 * 803 * <pre> 804 * Output only. The formats this Model supports in 805 * [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. 806 * If 807 * [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] 808 * exists, the instances should be given as per that schema. 809 * The possible formats are: 810 * * `jsonl` 811 * The JSON Lines format, where each instance is a single line. Uses 812 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 813 * * `csv` 814 * The CSV format, where each instance is a single comma-separated line. 815 * The first line in the file is the header, containing comma-separated field 816 * names. Uses 817 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 818 * * `tf-record` 819 * The TFRecord format, where each instance is a single record in tfrecord 820 * syntax. Uses 821 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 822 * * `tf-record-gzip` 823 * Similar to `tf-record`, but the file is gzipped. Uses 824 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 825 * * `bigquery` 826 * Each instance is a single row in BigQuery. Uses 827 * [BigQuerySource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.bigquery_source]. 828 * * `file-list` 829 * Each line of the file is the location of an instance to process, uses 830 * `gcs_source` field of the 831 * [InputConfig][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig] 832 * object. 833 * If this Model doesn't support any of these formats it means it cannot be 834 * used with a 835 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 836 * However, if it has 837 * [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], 838 * it could serve online predictions by using 839 * [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 840 * or 841 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. 842 * </pre> 843 * 844 * <code> 845 * repeated string supported_input_storage_formats = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; 846 * </code> 847 * 848 * @return A list containing the supportedInputStorageFormats. 849 */ getSupportedInputStorageFormatsList()850 java.util.List<java.lang.String> getSupportedInputStorageFormatsList(); 851 /** 852 * 853 * 854 * <pre> 855 * Output only. The formats this Model supports in 856 * [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. 857 * If 858 * [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] 859 * exists, the instances should be given as per that schema. 860 * The possible formats are: 861 * * `jsonl` 862 * The JSON Lines format, where each instance is a single line. Uses 863 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 864 * * `csv` 865 * The CSV format, where each instance is a single comma-separated line. 866 * The first line in the file is the header, containing comma-separated field 867 * names. Uses 868 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 869 * * `tf-record` 870 * The TFRecord format, where each instance is a single record in tfrecord 871 * syntax. Uses 872 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 873 * * `tf-record-gzip` 874 * Similar to `tf-record`, but the file is gzipped. Uses 875 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 876 * * `bigquery` 877 * Each instance is a single row in BigQuery. Uses 878 * [BigQuerySource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.bigquery_source]. 879 * * `file-list` 880 * Each line of the file is the location of an instance to process, uses 881 * `gcs_source` field of the 882 * [InputConfig][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig] 883 * object. 884 * If this Model doesn't support any of these formats it means it cannot be 885 * used with a 886 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 887 * However, if it has 888 * [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], 889 * it could serve online predictions by using 890 * [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 891 * or 892 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. 893 * </pre> 894 * 895 * <code> 896 * repeated string supported_input_storage_formats = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; 897 * </code> 898 * 899 * @return The count of supportedInputStorageFormats. 900 */ getSupportedInputStorageFormatsCount()901 int getSupportedInputStorageFormatsCount(); 902 /** 903 * 904 * 905 * <pre> 906 * Output only. The formats this Model supports in 907 * [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. 908 * If 909 * [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] 910 * exists, the instances should be given as per that schema. 911 * The possible formats are: 912 * * `jsonl` 913 * The JSON Lines format, where each instance is a single line. Uses 914 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 915 * * `csv` 916 * The CSV format, where each instance is a single comma-separated line. 917 * The first line in the file is the header, containing comma-separated field 918 * names. Uses 919 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 920 * * `tf-record` 921 * The TFRecord format, where each instance is a single record in tfrecord 922 * syntax. Uses 923 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 924 * * `tf-record-gzip` 925 * Similar to `tf-record`, but the file is gzipped. Uses 926 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 927 * * `bigquery` 928 * Each instance is a single row in BigQuery. Uses 929 * [BigQuerySource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.bigquery_source]. 930 * * `file-list` 931 * Each line of the file is the location of an instance to process, uses 932 * `gcs_source` field of the 933 * [InputConfig][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig] 934 * object. 935 * If this Model doesn't support any of these formats it means it cannot be 936 * used with a 937 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 938 * However, if it has 939 * [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], 940 * it could serve online predictions by using 941 * [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 942 * or 943 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. 944 * </pre> 945 * 946 * <code> 947 * repeated string supported_input_storage_formats = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; 948 * </code> 949 * 950 * @param index The index of the element to return. 951 * @return The supportedInputStorageFormats at the given index. 952 */ getSupportedInputStorageFormats(int index)953 java.lang.String getSupportedInputStorageFormats(int index); 954 /** 955 * 956 * 957 * <pre> 958 * Output only. The formats this Model supports in 959 * [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. 960 * If 961 * [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] 962 * exists, the instances should be given as per that schema. 963 * The possible formats are: 964 * * `jsonl` 965 * The JSON Lines format, where each instance is a single line. Uses 966 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 967 * * `csv` 968 * The CSV format, where each instance is a single comma-separated line. 969 * The first line in the file is the header, containing comma-separated field 970 * names. Uses 971 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 972 * * `tf-record` 973 * The TFRecord format, where each instance is a single record in tfrecord 974 * syntax. Uses 975 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 976 * * `tf-record-gzip` 977 * Similar to `tf-record`, but the file is gzipped. Uses 978 * [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. 979 * * `bigquery` 980 * Each instance is a single row in BigQuery. Uses 981 * [BigQuerySource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.bigquery_source]. 982 * * `file-list` 983 * Each line of the file is the location of an instance to process, uses 984 * `gcs_source` field of the 985 * [InputConfig][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig] 986 * object. 987 * If this Model doesn't support any of these formats it means it cannot be 988 * used with a 989 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 990 * However, if it has 991 * [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], 992 * it could serve online predictions by using 993 * [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 994 * or 995 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. 996 * </pre> 997 * 998 * <code> 999 * repeated string supported_input_storage_formats = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1000 * </code> 1001 * 1002 * @param index The index of the value to return. 1003 * @return The bytes of the supportedInputStorageFormats at the given index. 1004 */ getSupportedInputStorageFormatsBytes(int index)1005 com.google.protobuf.ByteString getSupportedInputStorageFormatsBytes(int index); 1006 1007 /** 1008 * 1009 * 1010 * <pre> 1011 * Output only. The formats this Model supports in 1012 * [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. 1013 * If both 1014 * [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] 1015 * and 1016 * [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri] 1017 * exist, the predictions are returned together with their instances. In other 1018 * words, the prediction has the original instance data first, followed by the 1019 * actual prediction content (as per the schema). 1020 * The possible formats are: 1021 * * `jsonl` 1022 * The JSON Lines format, where each prediction is a single line. Uses 1023 * [GcsDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.gcs_destination]. 1024 * * `csv` 1025 * The CSV format, where each prediction is a single comma-separated line. 1026 * The first line in the file is the header, containing comma-separated field 1027 * names. Uses 1028 * [GcsDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.gcs_destination]. 1029 * * `bigquery` 1030 * Each prediction is a single row in a BigQuery table, uses 1031 * [BigQueryDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.bigquery_destination] 1032 * . 1033 * If this Model doesn't support any of these formats it means it cannot be 1034 * used with a 1035 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 1036 * However, if it has 1037 * [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], 1038 * it could serve online predictions by using 1039 * [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 1040 * or 1041 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. 1042 * </pre> 1043 * 1044 * <code> 1045 * repeated string supported_output_storage_formats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1046 * </code> 1047 * 1048 * @return A list containing the supportedOutputStorageFormats. 1049 */ getSupportedOutputStorageFormatsList()1050 java.util.List<java.lang.String> getSupportedOutputStorageFormatsList(); 1051 /** 1052 * 1053 * 1054 * <pre> 1055 * Output only. The formats this Model supports in 1056 * [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. 1057 * If both 1058 * [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] 1059 * and 1060 * [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri] 1061 * exist, the predictions are returned together with their instances. In other 1062 * words, the prediction has the original instance data first, followed by the 1063 * actual prediction content (as per the schema). 1064 * The possible formats are: 1065 * * `jsonl` 1066 * The JSON Lines format, where each prediction is a single line. Uses 1067 * [GcsDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.gcs_destination]. 1068 * * `csv` 1069 * The CSV format, where each prediction is a single comma-separated line. 1070 * The first line in the file is the header, containing comma-separated field 1071 * names. Uses 1072 * [GcsDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.gcs_destination]. 1073 * * `bigquery` 1074 * Each prediction is a single row in a BigQuery table, uses 1075 * [BigQueryDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.bigquery_destination] 1076 * . 1077 * If this Model doesn't support any of these formats it means it cannot be 1078 * used with a 1079 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 1080 * However, if it has 1081 * [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], 1082 * it could serve online predictions by using 1083 * [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 1084 * or 1085 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. 1086 * </pre> 1087 * 1088 * <code> 1089 * repeated string supported_output_storage_formats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1090 * </code> 1091 * 1092 * @return The count of supportedOutputStorageFormats. 1093 */ getSupportedOutputStorageFormatsCount()1094 int getSupportedOutputStorageFormatsCount(); 1095 /** 1096 * 1097 * 1098 * <pre> 1099 * Output only. The formats this Model supports in 1100 * [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. 1101 * If both 1102 * [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] 1103 * and 1104 * [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri] 1105 * exist, the predictions are returned together with their instances. In other 1106 * words, the prediction has the original instance data first, followed by the 1107 * actual prediction content (as per the schema). 1108 * The possible formats are: 1109 * * `jsonl` 1110 * The JSON Lines format, where each prediction is a single line. Uses 1111 * [GcsDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.gcs_destination]. 1112 * * `csv` 1113 * The CSV format, where each prediction is a single comma-separated line. 1114 * The first line in the file is the header, containing comma-separated field 1115 * names. Uses 1116 * [GcsDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.gcs_destination]. 1117 * * `bigquery` 1118 * Each prediction is a single row in a BigQuery table, uses 1119 * [BigQueryDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.bigquery_destination] 1120 * . 1121 * If this Model doesn't support any of these formats it means it cannot be 1122 * used with a 1123 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 1124 * However, if it has 1125 * [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], 1126 * it could serve online predictions by using 1127 * [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 1128 * or 1129 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. 1130 * </pre> 1131 * 1132 * <code> 1133 * repeated string supported_output_storage_formats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1134 * </code> 1135 * 1136 * @param index The index of the element to return. 1137 * @return The supportedOutputStorageFormats at the given index. 1138 */ getSupportedOutputStorageFormats(int index)1139 java.lang.String getSupportedOutputStorageFormats(int index); 1140 /** 1141 * 1142 * 1143 * <pre> 1144 * Output only. The formats this Model supports in 1145 * [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. 1146 * If both 1147 * [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] 1148 * and 1149 * [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri] 1150 * exist, the predictions are returned together with their instances. In other 1151 * words, the prediction has the original instance data first, followed by the 1152 * actual prediction content (as per the schema). 1153 * The possible formats are: 1154 * * `jsonl` 1155 * The JSON Lines format, where each prediction is a single line. Uses 1156 * [GcsDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.gcs_destination]. 1157 * * `csv` 1158 * The CSV format, where each prediction is a single comma-separated line. 1159 * The first line in the file is the header, containing comma-separated field 1160 * names. Uses 1161 * [GcsDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.gcs_destination]. 1162 * * `bigquery` 1163 * Each prediction is a single row in a BigQuery table, uses 1164 * [BigQueryDestination][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.bigquery_destination] 1165 * . 1166 * If this Model doesn't support any of these formats it means it cannot be 1167 * used with a 1168 * [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 1169 * However, if it has 1170 * [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], 1171 * it could serve online predictions by using 1172 * [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] 1173 * or 1174 * [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]. 1175 * </pre> 1176 * 1177 * <code> 1178 * repeated string supported_output_storage_formats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1179 * </code> 1180 * 1181 * @param index The index of the value to return. 1182 * @return The bytes of the supportedOutputStorageFormats at the given index. 1183 */ getSupportedOutputStorageFormatsBytes(int index)1184 com.google.protobuf.ByteString getSupportedOutputStorageFormatsBytes(int index); 1185 1186 /** 1187 * 1188 * 1189 * <pre> 1190 * Output only. Timestamp when this Model was uploaded into Vertex AI. 1191 * </pre> 1192 * 1193 * <code>.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1194 * </code> 1195 * 1196 * @return Whether the createTime field is set. 1197 */ hasCreateTime()1198 boolean hasCreateTime(); 1199 /** 1200 * 1201 * 1202 * <pre> 1203 * Output only. Timestamp when this Model was uploaded into Vertex AI. 1204 * </pre> 1205 * 1206 * <code>.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1207 * </code> 1208 * 1209 * @return The createTime. 1210 */ getCreateTime()1211 com.google.protobuf.Timestamp getCreateTime(); 1212 /** 1213 * 1214 * 1215 * <pre> 1216 * Output only. Timestamp when this Model was uploaded into Vertex AI. 1217 * </pre> 1218 * 1219 * <code>.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1220 * </code> 1221 */ getCreateTimeOrBuilder()1222 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 1223 1224 /** 1225 * 1226 * 1227 * <pre> 1228 * Output only. Timestamp when this Model was most recently updated. 1229 * </pre> 1230 * 1231 * <code>.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1232 * </code> 1233 * 1234 * @return Whether the updateTime field is set. 1235 */ hasUpdateTime()1236 boolean hasUpdateTime(); 1237 /** 1238 * 1239 * 1240 * <pre> 1241 * Output only. Timestamp when this Model was most recently updated. 1242 * </pre> 1243 * 1244 * <code>.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1245 * </code> 1246 * 1247 * @return The updateTime. 1248 */ getUpdateTime()1249 com.google.protobuf.Timestamp getUpdateTime(); 1250 /** 1251 * 1252 * 1253 * <pre> 1254 * Output only. Timestamp when this Model was most recently updated. 1255 * </pre> 1256 * 1257 * <code>.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1258 * </code> 1259 */ getUpdateTimeOrBuilder()1260 com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); 1261 1262 /** 1263 * 1264 * 1265 * <pre> 1266 * Output only. The pointers to DeployedModels created from this Model. Note 1267 * that Model could have been deployed to Endpoints in different Locations. 1268 * </pre> 1269 * 1270 * <code> 1271 * repeated .google.cloud.aiplatform.v1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1272 * </code> 1273 */ getDeployedModelsList()1274 java.util.List<com.google.cloud.aiplatform.v1.DeployedModelRef> getDeployedModelsList(); 1275 /** 1276 * 1277 * 1278 * <pre> 1279 * Output only. The pointers to DeployedModels created from this Model. Note 1280 * that Model could have been deployed to Endpoints in different Locations. 1281 * </pre> 1282 * 1283 * <code> 1284 * repeated .google.cloud.aiplatform.v1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1285 * </code> 1286 */ getDeployedModels(int index)1287 com.google.cloud.aiplatform.v1.DeployedModelRef getDeployedModels(int index); 1288 /** 1289 * 1290 * 1291 * <pre> 1292 * Output only. The pointers to DeployedModels created from this Model. Note 1293 * that Model could have been deployed to Endpoints in different Locations. 1294 * </pre> 1295 * 1296 * <code> 1297 * repeated .google.cloud.aiplatform.v1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1298 * </code> 1299 */ getDeployedModelsCount()1300 int getDeployedModelsCount(); 1301 /** 1302 * 1303 * 1304 * <pre> 1305 * Output only. The pointers to DeployedModels created from this Model. Note 1306 * that Model could have been deployed to Endpoints in different Locations. 1307 * </pre> 1308 * 1309 * <code> 1310 * repeated .google.cloud.aiplatform.v1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1311 * </code> 1312 */ 1313 java.util.List<? extends com.google.cloud.aiplatform.v1.DeployedModelRefOrBuilder> getDeployedModelsOrBuilderList()1314 getDeployedModelsOrBuilderList(); 1315 /** 1316 * 1317 * 1318 * <pre> 1319 * Output only. The pointers to DeployedModels created from this Model. Note 1320 * that Model could have been deployed to Endpoints in different Locations. 1321 * </pre> 1322 * 1323 * <code> 1324 * repeated .google.cloud.aiplatform.v1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1325 * </code> 1326 */ getDeployedModelsOrBuilder(int index)1327 com.google.cloud.aiplatform.v1.DeployedModelRefOrBuilder getDeployedModelsOrBuilder(int index); 1328 1329 /** 1330 * 1331 * 1332 * <pre> 1333 * The default explanation specification for this Model. 1334 * The Model can be used for 1335 * [requesting 1336 * explanation][google.cloud.aiplatform.v1.PredictionService.Explain] after 1337 * being [deployed][google.cloud.aiplatform.v1.EndpointService.DeployModel] if 1338 * it is populated. The Model can be used for [batch 1339 * explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] 1340 * if it is populated. 1341 * All fields of the explanation_spec can be overridden by 1342 * [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] 1343 * of 1344 * [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model], 1345 * or 1346 * [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] 1347 * of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 1348 * If the default explanation specification is not set for this Model, this 1349 * Model can still be used for 1350 * [requesting 1351 * explanation][google.cloud.aiplatform.v1.PredictionService.Explain] by 1352 * setting 1353 * [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] 1354 * of 1355 * [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model] 1356 * and for [batch 1357 * explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] 1358 * by setting 1359 * [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] 1360 * of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 1361 * </pre> 1362 * 1363 * <code>.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 23;</code> 1364 * 1365 * @return Whether the explanationSpec field is set. 1366 */ hasExplanationSpec()1367 boolean hasExplanationSpec(); 1368 /** 1369 * 1370 * 1371 * <pre> 1372 * The default explanation specification for this Model. 1373 * The Model can be used for 1374 * [requesting 1375 * explanation][google.cloud.aiplatform.v1.PredictionService.Explain] after 1376 * being [deployed][google.cloud.aiplatform.v1.EndpointService.DeployModel] if 1377 * it is populated. The Model can be used for [batch 1378 * explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] 1379 * if it is populated. 1380 * All fields of the explanation_spec can be overridden by 1381 * [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] 1382 * of 1383 * [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model], 1384 * or 1385 * [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] 1386 * of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 1387 * If the default explanation specification is not set for this Model, this 1388 * Model can still be used for 1389 * [requesting 1390 * explanation][google.cloud.aiplatform.v1.PredictionService.Explain] by 1391 * setting 1392 * [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] 1393 * of 1394 * [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model] 1395 * and for [batch 1396 * explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] 1397 * by setting 1398 * [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] 1399 * of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 1400 * </pre> 1401 * 1402 * <code>.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 23;</code> 1403 * 1404 * @return The explanationSpec. 1405 */ getExplanationSpec()1406 com.google.cloud.aiplatform.v1.ExplanationSpec getExplanationSpec(); 1407 /** 1408 * 1409 * 1410 * <pre> 1411 * The default explanation specification for this Model. 1412 * The Model can be used for 1413 * [requesting 1414 * explanation][google.cloud.aiplatform.v1.PredictionService.Explain] after 1415 * being [deployed][google.cloud.aiplatform.v1.EndpointService.DeployModel] if 1416 * it is populated. The Model can be used for [batch 1417 * explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] 1418 * if it is populated. 1419 * All fields of the explanation_spec can be overridden by 1420 * [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] 1421 * of 1422 * [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model], 1423 * or 1424 * [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] 1425 * of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 1426 * If the default explanation specification is not set for this Model, this 1427 * Model can still be used for 1428 * [requesting 1429 * explanation][google.cloud.aiplatform.v1.PredictionService.Explain] by 1430 * setting 1431 * [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] 1432 * of 1433 * [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model] 1434 * and for [batch 1435 * explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] 1436 * by setting 1437 * [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] 1438 * of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. 1439 * </pre> 1440 * 1441 * <code>.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 23;</code> 1442 */ getExplanationSpecOrBuilder()1443 com.google.cloud.aiplatform.v1.ExplanationSpecOrBuilder getExplanationSpecOrBuilder(); 1444 1445 /** 1446 * 1447 * 1448 * <pre> 1449 * Used to perform consistent read-modify-write updates. If not set, a blind 1450 * "overwrite" update happens. 1451 * </pre> 1452 * 1453 * <code>string etag = 16;</code> 1454 * 1455 * @return The etag. 1456 */ getEtag()1457 java.lang.String getEtag(); 1458 /** 1459 * 1460 * 1461 * <pre> 1462 * Used to perform consistent read-modify-write updates. If not set, a blind 1463 * "overwrite" update happens. 1464 * </pre> 1465 * 1466 * <code>string etag = 16;</code> 1467 * 1468 * @return The bytes for etag. 1469 */ getEtagBytes()1470 com.google.protobuf.ByteString getEtagBytes(); 1471 1472 /** 1473 * 1474 * 1475 * <pre> 1476 * The labels with user-defined metadata to organize your Models. 1477 * Label keys and values can be no longer than 64 characters 1478 * (Unicode codepoints), can only contain lowercase letters, numeric 1479 * characters, underscores and dashes. International characters are allowed. 1480 * See https://goo.gl/xmQnxf for more information and examples of labels. 1481 * </pre> 1482 * 1483 * <code>map<string, string> labels = 17;</code> 1484 */ getLabelsCount()1485 int getLabelsCount(); 1486 /** 1487 * 1488 * 1489 * <pre> 1490 * The labels with user-defined metadata to organize your Models. 1491 * Label keys and values can be no longer than 64 characters 1492 * (Unicode codepoints), can only contain lowercase letters, numeric 1493 * characters, underscores and dashes. International characters are allowed. 1494 * See https://goo.gl/xmQnxf for more information and examples of labels. 1495 * </pre> 1496 * 1497 * <code>map<string, string> labels = 17;</code> 1498 */ containsLabels(java.lang.String key)1499 boolean containsLabels(java.lang.String key); 1500 /** Use {@link #getLabelsMap()} instead. */ 1501 @java.lang.Deprecated getLabels()1502 java.util.Map<java.lang.String, java.lang.String> getLabels(); 1503 /** 1504 * 1505 * 1506 * <pre> 1507 * The labels with user-defined metadata to organize your Models. 1508 * Label keys and values can be no longer than 64 characters 1509 * (Unicode codepoints), can only contain lowercase letters, numeric 1510 * characters, underscores and dashes. International characters are allowed. 1511 * See https://goo.gl/xmQnxf for more information and examples of labels. 1512 * </pre> 1513 * 1514 * <code>map<string, string> labels = 17;</code> 1515 */ getLabelsMap()1516 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 1517 /** 1518 * 1519 * 1520 * <pre> 1521 * The labels with user-defined metadata to organize your Models. 1522 * Label keys and values can be no longer than 64 characters 1523 * (Unicode codepoints), can only contain lowercase letters, numeric 1524 * characters, underscores and dashes. International characters are allowed. 1525 * See https://goo.gl/xmQnxf for more information and examples of labels. 1526 * </pre> 1527 * 1528 * <code>map<string, string> labels = 17;</code> 1529 */ 1530 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)1531 java.lang.String getLabelsOrDefault( 1532 java.lang.String key, 1533 /* nullable */ 1534 java.lang.String defaultValue); 1535 /** 1536 * 1537 * 1538 * <pre> 1539 * The labels with user-defined metadata to organize your Models. 1540 * Label keys and values can be no longer than 64 characters 1541 * (Unicode codepoints), can only contain lowercase letters, numeric 1542 * characters, underscores and dashes. International characters are allowed. 1543 * See https://goo.gl/xmQnxf for more information and examples of labels. 1544 * </pre> 1545 * 1546 * <code>map<string, string> labels = 17;</code> 1547 */ getLabelsOrThrow(java.lang.String key)1548 java.lang.String getLabelsOrThrow(java.lang.String key); 1549 1550 /** 1551 * 1552 * 1553 * <pre> 1554 * Customer-managed encryption key spec for a Model. If set, this 1555 * Model and all sub-resources of this Model will be secured by this key. 1556 * </pre> 1557 * 1558 * <code>.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;</code> 1559 * 1560 * @return Whether the encryptionSpec field is set. 1561 */ hasEncryptionSpec()1562 boolean hasEncryptionSpec(); 1563 /** 1564 * 1565 * 1566 * <pre> 1567 * Customer-managed encryption key spec for a Model. If set, this 1568 * Model and all sub-resources of this Model will be secured by this key. 1569 * </pre> 1570 * 1571 * <code>.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;</code> 1572 * 1573 * @return The encryptionSpec. 1574 */ getEncryptionSpec()1575 com.google.cloud.aiplatform.v1.EncryptionSpec getEncryptionSpec(); 1576 /** 1577 * 1578 * 1579 * <pre> 1580 * Customer-managed encryption key spec for a Model. If set, this 1581 * Model and all sub-resources of this Model will be secured by this key. 1582 * </pre> 1583 * 1584 * <code>.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;</code> 1585 */ getEncryptionSpecOrBuilder()1586 com.google.cloud.aiplatform.v1.EncryptionSpecOrBuilder getEncryptionSpecOrBuilder(); 1587 1588 /** 1589 * 1590 * 1591 * <pre> 1592 * Output only. Source of a model. It can either be automl training pipeline, 1593 * custom training pipeline, BigQuery ML, or existing Vertex AI Model. 1594 * </pre> 1595 * 1596 * <code> 1597 * .google.cloud.aiplatform.v1.ModelSourceInfo model_source_info = 38 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1598 * </code> 1599 * 1600 * @return Whether the modelSourceInfo field is set. 1601 */ hasModelSourceInfo()1602 boolean hasModelSourceInfo(); 1603 /** 1604 * 1605 * 1606 * <pre> 1607 * Output only. Source of a model. It can either be automl training pipeline, 1608 * custom training pipeline, BigQuery ML, or existing Vertex AI Model. 1609 * </pre> 1610 * 1611 * <code> 1612 * .google.cloud.aiplatform.v1.ModelSourceInfo model_source_info = 38 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1613 * </code> 1614 * 1615 * @return The modelSourceInfo. 1616 */ getModelSourceInfo()1617 com.google.cloud.aiplatform.v1.ModelSourceInfo getModelSourceInfo(); 1618 /** 1619 * 1620 * 1621 * <pre> 1622 * Output only. Source of a model. It can either be automl training pipeline, 1623 * custom training pipeline, BigQuery ML, or existing Vertex AI Model. 1624 * </pre> 1625 * 1626 * <code> 1627 * .google.cloud.aiplatform.v1.ModelSourceInfo model_source_info = 38 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1628 * </code> 1629 */ getModelSourceInfoOrBuilder()1630 com.google.cloud.aiplatform.v1.ModelSourceInfoOrBuilder getModelSourceInfoOrBuilder(); 1631 1632 /** 1633 * 1634 * 1635 * <pre> 1636 * Output only. If this Model is a copy of another Model, this contains info 1637 * about the original. 1638 * </pre> 1639 * 1640 * <code> 1641 * .google.cloud.aiplatform.v1.Model.OriginalModelInfo original_model_info = 34 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1642 * </code> 1643 * 1644 * @return Whether the originalModelInfo field is set. 1645 */ hasOriginalModelInfo()1646 boolean hasOriginalModelInfo(); 1647 /** 1648 * 1649 * 1650 * <pre> 1651 * Output only. If this Model is a copy of another Model, this contains info 1652 * about the original. 1653 * </pre> 1654 * 1655 * <code> 1656 * .google.cloud.aiplatform.v1.Model.OriginalModelInfo original_model_info = 34 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1657 * </code> 1658 * 1659 * @return The originalModelInfo. 1660 */ getOriginalModelInfo()1661 com.google.cloud.aiplatform.v1.Model.OriginalModelInfo getOriginalModelInfo(); 1662 /** 1663 * 1664 * 1665 * <pre> 1666 * Output only. If this Model is a copy of another Model, this contains info 1667 * about the original. 1668 * </pre> 1669 * 1670 * <code> 1671 * .google.cloud.aiplatform.v1.Model.OriginalModelInfo original_model_info = 34 [(.google.api.field_behavior) = OUTPUT_ONLY]; 1672 * </code> 1673 */ getOriginalModelInfoOrBuilder()1674 com.google.cloud.aiplatform.v1.Model.OriginalModelInfoOrBuilder getOriginalModelInfoOrBuilder(); 1675 1676 /** 1677 * 1678 * 1679 * <pre> 1680 * Output only. The resource name of the Artifact that was created in 1681 * MetadataStore when creating the Model. The Artifact resource name pattern 1682 * is 1683 * `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. 1684 * </pre> 1685 * 1686 * <code>string metadata_artifact = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 1687 * 1688 * @return The metadataArtifact. 1689 */ getMetadataArtifact()1690 java.lang.String getMetadataArtifact(); 1691 /** 1692 * 1693 * 1694 * <pre> 1695 * Output only. The resource name of the Artifact that was created in 1696 * MetadataStore when creating the Model. The Artifact resource name pattern 1697 * is 1698 * `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. 1699 * </pre> 1700 * 1701 * <code>string metadata_artifact = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 1702 * 1703 * @return The bytes for metadataArtifact. 1704 */ getMetadataArtifactBytes()1705 com.google.protobuf.ByteString getMetadataArtifactBytes(); 1706 } 1707