DataSphere API v2, gRPC: ProjectService.Execute
Executes code of the specified notebook using configuration defined in the project settings. If the default project configuration is not specified, c1.4
is used.
gRPC request
rpc Execute (ProjectExecutionRequest) returns (operation.Operation)
ProjectExecutionRequest
{
"projectId": "string",
// Includes only one of the fields `notebookId`, `cellId`
"notebookId": "string",
"cellId": "string",
// end of the list of possible fields
"inputVariables": "google.protobuf.Struct",
"outputVariableNames": [
"string"
],
"spec": "string",
"sparkConnectorId": "string"
}
Field |
Description |
projectId |
string Required field. ID of the project to execute notebook/cell in. |
notebookId |
string The path to the executable notebook in the project storage. The maximum string length is 200 characters. To get the path, right-click on the notebook in JupyterLab and select Includes only one of the fields |
cellId |
string ID of the cell to execute. Includes only one of the fields |
inputVariables |
Values of input variables. Input variables will be available in the project as environment variables. |
outputVariableNames[] |
string Names of output variables. |
spec |
string Specification of the VM |
sparkConnectorId |
string ID of the Spark Connector |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"projectId": "string",
// Includes only one of the fields `notebookId`, `cellId`
"notebookId": "string",
"cellId": "string"
// end of the list of possible fields
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"executionStatus": "ExecutionStatus"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
ProjectExecutionMetadata
Field |
Description |
projectId |
string ID of the project in which notebook is being executed. |
notebookId |
string ID of the notebook that is being executed Includes only one of the fields |
cellId |
string ID of the cell that is being executed Includes only one of the fields |
ProjectExecutionResponse
Field |
Description |
executionStatus |
enum ExecutionStatus Execution final status.
|