nisystemlink.clients.notebook

class nisystemlink.clients.notebook.NotebookClient(configuration=None)[source]

__init__(configuration=None)[source]

Initialize an instance.

Parameters: configuration (Optional[nisystemlink.clients.core.HttpConfiguration]) – Defines the web server to connect to and information about how to connect. If not provided, the HttpConfigurationManager is used to obtain the configuration.
Raises: ApiException – if unable to communicate with the Notebook Service.

get_notebook(id)[source]

Gets a notebook metadata by ID.

Parameters: id (str) – The ID of the notebook to read.
Return type: nisystemlink.clients.notebook.models.NotebookMetadata
Returns: The notebook metadata.
Raises: ApiException – if unable to communicate with the /ninotebook service or provided invalid arguments.

update_notebook(id, metadata=None, content=None)[source]

Updates a notebook metadata by ID.

Parameters

id (str) – The ID of the notebook to update.
metadata (Optional[nisystemlink.clients.notebook.models.NotebookMetadata]) – The notebook metadata.
content (Optional[io.BufferedReader]) – The notebook binary content.

Return type

nisystemlink.clients.notebook.models.NotebookMetadata

Returns

The updated notebook metadata.

Raises

ApiException – if unable to communicate with the /ninotebook service or provided invalid arguments.

delete_notebook(id)[source]

Deletes a notebook by ID.

Parameters: id (str) – The ID of the notebook to delete.
Raises: ApiException – if unable to communicate with the /ninotebook service or provided invalid arguments.
Return type: None

create_notebook(metadata, content)[source]

Creates a new notebook.

Parameters

metadata (nisystemlink.clients.notebook.models.NotebookMetadata) – The notebook metadata.
content (io.BufferedReader) – The notebook binary content.

Return type

nisystemlink.clients.notebook.models.NotebookMetadata

Returns

The created notebook metadata.

Raises

ApiException – if unable to communicate with the /ninotebook service or provided invalid arguments.

query_notebooks(query)[source]

Queries notebooks.

Parameters: query (nisystemlink.clients.notebook.models.QueryNotebookRequest) – The query parameters.
Return type: nisystemlink.clients.notebook.models.PagedNotebooks
Returns: The paged notebooks.
Raises: ApiException – if unable to communicate with the /ninotebook service or provided invalid arguments.

get_notebook_content(id)[source]

Gets a notebook content by ID.

Parameters: id (str) – The ID of the notebook to read.
Return type: nisystemlink.clients.core.helpers.IteratorFileLike
Returns: A file-like object for reading the notebook content.
Raises: ApiException – if unable to communicate with the /ninotebook service or provided invalid arguments.

create_executions(executions)[source]

Create one or more executions of Jupyter notebooks.

Parameters: execution – information about an execution of a Jupyter notebook.
Return type: nisystemlink.clients.notebook.models.CreateExecutionsResponse
Returns: A response to a request to create executions.
Raises: ApiException – if unable to communicate with the /ninbexecution Service or provided an invalid argument.

get_execution_by_id(id)[source]

Get information about the specified execution of a Jupyter notebook.

Parameters: id (str) – the ID of the execution.
Return type: nisystemlink.clients.notebook.models.Execution
Returns: Information about the execution of a Jupyter notebook fetched using it’s Id.
Raises: ApiException – if unable to communicate with the /ninbexecution Service or provided an invalid argument.

query_executions(query)[source]

Query executions of Jupyter notebooks.

Parameters: query (nisystemlink.clients.notebook.models.QueryExecutionsRequest) – query for executions of Jupyter notebooks.
Return type: List[nisystemlink.clients.notebook.models.Execution]
Returns: A response to a request to query executions.
Raises: ApiException – if unable to communicate with the /ninbexecution Service or provided an invalid argument.

pydantic model nisystemlink.clients.notebook.models.CreateExecutionRequest[source]

Creation information about an execution of a Jupyter notebook.

Show JSON schema

