Class PySparkBatch (4.15.0)

public final class PySparkBatch extends GeneratedMessageV3 implements PySparkBatchOrBuilder

A configuration for running an Apache PySpark batch workload.

Protobuf type google.cloud.dataproc.v1.PySparkBatch

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PySparkBatch

Implements

PySparkBatchOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ARCHIVE_URIS_FIELD_NUMBER

public static final int ARCHIVE_URIS_FIELD_NUMBER

Field Value
Type	Description
`int`

ARGS_FIELD_NUMBER

public static final int ARGS_FIELD_NUMBER

Field Value
Type	Description
`int`

FILE_URIS_FIELD_NUMBER

public static final int FILE_URIS_FIELD_NUMBER

Field Value
Type	Description
`int`

JAR_FILE_URIS_FIELD_NUMBER

public static final int JAR_FILE_URIS_FIELD_NUMBER

Field Value
Type	Description
`int`

MAIN_PYTHON_FILE_URI_FIELD_NUMBER

public static final int MAIN_PYTHON_FILE_URI_FIELD_NUMBER

Field Value
Type	Description
`int`

PYTHON_FILE_URIS_FIELD_NUMBER

public static final int PYTHON_FILE_URIS_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static PySparkBatch getDefaultInstance()

Returns
Type	Description
`PySparkBatch`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static PySparkBatch.Builder newBuilder()

Returns
Type	Description
`PySparkBatch.Builder`

newBuilder(PySparkBatch prototype)

public static PySparkBatch.Builder newBuilder(PySparkBatch prototype)

Parameter
Name	Description
`prototype`	`PySparkBatch`

Returns
Type	Description
`PySparkBatch.Builder`

parseDelimitedFrom(InputStream input)

public static PySparkBatch parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PySparkBatch`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PySparkBatch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PySparkBatch`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static PySparkBatch parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`PySparkBatch`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PySparkBatch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PySparkBatch`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static PySparkBatch parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`PySparkBatch`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PySparkBatch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PySparkBatch`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static PySparkBatch parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`PySparkBatch`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PySparkBatch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PySparkBatch`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static PySparkBatch parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`PySparkBatch`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PySparkBatch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PySparkBatch`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static PySparkBatch parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`PySparkBatch`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PySparkBatch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PySparkBatch`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<PySparkBatch> parser()

Returns
Type	Description
`Parser<PySparkBatch>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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`

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.

getParserForType()

public Parser<PySparkBatch> getParserForType()

Returns
Type	Description
`Parser<PySparkBatch>`

Overrides

GeneratedMessageV3.getParserForType()

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public PySparkBatch.Builder newBuilderForType()

Returns
Type	Description
`PySparkBatch.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PySparkBatch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`PySparkBatch.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public PySparkBatch.Builder toBuilder()

Returns
Type	Description
`PySparkBatch.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`