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 PigJobOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.PigJob) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The HCFS URI of the script that contains the Pig queries. 31 * </pre> 32 * 33 * <code>string query_file_uri = 1;</code> 34 * 35 * @return Whether the queryFileUri field is set. 36 */ hasQueryFileUri()37 boolean hasQueryFileUri(); 38 /** 39 * 40 * 41 * <pre> 42 * The HCFS URI of the script that contains the Pig queries. 43 * </pre> 44 * 45 * <code>string query_file_uri = 1;</code> 46 * 47 * @return The queryFileUri. 48 */ getQueryFileUri()49 java.lang.String getQueryFileUri(); 50 /** 51 * 52 * 53 * <pre> 54 * The HCFS URI of the script that contains the Pig queries. 55 * </pre> 56 * 57 * <code>string query_file_uri = 1;</code> 58 * 59 * @return The bytes for queryFileUri. 60 */ getQueryFileUriBytes()61 com.google.protobuf.ByteString getQueryFileUriBytes(); 62 63 /** 64 * 65 * 66 * <pre> 67 * A list of queries. 68 * </pre> 69 * 70 * <code>.google.cloud.dataproc.v1.QueryList query_list = 2;</code> 71 * 72 * @return Whether the queryList field is set. 73 */ hasQueryList()74 boolean hasQueryList(); 75 /** 76 * 77 * 78 * <pre> 79 * A list of queries. 80 * </pre> 81 * 82 * <code>.google.cloud.dataproc.v1.QueryList query_list = 2;</code> 83 * 84 * @return The queryList. 85 */ getQueryList()86 com.google.cloud.dataproc.v1.QueryList getQueryList(); 87 /** 88 * 89 * 90 * <pre> 91 * A list of queries. 92 * </pre> 93 * 94 * <code>.google.cloud.dataproc.v1.QueryList query_list = 2;</code> 95 */ getQueryListOrBuilder()96 com.google.cloud.dataproc.v1.QueryListOrBuilder getQueryListOrBuilder(); 97 98 /** 99 * 100 * 101 * <pre> 102 * Optional. Whether to continue executing queries if a query fails. 103 * The default value is `false`. Setting to `true` can be useful when 104 * executing independent parallel queries. 105 * </pre> 106 * 107 * <code>bool continue_on_failure = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 108 * 109 * @return The continueOnFailure. 110 */ getContinueOnFailure()111 boolean getContinueOnFailure(); 112 113 /** 114 * 115 * 116 * <pre> 117 * Optional. Mapping of query variable names to values (equivalent to the Pig 118 * command: `name=[value]`). 119 * </pre> 120 * 121 * <code>map<string, string> script_variables = 4 [(.google.api.field_behavior) = OPTIONAL]; 122 * </code> 123 */ getScriptVariablesCount()124 int getScriptVariablesCount(); 125 /** 126 * 127 * 128 * <pre> 129 * Optional. Mapping of query variable names to values (equivalent to the Pig 130 * command: `name=[value]`). 131 * </pre> 132 * 133 * <code>map<string, string> script_variables = 4 [(.google.api.field_behavior) = OPTIONAL]; 134 * </code> 135 */ containsScriptVariables(java.lang.String key)136 boolean containsScriptVariables(java.lang.String key); 137 /** Use {@link #getScriptVariablesMap()} instead. */ 138 @java.lang.Deprecated getScriptVariables()139 java.util.Map<java.lang.String, java.lang.String> getScriptVariables(); 140 /** 141 * 142 * 143 * <pre> 144 * Optional. Mapping of query variable names to values (equivalent to the Pig 145 * command: `name=[value]`). 146 * </pre> 147 * 148 * <code>map<string, string> script_variables = 4 [(.google.api.field_behavior) = OPTIONAL]; 149 * </code> 150 */ getScriptVariablesMap()151 java.util.Map<java.lang.String, java.lang.String> getScriptVariablesMap(); 152 /** 153 * 154 * 155 * <pre> 156 * Optional. Mapping of query variable names to values (equivalent to the Pig 157 * command: `name=[value]`). 158 * </pre> 159 * 160 * <code>map<string, string> script_variables = 4 [(.google.api.field_behavior) = OPTIONAL]; 161 * </code> 162 */ 163 /* nullable */ getScriptVariablesOrDefault( java.lang.String key, java.lang.String defaultValue)164 java.lang.String getScriptVariablesOrDefault( 165 java.lang.String key, 166 /* nullable */ 167 java.lang.String defaultValue); 168 /** 169 * 170 * 171 * <pre> 172 * Optional. Mapping of query variable names to values (equivalent to the Pig 173 * command: `name=[value]`). 174 * </pre> 175 * 176 * <code>map<string, string> script_variables = 4 [(.google.api.field_behavior) = OPTIONAL]; 177 * </code> 178 */ getScriptVariablesOrThrow(java.lang.String key)179 java.lang.String getScriptVariablesOrThrow(java.lang.String key); 180 181 /** 182 * 183 * 184 * <pre> 185 * Optional. A mapping of property names to values, used to configure Pig. 186 * Properties that conflict with values set by the Dataproc API may be 187 * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, 188 * /etc/pig/conf/pig.properties, and classes in user code. 189 * </pre> 190 * 191 * <code>map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL]; 192 * </code> 193 */ getPropertiesCount()194 int getPropertiesCount(); 195 /** 196 * 197 * 198 * <pre> 199 * Optional. A mapping of property names to values, used to configure Pig. 200 * Properties that conflict with values set by the Dataproc API may be 201 * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, 202 * /etc/pig/conf/pig.properties, and classes in user code. 203 * </pre> 204 * 205 * <code>map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL]; 206 * </code> 207 */ containsProperties(java.lang.String key)208 boolean containsProperties(java.lang.String key); 209 /** Use {@link #getPropertiesMap()} instead. */ 210 @java.lang.Deprecated getProperties()211 java.util.Map<java.lang.String, java.lang.String> getProperties(); 212 /** 213 * 214 * 215 * <pre> 216 * Optional. A mapping of property names to values, used to configure Pig. 217 * Properties that conflict with values set by the Dataproc API may be 218 * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, 219 * /etc/pig/conf/pig.properties, and classes in user code. 220 * </pre> 221 * 222 * <code>map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL]; 223 * </code> 224 */ getPropertiesMap()225 java.util.Map<java.lang.String, java.lang.String> getPropertiesMap(); 226 /** 227 * 228 * 229 * <pre> 230 * Optional. A mapping of property names to values, used to configure Pig. 231 * Properties that conflict with values set by the Dataproc API may be 232 * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, 233 * /etc/pig/conf/pig.properties, and classes in user code. 234 * </pre> 235 * 236 * <code>map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL]; 237 * </code> 238 */ 239 /* nullable */ getPropertiesOrDefault( java.lang.String key, java.lang.String defaultValue)240 java.lang.String getPropertiesOrDefault( 241 java.lang.String key, 242 /* nullable */ 243 java.lang.String defaultValue); 244 /** 245 * 246 * 247 * <pre> 248 * Optional. A mapping of property names to values, used to configure Pig. 249 * Properties that conflict with values set by the Dataproc API may be 250 * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, 251 * /etc/pig/conf/pig.properties, and classes in user code. 252 * </pre> 253 * 254 * <code>map<string, string> properties = 5 [(.google.api.field_behavior) = OPTIONAL]; 255 * </code> 256 */ getPropertiesOrThrow(java.lang.String key)257 java.lang.String getPropertiesOrThrow(java.lang.String key); 258 259 /** 260 * 261 * 262 * <pre> 263 * Optional. HCFS URIs of jar files to add to the CLASSPATH of 264 * the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. 265 * </pre> 266 * 267 * <code>repeated string jar_file_uris = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 268 * 269 * @return A list containing the jarFileUris. 270 */ getJarFileUrisList()271 java.util.List<java.lang.String> getJarFileUrisList(); 272 /** 273 * 274 * 275 * <pre> 276 * Optional. HCFS URIs of jar files to add to the CLASSPATH of 277 * the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. 278 * </pre> 279 * 280 * <code>repeated string jar_file_uris = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 281 * 282 * @return The count of jarFileUris. 283 */ getJarFileUrisCount()284 int getJarFileUrisCount(); 285 /** 286 * 287 * 288 * <pre> 289 * Optional. HCFS URIs of jar files to add to the CLASSPATH of 290 * the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. 291 * </pre> 292 * 293 * <code>repeated string jar_file_uris = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 294 * 295 * @param index The index of the element to return. 296 * @return The jarFileUris at the given index. 297 */ getJarFileUris(int index)298 java.lang.String getJarFileUris(int index); 299 /** 300 * 301 * 302 * <pre> 303 * Optional. HCFS URIs of jar files to add to the CLASSPATH of 304 * the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. 305 * </pre> 306 * 307 * <code>repeated string jar_file_uris = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 308 * 309 * @param index The index of the value to return. 310 * @return The bytes of the jarFileUris at the given index. 311 */ getJarFileUrisBytes(int index)312 com.google.protobuf.ByteString getJarFileUrisBytes(int index); 313 314 /** 315 * 316 * 317 * <pre> 318 * Optional. The runtime log config for job execution. 319 * </pre> 320 * 321 * <code> 322 * .google.cloud.dataproc.v1.LoggingConfig logging_config = 7 [(.google.api.field_behavior) = OPTIONAL]; 323 * </code> 324 * 325 * @return Whether the loggingConfig field is set. 326 */ hasLoggingConfig()327 boolean hasLoggingConfig(); 328 /** 329 * 330 * 331 * <pre> 332 * Optional. The runtime log config for job execution. 333 * </pre> 334 * 335 * <code> 336 * .google.cloud.dataproc.v1.LoggingConfig logging_config = 7 [(.google.api.field_behavior) = OPTIONAL]; 337 * </code> 338 * 339 * @return The loggingConfig. 340 */ getLoggingConfig()341 com.google.cloud.dataproc.v1.LoggingConfig getLoggingConfig(); 342 /** 343 * 344 * 345 * <pre> 346 * Optional. The runtime log config for job execution. 347 * </pre> 348 * 349 * <code> 350 * .google.cloud.dataproc.v1.LoggingConfig logging_config = 7 [(.google.api.field_behavior) = OPTIONAL]; 351 * </code> 352 */ getLoggingConfigOrBuilder()353 com.google.cloud.dataproc.v1.LoggingConfigOrBuilder getLoggingConfigOrBuilder(); 354 getQueriesCase()355 public com.google.cloud.dataproc.v1.PigJob.QueriesCase getQueriesCase(); 356 } 357