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/dataproc/v1/workflow_templates.proto 18 19 package com.google.cloud.dataproc.v1; 20 21 public interface OrderedJobOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.OrderedJob) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The step id. The id must be unique among all jobs 31 * within the template. 32 * The step id is used as prefix for job id, as job 33 * `goog-dataproc-workflow-step-id` label, and in 34 * [prerequisiteStepIds][google.cloud.dataproc.v1.OrderedJob.prerequisite_step_ids] 35 * field from other steps. 36 * The id must contain only letters (a-z, A-Z), numbers (0-9), 37 * underscores (_), and hyphens (-). Cannot begin or end with underscore 38 * or hyphen. Must consist of between 3 and 50 characters. 39 * </pre> 40 * 41 * <code>string step_id = 1 [(.google.api.field_behavior) = REQUIRED];</code> 42 * 43 * @return The stepId. 44 */ getStepId()45 java.lang.String getStepId(); 46 /** 47 * 48 * 49 * <pre> 50 * Required. The step id. The id must be unique among all jobs 51 * within the template. 52 * The step id is used as prefix for job id, as job 53 * `goog-dataproc-workflow-step-id` label, and in 54 * [prerequisiteStepIds][google.cloud.dataproc.v1.OrderedJob.prerequisite_step_ids] 55 * field from other steps. 56 * The id must contain only letters (a-z, A-Z), numbers (0-9), 57 * underscores (_), and hyphens (-). Cannot begin or end with underscore 58 * or hyphen. Must consist of between 3 and 50 characters. 59 * </pre> 60 * 61 * <code>string step_id = 1 [(.google.api.field_behavior) = REQUIRED];</code> 62 * 63 * @return The bytes for stepId. 64 */ getStepIdBytes()65 com.google.protobuf.ByteString getStepIdBytes(); 66 67 /** 68 * 69 * 70 * <pre> 71 * Optional. Job is a Hadoop job. 72 * </pre> 73 * 74 * <code> 75 * .google.cloud.dataproc.v1.HadoopJob hadoop_job = 2 [(.google.api.field_behavior) = OPTIONAL]; 76 * </code> 77 * 78 * @return Whether the hadoopJob field is set. 79 */ hasHadoopJob()80 boolean hasHadoopJob(); 81 /** 82 * 83 * 84 * <pre> 85 * Optional. Job is a Hadoop job. 86 * </pre> 87 * 88 * <code> 89 * .google.cloud.dataproc.v1.HadoopJob hadoop_job = 2 [(.google.api.field_behavior) = OPTIONAL]; 90 * </code> 91 * 92 * @return The hadoopJob. 93 */ getHadoopJob()94 com.google.cloud.dataproc.v1.HadoopJob getHadoopJob(); 95 /** 96 * 97 * 98 * <pre> 99 * Optional. Job is a Hadoop job. 100 * </pre> 101 * 102 * <code> 103 * .google.cloud.dataproc.v1.HadoopJob hadoop_job = 2 [(.google.api.field_behavior) = OPTIONAL]; 104 * </code> 105 */ getHadoopJobOrBuilder()106 com.google.cloud.dataproc.v1.HadoopJobOrBuilder getHadoopJobOrBuilder(); 107 108 /** 109 * 110 * 111 * <pre> 112 * Optional. Job is a Spark job. 113 * </pre> 114 * 115 * <code> 116 * .google.cloud.dataproc.v1.SparkJob spark_job = 3 [(.google.api.field_behavior) = OPTIONAL]; 117 * </code> 118 * 119 * @return Whether the sparkJob field is set. 120 */ hasSparkJob()121 boolean hasSparkJob(); 122 /** 123 * 124 * 125 * <pre> 126 * Optional. Job is a Spark job. 127 * </pre> 128 * 129 * <code> 130 * .google.cloud.dataproc.v1.SparkJob spark_job = 3 [(.google.api.field_behavior) = OPTIONAL]; 131 * </code> 132 * 133 * @return The sparkJob. 134 */ getSparkJob()135 com.google.cloud.dataproc.v1.SparkJob getSparkJob(); 136 /** 137 * 138 * 139 * <pre> 140 * Optional. Job is a Spark job. 141 * </pre> 142 * 143 * <code> 144 * .google.cloud.dataproc.v1.SparkJob spark_job = 3 [(.google.api.field_behavior) = OPTIONAL]; 145 * </code> 146 */ getSparkJobOrBuilder()147 com.google.cloud.dataproc.v1.SparkJobOrBuilder getSparkJobOrBuilder(); 148 149 /** 150 * 151 * 152 * <pre> 153 * Optional. Job is a PySpark job. 154 * </pre> 155 * 156 * <code> 157 * .google.cloud.dataproc.v1.PySparkJob pyspark_job = 4 [(.google.api.field_behavior) = OPTIONAL]; 158 * </code> 159 * 160 * @return Whether the pysparkJob field is set. 161 */ hasPysparkJob()162 boolean hasPysparkJob(); 163 /** 164 * 165 * 166 * <pre> 167 * Optional. Job is a PySpark job. 168 * </pre> 169 * 170 * <code> 171 * .google.cloud.dataproc.v1.PySparkJob pyspark_job = 4 [(.google.api.field_behavior) = OPTIONAL]; 172 * </code> 173 * 174 * @return The pysparkJob. 175 */ getPysparkJob()176 com.google.cloud.dataproc.v1.PySparkJob getPysparkJob(); 177 /** 178 * 179 * 180 * <pre> 181 * Optional. Job is a PySpark job. 182 * </pre> 183 * 184 * <code> 185 * .google.cloud.dataproc.v1.PySparkJob pyspark_job = 4 [(.google.api.field_behavior) = OPTIONAL]; 186 * </code> 187 */ getPysparkJobOrBuilder()188 com.google.cloud.dataproc.v1.PySparkJobOrBuilder getPysparkJobOrBuilder(); 189 190 /** 191 * 192 * 193 * <pre> 194 * Optional. Job is a Hive job. 195 * </pre> 196 * 197 * <code>.google.cloud.dataproc.v1.HiveJob hive_job = 5 [(.google.api.field_behavior) = OPTIONAL]; 198 * </code> 199 * 200 * @return Whether the hiveJob field is set. 201 */ hasHiveJob()202 boolean hasHiveJob(); 203 /** 204 * 205 * 206 * <pre> 207 * Optional. Job is a Hive job. 208 * </pre> 209 * 210 * <code>.google.cloud.dataproc.v1.HiveJob hive_job = 5 [(.google.api.field_behavior) = OPTIONAL]; 211 * </code> 212 * 213 * @return The hiveJob. 214 */ getHiveJob()215 com.google.cloud.dataproc.v1.HiveJob getHiveJob(); 216 /** 217 * 218 * 219 * <pre> 220 * Optional. Job is a Hive job. 221 * </pre> 222 * 223 * <code>.google.cloud.dataproc.v1.HiveJob hive_job = 5 [(.google.api.field_behavior) = OPTIONAL]; 224 * </code> 225 */ getHiveJobOrBuilder()226 com.google.cloud.dataproc.v1.HiveJobOrBuilder getHiveJobOrBuilder(); 227 228 /** 229 * 230 * 231 * <pre> 232 * Optional. Job is a Pig job. 233 * </pre> 234 * 235 * <code>.google.cloud.dataproc.v1.PigJob pig_job = 6 [(.google.api.field_behavior) = OPTIONAL]; 236 * </code> 237 * 238 * @return Whether the pigJob field is set. 239 */ hasPigJob()240 boolean hasPigJob(); 241 /** 242 * 243 * 244 * <pre> 245 * Optional. Job is a Pig job. 246 * </pre> 247 * 248 * <code>.google.cloud.dataproc.v1.PigJob pig_job = 6 [(.google.api.field_behavior) = OPTIONAL]; 249 * </code> 250 * 251 * @return The pigJob. 252 */ getPigJob()253 com.google.cloud.dataproc.v1.PigJob getPigJob(); 254 /** 255 * 256 * 257 * <pre> 258 * Optional. Job is a Pig job. 259 * </pre> 260 * 261 * <code>.google.cloud.dataproc.v1.PigJob pig_job = 6 [(.google.api.field_behavior) = OPTIONAL]; 262 * </code> 263 */ getPigJobOrBuilder()264 com.google.cloud.dataproc.v1.PigJobOrBuilder getPigJobOrBuilder(); 265 266 /** 267 * 268 * 269 * <pre> 270 * Optional. Job is a SparkR job. 271 * </pre> 272 * 273 * <code> 274 * .google.cloud.dataproc.v1.SparkRJob spark_r_job = 11 [(.google.api.field_behavior) = OPTIONAL]; 275 * </code> 276 * 277 * @return Whether the sparkRJob field is set. 278 */ hasSparkRJob()279 boolean hasSparkRJob(); 280 /** 281 * 282 * 283 * <pre> 284 * Optional. Job is a SparkR job. 285 * </pre> 286 * 287 * <code> 288 * .google.cloud.dataproc.v1.SparkRJob spark_r_job = 11 [(.google.api.field_behavior) = OPTIONAL]; 289 * </code> 290 * 291 * @return The sparkRJob. 292 */ getSparkRJob()293 com.google.cloud.dataproc.v1.SparkRJob getSparkRJob(); 294 /** 295 * 296 * 297 * <pre> 298 * Optional. Job is a SparkR job. 299 * </pre> 300 * 301 * <code> 302 * .google.cloud.dataproc.v1.SparkRJob spark_r_job = 11 [(.google.api.field_behavior) = OPTIONAL]; 303 * </code> 304 */ getSparkRJobOrBuilder()305 com.google.cloud.dataproc.v1.SparkRJobOrBuilder getSparkRJobOrBuilder(); 306 307 /** 308 * 309 * 310 * <pre> 311 * Optional. Job is a SparkSql job. 312 * </pre> 313 * 314 * <code> 315 * .google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 7 [(.google.api.field_behavior) = OPTIONAL]; 316 * </code> 317 * 318 * @return Whether the sparkSqlJob field is set. 319 */ hasSparkSqlJob()320 boolean hasSparkSqlJob(); 321 /** 322 * 323 * 324 * <pre> 325 * Optional. Job is a SparkSql job. 326 * </pre> 327 * 328 * <code> 329 * .google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 7 [(.google.api.field_behavior) = OPTIONAL]; 330 * </code> 331 * 332 * @return The sparkSqlJob. 333 */ getSparkSqlJob()334 com.google.cloud.dataproc.v1.SparkSqlJob getSparkSqlJob(); 335 /** 336 * 337 * 338 * <pre> 339 * Optional. Job is a SparkSql job. 340 * </pre> 341 * 342 * <code> 343 * .google.cloud.dataproc.v1.SparkSqlJob spark_sql_job = 7 [(.google.api.field_behavior) = OPTIONAL]; 344 * </code> 345 */ getSparkSqlJobOrBuilder()346 com.google.cloud.dataproc.v1.SparkSqlJobOrBuilder getSparkSqlJobOrBuilder(); 347 348 /** 349 * 350 * 351 * <pre> 352 * Optional. Job is a Presto job. 353 * </pre> 354 * 355 * <code> 356 * .google.cloud.dataproc.v1.PrestoJob presto_job = 12 [(.google.api.field_behavior) = OPTIONAL]; 357 * </code> 358 * 359 * @return Whether the prestoJob field is set. 360 */ hasPrestoJob()361 boolean hasPrestoJob(); 362 /** 363 * 364 * 365 * <pre> 366 * Optional. Job is a Presto job. 367 * </pre> 368 * 369 * <code> 370 * .google.cloud.dataproc.v1.PrestoJob presto_job = 12 [(.google.api.field_behavior) = OPTIONAL]; 371 * </code> 372 * 373 * @return The prestoJob. 374 */ getPrestoJob()375 com.google.cloud.dataproc.v1.PrestoJob getPrestoJob(); 376 /** 377 * 378 * 379 * <pre> 380 * Optional. Job is a Presto job. 381 * </pre> 382 * 383 * <code> 384 * .google.cloud.dataproc.v1.PrestoJob presto_job = 12 [(.google.api.field_behavior) = OPTIONAL]; 385 * </code> 386 */ getPrestoJobOrBuilder()387 com.google.cloud.dataproc.v1.PrestoJobOrBuilder getPrestoJobOrBuilder(); 388 389 /** 390 * 391 * 392 * <pre> 393 * Optional. The labels to associate with this job. 394 * Label keys must be between 1 and 63 characters long, and must conform to 395 * the following regular expression: 396 * [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62} 397 * Label values must be between 1 and 63 characters long, and must conform to 398 * the following regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 399 * No more than 32 labels can be associated with a given job. 400 * </pre> 401 * 402 * <code>map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 403 */ getLabelsCount()404 int getLabelsCount(); 405 /** 406 * 407 * 408 * <pre> 409 * Optional. The labels to associate with this job. 410 * Label keys must be between 1 and 63 characters long, and must conform to 411 * the following regular expression: 412 * [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62} 413 * Label values must be between 1 and 63 characters long, and must conform to 414 * the following regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 415 * No more than 32 labels can be associated with a given job. 416 * </pre> 417 * 418 * <code>map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 419 */ containsLabels(java.lang.String key)420 boolean containsLabels(java.lang.String key); 421 /** Use {@link #getLabelsMap()} instead. */ 422 @java.lang.Deprecated getLabels()423 java.util.Map<java.lang.String, java.lang.String> getLabels(); 424 /** 425 * 426 * 427 * <pre> 428 * Optional. The labels to associate with this job. 429 * Label keys must be between 1 and 63 characters long, and must conform to 430 * the following regular expression: 431 * [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62} 432 * Label values must be between 1 and 63 characters long, and must conform to 433 * the following regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 434 * No more than 32 labels can be associated with a given job. 435 * </pre> 436 * 437 * <code>map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 438 */ getLabelsMap()439 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 440 /** 441 * 442 * 443 * <pre> 444 * Optional. The labels to associate with this job. 445 * Label keys must be between 1 and 63 characters long, and must conform to 446 * the following regular expression: 447 * [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62} 448 * Label values must be between 1 and 63 characters long, and must conform to 449 * the following regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 450 * No more than 32 labels can be associated with a given job. 451 * </pre> 452 * 453 * <code>map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 454 */ 455 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)456 java.lang.String getLabelsOrDefault( 457 java.lang.String key, 458 /* nullable */ 459 java.lang.String defaultValue); 460 /** 461 * 462 * 463 * <pre> 464 * Optional. The labels to associate with this job. 465 * Label keys must be between 1 and 63 characters long, and must conform to 466 * the following regular expression: 467 * [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62} 468 * Label values must be between 1 and 63 characters long, and must conform to 469 * the following regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 470 * No more than 32 labels can be associated with a given job. 471 * </pre> 472 * 473 * <code>map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 474 */ getLabelsOrThrow(java.lang.String key)475 java.lang.String getLabelsOrThrow(java.lang.String key); 476 477 /** 478 * 479 * 480 * <pre> 481 * Optional. Job scheduling configuration. 482 * </pre> 483 * 484 * <code> 485 * .google.cloud.dataproc.v1.JobScheduling scheduling = 9 [(.google.api.field_behavior) = OPTIONAL]; 486 * </code> 487 * 488 * @return Whether the scheduling field is set. 489 */ hasScheduling()490 boolean hasScheduling(); 491 /** 492 * 493 * 494 * <pre> 495 * Optional. Job scheduling configuration. 496 * </pre> 497 * 498 * <code> 499 * .google.cloud.dataproc.v1.JobScheduling scheduling = 9 [(.google.api.field_behavior) = OPTIONAL]; 500 * </code> 501 * 502 * @return The scheduling. 503 */ getScheduling()504 com.google.cloud.dataproc.v1.JobScheduling getScheduling(); 505 /** 506 * 507 * 508 * <pre> 509 * Optional. Job scheduling configuration. 510 * </pre> 511 * 512 * <code> 513 * .google.cloud.dataproc.v1.JobScheduling scheduling = 9 [(.google.api.field_behavior) = OPTIONAL]; 514 * </code> 515 */ getSchedulingOrBuilder()516 com.google.cloud.dataproc.v1.JobSchedulingOrBuilder getSchedulingOrBuilder(); 517 518 /** 519 * 520 * 521 * <pre> 522 * Optional. The optional list of prerequisite job step_ids. 523 * If not specified, the job will start at the beginning of workflow. 524 * </pre> 525 * 526 * <code>repeated string prerequisite_step_ids = 10 [(.google.api.field_behavior) = OPTIONAL]; 527 * </code> 528 * 529 * @return A list containing the prerequisiteStepIds. 530 */ getPrerequisiteStepIdsList()531 java.util.List<java.lang.String> getPrerequisiteStepIdsList(); 532 /** 533 * 534 * 535 * <pre> 536 * Optional. The optional list of prerequisite job step_ids. 537 * If not specified, the job will start at the beginning of workflow. 538 * </pre> 539 * 540 * <code>repeated string prerequisite_step_ids = 10 [(.google.api.field_behavior) = OPTIONAL]; 541 * </code> 542 * 543 * @return The count of prerequisiteStepIds. 544 */ getPrerequisiteStepIdsCount()545 int getPrerequisiteStepIdsCount(); 546 /** 547 * 548 * 549 * <pre> 550 * Optional. The optional list of prerequisite job step_ids. 551 * If not specified, the job will start at the beginning of workflow. 552 * </pre> 553 * 554 * <code>repeated string prerequisite_step_ids = 10 [(.google.api.field_behavior) = OPTIONAL]; 555 * </code> 556 * 557 * @param index The index of the element to return. 558 * @return The prerequisiteStepIds at the given index. 559 */ getPrerequisiteStepIds(int index)560 java.lang.String getPrerequisiteStepIds(int index); 561 /** 562 * 563 * 564 * <pre> 565 * Optional. The optional list of prerequisite job step_ids. 566 * If not specified, the job will start at the beginning of workflow. 567 * </pre> 568 * 569 * <code>repeated string prerequisite_step_ids = 10 [(.google.api.field_behavior) = OPTIONAL]; 570 * </code> 571 * 572 * @param index The index of the value to return. 573 * @return The bytes of the prerequisiteStepIds at the given index. 574 */ getPrerequisiteStepIdsBytes(int index)575 com.google.protobuf.ByteString getPrerequisiteStepIdsBytes(int index); 576 getJobTypeCase()577 public com.google.cloud.dataproc.v1.OrderedJob.JobTypeCase getJobTypeCase(); 578 } 579