Cancel

Cancels running job.

TypeScript

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

const CancelProjectJobRequest =
  cloudApi.datasphere.jobs_project_job_service.CancelProjectJobRequest;

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

  const result = await client.cancel(
    CancelProjectJobRequest.fromPartial({
      // jobId: "jobId",
      // reason: "reason",
      // graceful: true
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.datasphere.v2.jobs.project_job_service_pb2 import CancelProjectJobRequest
from yandex.cloud.datasphere.v2.jobs.project_job_service_pb2_grpc import ProjectJobServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ProjectJobServiceStub)
response = service.Cancel(
    CancelProjectJobRequest(
        # job_id = "jobId",
        # reason = "reason",
        # graceful = true
    )
)
print(response)

CancelProjectJobRequest

jobId : string

ID of the job.

reason : string

Optional cancellation reason.

graceful : bool

If the job is launched with graceful shutdown support, the shutdown will be performed gracefully

Empty

---