{
   "title": "CreateExecutionRequest",
   "description": "Creation information about an execution of a Jupyter notebook.",
   "type": "object",
   "properties": {
      "notebookId": {
         "title": "Notebookid",
         "minLength": 1,
         "type": "string"
      },
      "parameters": {
         "title": "Parameters",
         "type": "object",
         "additionalProperties": {
            "type": "string"
         }
      },
      "workspaceId": {
         "title": "Workspaceid",
         "minLength": 1,
         "type": "string"
      },
      "timeout": {
         "title": "Timeout",
         "type": "integer"
      },
      "resultCachePeriod": {
         "title": "Resultcacheperiod",
         "type": "integer"
      },
      "reportSettings": {
         "$ref": "#/definitions/ReportSettings"
      },
      "clientRequestsId": {
         "title": "Clientrequestsid",
         "type": "string"
      },
      "priority": {
         "$ref": "#/definitions/ExecutionPriority"
      },
      "resourceProfile": {
         "$ref": "#/definitions/ExecutionResourceProfile"
      }
   },
   "required": [
      "notebookId",
      "workspaceId"
   ],
   "definitions": {
      "ReportType": {
         "title": "ReportType",
         "description": "Available types for a report that is going to be generated.",
         "enum": [
            "NO_REPORT",
            "HTML",
            "PDF"
         ],
         "type": "string"
      },
      "ReportSettings": {
         "title": "ReportSettings",
         "description": "A class that defines settings of the Report",
         "type": "object",
         "properties": {
            "format": {
               "$ref": "#/definitions/ReportType"
            },
            "excludeCode": {
               "title": "Excludecode",
               "type": "boolean"
            }
         },
         "required": [
            "format",
            "excludeCode"
         ]
      },
      "ExecutionPriority": {
         "title": "ExecutionPriority",
         "description": "Execution priority. Can be one of Low, Medium or High.",
         "enum": [
            "LOW",
            "MEDIUM",
            "HIGH"
         ],
         "type": "string"
      },
      "ExecutionResourceProfile": {
         "title": "ExecutionResourceProfile",
         "description": "An enumeration.",
         "enum": [
            "DEFAULT",
            "LOW",
            "MEDIUM",
            "HIGH"
         ],
         "type": "string"
      }
   }
}

Fields

client_requests_id
notebook_id
parameters
priority
report_settings
resource_profile
result_cache_period
timeout
workspace_id

field client_requests_id: Optional[str] = None: The client request ID unique for each execution to be created. This is provided by the caller to be able to track executions that could not be created. The error response will contain this in the resourceId field. If not provided, the notebookId is used as the resourceId.

field notebook_id: str [Required]

The ID of the notebook to execute.

Constraints

minLength = 1

field parameters: Optional[Dict[str, Optional[str]]] = None: The input parameters for this execution of the notebook. The keys are strings and the values can be of any valid JSON type.

field priority: Optional[ExecutionPriority] = None: Execution priority. Can be one of Low, Medium or High.

field report_settings: Optional[ReportSettings] = None: Settings of the Report

field resource_profile: Optional[ExecutionResourceProfile] = None: Resource profile of the execution.

field result_cache_period: Optional[int] = None: The period of time, in seconds, when the result of a previous notebook execution can be used as the result of the current notebook execution. Results will only be reused if the notebook and input parameters match. A value of 0 means do not reuse results from any previous executions. A value of -1 means always reuse results if possible and return an error if not possible. This prevents actual execution of a notebook.

field timeout: Optional[int] = None: The number of seconds the execution runs before it aborts if uncompleted. The timer starts once status is IN_PROGRESS. 0 means infinite.

field workspace_id: str [Required]

The ID of the workspace this execution belongs to.

Constraints

minLength = 1

pydantic model nisystemlink.clients.notebook.models.CreateExecutionsResponse[source]

Model for response to a request to create an execution.

Show JSON schema

