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, theHttpConfigurationManageris 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
- Returns
The notebook metadata.
- Raises
ApiException – if unable to communicate with the
/ninotebookservice 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
- Returns
The updated notebook metadata.
- Raises
ApiException – if unable to communicate with the
/ninotebookservice 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
/ninotebookservice 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
- Returns
The created notebook metadata.
- Raises
ApiException – if unable to communicate with the
/ninotebookservice or provided invalid arguments.
- query_notebooks(query)[source]
Queries notebooks.
- Parameters
query (
nisystemlink.clients.notebook.models.QueryNotebookRequest) – The query parameters.- Return type
- Returns
The paged notebooks.
- Raises
ApiException – if unable to communicate with the
/ninotebookservice 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
- Returns
A file-like object for reading the notebook content.
- Raises
ApiException – if unable to communicate with the
/ninotebookservice 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
/ninbexecutionService 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
- Returns
Information about the execution of a Jupyter notebook fetched using it’s Id.
- Raises
ApiException – if unable to communicate with the
/ninbexecutionService 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
- Returns
A response to a request to query executions.
- Raises
ApiException – if unable to communicate with the
/ninbexecutionService 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": { "notebook_id": { "minLength": 1, "title": "Notebook Id", "type": "string" }, "parameters": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" }, "workspace_id": { "minLength": 1, "title": "Workspace Id", "type": "string" }, "timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Timeout" }, "result_cache_period": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Result Cache Period" }, "report_settings": { "anyOf": [ { "$ref": "#/$defs/ReportSettings" }, { "type": "null" } ], "default": null }, "client_requests_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Client Requests Id" }, "priority": { "anyOf": [ { "$ref": "#/$defs/ExecutionPriority" }, { "type": "null" } ], "default": null }, "resource_profile": { "anyOf": [ { "$ref": "#/$defs/ExecutionResourceProfile" }, { "type": "null" } ], "default": null } }, "$defs": { "ExecutionPriority": { "description": "Execution priority. Can be one of Low, Medium or High.", "enum": [ "LOW", "MEDIUM", "HIGH" ], "title": "ExecutionPriority", "type": "string" }, "ExecutionResourceProfile": { "description": "Resource profile of the execution. Can be one of Low, Medium, High or Default.", "enum": [ "DEFAULT", "LOW", "MEDIUM", "HIGH" ], "title": "ExecutionResourceProfile", "type": "string" }, "ReportSettings": { "description": "A class that defines settings of the Report.", "properties": { "format": { "$ref": "#/$defs/ReportType" }, "exclude_code": { "title": "Exclude Code", "type": "boolean" } }, "required": [ "format", "exclude_code" ], "title": "ReportSettings", "type": "object" }, "ReportType": { "description": "Available types for a report that is going to be generated.", "enum": [ "NO_REPORT", "HTML", "PDF" ], "title": "ReportType", "type": "string" } }, "required": [ "notebook_id", "workspace_id" ] }
- Fields
-
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
min_length = 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
min_length = 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": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "executions": { "anyOf": [ { "items": { "$ref": "#/$defs/CreatedExecution" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Executions" } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resource_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Type" }, "resource_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resource Id" }, "inner_errors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Inner Errors", "type": "array" } }, "title": "ApiError", "type": "object" }, "CreatedExecution": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "notebook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Notebook Id" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Organization Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "User Id" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" }, "workspace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace Id" }, "timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Timeout" }, "status": { "anyOf": [ { "$ref": "#/$defs/ExecutionStatus" }, { "type": "null" } ], "default": null }, "queued_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Queued At" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Started At" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Completed At" }, "last_updated_timestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Last Updated Timestamp" }, "last_updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Last Updated By" }, "retry_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Retry Count" }, "exception": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exception" }, "error_code": { "anyOf": [ { "$ref": "#/$defs/ExecutionErrorCode" }, { "type": "null" } ], "default": null }, "report_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Report Id" }, "report_settings": { "anyOf": [ { "$ref": "#/$defs/ReportSettings" }, { "type": "null" } ], "default": null }, "result": { "anyOf": [ { "additionalProperties": { "anyOf": [ {}, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Result" }, "source": { "anyOf": [ { "$ref": "#/$defs/Source" }, { "type": "null" } ], "default": null }, "priority": { "anyOf": [ { "$ref": "#/$defs/ExecutionPriority" }, { "type": "null" } ], "default": null }, "resource_profile": { "anyOf": [ { "$ref": "#/$defs/ExecutionResourceProfile" }, { "type": "null" } ], "default": null }, "cached_result": { "title": "Cached Result", "type": "boolean" } }, "required": [ "cached_result" ], "title": "CreatedExecution", "type": "object" }, "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" ], "title": "ExecutionErrorCode", "type": "string" }, "ExecutionPriority": { "description": "Execution priority. Can be one of Low, Medium or High.", "enum": [ "LOW", "MEDIUM", "HIGH" ], "title": "ExecutionPriority", "type": "string" }, "ExecutionResourceProfile": { "description": "Resource profile of the execution. Can be one of Low, Medium, High or Default.", "enum": [ "DEFAULT", "LOW", "MEDIUM", "HIGH" ], "title": "ExecutionResourceProfile", "type": "string" }, "ExecutionStatus": { "description": "Status of an execution.", "enum": [ "IN_PROGRESS", "QUEUED", "FAILED", "SUCCEEDED", "CANCELED", "TIMED_OUT" ], "title": "ExecutionStatus", "type": "string" }, "ReportSettings": { "description": "A class that defines settings of the Report.", "properties": { "format": { "$ref": "#/$defs/ReportType" }, "exclude_code": { "title": "Exclude Code", "type": "boolean" } }, "required": [ "format", "exclude_code" ], "title": "ReportSettings", "type": "object" }, "ReportType": { "description": "Available types for a report that is going to be generated.", "enum": [ "NO_REPORT", "HTML", "PDF" ], "title": "ReportType", "type": "string" }, "Source": { "description": "An object that defines properties set by routine service.", "properties": { "type": { "$ref": "#/$defs/SourceType" }, "routine_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Routine Id" }, "event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Event Id" } }, "required": [ "type" ], "title": "Source", "type": "object" }, "SourceType": { "description": "Source type of an execution.", "enum": [ "MANUAL", "TRIGGERED" ], "title": "SourceType", "type": "string" } } }
- Fields
-
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", "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "notebook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Notebook Id" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Organization Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "User Id" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" }, "workspace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace Id" }, "timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Timeout" }, "status": { "anyOf": [ { "$ref": "#/$defs/ExecutionStatus" }, { "type": "null" } ], "default": null }, "queued_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Queued At" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Started At" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Completed At" }, "last_updated_timestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Last Updated Timestamp" }, "last_updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Last Updated By" }, "retry_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Retry Count" }, "exception": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exception" }, "error_code": { "anyOf": [ { "$ref": "#/$defs/ExecutionErrorCode" }, { "type": "null" } ], "default": null }, "report_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Report Id" }, "report_settings": { "anyOf": [ { "$ref": "#/$defs/ReportSettings" }, { "type": "null" } ], "default": null }, "result": { "anyOf": [ { "additionalProperties": { "anyOf": [ {}, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Result" }, "source": { "anyOf": [ { "$ref": "#/$defs/Source" }, { "type": "null" } ], "default": null }, "priority": { "anyOf": [ { "$ref": "#/$defs/ExecutionPriority" }, { "type": "null" } ], "default": null }, "resource_profile": { "anyOf": [ { "$ref": "#/$defs/ExecutionResourceProfile" }, { "type": "null" } ], "default": null }, "cached_result": { "title": "Cached Result", "type": "boolean" } }, "$defs": { "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" ], "title": "ExecutionErrorCode", "type": "string" }, "ExecutionPriority": { "description": "Execution priority. Can be one of Low, Medium or High.", "enum": [ "LOW", "MEDIUM", "HIGH" ], "title": "ExecutionPriority", "type": "string" }, "ExecutionResourceProfile": { "description": "Resource profile of the execution. Can be one of Low, Medium, High or Default.", "enum": [ "DEFAULT", "LOW", "MEDIUM", "HIGH" ], "title": "ExecutionResourceProfile", "type": "string" }, "ExecutionStatus": { "description": "Status of an execution.", "enum": [ "IN_PROGRESS", "QUEUED", "FAILED", "SUCCEEDED", "CANCELED", "TIMED_OUT" ], "title": "ExecutionStatus", "type": "string" }, "ReportSettings": { "description": "A class that defines settings of the Report.", "properties": { "format": { "$ref": "#/$defs/ReportType" }, "exclude_code": { "title": "Exclude Code", "type": "boolean" } }, "required": [ "format", "exclude_code" ], "title": "ReportSettings", "type": "object" }, "ReportType": { "description": "Available types for a report that is going to be generated.", "enum": [ "NO_REPORT", "HTML", "PDF" ], "title": "ReportType", "type": "string" }, "Source": { "description": "An object that defines properties set by routine service.", "properties": { "type": { "$ref": "#/$defs/SourceType" }, "routine_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Routine Id" }, "event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Event Id" } }, "required": [ "type" ], "title": "Source", "type": "object" }, "SourceType": { "description": "Source type of an execution.", "enum": [ "MANUAL", "TRIGGERED" ], "title": "SourceType", "type": "string" } }, "required": [ "cached_result" ] }
- Fields
-
field cached_result:
bool[Required] Returns true if the execution is returned from cache
- pydantic model nisystemlink.clients.notebook.models.Execution[source]
Jupyter notebook execution information.
Includes the cachedResult field.
Show JSON schema
{ "title": "Execution", "description": "Jupyter notebook execution information.\n\nIncludes the cachedResult field.", "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "notebook_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Notebook Id" }, "organization_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Organization Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "User Id" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" }, "workspace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace Id" }, "timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Timeout" }, "status": { "anyOf": [ { "$ref": "#/$defs/ExecutionStatus" }, { "type": "null" } ], "default": null }, "queued_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Queued At" }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Started At" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Completed At" }, "last_updated_timestamp": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Last Updated Timestamp" }, "last_updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Last Updated By" }, "retry_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Retry Count" }, "exception": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exception" }, "error_code": { "anyOf": [ { "$ref": "#/$defs/ExecutionErrorCode" }, { "type": "null" } ], "default": null }, "report_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Report Id" }, "report_settings": { "anyOf": [ { "$ref": "#/$defs/ReportSettings" }, { "type": "null" } ], "default": null }, "result": { "anyOf": [ { "additionalProperties": { "anyOf": [ {}, { "type": "null" } ] }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Result" }, "source": { "anyOf": [ { "$ref": "#/$defs/Source" }, { "type": "null" } ], "default": null }, "priority": { "anyOf": [ { "$ref": "#/$defs/ExecutionPriority" }, { "type": "null" } ], "default": null }, "resource_profile": { "anyOf": [ { "$ref": "#/$defs/ExecutionResourceProfile" }, { "type": "null" } ], "default": null } }, "$defs": { "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" ], "title": "ExecutionErrorCode", "type": "string" }, "ExecutionPriority": { "description": "Execution priority. Can be one of Low, Medium or High.", "enum": [ "LOW", "MEDIUM", "HIGH" ], "title": "ExecutionPriority", "type": "string" }, "ExecutionResourceProfile": { "description": "Resource profile of the execution. Can be one of Low, Medium, High or Default.", "enum": [ "DEFAULT", "LOW", "MEDIUM", "HIGH" ], "title": "ExecutionResourceProfile", "type": "string" }, "ExecutionStatus": { "description": "Status of an execution.", "enum": [ "IN_PROGRESS", "QUEUED", "FAILED", "SUCCEEDED", "CANCELED", "TIMED_OUT" ], "title": "ExecutionStatus", "type": "string" }, "ReportSettings": { "description": "A class that defines settings of the Report.", "properties": { "format": { "$ref": "#/$defs/ReportType" }, "exclude_code": { "title": "Exclude Code", "type": "boolean" } }, "required": [ "format", "exclude_code" ], "title": "ReportSettings", "type": "object" }, "ReportType": { "description": "Available types for a report that is going to be generated.", "enum": [ "NO_REPORT", "HTML", "PDF" ], "title": "ReportType", "type": "string" }, "Source": { "description": "An object that defines properties set by routine service.", "properties": { "type": { "$ref": "#/$defs/SourceType" }, "routine_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Routine Id" }, "event_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Event Id" } }, "required": [ "type" ], "title": "Source", "type": "object" }, "SourceType": { "description": "Source type of an execution.", "enum": [ "MANUAL", "TRIGGERED" ], "title": "SourceType", "type": "string" } } }
- Fields
-
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.
The keys are strings and the values can be 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 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.
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.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]
Resource profile of the execution. Can be one of Low, Medium, High or Default.
- class nisystemlink.clients.notebook.models.ExecutionSortField(value)[source]
Possible fields used to sort executions.
- 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": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Metadata" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } } }
-
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.
-
field created_at:
- 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": { "continuation_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuation Token" }, "notebooks": { "anyOf": [ { "items": { "$ref": "#/$defs/NotebookMetadata" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Notebooks" } }, "$defs": { "NotebookMetadata": { "description": "Metadata for a notebook.", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Created At" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated At" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Metadata" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Parameters" } }, "title": "NotebookMetadata", "type": "object" } } }
- Fields
-
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": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" }, "order_by": { "anyOf": [ { "$ref": "#/$defs/ExecutionSortField" }, { "type": "null" } ], "default": null }, "descending": { "default": false, "title": "Descending", "type": "boolean" }, "projection": { "default": [], "items": { "$ref": "#/$defs/ExecutionField" }, "title": "Projection", "type": "array" } }, "$defs": { "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" ], "title": "ExecutionField", "type": "string" }, "ExecutionSortField": { "description": "Possible fields used to sort executions.", "enum": [ "NOTEBOOK_ID", "EXECUTION_HASH", "TIMEOUT", "QUEUED_AT", "STARTED_AT", "COMPLETED_AT", "STATUS" ], "title": "ExecutionSortField", "type": "string" } } }
- Fields
-
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": { "continuation_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuation Token" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" }, "take": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "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.
-
field filter:
- 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": "#/$defs/ReportType" }, "exclude_code": { "title": "Exclude Code", "type": "boolean" } }, "$defs": { "ReportType": { "description": "Available types for a report that is going to be generated.", "enum": [ "NO_REPORT", "HTML", "PDF" ], "title": "ReportType", "type": "string" } }, "required": [ "format", "exclude_code" ] }
- Fields
-
field exclude_code:
bool[Required] Whether the source code should be included in the report.
-
field format:
ReportType[Required] Type for the report that is going to be generated.