NotebookSessionSummary¶

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

Bases: object

Summary information for a notebook session.

Attributes:

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

Methods:

__init__(**kwargs)

Initializes a new NotebookSessionSummary object with values from keyword arguments.

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new NotebookSessionSummary 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 NotebookSessionSummary.
time_created (datetime) – The value to assign to the time_created property of this NotebookSessionSummary.
display_name (str) – The value to assign to the display_name property of this NotebookSessionSummary.
project_id (str) – The value to assign to the project_id property of this NotebookSessionSummary.
created_by (str) – The value to assign to the created_by property of this NotebookSessionSummary.
compartment_id (str) – The value to assign to the compartment_id property of this NotebookSessionSummary.
notebook_session_configuration_details (oci.data_science.models.NotebookSessionConfigurationDetails) – The value to assign to the notebook_session_configuration_details property of this NotebookSessionSummary.
notebook_session_config_details (oci.data_science.models.NotebookSessionConfigDetails) – The value to assign to the notebook_session_config_details property of this NotebookSessionSummary.
notebook_session_url (str) – The value to assign to the notebook_session_url property of this NotebookSessionSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this NotebookSessionSummary. 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’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this NotebookSessionSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this NotebookSessionSummary.

property compartment_id¶

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

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

property created_by¶

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

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

property defined_tags¶

Gets the defined_tags of this NotebookSessionSummary. 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 NotebookSessionSummary.
Return type: dict(str, dict(str, object))

property display_name¶

[Required] Gets the display_name of this NotebookSessionSummary. 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 NotebookSessionSummary.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this NotebookSessionSummary. 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 NotebookSessionSummary.
Return type: dict(str, str)

property id¶

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

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this NotebookSessionSummary. 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 NotebookSessionSummary.
Return type: str

property notebook_session_config_details¶

Gets the notebook_session_config_details of this NotebookSessionSummary.

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

property notebook_session_configuration_details¶

Gets the notebook_session_configuration_details of this NotebookSessionSummary.

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

property notebook_session_url¶

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

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

property project_id¶

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

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

property time_created¶

[Required] Gets the time_created of this NotebookSessionSummary. 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 NotebookSessionSummary.
Return type: datetime