DataSphere API v2, gRPC: ProjectService.Execute

Field

Description

notebook_id

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 Copy path.

The maximum string length in characters is 200.

Includes only one of the fields notebook_id, cell_id.

cell_id

string

ID of the cell to execute.
Deprecated

The maximum string length in characters is 200.

Includes only one of the fields notebook_id, cell_id.

project_id

string

Required field. ID of the project to execute notebook/cell in.

The maximum string length in characters is 50.

input_variables

google.protobuf.Struct

Values of input variables. Input variables will be available in the project as environment variables.

output_variable_names[]

string

Names of output variables.

spec

string

Specification of the VM

spark_connector_id

string

ID of the Spark Connector

The maximum string length in characters is 200.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

google.protobuf.Any

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Any

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.