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