Show / Hide Table of Contents

Class NotebookSession

Notebook sessions are interactive coding environments for data scientists.

Inheritance
object
NotebookSession
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DatascienceService.Models
Assembly: OCI.DotNetSDK.Datascience.dll
Syntax
public class NotebookSession

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the notebook session's compartment.

Remarks

Required

CreatedBy

Declaration
[Required(ErrorMessage = "CreatedBy is required.")]
[JsonProperty(PropertyName = "createdBy")]
public string CreatedBy { get; set; }
Property Value
Type Description
string

The OCID of the user who created the notebook session.

Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

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

Remarks

Required

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the notebook session.

Remarks

Required

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

Details about the state of the notebook session.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public NotebookSessionLifecycleState? LifecycleState { get; set; }
Property Value
Type Description
NotebookSessionLifecycleState?

The state of the notebook session.

Remarks

Required

NotebookSessionConfigDetails

Declaration
[JsonProperty(PropertyName = "notebookSessionConfigDetails")]
public NotebookSessionConfigDetails NotebookSessionConfigDetails { get; set; }
Property Value
Type Description
NotebookSessionConfigDetails

NotebookSessionConfigurationDetails

Declaration
[JsonProperty(PropertyName = "notebookSessionConfigurationDetails")]
public NotebookSessionConfigurationDetails NotebookSessionConfigurationDetails { get; set; }
Property Value
Type Description
NotebookSessionConfigurationDetails

NotebookSessionRuntimeConfigDetails

Declaration
[JsonProperty(PropertyName = "notebookSessionRuntimeConfigDetails")]
public NotebookSessionRuntimeConfigDetails NotebookSessionRuntimeConfigDetails { get; set; }
Property Value
Type Description
NotebookSessionRuntimeConfigDetails

NotebookSessionStorageMountConfigurationDetailsList

Declaration
[JsonProperty(PropertyName = "notebookSessionStorageMountConfigurationDetailsList")]
public List<StorageMountConfigurationDetails> NotebookSessionStorageMountConfigurationDetailsList { get; set; }
Property Value
Type Description
List<StorageMountConfigurationDetails>

Collection of NotebookSessionStorageMountConfigurationDetails.

NotebookSessionUrl

Declaration
[JsonProperty(PropertyName = "notebookSessionUrl")]
public string NotebookSessionUrl { get; set; }
Property Value
Type Description
string

The URL to interact with the notebook session.

ProjectId

Declaration
[Required(ErrorMessage = "ProjectId is required.")]
[JsonProperty(PropertyName = "projectId")]
public string ProjectId { get; set; }
Property Value
Type Description
string

The OCID of the project associated with the notebook session.

Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

Remarks

Required

In this article
Back to top