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