NotebookSession¶

class oci.data_science.models.NotebookSession(**kwargs)¶

Bases: object

Notebook sessions are interactive coding environments for data scientists.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a NotebookSession.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a NotebookSession.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a NotebookSession.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a NotebookSession.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a NotebookSession.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a NotebookSession.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a NotebookSession.
`compartment_id`	[Required] Gets the compartment_id of this NotebookSession.
`created_by`	[Required] Gets the created_by of this NotebookSession.
`defined_tags`	Gets the defined_tags of this NotebookSession.
`display_name`	[Required] Gets the display_name of this NotebookSession.
`freeform_tags`	Gets the freeform_tags of this NotebookSession.
`id`	[Required] Gets the id of this NotebookSession.
`lifecycle_details`	Gets the lifecycle_details of this NotebookSession.
`lifecycle_state`	[Required] Gets the lifecycle_state of this NotebookSession.
`notebook_session_config_details`	Gets the notebook_session_config_details of this NotebookSession.
`notebook_session_configuration_details`	Gets the notebook_session_configuration_details of this NotebookSession.
`notebook_session_runtime_config_details`	Gets the notebook_session_runtime_config_details of this NotebookSession.
`notebook_session_storage_mount_configuration_details_list`	Gets the notebook_session_storage_mount_configuration_details_list of this NotebookSession.
`notebook_session_url`	Gets the notebook_session_url of this NotebookSession.
`project_id`	[Required] Gets the project_id of this NotebookSession.
`time_created`	[Required] Gets the time_created of this NotebookSession.

Methods

__init__(**kwargs) Initializes a new NotebookSession object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a NotebookSession. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a NotebookSession. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a NotebookSession. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a NotebookSession. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a NotebookSession. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a NotebookSession. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a NotebookSession. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new NotebookSession object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this NotebookSession.
time_created (datetime) – The value to assign to the time_created property of this NotebookSession.
display_name (str) – The value to assign to the display_name property of this NotebookSession.
project_id (str) – The value to assign to the project_id property of this NotebookSession.
created_by (str) – The value to assign to the created_by property of this NotebookSession.
compartment_id (str) – The value to assign to the compartment_id property of this NotebookSession.
notebook_session_configuration_details (oci.data_science.models.NotebookSessionConfigurationDetails) – The value to assign to the notebook_session_configuration_details property of this NotebookSession.
notebook_session_config_details (oci.data_science.models.NotebookSessionConfigDetails) – The value to assign to the notebook_session_config_details property of this NotebookSession.
notebook_session_runtime_config_details (oci.data_science.models.NotebookSessionRuntimeConfigDetails) – The value to assign to the notebook_session_runtime_config_details property of this NotebookSession.
notebook_session_storage_mount_configuration_details_list (list[oci.data_science.models.StorageMountConfigurationDetails]) – The value to assign to the notebook_session_storage_mount_configuration_details_list property of this NotebookSession.
notebook_session_url (str) – The value to assign to the notebook_session_url property of this NotebookSession.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this NotebookSession. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this NotebookSession.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this NotebookSession.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this NotebookSession.

compartment_id¶

[Required] Gets the compartment_id of this NotebookSession. The OCID of the notebook session’s compartment.

Returns:	The compartment_id of this NotebookSession.
Return type:	str

created_by¶

[Required] Gets the created_by of this NotebookSession. The OCID of the user who created the notebook session.

Returns:	The created_by of this NotebookSession.
Return type:	str

defined_tags¶

Gets the defined_tags of this NotebookSession. Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this NotebookSession.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this NotebookSession. A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: My NotebookSession

Returns:	The display_name of this NotebookSession.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this NotebookSession. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this NotebookSession.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this NotebookSession. The OCID of the notebook session.

Returns:	The id of this NotebookSession.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this NotebookSession. Details about the state of the notebook session.

Returns:	The lifecycle_details of this NotebookSession.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this NotebookSession. The state of the notebook session.

Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this NotebookSession.
Return type:	str

notebook_session_config_details¶

Gets the notebook_session_config_details of this NotebookSession.

Returns:	The notebook_session_config_details of this NotebookSession.
Return type:	oci.data_science.models.NotebookSessionConfigDetails

notebook_session_configuration_details¶

Gets the notebook_session_configuration_details of this NotebookSession.

Returns:	The notebook_session_configuration_details of this NotebookSession.
Return type:	oci.data_science.models.NotebookSessionConfigurationDetails

notebook_session_runtime_config_details¶

Gets the notebook_session_runtime_config_details of this NotebookSession.

Returns:	The notebook_session_runtime_config_details of this NotebookSession.
Return type:	oci.data_science.models.NotebookSessionRuntimeConfigDetails

notebook_session_storage_mount_configuration_details_list¶

Gets the notebook_session_storage_mount_configuration_details_list of this NotebookSession. Collection of NotebookSessionStorageMountConfigurationDetails.

Returns:	The notebook_session_storage_mount_configuration_details_list of this NotebookSession.
Return type:	list[oci.data_science.models.StorageMountConfigurationDetails]

notebook_session_url¶

Gets the notebook_session_url of this NotebookSession. The URL to interact with the notebook session.

Returns:	The notebook_session_url of this NotebookSession.
Return type:	str

project_id¶

[Required] Gets the project_id of this NotebookSession. The OCID of the project associated with the notebook session.

Returns:	The project_id of this NotebookSession.
Return type:	str

time_created¶

[Required] Gets the time_created of this NotebookSession. The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

Returns:	The time_created of this NotebookSession.
Return type:	datetime