{
   "title": "CreateExecutionsResponse",
   "description": "Model for response to a request to create an execution.",
   "type": "object",
   "properties": {
      "error": {
         "$ref": "#/definitions/ApiError"
      },
      "executions": {
         "title": "Executions",
         "type": "array",
         "items": {
            "$ref": "#/definitions/CreatedExecution"
         }
      }
   },
   "definitions": {
      "ApiError": {
         "title": "ApiError",
         "description": "Represents the standard error structure for SystemLink API responses.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "code": {
               "title": "Code",
               "type": "integer"
            },
            "message": {
               "title": "Message",
               "type": "string"
            },
            "args": {
               "title": "Args",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string"
               }
            },
            "resourceType": {
               "title": "Resourcetype",
               "type": "string"
            },
            "resourceId": {
               "title": "Resourceid",
               "type": "string"
            },
            "innerErrors": {
               "title": "Innererrors",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ApiError"
               }
            }
         }
      },
      "ExecutionStatus": {
         "title": "ExecutionStatus",
         "description": "Status of an execution.",
         "enum": [
            "IN_PROGRESS",
            "QUEUED",
            "FAILED",
            "SUCCEEDED",
            "CANCELED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "ExecutionErrorCode": {
         "title": "ExecutionErrorCode",
         "description": "Execution error code.",
         "enum": [
            "NO_ERROR",
            "NOTEBOOK_ERROR",
            "NOTEBOOK_TIMEOUT_ERROR",
            "NOTEBOOK_NOT_FOUND_ERROR",
            "NOTEBOOK_RESULT_TOO_BIG_ERROR",
            "NOT_PUBLISHED_ERROR",
            "OUT_OF_MEMORY_ERROR",
            "UNKNOWN_ERROR",
            "DEAD_KERNEL_ERROR",
            "EXECUTION_COULD_NOT_BE_RETRIED"
         ],
         "type": "string"
      },
      "ReportType": {
         "title": "ReportType",
         "description": "Available types for a report that is going to be generated.",
         "enum": [
            "NO_REPORT",
            "HTML",
            "PDF"
         ],
         "type": "string"
      },
      "ReportSettings": {
         "title": "ReportSettings",
         "description": "A class that defines settings of the Report",
         "type": "object",
         "properties": {
            "format": {
               "$ref": "#/definitions/ReportType"
            },
            "excludeCode": {
               "title": "Excludecode",
               "type": "boolean"
            }
         },
         "required": [
            "format",
            "excludeCode"
         ]
      },
      "SourceType": {
         "title": "SourceType",
         "description": "Source type of an execution",
         "enum": [
            "MANUAL",
            "TRIGGERED"
         ],
         "type": "string"
      },
      "Source": {
         "title": "Source",
         "description": "An object that defines properties set by routine service",
         "type": "object",
         "properties": {
            "type": {
               "$ref": "#/definitions/SourceType"
            },
            "routineId": {
               "title": "Routineid",
               "type": "string"
            },
            "eventId": {
               "title": "Eventid",
               "type": "string"
            }
         },
         "required": [
            "type"
         ]
      },
      "ExecutionPriority": {
         "title": "ExecutionPriority",
         "description": "Execution priority. Can be one of Low, Medium or High.",
         "enum": [
            "LOW",
            "MEDIUM",
            "HIGH"
         ],
         "type": "string"
      },
      "ExecutionResourceProfile": {
         "title": "ExecutionResourceProfile",
         "description": "An enumeration.",
         "enum": [
            "DEFAULT",
            "LOW",
            "MEDIUM",
            "HIGH"
         ],
         "type": "string"
      },
      "CreatedExecution": {
         "title": "CreatedExecution",
         "description": "Information about an execution of a Jupyter notebook that has the cachedResult field added.",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "string"
            },
            "notebookId": {
               "title": "Notebookid",
               "type": "string"
            },
            "orgId": {
               "title": "Orgid",
               "type": "string"
            },
            "userId": {
               "title": "Userid",
               "type": "string"
            },
            "parameters": {
               "title": "Parameters",
               "type": "object"
            },
            "workspaceId": {
               "title": "Workspaceid",
               "type": "string"
            },
            "timeout": {
               "title": "Timeout",
               "type": "integer"
            },
            "status": {
               "$ref": "#/definitions/ExecutionStatus"
            },
            "queuedAt": {
               "title": "Queuedat",
               "type": "string",
               "format": "date-time"
            },
            "startedAt": {
               "title": "Startedat",
               "type": "string",
               "format": "date-time"
            },
            "completedAt": {
               "title": "Completedat",
               "type": "string",
               "format": "date-time"
            },
            "lastUpdatedTimestamp": {
               "title": "Lastupdatedtimestamp",
               "type": "string",
               "format": "date-time"
            },
            "lastUpdatedBy": {
               "title": "Lastupdatedby",
               "type": "string"
            },
            "retryCount": {
               "title": "Retrycount",
               "type": "integer"
            },
            "exception": {
               "title": "Exception",
               "type": "string"
            },
            "errorCode": {
               "$ref": "#/definitions/ExecutionErrorCode"
            },
            "reportId": {
               "title": "Reportid",
               "type": "string"
            },
            "reportSettings": {
               "$ref": "#/definitions/ReportSettings"
            },
            "result": {
               "title": "Result",
               "type": "object"
            },
            "source": {
               "$ref": "#/definitions/Source"
            },
            "priority": {
               "$ref": "#/definitions/ExecutionPriority"
            },
            "resourceProfile": {
               "$ref": "#/definitions/ExecutionResourceProfile"
            },
            "cachedResult": {
               "title": "Cachedresult",
               "type": "boolean"
            }
         },
         "required": [
            "cachedResult"
         ]
      }
   }
}

