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.

TypeScript

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const ProjectExecutionRequest =
  cloudApi.datasphere.project_service.ProjectExecutionRequest;
const ProjectExecutionResponse =
  cloudApi.datasphere.project_service.ProjectExecutionResponse;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.ProjectServiceClient);

  const operation = await client.execute(
    ProjectExecutionRequest.fromPartial({
      projectId: "projectId",
      // notebookId: "notebookId",
      // cellId: "cellId",
      // inputVariables: {},
      // outputVariableNames: ["outputVariableNames"]
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof ProjectExecutionResponse>(
      finishedOp.response
    );
    console.log(result);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.datasphere.v1.project_service_pb2 import ProjectExecutionMetadata
from yandex.cloud.datasphere.v1.project_service_pb2 import ProjectExecutionRequest
from yandex.cloud.datasphere.v1.project_service_pb2 import ProjectExecutionResponse
from yandex.cloud.datasphere.v1.project_service_pb2_grpc import ProjectServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ProjectServiceStub)
operation = service.Execute(
    ProjectExecutionRequest(
        project_id="projectId",
        # notebook_id = "notebookId",
        # cell_id = "cellId",
        # input_variables = {},
        # output_variable_names = ["outputVariableNames"]
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=ProjectExecutionResponse,
    meta_type=ProjectExecutionMetadata,
)
print(operation_result)

ProjectExecutionRequest

projectId : string

ID of the project to execute notebook/cell in.

One of target

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

• cellId : string

  ID of the cell to execute.

  Deprecated

inputVariables : google.protobuf.Struct

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

An Operation resource. For more information, see Operation.

id : string

ID of the operation.

description : string

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp

Creation timestamp.

createdBy : string

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

modifiedAt : 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.

One of result

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.

• error : google.rpc.Status

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

• 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.

---