Class PySparkNotebookBatch.Builder (4.90.0)

public static final class PySparkNotebookBatch.Builder extends GeneratedMessage.Builder<PySparkNotebookBatch.Builder> implements PySparkNotebookBatchOrBuilder

A configuration for running a PySpark Notebook batch workload.

Protobuf type google.cloud.dataproc.v1.PySparkNotebookBatch

Static Methods

getDescriptor()

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

Methods

addAllArchiveUris(Iterable<String> values)

public PySparkNotebookBatch.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
PySparkNotebookBatch.Builder

This builder for chaining.

addAllFileUris(Iterable<String> values)

public PySparkNotebookBatch.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
PySparkNotebookBatch.Builder

This builder for chaining.

addAllJarFileUris(Iterable<String> values)

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

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

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

Parameter
Name Description
values Iterable<String>

The jarFileUris to add.

Returns
Type Description
PySparkNotebookBatch.Builder

This builder for chaining.

addAllPythonFileUris(Iterable<String> values)

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

Optional. HCFS URIs of Python files to pass to the PySpark framework.

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

Parameter
Name Description
values Iterable<String>

The pythonFileUris to add.

Returns
Type Description
PySparkNotebookBatch.Builder

This builder for chaining.

addArchiveUris(String value)

public PySparkNotebookBatch.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
PySparkNotebookBatch.Builder

This builder for chaining.

addArchiveUrisBytes(ByteString value)

public PySparkNotebookBatch.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
PySparkNotebookBatch.Builder

This builder for chaining.

addFileUris(String value)

public PySparkNotebookBatch.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
PySparkNotebookBatch.Builder

This builder for chaining.

addFileUrisBytes(ByteString value)

public PySparkNotebookBatch.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
PySparkNotebookBatch.Builder

This builder for chaining.

addJarFileUris(String value)

public PySparkNotebookBatch.Builder addJarFileUris(String value)

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

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

Parameter
Name Description
value String

The jarFileUris to add.

Returns
Type Description
PySparkNotebookBatch.Builder

This builder for chaining.

addJarFileUrisBytes(ByteString value)

public PySparkNotebookBatch.Builder addJarFileUrisBytes(ByteString value)

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

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

This builder for chaining.

addPythonFileUris(String value)

public PySparkNotebookBatch.Builder addPythonFileUris(String value)

Optional. HCFS URIs of Python files to pass to the PySpark framework.

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

Parameter
Name Description
value String

The pythonFileUris to add.

Returns
Type Description
PySparkNotebookBatch.Builder

This builder for chaining.

addPythonFileUrisBytes(ByteString value)

public PySparkNotebookBatch.Builder addPythonFileUrisBytes(ByteString value)

Optional. HCFS URIs of Python files to pass to the PySpark framework.

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

This builder for chaining.

build()

public PySparkNotebookBatch build()
Returns
Type Description
PySparkNotebookBatch

buildPartial()

public PySparkNotebookBatch buildPartial()
Returns
Type Description
PySparkNotebookBatch

clear()

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

clearArchiveUris()

public PySparkNotebookBatch.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
PySparkNotebookBatch.Builder

This builder for chaining.

clearFileUris()

public PySparkNotebookBatch.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
PySparkNotebookBatch.Builder

This builder for chaining.

clearJarFileUris()

public PySparkNotebookBatch.Builder clearJarFileUris()

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

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

Returns
Type Description
PySparkNotebookBatch.Builder

This builder for chaining.

clearNotebookFileUri()

public PySparkNotebookBatch.Builder clearNotebookFileUri()

Required. The HCFS URI of the notebook file to execute.

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

Returns
Type Description
PySparkNotebookBatch.Builder

This builder for chaining.

clearParams()

public PySparkNotebookBatch.Builder clearParams()
Returns
Type Description
PySparkNotebookBatch.Builder

clearPythonFileUris()

public PySparkNotebookBatch.Builder clearPythonFileUris()

Optional. HCFS URIs of Python files to pass to the PySpark framework.

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

Returns
Type Description
PySparkNotebookBatch.Builder

This builder for chaining.

