Class PySparkBatch.Builder (4.52.0)

public static final class PySparkBatch.Builder extends GeneratedMessageV3.Builder<PySparkBatch.Builder> implements PySparkBatchOrBuilder

A configuration for running an Apache PySpark batch workload.

Protobuf type google.cloud.dataproc.v1.PySparkBatch

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllArchiveUris(Iterable<String> values)

public PySparkBatch.Builder addAllArchiveUris(Iterable<String> values)

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
values Iterable<String>

The archiveUris to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addAllArgs(Iterable<String> values)

public PySparkBatch.Builder addAllArgs(Iterable<String> values)

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

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

Parameter
Name Description
values Iterable<String>

The args to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addAllFileUris(Iterable<String> values)

public PySparkBatch.Builder addAllFileUris(Iterable<String> values)

Optional. HCFS URIs of files to be placed in the working directory of each executor.

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

Parameter
Name Description
values Iterable<String>

The fileUris to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addAllJarFileUris(Iterable<String> values)

public PySparkBatch.Builder addAllJarFileUris(Iterable<String> values)

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

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

Parameter
Name Description
values Iterable<String>

The jarFileUris to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addAllPythonFileUris(Iterable<String> values)

public PySparkBatch.Builder addAllPythonFileUris(Iterable<String> values)

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
values Iterable<String>

The pythonFileUris to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addArchiveUris(String value)

public PySparkBatch.Builder addArchiveUris(String value)

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
value String

The archiveUris to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addArchiveUrisBytes(ByteString value)

public PySparkBatch.Builder addArchiveUrisBytes(ByteString value)

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
value ByteString

The bytes of the archiveUris to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addArgs(String value)

public PySparkBatch.Builder addArgs(String value)

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

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

Parameter
Name Description
value String

The args to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addArgsBytes(ByteString value)

public PySparkBatch.Builder addArgsBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes of the args to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addFileUris(String value)

public PySparkBatch.Builder addFileUris(String value)

Optional. HCFS URIs of files to be placed in the working directory of each executor.

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

Parameter
Name Description
value String

The fileUris to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addFileUrisBytes(ByteString value)

public PySparkBatch.Builder addFileUrisBytes(ByteString value)

Optional. HCFS URIs of files to be placed in the working directory of each executor.

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

Parameter
Name Description
value ByteString

The bytes of the fileUris to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addJarFileUris(String value)

public PySparkBatch.Builder addJarFileUris(String value)

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

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

Parameter
Name Description
value String

The jarFileUris to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addJarFileUrisBytes(ByteString value)

public PySparkBatch.Builder addJarFileUrisBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes of the jarFileUris to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addPythonFileUris(String value)

public PySparkBatch.Builder addPythonFileUris(String value)

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
value String

The pythonFileUris to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addPythonFileUrisBytes(ByteString value)

public PySparkBatch.Builder addPythonFileUrisBytes(ByteString value)

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
value ByteString

The bytes of the pythonFileUris to add.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PySparkBatch.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PySparkBatch.Builder
Overrides

build()

public PySparkBatch build()
Returns
Type Description
PySparkBatch

buildPartial()

public PySparkBatch buildPartial()
Returns
Type Description
PySparkBatch

clear()

public PySparkBatch.Builder clear()
Returns
Type Description
PySparkBatch.Builder
Overrides

clearArchiveUris()

public PySparkBatch.Builder clearArchiveUris()

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
PySparkBatch.Builder

This builder for chaining.

clearArgs()

public PySparkBatch.Builder clearArgs()

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

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

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PySparkBatch.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PySparkBatch.Builder
Overrides

clearFileUris()

public PySparkBatch.Builder clearFileUris()

Optional. HCFS URIs of files to be placed in the working directory of each executor.

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

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

clearJarFileUris()

public PySparkBatch.Builder clearJarFileUris()

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

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

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

clearMainPythonFileUri()

public PySparkBatch.Builder clearMainPythonFileUri()

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

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

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PySparkBatch.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PySparkBatch.Builder
Overrides

clearPythonFileUris()

public PySparkBatch.Builder clearPythonFileUris()

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
PySparkBatch.Builder

This builder for chaining.

clone()