Fields

error
executions

field error: Optional[ApiError] = None: The error that occurred during the request, if any.

field executions: Optional[List[CreatedExecution]] = None: Gets or sets the collection of authorized executions.

pydantic model nisystemlink.clients.notebook.models.CreatedExecution[source]

Show JSON schema

{
   "title": "CreatedExecution",
   "description": "Information about an execution of a Jupyter notebook that has the cachedResult field added.",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "string"
      },
      "notebookId": {
         "title": "Notebookid",
         "type": "string"
      },
      "orgId": {
         "title": "Orgid",
         "type": "string"
      },
      "userId": {
         "title": "Userid",
         "type": "string"
      },
      "parameters": {
         "title": "Parameters",
         "type": "object"
      },
      "workspaceId": {
         "title": "Workspaceid",
         "type": "string"
      },
      "timeout": {
         "title": "Timeout",
         "type": "integer"
      },
      "status": {
         "$ref": "#/definitions/ExecutionStatus"
      },
      "queuedAt": {
         "title": "Queuedat",
         "type": "string",
         "format": "date-time"
      },
      "startedAt": {
         "title": "Startedat",
         "type": "string",
         "format": "date-time"
      },
      "completedAt": {
         "title": "Completedat",
         "type": "string",
         "format": "date-time"
      },
      "lastUpdatedTimestamp": {
         "title": "Lastupdatedtimestamp",
         "type": "string",
         "format": "date-time"
      },
      "lastUpdatedBy": {
         "title": "Lastupdatedby",
         "type": "string"
      },
      "retryCount": {
         "title": "Retrycount",
         "type": "integer"
      },
      "exception": {
         "title": "Exception",
         "type": "string"
      },
      "errorCode": {
         "$ref": "#/definitions/ExecutionErrorCode"
      },
      "reportId": {
         "title": "Reportid",
         "type": "string"
      },
      "reportSettings": {
         "$ref": "#/definitions/ReportSettings"
      },
      "result": {
         "title": "Result",
         "type": "object"
      },
      "source": {
         "$ref": "#/definitions/Source"
      },
      "priority": {
         "$ref": "#/definitions/ExecutionPriority"
      },
      "resourceProfile": {
         "$ref": "#/definitions/ExecutionResourceProfile"
      },
      "cachedResult": {
         "title": "Cachedresult",
         "type": "boolean"
      }
   },
   "required": [
      "cachedResult"
   ],
   "definitions": {
      "ExecutionStatus": {
         "title": "ExecutionStatus",
         "description": "Status of an execution.",
         "enum": [
            "IN_PROGRESS",
            "QUEUED",
            "FAILED",
            "SUCCEEDED",
            "CANCELED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "ExecutionErrorCode": {
         "title": "ExecutionErrorCode",
         "description": "Execution error code.",
         "enum": [
            "NO_ERROR",
            "NOTEBOOK_ERROR",
            "NOTEBOOK_TIMEOUT_ERROR",
            "NOTEBOOK_NOT_FOUND_ERROR",
            "NOTEBOOK_RESULT_TOO_BIG_ERROR",
            "NOT_PUBLISHED_ERROR",
            "OUT_OF_MEMORY_ERROR",
            "UNKNOWN_ERROR",
            "DEAD_KERNEL_ERROR",
            "EXECUTION_COULD_NOT_BE_RETRIED"
         ],
         "type": "string"
      },
      "ReportType": {
         "title": "ReportType",
         "description": "Available types for a report that is going to be generated.",
         "enum": [
            "NO_REPORT",
            "HTML",
            "PDF"
         ],
         "type": "string"
      },
      "ReportSettings": {
         "title": "ReportSettings",
         "description": "A class that defines settings of the Report",
         "type": "object",
         "properties": {
            "format": {
               "$ref": "#/definitions/ReportType"
            },
            "excludeCode": {
               "title": "Excludecode",
               "type": "boolean"
            }
         },
         "required": [
            "format",
            "excludeCode"
         ]
      },
      "SourceType": {
         "title": "SourceType",
         "description": "Source type of an execution",
         "enum": [
            "MANUAL",
            "TRIGGERED"
         ],
         "type": "string"
      },
      "Source": {
         "title": "Source",
         "description": "An object that defines properties set by routine service",
         "type": "object",
         "properties": {
            "type": {
               "$ref": "#/definitions/SourceType"
            },
            "routineId": {
               "title": "Routineid",
               "type": "string"
            },
            "eventId": {
               "title": "Eventid",
               "type": "string"
            }
         },
         "required": [
            "type"
         ]
      },
      "ExecutionPriority": {
         "title": "ExecutionPriority",
         "description": "Execution priority. Can be one of Low, Medium or High.",
         "enum": [
            "LOW",
            "MEDIUM",
            "HIGH"
         ],
         "type": "string"
      },
      "ExecutionResourceProfile": {
         "title": "ExecutionResourceProfile",
         "description": "An enumeration.",
         "enum": [
            "DEFAULT",
            "LOW",
            "MEDIUM",
            "HIGH"
         ],
         "type": "string"
      }
   }
}

