com.google.cloud.dataproc.v1

Interface PySparkJobOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

PySparkJob, PySparkJob.Builder

public interface PySparkJobOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsProperties(String key) Optional.
String	getArchiveUris(int index) Optional.
ByteString	getArchiveUrisBytes(int index) Optional.
int	getArchiveUrisCount() Optional.
List<String>	getArchiveUrisList() Optional.
String	getArgs(int index) Optional.
ByteString	getArgsBytes(int index) Optional.
int	getArgsCount() Optional.
List<String>	getArgsList() Optional.
String	getFileUris(int index) Optional.
ByteString	getFileUrisBytes(int index) Optional.
int	getFileUrisCount() Optional.
List<String>	getFileUrisList() Optional.
String	getJarFileUris(int index) Optional.
ByteString	getJarFileUrisBytes(int index) Optional.
int	getJarFileUrisCount() Optional.
List<String>	getJarFileUrisList() Optional.
LoggingConfig	getLoggingConfig() Optional.
LoggingConfigOrBuilder	getLoggingConfigOrBuilder() Optional.
String	getMainPythonFileUri() Required.
ByteString	getMainPythonFileUriBytes() Required.
Map<String,String>	getProperties() Deprecated.
int	getPropertiesCount() Optional.
Map<String,String>	getPropertiesMap() Optional.
String	getPropertiesOrDefault(String key, String defaultValue) Optional.
String	getPropertiesOrThrow(String key) Optional.
String	getPythonFileUris(int index) Optional.
ByteString	getPythonFileUrisBytes(int index) Optional.
int	getPythonFileUrisCount() Optional.
List<String>	getPythonFileUrisList() Optional.
boolean	hasLoggingConfig() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getMainPythonFileUri

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:

The mainPythonFileUri.

getMainPythonFileUriBytes

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:

The bytes for mainPythonFileUri.

getArgsList

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:

A list containing the args.

getArgsCount

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:

The count of args.

getArgs

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];

Parameters:

index - The index of the element to return.

Returns:

The args at the given index.

getArgsBytes

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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the args at the given index.

getPythonFileUrisList

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:

A list containing the pythonFileUris.

getPythonFileUrisCount

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:

The count of pythonFileUris.

getPythonFileUris

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];

Parameters:

index - The index of the element to return.

Returns:

The pythonFileUris at the given index.

getPythonFileUrisBytes

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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the pythonFileUris at the given index.

getJarFileUrisList

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:

A list containing the jarFileUris.

getJarFileUrisCount

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:

The count of jarFileUris.

getJarFileUris

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];

Parameters:

index - The index of the element to return.

Returns:

The jarFileUris at the given index.

getJarFileUrisBytes

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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the jarFileUris at the given index.

getFileUrisList

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:

A list containing the fileUris.

getFileUrisCount

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:

The count of fileUris.

getFileUris

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];

Parameters:

index - The index of the element to return.

Returns:

The fileUris at the given index.

getFileUrisBytes

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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the fileUris at the given index.

getArchiveUrisList

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:

A list containing the archiveUris.

getArchiveUrisCount

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:

The count of archiveUris.

getArchiveUris

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];

Parameters:

index - The index of the element to return.

Returns:

The archiveUris at the given index.

getArchiveUrisBytes

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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the archiveUris at the given index.

getPropertiesCount

int getPropertiesCount()

 Optional. A mapping of property names to values, used to configure PySpark.
 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];

containsProperties

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 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];

getProperties

@Deprecated
Map<String,String> getProperties()

Deprecated.

Use getPropertiesMap() instead.

getPropertiesMap

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 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];

getPropertiesOrDefault

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 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];

getPropertiesOrThrow

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 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];

hasLoggingConfig

boolean hasLoggingConfig()

 Optional. The runtime log config for job execution.
 

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

Returns:

Whether the loggingConfig field is set.

getLoggingConfig

LoggingConfig getLoggingConfig()

 Optional. The runtime log config for job execution.
 

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

Returns:

The loggingConfig.

getLoggingConfigOrBuilder

LoggingConfigOrBuilder getLoggingConfigOrBuilder()

 Optional. The runtime log config for job execution.
 

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