public PySparkBatch.Builder clone()
Returns
Type Description
PySparkBatch.Builder
Overrides

getArchiveUris(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the archiveUris.

getArgs(int index)

public String getArgs(int index)

Optional. The arguments to pass to the driver. Do not include arguments that can be set as batch properties, such as --conf, since a collision can occur that causes an incorrect batch 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 ByteString getArgsBytes(int index)

Optional. The arguments to pass to the driver. Do not include arguments that can be set as batch properties, such as --conf, since a collision can occur that causes an incorrect batch 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 int getArgsCount()

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

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

Returns
Type Description
int

The count of args.

getArgsList()

public ProtocolStringList getArgsList()

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

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

Returns
Type Description
ProtocolStringList

A list containing the args.

getDefaultInstanceForType()

public PySparkBatch getDefaultInstanceForType()
Returns
Type Description
PySparkBatch

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFileUris(int index)

public String getFileUris(int index)

Optional. HCFS URIs of files to be placed in the working directory of each executor.

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 ByteString getFileUrisBytes(int index)

Optional. HCFS URIs of files to be placed in the working directory of each executor.

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 int getFileUrisCount()

Optional. HCFS URIs of files to be placed in the working directory of each executor.

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

Returns
Type Description
int

The count of fileUris.

getFileUrisList()

public ProtocolStringList getFileUrisList()

Optional. HCFS URIs of files to be placed in the working directory of each executor.

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

Returns
Type Description
ProtocolStringList

A list containing the fileUris.

getJarFileUris(int index)

public String getJarFileUris(int index)

Optional. HCFS URIs of jar files to add to the classpath 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 ByteString getJarFileUrisBytes(int index)

Optional. HCFS URIs of jar files to add to the classpath 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 int getJarFileUrisCount()

Optional. HCFS URIs of jar files to add to the classpath 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 ProtocolStringList getJarFileUrisList()

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

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

Returns
Type Description
ProtocolStringList

A list containing the jarFileUris.

getMainPythonFileUri()

public String getMainPythonFileUri()

Required. The HCFS URI of the main Python file to use as the Spark 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 ByteString getMainPythonFileUriBytes()

Required. The HCFS URI of the main Python file to use as the Spark 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.

getPythonFileUris(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the pythonFileUris.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PySparkBatch other)

public PySparkBatch.Builder mergeFrom(PySparkBatch other)
Parameter
Name Description
other PySparkBatch
Returns
Type Description
PySparkBatch.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PySparkBatch.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PySparkBatch.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PySparkBatch.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PySparkBatch.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PySparkBatch.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PySparkBatch.Builder
Overrides

setArchiveUris(int index, String value)

public PySparkBatch.Builder setArchiveUris(int index, String value)

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
Name Description
index int

The index to set the value at.

value String

The archiveUris to set.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

setArgs(int index, String value)

public PySparkBatch.Builder setArgs(int index, String value)

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

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

Parameters
Name Description
index int

The index to set the value at.

value String

The args to set.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PySparkBatch.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PySparkBatch.Builder
Overrides

setFileUris(int index, String value)

public PySparkBatch.Builder setFileUris(int index, String value)

Optional. HCFS URIs of files to be placed in the working directory of each executor.

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

Parameters
Name Description
index int

The index to set the value at.

value String

The fileUris to set.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

setJarFileUris(int index, String value)

public PySparkBatch.Builder setJarFileUris(int index, String value)

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

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

Parameters
Name Description
index int

The index to set the value at.

value String

The jarFileUris to set.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

setMainPythonFileUri(String value)

public PySparkBatch.Builder setMainPythonFileUri(String value)

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

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

Parameter
Name Description
value String

The mainPythonFileUri to set.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

setMainPythonFileUriBytes(ByteString value)

public PySparkBatch.Builder setMainPythonFileUriBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for mainPythonFileUri to set.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

setPythonFileUris(int index, String value)

public PySparkBatch.Builder setPythonFileUris(int index, String value)

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
Name Description
index int

The index to set the value at.

value String

The pythonFileUris to set.

Returns
Type Description
PySparkBatch.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PySparkBatch.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PySparkBatch.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PySparkBatch.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PySparkBatch.Builder
Overrides