containsParams(String key)

public boolean containsParams(String key)

Optional. The parameters to pass to the notebook.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

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.

getDefaultInstanceForType()

public PySparkNotebookBatch getDefaultInstanceForType()
Returns
Type Description
PySparkNotebookBatch

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 be added to the Spark CLASSPATH.

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 be added to the Spark CLASSPATH.

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 be added to the Spark CLASSPATH.

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 be added to the Spark CLASSPATH.

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

Returns
Type Description
ProtocolStringList

A list containing the jarFileUris.

getMutableParams() (deprecated)

public Map<String,String> getMutableParams()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getNotebookFileUri()

public String getNotebookFileUri()

Required. The HCFS URI of the notebook file to execute.

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

Returns
Type Description
String

The notebookFileUri.

getNotebookFileUriBytes()

public ByteString getNotebookFileUriBytes()

Required. The HCFS URI of the notebook file to execute.

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

Returns
Type Description
ByteString

The bytes for notebookFileUri.

getParams() (deprecated)

public Map<String,String> getParams()

Use #getParamsMap() instead.

Returns
Type Description
Map<String,String>

getParamsCount()

public int getParamsCount()

Optional. The parameters to pass to the notebook.

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

Returns
Type Description
int

getParamsMap()

public Map<String,String> getParamsMap()

Optional. The parameters to pass to the notebook.

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

Returns
Type Description
Map<String,String>

getParamsOrDefault(String key, String defaultValue)

public String getParamsOrDefault(String key, String defaultValue)

Optional. The parameters to pass to the notebook.

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getParamsOrThrow(String key)

public String getParamsOrThrow(String key)

Optional. The parameters to pass to the notebook.

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

Parameter
Name Description
key String
Returns
Type Description
String

getPythonFileUris(int index)

public String getPythonFileUris(int index)

Optional. HCFS URIs of Python files to pass to the PySpark framework.

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 URIs of Python files to pass to the PySpark framework.

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 URIs of Python files to pass to the PySpark framework.

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 URIs of Python files to pass to the PySpark framework.

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

Returns
Type Description
ProtocolStringList

A list containing the pythonFileUris.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PySparkNotebookBatch other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

putAllParams(Map<String,String> values)

public PySparkNotebookBatch.Builder putAllParams(Map<String,String> values)

Optional. The parameters to pass to the notebook.

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

Parameter
Name Description
values Map<String,String>
Returns
Type Description
PySparkNotebookBatch.Builder

putParams(String key, String value)

public PySparkNotebookBatch.Builder putParams(String key, String value)

Optional. The parameters to pass to the notebook.

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

Parameters
Name Description
key String
value String
Returns
Type Description
PySparkNotebookBatch.Builder

removeParams(String key)

public PySparkNotebookBatch.Builder removeParams(String key)

Optional. The parameters to pass to the notebook.

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

Parameter
Name Description
key String
Returns
Type Description
PySparkNotebookBatch.Builder

setArchiveUris(int index, String value)

public PySparkNotebookBatch.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
PySparkNotebookBatch.Builder

This builder for chaining.

setFileUris(int index, String value)

public PySparkNotebookBatch.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
PySparkNotebookBatch.Builder

This builder for chaining.

setJarFileUris(int index, String value)

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

Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

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

This builder for chaining.

setNotebookFileUri(String value)

public PySparkNotebookBatch.Builder setNotebookFileUri(String value)

Required. The HCFS URI of the notebook file to execute.

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

Parameter
Name Description
value String

The notebookFileUri to set.

Returns
Type Description
PySparkNotebookBatch.Builder

This builder for chaining.

setNotebookFileUriBytes(ByteString value)

public PySparkNotebookBatch.Builder setNotebookFileUriBytes(ByteString value)

Required. The HCFS URI of the notebook file to execute.

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

Parameter
Name Description
value ByteString

The bytes for notebookFileUri to set.

Returns
Type Description
PySparkNotebookBatch.Builder

This builder for chaining.

setPythonFileUris(int index, String value)

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

Optional. HCFS URIs of Python files to pass to the PySpark framework.

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

This builder for chaining.