Fields

cached_result

field cached_result: bool [Required]: Returns true if the execution is returned from cache

pydantic model nisystemlink.clients.notebook.models.Execution[source]

Information about an execution of a Jupyter notebook that has the cachedResult field added.

Show JSON schema

{
   "title": "Execution",
   "description": "Information about an execution of a Jupyter notebook that has the cachedResult field added.",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "string"
      },
      "notebookId": {
         "title": "Notebookid",
         "type": "string"
      },
      "orgId": {
         "title": "Orgid",
         "type": "string"
      },
      "userId": {
         "title": "Userid",
         "type": "string"
      },
      "parameters": {
         "title": "Parameters",
         "type": "object"
      },
      "workspaceId": {
         "title": "Workspaceid",
         "type": "string"
      },
      "timeout": {
         "title": "Timeout",
         "type": "integer"
      },
      "status": {
         "$ref": "#/definitions/ExecutionStatus"
      },
      "queuedAt": {
         "title": "Queuedat",
         "type": "string",
         "format": "date-time"
      },
      "startedAt": {
         "title": "Startedat",
         "type": "string",
         "format": "date-time"
      },
      "completedAt": {
         "title": "Completedat",
         "type": "string",
         "format": "date-time"
      },
      "lastUpdatedTimestamp": {
         "title": "Lastupdatedtimestamp",
         "type": "string",
         "format": "date-time"
      },
      "lastUpdatedBy": {
         "title": "Lastupdatedby",
         "type": "string"
      },
      "retryCount": {
         "title": "Retrycount",
         "type": "integer"
      },
      "exception": {
         "title": "Exception",
         "type": "string"
      },
      "errorCode": {
         "$ref": "#/definitions/ExecutionErrorCode"
      },
      "reportId": {
         "title": "Reportid",
         "type": "string"
      },
      "reportSettings": {
         "$ref": "#/definitions/ReportSettings"
      },
      "result": {
         "title": "Result",
         "type": "object"
      },
      "source": {
         "$ref": "#/definitions/Source"
      },
      "priority": {
         "$ref": "#/definitions/ExecutionPriority"
      },
      "resourceProfile": {
         "$ref": "#/definitions/ExecutionResourceProfile"
      }
   },
   "definitions": {
      "ExecutionStatus": {
         "title": "ExecutionStatus",
         "description": "Status of an execution.",
         "enum": [
            "IN_PROGRESS",
            "QUEUED",
            "FAILED",
            "SUCCEEDED",
            "CANCELED",
            "TIMED_OUT"
         ],
         "type": "string"
      },
      "ExecutionErrorCode": {
         "title": "ExecutionErrorCode",
         "description": "Execution error code.",
         "enum": [
            "NO_ERROR",
            "NOTEBOOK_ERROR",
            "NOTEBOOK_TIMEOUT_ERROR",
            "NOTEBOOK_NOT_FOUND_ERROR",
            "NOTEBOOK_RESULT_TOO_BIG_ERROR",
            "NOT_PUBLISHED_ERROR",
            "OUT_OF_MEMORY_ERROR",
            "UNKNOWN_ERROR",
            "DEAD_KERNEL_ERROR",
            "EXECUTION_COULD_NOT_BE_RETRIED"
         ],
         "type": "string"
      },
      "ReportType": {
         "title": "ReportType",
         "description": "Available types for a report that is going to be generated.",
         "enum": [
            "NO_REPORT",
            "HTML",
            "PDF"
         ],
         "type": "string"
      },
      "ReportSettings": {
         "title": "ReportSettings",
         "description": "A class that defines settings of the Report",
         "type": "object",
         "properties": {
            "format": {
               "$ref": "#/definitions/ReportType"
            },
            "excludeCode": {
               "title": "Excludecode",
               "type": "boolean"
            }
         },
         "required": [
            "format",
            "excludeCode"
         ]
      },
      "SourceType": {
         "title": "SourceType",
         "description": "Source type of an execution",
         "enum": [
            "MANUAL",
            "TRIGGERED"
         ],
         "type": "string"
      },
      "Source": {
         "title": "Source",
         "description": "An object that defines properties set by routine service",
         "type": "object",
         "properties": {
            "type": {
               "$ref": "#/definitions/SourceType"
            },
            "routineId": {
               "title": "Routineid",
               "type": "string"
            },
            "eventId": {
               "title": "Eventid",
               "type": "string"
            }
         },
         "required": [
            "type"
         ]
      },
      "ExecutionPriority": {
         "title": "ExecutionPriority",
         "description": "Execution priority. Can be one of Low, Medium or High.",
         "enum": [
            "LOW",
            "MEDIUM",
            "HIGH"
         ],
         "type": "string"
      },
      "ExecutionResourceProfile": {
         "title": "ExecutionResourceProfile",
         "description": "An enumeration.",
         "enum": [
            "DEFAULT",
            "LOW",
            "MEDIUM",
            "HIGH"
         ],
         "type": "string"
      }
   }
}

