Package ganymede.jupyter.notebook.model

Class KernelSpecFile

java.lang.Object

ganymede.jupyter.notebook.model.KernelSpecFile

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.6.0")
public class KernelSpecFile
extends Object

Kernel spec json file

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_ARGV
static String	JSON_PROPERTY_CODEMIRROR_MODE
static String	JSON_PROPERTY_DISPLAY_NAME
static String	JSON_PROPERTY_ENV
static String	JSON_PROPERTY_HELP_LINKS
static String	JSON_PROPERTY_LANGUAGE

Constructor Summary

Constructors

Constructor	Description
KernelSpecFile()

Method Summary

Modifier and Type	Method	Description
KernelSpecFile	addArgvItem(String argvItem)
KernelSpecFile	addHelpLinksItem(KernelSpecFileHelpLinksInner helpLinksItem)
KernelSpecFile	argv(List<String> argv)
KernelSpecFile	codemirrorMode(String codemirrorMode)
KernelSpecFile	displayName(String displayName)
KernelSpecFile	env(Map<String,String> env)
boolean	equals(Object o)	Return true if this KernelSpecFile object is equal to o.
List<String>	getArgv()	A list of command line arguments used to start the kernel.
String	getCodemirrorMode()	Codemirror mode.
String	getDisplayName()	The kernel's name as it should be displayed in the UI.
Map<String,String>	getEnv()	A dictionary of environment variables to set for the kernel.
List<KernelSpecFileHelpLinksInner>	getHelpLinks()	Help items to be displayed in the help menu in the notebook UI.
String	getLanguage()	The programming language which this kernel runs.
int	hashCode()
KernelSpecFile	helpLinks(List<KernelSpecFileHelpLinksInner> helpLinks)
KernelSpecFile	language(String language)
KernelSpecFile	putEnvItem(String key, String envItem)
void	setArgv(List<String> argv)
void	setCodemirrorMode(String codemirrorMode)
void	setDisplayName(String displayName)
void	setEnv(Map<String,String> env)
void	setHelpLinks(List<KernelSpecFileHelpLinksInner> helpLinks)
void	setLanguage(String language)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_LANGUAGE

public static final String JSON_PROPERTY_LANGUAGE

See Also:

Constant Field Values

JSON_PROPERTY_ARGV

public static final String JSON_PROPERTY_ARGV

See Also:

Constant Field Values

JSON_PROPERTY_DISPLAY_NAME

public static final String JSON_PROPERTY_DISPLAY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_CODEMIRROR_MODE

public static final String JSON_PROPERTY_CODEMIRROR_MODE

See Also:

Constant Field Values

JSON_PROPERTY_ENV

public static final String JSON_PROPERTY_ENV

See Also:

Constant Field Values

JSON_PROPERTY_HELP_LINKS

public static final String JSON_PROPERTY_HELP_LINKS

See Also:

Constant Field Values

Constructor Detail

KernelSpecFile

public KernelSpecFile()

Method Detail

language

public KernelSpecFile language(String language)

getLanguage

@Nonnull
public String getLanguage()

The programming language which this kernel runs. This will be stored in notebook metadata.

Returns:

language

setLanguage

public void setLanguage(String language)

argv

public KernelSpecFile argv(List<String> argv)

addArgvItem

public KernelSpecFile addArgvItem(String argvItem)

getArgv

@Nonnull
public List<String> getArgv()

A list of command line arguments used to start the kernel. The text `{connection_file}` in any argument will be replaced with the path to the connection file.

Returns:

argv

setArgv

public void setArgv(List<String> argv)

displayName

public KernelSpecFile displayName(String displayName)

getDisplayName

@Nonnull
public String getDisplayName()

The kernel's name as it should be displayed in the UI. Unlike the kernel name used in the API, this can contain arbitrary unicode characters.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

codemirrorMode

public KernelSpecFile codemirrorMode(String codemirrorMode)

getCodemirrorMode

@Nullable
public String getCodemirrorMode()

Codemirror mode. Can be a string *or* an valid Codemirror mode object. This defaults to the string from the `language` property.

Returns:

codemirrorMode

setCodemirrorMode

public void setCodemirrorMode(String codemirrorMode)

env

public KernelSpecFile env(Map<String,String> env)

putEnvItem

public KernelSpecFile putEnvItem(String key,
                                 String envItem)

getEnv

@Nullable
public Map<String,String> getEnv()

A dictionary of environment variables to set for the kernel. These will be added to the current environment variables.

Returns:

env

setEnv

public void setEnv(Map<String,String> env)

helpLinks

public KernelSpecFile helpLinks(List<KernelSpecFileHelpLinksInner> helpLinks)

addHelpLinksItem

public KernelSpecFile addHelpLinksItem(KernelSpecFileHelpLinksInner helpLinksItem)

getHelpLinks

@Nullable
public List<KernelSpecFileHelpLinksInner> getHelpLinks()

Help items to be displayed in the help menu in the notebook UI.

Returns:

helpLinks

setHelpLinks

public void setHelpLinks(List<KernelSpecFileHelpLinksInner> helpLinks)

equals

public boolean equals(Object o)

Return true if this KernelSpecFile object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string