Interface SparkJobOrBuilder (4.39.0)

Version 4.39.0

• 4.50.0 (latest)
• 4.49.0
• 4.48.0
• 4.46.0
• 4.45.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.34.0
• 4.33.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.8
• 3.1.2
• 3.0.3
• 2.3.1

public interface SparkJobOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsProperties(String key)

public abstract boolean containsProperties(String key)

Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getArchiveUris(int index)

public abstract String getArchiveUris(int index)

Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The archiveUris at the given index.

getArchiveUrisBytes(int index)

public abstract ByteString getArchiveUrisBytes(int index)

Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the archiveUris at the given index.

getArchiveUrisCount()

public abstract int getArchiveUrisCount()

Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of archiveUris.

getArchiveUrisList()

public abstract List<String> getArchiveUrisList()

Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

repeated string archive_uris = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the archiveUris.

getArgs(int index)

public abstract String getArgs(int index)

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The args at the given index.

getArgsBytes(int index)

public abstract ByteString getArgsBytes(int index)

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the args at the given index.

getArgsCount()

public abstract int getArgsCount()

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of args.

getArgsList()

public abstract List<String> getArgsList()

Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.

repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the args.

getDriverCase()

public abstract SparkJob.DriverCase getDriverCase()

Returns
Type	Description
SparkJob.DriverCase

getFileUris(int index)

public abstract String getFileUris(int index)

Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The fileUris at the given index.

getFileUrisBytes(int index)

public abstract ByteString getFileUrisBytes(int index)

Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the fileUris at the given index.

getFileUrisCount()

public abstract int getFileUrisCount()

Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of fileUris.

getFileUrisList()

public abstract List<String> getFileUrisList()

Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.

repeated string file_uris = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the fileUris.

getJarFileUris(int index)

public abstract String getJarFileUris(int index)

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The jarFileUris at the given index.

getJarFileUrisBytes(int index)

public abstract ByteString getJarFileUrisBytes(int index)

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the jarFileUris at the given index.

getJarFileUrisCount()

public abstract int getJarFileUrisCount()

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of jarFileUris.

getJarFileUrisList()

public abstract List<String> getJarFileUrisList()

Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the jarFileUris.

getLoggingConfig()

public abstract LoggingConfig getLoggingConfig()

Optional. The runtime log config for job execution.

.google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
LoggingConfig	The loggingConfig.

getLoggingConfigOrBuilder()

public abstract LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Optional. The runtime log config for job execution.

.google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
LoggingConfigOrBuilder

getMainClass()

public abstract String getMainClass()

The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.

string main_class = 2;

Returns
Type	Description
String	The mainClass.

getMainClassBytes()

public abstract ByteString getMainClassBytes()

The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.

string main_class = 2;

Returns
Type	Description
ByteString	The bytes for mainClass.

getMainJarFileUri()

public abstract String getMainJarFileUri()

The HCFS URI of the jar file that contains the main class.

string main_jar_file_uri = 1;

Returns
Type	Description
String	The mainJarFileUri.

getMainJarFileUriBytes()

public abstract ByteString getMainJarFileUriBytes()

The HCFS URI of the jar file that contains the main class.

string main_jar_file_uri = 1;

Returns
Type	Description
ByteString	The bytes for mainJarFileUri.

getProperties() (deprecated)

public abstract Map<String,String> getProperties()

Use #getPropertiesMap() instead.

Returns
Type	Description
Map<String,String>

getPropertiesCount()

public abstract int getPropertiesCount()

Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getPropertiesMap()

public abstract Map<String,String> getPropertiesMap()

Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getPropertiesOrDefault(String key, String defaultValue)

public abstract String getPropertiesOrDefault(String key, String defaultValue)

Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getPropertiesOrThrow(String key)

public abstract String getPropertiesOrThrow(String key)

Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

hasLoggingConfig()

public abstract boolean hasLoggingConfig()

Optional. The runtime log config for job execution.

.google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the loggingConfig field is set.

hasMainClass()

public abstract boolean hasMainClass()

The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.

string main_class = 2;

Returns
Type	Description
boolean	Whether the mainClass field is set.

hasMainJarFileUri()

public abstract boolean hasMainJarFileUri()

The HCFS URI of the jar file that contains the main class.

string main_jar_file_uri = 1;

Returns
Type	Description
boolean	Whether the mainJarFileUri field is set.