field completed_at: Optional[datetime] = None: Timestamp of when the notebook execution was completed.

field error_code: Optional[ExecutionErrorCode] = None: Execution error code.

field exception: Optional[str] = None: Exception that occured during the execution. This is used only when status is FAILED.

field id: Optional[str] = None: The ID of the execution.

field last_updated_by: Optional[str] = None: “The user ID of the user who last updated the execution.

field last_updated_timestamp: Optional[datetime] = None: Timestamp of when the notebook execution was last updated.

field notebook_id: Optional[str] = None: The ID of the executed notebook.

field organization_id: Optional[str] = None: The org ID of the user creating the request.

field parameters: Optional[Dict[str, Any]] = None: The input parameters for this execution of the notebook. The keys are strings and the values can be of any valid JSON type.

field priority: Optional[ExecutionPriority] = None: Execution priority. Can be one of Low, Medium or High.

field queued_at: Optional[datetime] = None: Timestamp of when the notebook execution was queued.

field report_id: Optional[str] = None: The ID of the report this execution generates.

field report_settings: Optional[ReportSettings] = None: Settings of the Report

field resource_profile: Optional[ExecutionResourceProfile] = None: Resource profile of the execution.

field result: Optional[Dict[str, Optional[object]]] = None: Result of the execution. This is used only when status is SUCCEEDED.

field retry_count: Optional[int] = None: The number of manually retried attempts of the notebook execution.

field source: Optional[Source] = None: An object that defines properties set by routine service

field started_at: Optional[datetime] = None: Timestamp of when the notebook execution was started.

field status: Optional[ExecutionStatus] = None: Status of an execution.

field timeout: Optional[int] = None: The number of seconds the execution runs before it aborts if uncompleted. The timer starts once status is IN_PROGRESS. 0 means infinite.

field user_id: Optional[str] = None: The user ID of the user creating the request.

field workspace_id: Optional[str] = None: The ID of the workspace this execution belongs to.

class nisystemlink.clients.notebook.models.ExecutionErrorCode(value)[source]: Execution error code.

class nisystemlink.clients.notebook.models.ExecutionField(value)[source]: Possible fields in executions.

class nisystemlink.clients.notebook.models.ExecutionPriority(value)[source]: Execution priority. Can be one of Low, Medium or High.

