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/jobs.proto 18 19 package com.google.cloud.dataproc.v1; 20 21 public interface HadoopJobOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.HadoopJob) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The HCFS URI of the jar file containing the main class. 31 * Examples: 32 * 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 33 * 'hdfs:/tmp/test-samples/custom-wordcount.jar' 34 * 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' 35 * </pre> 36 * 37 * <code>string main_jar_file_uri = 1;</code> 38 * 39 * @return Whether the mainJarFileUri field is set. 40 */ hasMainJarFileUri()41 boolean hasMainJarFileUri(); 42 /** 43 * 44 * 45 * <pre> 46 * The HCFS URI of the jar file containing the main class. 47 * Examples: 48 * 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 49 * 'hdfs:/tmp/test-samples/custom-wordcount.jar' 50 * 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' 51 * </pre> 52 * 53 * <code>string main_jar_file_uri = 1;</code> 54 * 55 * @return The mainJarFileUri. 56 */ getMainJarFileUri()57 java.lang.String getMainJarFileUri(); 58 /** 59 * 60 * 61 * <pre> 62 * The HCFS URI of the jar file containing the main class. 63 * Examples: 64 * 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 65 * 'hdfs:/tmp/test-samples/custom-wordcount.jar' 66 * 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' 67 * </pre> 68 * 69 * <code>string main_jar_file_uri = 1;</code> 70 * 71 * @return The bytes for mainJarFileUri. 72 */ getMainJarFileUriBytes()73 com.google.protobuf.ByteString getMainJarFileUriBytes(); 74 75 /** 76 * 77 * 78 * <pre> 79 * The name of the driver's main class. The jar file containing the class 80 * must be in the default CLASSPATH or specified in `jar_file_uris`. 81 * </pre> 82 * 83 * <code>string main_class = 2;</code> 84 * 85 * @return Whether the mainClass field is set. 86 */ hasMainClass()87 boolean hasMainClass(); 88 /** 89 * 90 * 91 * <pre> 92 * The name of the driver's main class. The jar file containing the class 93 * must be in the default CLASSPATH or specified in `jar_file_uris`. 94 * </pre> 95 * 96 * <code>string main_class = 2;</code> 97 * 98 * @return The mainClass. 99 */ getMainClass()100 java.lang.String getMainClass(); 101 /** 102 * 103 * 104 * <pre> 105 * The name of the driver's main class. The jar file containing the class 106 * must be in the default CLASSPATH or specified in `jar_file_uris`. 107 * </pre> 108 * 109 * <code>string main_class = 2;</code> 110 * 111 * @return The bytes for mainClass. 112 */ getMainClassBytes()113 com.google.protobuf.ByteString getMainClassBytes(); 114 115 /** 116 * 117 * 118 * <pre> 119 * Optional. The arguments to pass to the driver. Do not 120 * include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as 121 * job properties, since a collision may occur that causes an incorrect job 122 * submission. 123 * </pre> 124 * 125 * <code>repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 126 * 127 * @return A list containing the args. 128 */ getArgsList()129 java.util.List<java.lang.String> getArgsList(); 130 /** 131 * 132 * 133 * <pre> 134 * Optional. The arguments to pass to the driver. Do not 135 * include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as 136 * job properties, since a collision may occur that causes an incorrect job 137 * submission. 138 * </pre> 139 * 140 * <code>repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 141 * 142 * @return The count of args. 143 */ getArgsCount()144 int getArgsCount(); 145 /** 146 * 147 * 148 * <pre> 149 * Optional. The arguments to pass to the driver. Do not 150 * include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as 151 * job properties, since a collision may occur that causes an incorrect job 152 * submission. 153 * </pre> 154 * 155 * <code>repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 156 * 157 * @param index The index of the element to return. 158 * @return The args at the given index. 159 */ getArgs(int index)160 java.lang.String getArgs(int index); 161 /** 162 * 163 * 164 * <pre> 165 * Optional. The arguments to pass to the driver. Do not 166 * include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as 167 * job properties, since a collision may occur that causes an incorrect job 168 * submission. 169 * </pre> 170 * 171 * <code>repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 172 * 173 * @param index The index of the value to return. 174 * @return The bytes of the args at the given index. 175 */ getArgsBytes(int index)176 com.google.protobuf.ByteString getArgsBytes(int index); 177 178 /** 179 * 180 * 181 * <pre> 182 * Optional. Jar file URIs to add to the CLASSPATHs of the 183 * Hadoop driver and tasks. 184 * </pre> 185 * 186 * <code>repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 187 * 188 * @return A list containing the jarFileUris. 189 */ getJarFileUrisList()190 java.util.List<java.lang.String> getJarFileUrisList(); 191 /** 192 * 193 * 194 * <pre> 195 * Optional. Jar file URIs to add to the CLASSPATHs of the 196 * Hadoop driver and tasks. 197 * </pre> 198 * 199 * <code>repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 200 * 201 * @return The count of jarFileUris. 202 */ getJarFileUrisCount()203 int getJarFileUrisCount(); 204 /** 205 * 206 * 207 * <pre> 208 * Optional. Jar file URIs to add to the CLASSPATHs of the 209 * Hadoop driver and tasks. 210 * </pre> 211 * 212 * <code>repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 213 * 214 * @param index The index of the element to return. 215 * @return The jarFileUris at the given index. 216 */ getJarFileUris(int index)217 java.lang.String getJarFileUris(int index); 218 /** 219 * 220 * 221 * <pre> 222 * Optional. Jar file URIs to add to the CLASSPATHs of the 223 * Hadoop driver and tasks. 224 * </pre> 225 * 226 * <code>repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 227 * 228 * @param index The index of the value to return. 229 * @return The bytes of the jarFileUris at the given index. 230 */ getJarFileUrisBytes(int index)231 com.google.protobuf.ByteString getJarFileUrisBytes(int index); 232 233 /** 234 * 235 * 236 * <pre> 237 * Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied 238 * to the working directory of Hadoop drivers and distributed tasks. Useful 239 * for naively parallel tasks. 240 * </pre> 241 * 242 * <code>repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];</code> 243 * 244 * @return A list containing the fileUris. 245 */ getFileUrisList()246 java.util.List<java.lang.String> getFileUrisList(); 247 /** 248 * 249 * 250 * <pre> 251 * Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied 252 * to the working directory of Hadoop drivers and distributed tasks. Useful 253 * for naively parallel tasks. 254 * </pre> 255 * 256 * <code>repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];</code> 257 * 258 * @return The count of fileUris. 259 */ getFileUrisCount()260 int getFileUrisCount(); 261 /** 262 * 263 * 264 * <pre> 265 * Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied 266 * to the working directory of Hadoop drivers and distributed tasks. Useful 267 * for naively parallel tasks. 268 * </pre> 269 * 270 * <code>repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];</code> 271 * 272 * @param index The index of the element to return. 273 * @return The fileUris at the given index. 274 */ getFileUris(int index)275 java.lang.String getFileUris(int index); 276 /** 277 * 278 * 279 * <pre> 280 * Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied 281 * to the working directory of Hadoop drivers and distributed tasks. Useful 282 * for naively parallel tasks. 283 * </pre> 284 * 285 * <code>repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];</code> 286 * 287 * @param index The index of the value to return. 288 * @return The bytes of the fileUris at the given index. 289 */ getFileUrisBytes(int index)290 com.google.protobuf.ByteString getFileUrisBytes(int index); 291 292 /** 293 * 294 * 295 * <pre> 296 * Optional. HCFS URIs of archives to be extracted in the working directory of 297 * Hadoop drivers and tasks. Supported file types: 298 * .jar, .tar, .tar.gz, .tgz, or .zip. 299 * </pre> 300 * 301 * <code>repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 302 * 303 * @return A list containing the archiveUris. 304 */ getArchiveUrisList()305 java.util.List<java.lang.String> getArchiveUrisList(); 306 /** 307 * 308 * 309 * <pre> 310 * Optional. HCFS URIs of archives to be extracted in the working directory of 311 * Hadoop drivers and tasks. Supported file types: 312 * .jar, .tar, .tar.gz, .tgz, or .zip. 313 * </pre> 314 * 315 * <code>repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 316 * 317 * @return The count of archiveUris. 318 */ getArchiveUrisCount()319 int getArchiveUrisCount(); 320 /** 321 * 322 * 323 * <pre> 324 * Optional. HCFS URIs of archives to be extracted in the working directory of 325 * Hadoop drivers and tasks. Supported file types: 326 * .jar, .tar, .tar.gz, .tgz, or .zip. 327 * </pre> 328 * 329 * <code>repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 330 * 331 * @param index The index of the element to return. 332 * @return The archiveUris at the given index. 333 */ getArchiveUris(int index)334 java.lang.String getArchiveUris(int index); 335 /** 336 * 337 * 338 * <pre> 339 * Optional. HCFS URIs of archives to be extracted in the working directory of 340 * Hadoop drivers and tasks. Supported file types: 341 * .jar, .tar, .tar.gz, .tgz, or .zip. 342 * </pre> 343 * 344 * <code>repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 345 * 346 * @param index The index of the value to return. 347 * @return The bytes of the archiveUris at the given index. 348 */ getArchiveUrisBytes(int index)349 com.google.protobuf.ByteString getArchiveUrisBytes(int index); 350 351 /** 352 * 353 * 354 * <pre> 355 * Optional. A mapping of property names to values, used to configure Hadoop. 356 * Properties that conflict with values set by the Dataproc API may be 357 * overwritten. Can include properties set in /etc/hadoop/conf/*-site and 358 * classes in user code. 359 * </pre> 360 * 361 * <code>map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL]; 362 * </code> 363 */ getPropertiesCount()364 int getPropertiesCount(); 365 /** 366 * 367 * 368 * <pre> 369 * Optional. A mapping of property names to values, used to configure Hadoop. 370 * Properties that conflict with values set by the Dataproc API may be 371 * overwritten. Can include properties set in /etc/hadoop/conf/*-site and 372 * classes in user code. 373 * </pre> 374 * 375 * <code>map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL]; 376 * </code> 377 */ containsProperties(java.lang.String key)378 boolean containsProperties(java.lang.String key); 379 /** Use {@link #getPropertiesMap()} instead. */ 380 @java.lang.Deprecated getProperties()381 java.util.Map<java.lang.String, java.lang.String> getProperties(); 382 /** 383 * 384 * 385 * <pre> 386 * Optional. A mapping of property names to values, used to configure Hadoop. 387 * Properties that conflict with values set by the Dataproc API may be 388 * overwritten. Can include properties set in /etc/hadoop/conf/*-site and 389 * classes in user code. 390 * </pre> 391 * 392 * <code>map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL]; 393 * </code> 394 */ getPropertiesMap()395 java.util.Map<java.lang.String, java.lang.String> getPropertiesMap(); 396 /** 397 * 398 * 399 * <pre> 400 * Optional. A mapping of property names to values, used to configure Hadoop. 401 * Properties that conflict with values set by the Dataproc API may be 402 * overwritten. Can include properties set in /etc/hadoop/conf/*-site and 403 * classes in user code. 404 * </pre> 405 * 406 * <code>map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL]; 407 * </code> 408 */ 409 /* nullable */ getPropertiesOrDefault( java.lang.String key, java.lang.String defaultValue)410 java.lang.String getPropertiesOrDefault( 411 java.lang.String key, 412 /* nullable */ 413 java.lang.String defaultValue); 414 /** 415 * 416 * 417 * <pre> 418 * Optional. A mapping of property names to values, used to configure Hadoop. 419 * Properties that conflict with values set by the Dataproc API may be 420 * overwritten. Can include properties set in /etc/hadoop/conf/*-site and 421 * classes in user code. 422 * </pre> 423 * 424 * <code>map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL]; 425 * </code> 426 */ getPropertiesOrThrow(java.lang.String key)427 java.lang.String getPropertiesOrThrow(java.lang.String key); 428 429 /** 430 * 431 * 432 * <pre> 433 * Optional. The runtime log config for job execution. 434 * </pre> 435 * 436 * <code> 437 * .google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL]; 438 * </code> 439 * 440 * @return Whether the loggingConfig field is set. 441 */ hasLoggingConfig()442 boolean hasLoggingConfig(); 443 /** 444 * 445 * 446 * <pre> 447 * Optional. The runtime log config for job execution. 448 * </pre> 449 * 450 * <code> 451 * .google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL]; 452 * </code> 453 * 454 * @return The loggingConfig. 455 */ getLoggingConfig()456 com.google.cloud.dataproc.v1.LoggingConfig getLoggingConfig(); 457 /** 458 * 459 * 460 * <pre> 461 * Optional. The runtime log config for job execution. 462 * </pre> 463 * 464 * <code> 465 * .google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL]; 466 * </code> 467 */ getLoggingConfigOrBuilder()468 com.google.cloud.dataproc.v1.LoggingConfigOrBuilder getLoggingConfigOrBuilder(); 469 getDriverCase()470 public com.google.cloud.dataproc.v1.HadoopJob.DriverCase getDriverCase(); 471 } 472