Class PySparkNotebookBatch (4.90.0)

public final class PySparkNotebookBatch extends GeneratedMessage implements PySparkNotebookBatchOrBuilder

A configuration for running a PySpark Notebook batch workload.

Protobuf type google.cloud.dataproc.v1.PySparkNotebookBatch

Static Fields

ARCHIVE_URIS_FIELD_NUMBER

public static final int ARCHIVE_URIS_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

NOTEBOOK_FILE_URI_FIELD_NUMBER

public static final int NOTEBOOK_FILE_URI_FIELD_NUMBER
Field Value
Type Description
int

PARAMS_FIELD_NUMBER

public static final int PARAMS_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 PySparkNotebookBatch getDefaultInstance()
Returns
Type Description
PySparkNotebookBatch

getDescriptor()

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

newBuilder()

public static PySparkNotebookBatch.Builder newBuilder()
Returns
Type Description
PySparkNotebookBatch.Builder

newBuilder(PySparkNotebookBatch prototype)

public static PySparkNotebookBatch.Builder newBuilder(PySparkNotebookBatch prototype)
Parameter
Name Description
prototype PySparkNotebookBatch
Returns
Type Description
PySparkNotebookBatch.Builder

parseDelimitedFrom(InputStream input)

public static PySparkNotebookBatch parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PySparkNotebookBatch
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PySparkNotebookBatch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PySparkNotebookBatch
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PySparkNotebookBatch parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PySparkNotebookBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PySparkNotebookBatch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PySparkNotebookBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PySparkNotebookBatch parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PySparkNotebookBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PySparkNotebookBatch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PySparkNotebookBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PySparkNotebookBatch parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PySparkNotebookBatch
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PySparkNotebookBatch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PySparkNotebookBatch
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PySparkNotebookBatch parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PySparkNotebookBatch
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PySparkNotebookBatch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PySparkNotebookBatch
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PySparkNotebookBatch parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PySparkNotebookBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PySparkNotebookBatch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PySparkNotebookBatch
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PySparkNotebookBatch> parser()
Returns
Type Description
Parser<PySparkNotebookBatch>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

getDefaultInstanceForType()

public PySparkNotebookBatch getDefaultInstanceForType()
Returns
Type Description
PySparkNotebookBatch

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.

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

getParserForType()

public Parser<PySparkNotebookBatch> getParserForType()
Returns
Type Description
Parser<PySparkNotebookBatch>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected PySparkNotebookBatch.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PySparkNotebookBatch.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException