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 SparkRJobOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.SparkRJob) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The HCFS URI of the main R file to use as the driver. 31 * Must be a .R file. 32 * </pre> 33 * 34 * <code>string main_r_file_uri = 1 [(.google.api.field_behavior) = REQUIRED];</code> 35 * 36 * @return The mainRFileUri. 37 */ getMainRFileUri()38 java.lang.String getMainRFileUri(); 39 /** 40 * 41 * 42 * <pre> 43 * Required. The HCFS URI of the main R file to use as the driver. 44 * Must be a .R file. 45 * </pre> 46 * 47 * <code>string main_r_file_uri = 1 [(.google.api.field_behavior) = REQUIRED];</code> 48 * 49 * @return The bytes for mainRFileUri. 50 */ getMainRFileUriBytes()51 com.google.protobuf.ByteString getMainRFileUriBytes(); 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 URIs of files to be placed in the working directory of 117 * each executor. Useful for naively parallel tasks. 118 * </pre> 119 * 120 * <code>repeated string file_uris = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 121 * 122 * @return A list containing the fileUris. 123 */ getFileUrisList()124 java.util.List<java.lang.String> getFileUrisList(); 125 /** 126 * 127 * 128 * <pre> 129 * Optional. HCFS URIs of files to be placed in the working directory of 130 * each executor. Useful for naively parallel tasks. 131 * </pre> 132 * 133 * <code>repeated string file_uris = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 134 * 135 * @return The count of fileUris. 136 */ getFileUrisCount()137 int getFileUrisCount(); 138 /** 139 * 140 * 141 * <pre> 142 * Optional. HCFS URIs of files to be placed in the working directory of 143 * each executor. Useful for naively parallel tasks. 144 * </pre> 145 * 146 * <code>repeated string file_uris = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 147 * 148 * @param index The index of the element to return. 149 * @return The fileUris at the given index. 150 */ getFileUris(int index)151 java.lang.String getFileUris(int index); 152 /** 153 * 154 * 155 * <pre> 156 * Optional. HCFS URIs of files to be placed in the working directory of 157 * each executor. Useful for naively parallel tasks. 158 * </pre> 159 * 160 * <code>repeated string 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 fileUris at the given index. 164 */ getFileUrisBytes(int index)165 com.google.protobuf.ByteString getFileUrisBytes(int index); 166 167 /** 168 * 169 * 170 * <pre> 171 * Optional. HCFS URIs of archives to be extracted into the working directory 172 * of each executor. Supported file types: 173 * .jar, .tar, .tar.gz, .tgz, and .zip. 174 * </pre> 175 * 176 * <code>repeated string archive_uris = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 177 * 178 * @return A list containing the archiveUris. 179 */ getArchiveUrisList()180 java.util.List<java.lang.String> getArchiveUrisList(); 181 /** 182 * 183 * 184 * <pre> 185 * Optional. HCFS URIs of archives to be extracted into the working directory 186 * of each executor. Supported file types: 187 * .jar, .tar, .tar.gz, .tgz, and .zip. 188 * </pre> 189 * 190 * <code>repeated string archive_uris = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 191 * 192 * @return The count of archiveUris. 193 */ getArchiveUrisCount()194 int getArchiveUrisCount(); 195 /** 196 * 197 * 198 * <pre> 199 * Optional. HCFS URIs of archives to be extracted into the working directory 200 * of each executor. Supported file types: 201 * .jar, .tar, .tar.gz, .tgz, and .zip. 202 * </pre> 203 * 204 * <code>repeated string archive_uris = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 205 * 206 * @param index The index of the element to return. 207 * @return The archiveUris at the given index. 208 */ getArchiveUris(int index)209 java.lang.String getArchiveUris(int index); 210 /** 211 * 212 * 213 * <pre> 214 * Optional. HCFS URIs of archives to be extracted into the working directory 215 * of each executor. Supported file types: 216 * .jar, .tar, .tar.gz, .tgz, and .zip. 217 * </pre> 218 * 219 * <code>repeated string archive_uris = 4 [(.google.api.field_behavior) = OPTIONAL];</code> 220 * 221 * @param index The index of the value to return. 222 * @return The bytes of the archiveUris at the given index. 223 */ getArchiveUrisBytes(int index)224 com.google.protobuf.ByteString getArchiveUrisBytes(int index); 225 226 /** 227 * 228 * 229 * <pre> 230 * Optional. A mapping of property names to values, used to configure SparkR. 231 * Properties that conflict with values set by the Dataproc API may be 232 * overwritten. Can include properties set in 233 * /etc/spark/conf/spark-defaults.conf and classes in user code. 234 * </pre> 235 * 236 * <code>map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL]; 237 * </code> 238 */ getPropertiesCount()239 int getPropertiesCount(); 240 /** 241 * 242 * 243 * <pre> 244 * Optional. A mapping of property names to values, used to configure SparkR. 245 * Properties that conflict with values set by the Dataproc API may be 246 * overwritten. Can include properties set in 247 * /etc/spark/conf/spark-defaults.conf and classes in user code. 248 * </pre> 249 * 250 * <code>map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL]; 251 * </code> 252 */ containsProperties(java.lang.String key)253 boolean containsProperties(java.lang.String key); 254 /** Use {@link #getPropertiesMap()} instead. */ 255 @java.lang.Deprecated getProperties()256 java.util.Map<java.lang.String, java.lang.String> getProperties(); 257 /** 258 * 259 * 260 * <pre> 261 * Optional. A mapping of property names to values, used to configure SparkR. 262 * Properties that conflict with values set by the Dataproc API may be 263 * overwritten. Can include properties set in 264 * /etc/spark/conf/spark-defaults.conf and classes in user code. 265 * </pre> 266 * 267 * <code>map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL]; 268 * </code> 269 */ getPropertiesMap()270 java.util.Map<java.lang.String, java.lang.String> getPropertiesMap(); 271 /** 272 * 273 * 274 * <pre> 275 * Optional. A mapping of property names to values, used to configure SparkR. 276 * Properties that conflict with values set by the Dataproc API may be 277 * overwritten. Can include properties set in 278 * /etc/spark/conf/spark-defaults.conf and classes in user code. 279 * </pre> 280 * 281 * <code>map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL]; 282 * </code> 283 */ 284 /* nullable */ getPropertiesOrDefault( java.lang.String key, java.lang.String defaultValue)285 java.lang.String getPropertiesOrDefault( 286 java.lang.String key, 287 /* nullable */ 288 java.lang.String defaultValue); 289 /** 290 * 291 * 292 * <pre> 293 * Optional. A mapping of property names to values, used to configure SparkR. 294 * Properties that conflict with values set by the Dataproc API may be 295 * overwritten. Can include properties set in 296 * /etc/spark/conf/spark-defaults.conf and classes in user code. 297 * </pre> 298 * 299 * <code>map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL]; 300 * </code> 301 */ getPropertiesOrThrow(java.lang.String key)302 java.lang.String getPropertiesOrThrow(java.lang.String key); 303 304 /** 305 * 306 * 307 * <pre> 308 * Optional. The runtime log config for job execution. 309 * </pre> 310 * 311 * <code> 312 * .google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL]; 313 * </code> 314 * 315 * @return Whether the loggingConfig field is set. 316 */ hasLoggingConfig()317 boolean hasLoggingConfig(); 318 /** 319 * 320 * 321 * <pre> 322 * Optional. The runtime log config for job execution. 323 * </pre> 324 * 325 * <code> 326 * .google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL]; 327 * </code> 328 * 329 * @return The loggingConfig. 330 */ getLoggingConfig()331 com.google.cloud.dataproc.v1.LoggingConfig getLoggingConfig(); 332 /** 333 * 334 * 335 * <pre> 336 * Optional. The runtime log config for job execution. 337 * </pre> 338 * 339 * <code> 340 * .google.cloud.dataproc.v1.LoggingConfig logging_config = 6 [(.google.api.field_behavior) = OPTIONAL]; 341 * </code> 342 */ getLoggingConfigOrBuilder()343 com.google.cloud.dataproc.v1.LoggingConfigOrBuilder getLoggingConfigOrBuilder(); 344 } 345