class nisystemlink.clients.notebook.models.ExecutionResourceProfile(value)[source]: An enumeration.

class nisystemlink.clients.notebook.models.ExecutionSortField(value)[source]: Possible fields used to sort executions.

class nisystemlink.clients.notebook.models.ExecutionStatus(value)[source]: Status of an execution.

pydantic model nisystemlink.clients.notebook.models.NotebookMetadata[source]

Metadata for a notebook.

Show JSON schema

{
   "title": "NotebookMetadata",
   "description": "Metadata for a notebook.",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "workspace": {
         "title": "Workspace",
         "type": "string"
      },
      "createdBy": {
         "title": "Createdby",
         "type": "string"
      },
      "updatedBy": {
         "title": "Updatedby",
         "type": "string"
      },
      "createdAt": {
         "title": "Createdat",
         "type": "string",
         "format": "date-time"
      },
      "updatedAt": {
         "title": "Updatedat",
         "type": "string",
         "format": "date-time"
      },
      "properties": {
         "title": "Properties",
         "type": "object",
         "additionalProperties": {
            "type": "string"
         }
      },
      "metadata": {
         "title": "Metadata",
         "type": "object"
      },
      "parameters": {
         "title": "Parameters",
         "type": "object"
      }
   }
}

Fields

created_at
created_by
id
metadata
name
parameters
properties
updated_at
updated_by
workspace

field created_at: Optional[datetime] = None: The created timestamp (ISO8601 format).

field created_by: Optional[str] = None: The Id of the user that created the notebook.

field id: Optional[str] = None: The ID of the notebook.

field metadata: Optional[Dict[str, Any]] = None: The metadata of the notebook.

field name: Optional[str] = None: The name of the notebook.

field parameters: Optional[Dict[str, Any]] = None: The parameters of the notebook.

field properties: Optional[Dict[str, str]] = None: A map of key value properties associated with the notebook.

field updated_at: Optional[datetime] = None: The last updated timestamp (ISO8601 format).

field updated_by: Optional[str] = None: The Id of the user that last updated the notebook.

field workspace: Optional[str] = None: The Id of the workspace containing the notebook.

pydantic model nisystemlink.clients.notebook.models.PagedNotebooks[source]

Model for a query notebooks response.

Show JSON schema

{
   "title": "PagedNotebooks",
   "description": "Model for a query notebooks response.",
   "type": "object",
   "properties": {
      "continuationToken": {
         "title": "Continuationtoken",
         "type": "string"
      },
      "notebooks": {
         "title": "Notebooks",
         "type": "array",
         "items": {
            "$ref": "#/definitions/NotebookMetadata"
         }
      }
   },
   "definitions": {
      "NotebookMetadata": {
         "title": "NotebookMetadata",
         "description": "Metadata for a notebook.",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "workspace": {
               "title": "Workspace",
               "type": "string"
            },
            "createdBy": {
               "title": "Createdby",
               "type": "string"
            },
            "updatedBy": {
               "title": "Updatedby",
               "type": "string"
            },
            "createdAt": {
               "title": "Createdat",
               "type": "string",
               "format": "date-time"
            },
            "updatedAt": {
               "title": "Updatedat",
               "type": "string",
               "format": "date-time"
            },
            "properties": {
               "title": "Properties",
               "type": "object",
               "additionalProperties": {
                  "type": "string"
               }
            },
            "metadata": {
               "title": "Metadata",
               "type": "object"
            },
            "parameters": {
               "title": "Parameters",
               "type": "object"
            }
         }
      }
   }
}

Fields

notebooks

field notebooks: Optional[List[NotebookMetadata]] = None: The list of notebooks.

pydantic model nisystemlink.clients.notebook.models.QueryExecutionsRequest[source]

Query for executions of Jupyter notebooks.

Show JSON schema

