Interface PySparkJobOrBuilder (4.48.0)

public interface PySparkJobOrBuilder 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 PySpark. Properties that conflict with values set by the Dataproc API might 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 = 2 [(.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 = 2 [(.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 = 2 [(.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 = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the args.

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 Python 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 Python 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 Python 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 Python 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

getMainPythonFileUri()

public abstract String getMainPythonFileUri()

Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

string main_python_file_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The mainPythonFileUri.

getMainPythonFileUriBytes()

public abstract ByteString getMainPythonFileUriBytes()

Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

string main_python_file_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for mainPythonFileUri.

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 PySpark. Properties that conflict with values set by the Dataproc API might 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 PySpark. Properties that conflict with values set by the Dataproc API might 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 PySpark. Properties that conflict with values set by the Dataproc API might 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 PySpark. Properties that conflict with values set by the Dataproc API might 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

getPythonFileUris(int index)

public abstract String getPythonFileUris(int index)

Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

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

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The pythonFileUris at the given index.

getPythonFileUrisBytes(int index)

public abstract ByteString getPythonFileUrisBytes(int index)

Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

repeated string python_file_uris = 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 pythonFileUris at the given index.

getPythonFileUrisCount()

public abstract int getPythonFileUrisCount()

Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

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

Returns
Type Description
int

The count of pythonFileUris.

getPythonFileUrisList()

public abstract List<String> getPythonFileUrisList()

Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

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

Returns
Type Description
List<String>

A list containing the pythonFileUris.

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.