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/study.proto 18 19 package com.google.cloud.aiplatform.v1; 20 21 public interface TrialOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.aiplatform.v1.Trial) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Output only. Resource name of the Trial assigned by the service. 31 * </pre> 32 * 33 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 34 * 35 * @return The name. 36 */ getName()37 java.lang.String getName(); 38 /** 39 * 40 * 41 * <pre> 42 * Output only. Resource name of the Trial assigned by the service. 43 * </pre> 44 * 45 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</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. The identifier of the Trial assigned by the service. 56 * </pre> 57 * 58 * <code>string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 59 * 60 * @return The id. 61 */ getId()62 java.lang.String getId(); 63 /** 64 * 65 * 66 * <pre> 67 * Output only. The identifier of the Trial assigned by the service. 68 * </pre> 69 * 70 * <code>string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 71 * 72 * @return The bytes for id. 73 */ getIdBytes()74 com.google.protobuf.ByteString getIdBytes(); 75 76 /** 77 * 78 * 79 * <pre> 80 * Output only. The detailed state of the Trial. 81 * </pre> 82 * 83 * <code> 84 * .google.cloud.aiplatform.v1.Trial.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; 85 * </code> 86 * 87 * @return The enum numeric value on the wire for state. 88 */ getStateValue()89 int getStateValue(); 90 /** 91 * 92 * 93 * <pre> 94 * Output only. The detailed state of the Trial. 95 * </pre> 96 * 97 * <code> 98 * .google.cloud.aiplatform.v1.Trial.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; 99 * </code> 100 * 101 * @return The state. 102 */ getState()103 com.google.cloud.aiplatform.v1.Trial.State getState(); 104 105 /** 106 * 107 * 108 * <pre> 109 * Output only. The parameters of the Trial. 110 * </pre> 111 * 112 * <code> 113 * repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 114 * </code> 115 */ getParametersList()116 java.util.List<com.google.cloud.aiplatform.v1.Trial.Parameter> getParametersList(); 117 /** 118 * 119 * 120 * <pre> 121 * Output only. The parameters of the Trial. 122 * </pre> 123 * 124 * <code> 125 * repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 126 * </code> 127 */ getParameters(int index)128 com.google.cloud.aiplatform.v1.Trial.Parameter getParameters(int index); 129 /** 130 * 131 * 132 * <pre> 133 * Output only. The parameters of the Trial. 134 * </pre> 135 * 136 * <code> 137 * repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 138 * </code> 139 */ getParametersCount()140 int getParametersCount(); 141 /** 142 * 143 * 144 * <pre> 145 * Output only. The parameters of the Trial. 146 * </pre> 147 * 148 * <code> 149 * repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 150 * </code> 151 */ 152 java.util.List<? extends com.google.cloud.aiplatform.v1.Trial.ParameterOrBuilder> getParametersOrBuilderList()153 getParametersOrBuilderList(); 154 /** 155 * 156 * 157 * <pre> 158 * Output only. The parameters of the Trial. 159 * </pre> 160 * 161 * <code> 162 * repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 163 * </code> 164 */ getParametersOrBuilder(int index)165 com.google.cloud.aiplatform.v1.Trial.ParameterOrBuilder getParametersOrBuilder(int index); 166 167 /** 168 * 169 * 170 * <pre> 171 * Output only. The final measurement containing the objective value. 172 * </pre> 173 * 174 * <code> 175 * .google.cloud.aiplatform.v1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 176 * </code> 177 * 178 * @return Whether the finalMeasurement field is set. 179 */ hasFinalMeasurement()180 boolean hasFinalMeasurement(); 181 /** 182 * 183 * 184 * <pre> 185 * Output only. The final measurement containing the objective value. 186 * </pre> 187 * 188 * <code> 189 * .google.cloud.aiplatform.v1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 190 * </code> 191 * 192 * @return The finalMeasurement. 193 */ getFinalMeasurement()194 com.google.cloud.aiplatform.v1.Measurement getFinalMeasurement(); 195 /** 196 * 197 * 198 * <pre> 199 * Output only. The final measurement containing the objective value. 200 * </pre> 201 * 202 * <code> 203 * .google.cloud.aiplatform.v1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 204 * </code> 205 */ getFinalMeasurementOrBuilder()206 com.google.cloud.aiplatform.v1.MeasurementOrBuilder getFinalMeasurementOrBuilder(); 207 208 /** 209 * 210 * 211 * <pre> 212 * Output only. A list of measurements that are strictly lexicographically 213 * ordered by their induced tuples (steps, elapsed_duration). 214 * These are used for early stopping computations. 215 * </pre> 216 * 217 * <code> 218 * repeated .google.cloud.aiplatform.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 219 * </code> 220 */ getMeasurementsList()221 java.util.List<com.google.cloud.aiplatform.v1.Measurement> getMeasurementsList(); 222 /** 223 * 224 * 225 * <pre> 226 * Output only. A list of measurements that are strictly lexicographically 227 * ordered by their induced tuples (steps, elapsed_duration). 228 * These are used for early stopping computations. 229 * </pre> 230 * 231 * <code> 232 * repeated .google.cloud.aiplatform.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 233 * </code> 234 */ getMeasurements(int index)235 com.google.cloud.aiplatform.v1.Measurement getMeasurements(int index); 236 /** 237 * 238 * 239 * <pre> 240 * Output only. A list of measurements that are strictly lexicographically 241 * ordered by their induced tuples (steps, elapsed_duration). 242 * These are used for early stopping computations. 243 * </pre> 244 * 245 * <code> 246 * repeated .google.cloud.aiplatform.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 247 * </code> 248 */ getMeasurementsCount()249 int getMeasurementsCount(); 250 /** 251 * 252 * 253 * <pre> 254 * Output only. A list of measurements that are strictly lexicographically 255 * ordered by their induced tuples (steps, elapsed_duration). 256 * These are used for early stopping computations. 257 * </pre> 258 * 259 * <code> 260 * repeated .google.cloud.aiplatform.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 261 * </code> 262 */ 263 java.util.List<? extends com.google.cloud.aiplatform.v1.MeasurementOrBuilder> getMeasurementsOrBuilderList()264 getMeasurementsOrBuilderList(); 265 /** 266 * 267 * 268 * <pre> 269 * Output only. A list of measurements that are strictly lexicographically 270 * ordered by their induced tuples (steps, elapsed_duration). 271 * These are used for early stopping computations. 272 * </pre> 273 * 274 * <code> 275 * repeated .google.cloud.aiplatform.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 276 * </code> 277 */ getMeasurementsOrBuilder(int index)278 com.google.cloud.aiplatform.v1.MeasurementOrBuilder getMeasurementsOrBuilder(int index); 279 280 /** 281 * 282 * 283 * <pre> 284 * Output only. Time when the Trial was started. 285 * </pre> 286 * 287 * <code>.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 288 * </code> 289 * 290 * @return Whether the startTime field is set. 291 */ hasStartTime()292 boolean hasStartTime(); 293 /** 294 * 295 * 296 * <pre> 297 * Output only. Time when the Trial was started. 298 * </pre> 299 * 300 * <code>.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 301 * </code> 302 * 303 * @return The startTime. 304 */ getStartTime()305 com.google.protobuf.Timestamp getStartTime(); 306 /** 307 * 308 * 309 * <pre> 310 * Output only. Time when the Trial was started. 311 * </pre> 312 * 313 * <code>.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 314 * </code> 315 */ getStartTimeOrBuilder()316 com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder(); 317 318 /** 319 * 320 * 321 * <pre> 322 * Output only. Time when the Trial's status changed to `SUCCEEDED` or 323 * `INFEASIBLE`. 324 * </pre> 325 * 326 * <code>.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; 327 * </code> 328 * 329 * @return Whether the endTime field is set. 330 */ hasEndTime()331 boolean hasEndTime(); 332 /** 333 * 334 * 335 * <pre> 336 * Output only. Time when the Trial's status changed to `SUCCEEDED` or 337 * `INFEASIBLE`. 338 * </pre> 339 * 340 * <code>.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; 341 * </code> 342 * 343 * @return The endTime. 344 */ getEndTime()345 com.google.protobuf.Timestamp getEndTime(); 346 /** 347 * 348 * 349 * <pre> 350 * Output only. Time when the Trial's status changed to `SUCCEEDED` or 351 * `INFEASIBLE`. 352 * </pre> 353 * 354 * <code>.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY]; 355 * </code> 356 */ getEndTimeOrBuilder()357 com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder(); 358 359 /** 360 * 361 * 362 * <pre> 363 * Output only. The identifier of the client that originally requested this 364 * Trial. Each client is identified by a unique client_id. When a client asks 365 * for a suggestion, Vertex AI Vizier will assign it a Trial. The client 366 * should evaluate the Trial, complete it, and report back to Vertex AI 367 * Vizier. If suggestion is asked again by same client_id before the Trial is 368 * completed, the same Trial will be returned. Multiple clients with 369 * different client_ids can ask for suggestions simultaneously, each of them 370 * will get their own Trial. 371 * </pre> 372 * 373 * <code>string client_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 374 * 375 * @return The clientId. 376 */ getClientId()377 java.lang.String getClientId(); 378 /** 379 * 380 * 381 * <pre> 382 * Output only. The identifier of the client that originally requested this 383 * Trial. Each client is identified by a unique client_id. When a client asks 384 * for a suggestion, Vertex AI Vizier will assign it a Trial. The client 385 * should evaluate the Trial, complete it, and report back to Vertex AI 386 * Vizier. If suggestion is asked again by same client_id before the Trial is 387 * completed, the same Trial will be returned. Multiple clients with 388 * different client_ids can ask for suggestions simultaneously, each of them 389 * will get their own Trial. 390 * </pre> 391 * 392 * <code>string client_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 393 * 394 * @return The bytes for clientId. 395 */ getClientIdBytes()396 com.google.protobuf.ByteString getClientIdBytes(); 397 398 /** 399 * 400 * 401 * <pre> 402 * Output only. A human readable string describing why the Trial is 403 * infeasible. This is set only if Trial state is `INFEASIBLE`. 404 * </pre> 405 * 406 * <code>string infeasible_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 407 * 408 * @return The infeasibleReason. 409 */ getInfeasibleReason()410 java.lang.String getInfeasibleReason(); 411 /** 412 * 413 * 414 * <pre> 415 * Output only. A human readable string describing why the Trial is 416 * infeasible. This is set only if Trial state is `INFEASIBLE`. 417 * </pre> 418 * 419 * <code>string infeasible_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 420 * 421 * @return The bytes for infeasibleReason. 422 */ getInfeasibleReasonBytes()423 com.google.protobuf.ByteString getInfeasibleReasonBytes(); 424 425 /** 426 * 427 * 428 * <pre> 429 * Output only. The CustomJob name linked to the Trial. 430 * It's set for a HyperparameterTuningJob's Trial. 431 * </pre> 432 * 433 * <code> 434 * string custom_job = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 435 * </code> 436 * 437 * @return The customJob. 438 */ getCustomJob()439 java.lang.String getCustomJob(); 440 /** 441 * 442 * 443 * <pre> 444 * Output only. The CustomJob name linked to the Trial. 445 * It's set for a HyperparameterTuningJob's Trial. 446 * </pre> 447 * 448 * <code> 449 * string custom_job = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 450 * </code> 451 * 452 * @return The bytes for customJob. 453 */ getCustomJobBytes()454 com.google.protobuf.ByteString getCustomJobBytes(); 455 456 /** 457 * 458 * 459 * <pre> 460 * Output only. URIs for accessing [interactive 461 * shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) 462 * (one URI for each training node). Only available if this trial is part of 463 * a 464 * [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob] 465 * and the job's 466 * [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access] 467 * field is `true`. 468 * The keys are names of each node used for the trial; for example, 469 * `workerpool0-0` for the primary node, `workerpool1-0` for the first node in 470 * the second worker pool, and `workerpool1-1` for the second node in the 471 * second worker pool. 472 * The values are the URIs for each node's interactive shell. 473 * </pre> 474 * 475 * <code> 476 * map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 477 * </code> 478 */ getWebAccessUrisCount()479 int getWebAccessUrisCount(); 480 /** 481 * 482 * 483 * <pre> 484 * Output only. URIs for accessing [interactive 485 * shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) 486 * (one URI for each training node). Only available if this trial is part of 487 * a 488 * [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob] 489 * and the job's 490 * [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access] 491 * field is `true`. 492 * The keys are names of each node used for the trial; for example, 493 * `workerpool0-0` for the primary node, `workerpool1-0` for the first node in 494 * the second worker pool, and `workerpool1-1` for the second node in the 495 * second worker pool. 496 * The values are the URIs for each node's interactive shell. 497 * </pre> 498 * 499 * <code> 500 * map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 501 * </code> 502 */ containsWebAccessUris(java.lang.String key)503 boolean containsWebAccessUris(java.lang.String key); 504 /** Use {@link #getWebAccessUrisMap()} instead. */ 505 @java.lang.Deprecated getWebAccessUris()506 java.util.Map<java.lang.String, java.lang.String> getWebAccessUris(); 507 /** 508 * 509 * 510 * <pre> 511 * Output only. URIs for accessing [interactive 512 * shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) 513 * (one URI for each training node). Only available if this trial is part of 514 * a 515 * [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob] 516 * and the job's 517 * [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access] 518 * field is `true`. 519 * The keys are names of each node used for the trial; for example, 520 * `workerpool0-0` for the primary node, `workerpool1-0` for the first node in 521 * the second worker pool, and `workerpool1-1` for the second node in the 522 * second worker pool. 523 * The values are the URIs for each node's interactive shell. 524 * </pre> 525 * 526 * <code> 527 * map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 528 * </code> 529 */ getWebAccessUrisMap()530 java.util.Map<java.lang.String, java.lang.String> getWebAccessUrisMap(); 531 /** 532 * 533 * 534 * <pre> 535 * Output only. URIs for accessing [interactive 536 * shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) 537 * (one URI for each training node). Only available if this trial is part of 538 * a 539 * [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob] 540 * and the job's 541 * [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access] 542 * field is `true`. 543 * The keys are names of each node used for the trial; for example, 544 * `workerpool0-0` for the primary node, `workerpool1-0` for the first node in 545 * the second worker pool, and `workerpool1-1` for the second node in the 546 * second worker pool. 547 * The values are the URIs for each node's interactive shell. 548 * </pre> 549 * 550 * <code> 551 * map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 552 * </code> 553 */ 554 /* nullable */ getWebAccessUrisOrDefault( java.lang.String key, java.lang.String defaultValue)555 java.lang.String getWebAccessUrisOrDefault( 556 java.lang.String key, 557 /* nullable */ 558 java.lang.String defaultValue); 559 /** 560 * 561 * 562 * <pre> 563 * Output only. URIs for accessing [interactive 564 * shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) 565 * (one URI for each training node). Only available if this trial is part of 566 * a 567 * [HyperparameterTuningJob][google.cloud.aiplatform.v1.HyperparameterTuningJob] 568 * and the job's 569 * [trial_job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access] 570 * field is `true`. 571 * The keys are names of each node used for the trial; for example, 572 * `workerpool0-0` for the primary node, `workerpool1-0` for the first node in 573 * the second worker pool, and `workerpool1-1` for the second node in the 574 * second worker pool. 575 * The values are the URIs for each node's interactive shell. 576 * </pre> 577 * 578 * <code> 579 * map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 580 * </code> 581 */ getWebAccessUrisOrThrow(java.lang.String key)582 java.lang.String getWebAccessUrisOrThrow(java.lang.String key); 583 } 584