{
   "title": "QueryExecutionsRequest",
   "description": "Query for executions of Jupyter notebooks.",
   "type": "object",
   "properties": {
      "filter": {
         "title": "Filter",
         "type": "string"
      },
      "orderBy": {
         "$ref": "#/definitions/ExecutionSortField"
      },
      "descending": {
         "title": "Descending",
         "default": false,
         "type": "boolean"
      },
      "projection": {
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/ExecutionField"
         }
      }
   },
   "definitions": {
      "ExecutionSortField": {
         "title": "ExecutionSortField",
         "description": "Possible fields used to sort executions.",
         "enum": [
            "NOTEBOOK_ID",
            "EXECUTION_HASH",
            "TIMEOUT",
            "QUEUED_AT",
            "STARTED_AT",
            "COMPLETED_AT",
            "STATUS"
         ],
         "type": "string"
      },
      "ExecutionField": {
         "title": "ExecutionField",
         "description": "Possible fields in executions.",
         "enum": [
            "id",
            "notebookId",
            "orgId",
            "userId",
            "parameters",
            "workspaceId",
            "timeout",
            "status",
            "queuedAt",
            "startedAt",
            "completedAt",
            "lastUpdatedTimestamp",
            "exception",
            "errorCode",
            "reportId",
            "reportSettings",
            "result",
            "source",
            "priority",
            "resourceProfile"
         ],
         "type": "string"
      }
   }
}

Fields

descending
filter
order_by
projection

field descending: bool = False: Whether to return the executions in descending order.

field filter: Optional[str] = None: The query filter in Dynamic LINQ.

field order_by: Optional[ExecutionSortField] = None: Possible fields used to sort executions.

field projection: List[ExecutionField] = []: The projection to be applied for the items in the provider.

pydantic model nisystemlink.clients.notebook.models.QueryNotebookRequest[source]

Model for a query notebooks request.

Show JSON schema

{
   "title": "QueryNotebookRequest",
   "description": "Model for a query notebooks request.",
   "type": "object",
   "properties": {
      "continuationToken": {
         "title": "Continuationtoken",
         "type": "string"
      },
      "filter": {
         "title": "Filter",
         "type": "string"
      },
      "take": {
         "title": "Take",
         "type": "integer"
      }
   }
}

Fields

filter
take

field filter: Optional[str] = None: The filter criteria for notebook, consisting of a string of queries composed using AND/OR operators. String values need to be enclosed in double quotes. Parenthesis can be used within the filter to better define the order of operations. Filter syntax: ‘[property name][operator][operand] and [property name][operator][operand]’ Operators:

Equals operator ‘=’. Example: ‘x = y’ Not equal operator ‘!=’. Example: ‘x != y’ Greater than operator ‘>’. Example: ‘x > y’ Greater than or equal operator ‘>=’. Example: ‘x >= y’ Less than operator ‘<’. Example: ‘x < y’ Less than or equal operator ‘<=’. Example: ‘x <= y’ Logical AND operator ‘and’. Example: ‘x and y’ Logical OR operator ‘or’. Example: ‘x or y’ Starts with operator ‘.StartsWith()’, used to check whether a string starts with another string. Example: ‘x.StartsWith(y)’ Does not start with operator ‘!.StartsWith()’, used to check whether a string does not start with another string. Example: ‘!x.StartsWith(y)’ String null or empty ‘string.IsNullOrEmpty()’, used to check whether a string is null or empty. Example: ‘string.IsNullOrEmpty(x)’ String is not null or empty ‘!string.IsNullOrEmpty()’, used to check whether a string is not null or empty. Example: ‘!string.IsNullOrEmpty(x)’

Valid notebook properties that can be used in the filter:

id name properties.interface workspace

field take: Optional[int] = None: The maximum number of notebooks to return.

pydantic model nisystemlink.clients.notebook.models.ReportSettings[source]

A class that defines settings of the Report

Show JSON schema

{
   "title": "ReportSettings",
   "description": "A class that defines settings of the Report",
   "type": "object",
   "properties": {
      "format": {
         "$ref": "#/definitions/ReportType"
      },
      "excludeCode": {
         "title": "Excludecode",
         "type": "boolean"
      }
   },
   "required": [
      "format",
      "excludeCode"
   ],
   "definitions": {
      "ReportType": {
         "title": "ReportType",
         "description": "Available types for a report that is going to be generated.",
         "enum": [
            "NO_REPORT",
            "HTML",
            "PDF"
         ],
         "type": "string"
      }
   }
}

Fields

exclude_code
format

field exclude_code: bool [Required]: Boolean parameter that will define if the source code should be included in the report or not.

field format: ReportType [Required]: Type for the report that is going to be generated.

class nisystemlink.clients.notebook.models.ReportType(value)[source]: Available types for a report that is going to be generated.

class nisystemlink.clients.notebook.models.SourceType(value)[source]: Source type of an execution