Interface PySparkNotebookBatchOrBuilder (4.90.0)

public interface PySparkNotebookBatchOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsParams(String key)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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
Type Description
List<String>

A list containing the archiveUris.

getFileUris(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the fileUris.

getJarFileUris(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the jarFileUris.

getNotebookFileUri()

public abstract 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 abstract 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 abstract Map<String,String> getParams()

Use #getParamsMap() instead.

Returns
Type Description
Map<String,String>

getParamsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the pythonFileUris.