Yandex Data Processing API, gRPC: JobService.Cancel

Written by

Yandex Cloud

Updated at April 2, 2025

gRPC request
CancelJobRequest
operation.Operation
CreateJobMetadata
Job
MapreduceJob
SparkJob
PysparkJob
HiveJob
QueryList
ApplicationInfo
ApplicationAttempt

Cancels the specified Yandex Data Processing job.

gRPC request

rpc Cancel (CancelJobRequest) returns (operation.Operation)

CancelJobRequest

{
  "cluster_id": "string",
  "job_id": "string"
}

Field

Description

cluster_id

string

Required field. Required. ID of the Yandex Data Processing cluster.

job_id

string

Required field. Required. ID of the Yandex Data Processing job to cancel.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "cluster_id": "string",
    "job_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "cluster_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "started_at": "google.protobuf.Timestamp",
    "finished_at": "google.protobuf.Timestamp",
    "name": "string",
    "created_by": "string",
    "status": "Status",
    // Includes only one of the fields `mapreduce_job`, `spark_job`, `pyspark_job`, `hive_job`
    "mapreduce_job": {
      "args": [
        "string"
      ],
      "jar_file_uris": [
        "string"
      ],
      "file_uris": [
        "string"
      ],
      "archive_uris": [
        "string"
      ],
      "properties": "map<string, string>",
      // Includes only one of the fields `main_jar_file_uri`, `main_class`
      "main_jar_file_uri": "string",
      "main_class": "string"
      // end of the list of possible fields
    },
    "spark_job": {
      "args": [
        "string"
      ],
      "jar_file_uris": [
        "string"
      ],
      "file_uris": [
        "string"
      ],
      "archive_uris": [
        "string"
      ],
      "properties": "map<string, string>",
      "main_jar_file_uri": "string",
      "main_class": "string",
      "packages": [
        "string"
      ],
      "repositories": [
        "string"
      ],
      "exclude_packages": [
        "string"
      ]
    },
    "pyspark_job": {
      "args": [
        "string"
      ],
      "jar_file_uris": [
        "string"
      ],
      "file_uris": [
        "string"
      ],
      "archive_uris": [
        "string"
      ],
      "properties": "map<string, string>",
      "main_python_file_uri": "string",
      "python_file_uris": [
        "string"
      ],
      "packages": [
        "string"
      ],
      "repositories": [
        "string"
      ],
      "exclude_packages": [
        "string"
      ]
    },
    "hive_job": {
      "properties": "map<string, string>",
      "continue_on_failure": "bool",
      "script_variables": "map<string, string>",
      "jar_file_uris": [
        "string"
      ],
      // Includes only one of the fields `query_file_uri`, `query_list`
      "query_file_uri": "string",
      "query_list": {
        "queries": [
          "string"
        ]
      }
      // end of the list of possible fields
    },
    // end of the list of possible fields
    "application_info": {
      "id": "string",
      "application_attempts": [
        {
          "id": "string",
          "am_container_id": "string"
        }
      ]
    }
  }
  // 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.
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	CreateJobMetadata 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	Job 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.

CreateJobMetadata

Field

Description

cluster_id

string

Required field. ID of the cluster that the job is being created for.

job_id

string

ID of the job being created.

Job

A Yandex Data Processing job. For details about the concept, see documentation.

Field	Description
id	string ID of the job. Generated at creation time.
cluster_id	string ID of the Yandex Data Processing cluster that the job belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
started_at	google.protobuf.Timestamp The time when the job was started.
finished_at	google.protobuf.Timestamp The time when the job was finished.
name	string Name of the job, specified in the JobService.Create request.
created_by	string The id of the user who created the job
status	enum Status Job status. `STATUS_UNSPECIFIED` `PROVISIONING`: Job is logged in the database and is waiting for the agent to run it. `PENDING`: Job is acquired by the agent and is in the queue for execution. `RUNNING`: Job is being run in the cluster. `ERROR`: Job failed to finish the run properly. `DONE`: Job is finished. `CANCELLED`: Job is cancelled. `CANCELLING`: Job is waiting for cancellation.
mapreduce_job	MapreduceJob Specification for a MapReduce job. Includes only one of the fields `mapreduce_job`, `spark_job`, `pyspark_job`, `hive_job`. Specification for the job.
spark_job	SparkJob Specification for a Spark job. Includes only one of the fields `mapreduce_job`, `spark_job`, `pyspark_job`, `hive_job`. Specification for the job.
pyspark_job	PysparkJob Specification for a PySpark job. Includes only one of the fields `mapreduce_job`, `spark_job`, `pyspark_job`, `hive_job`. Specification for the job.
hive_job	HiveJob Specification for a Hive job. Includes only one of the fields `mapreduce_job`, `spark_job`, `pyspark_job`, `hive_job`. Specification for the job.
application_info	ApplicationInfo Attributes of YARN application.

MapreduceJob

Field	Description
args[]	string Optional arguments to pass to the driver.
jar_file_uris[]	string JAR file URIs to add to CLASSPATH of the Yandex Data Processing driver and each task.
file_uris[]	string URIs of resource files to be copied to the working directory of Yandex Data Processing drivers and distributed Hadoop tasks.
archive_uris[]	string URIs of archives to be extracted to the working directory of Yandex Data Processing drivers and tasks.
properties	object (map<string, string>) Property names and values, used to configure Yandex Data Processing and MapReduce.
main_jar_file_uri	string HCFS URI of the .jar file containing the driver class. Includes only one of the fields `main_jar_file_uri`, `main_class`.
main_class	string The name of the driver class. Includes only one of the fields `main_jar_file_uri`, `main_class`.

SparkJob

Field	Description
args[]	string Optional arguments to pass to the driver.
jar_file_uris[]	string JAR file URIs to add to CLASSPATH of the Yandex Data Processing driver and each task.
file_uris[]	string URIs of resource files to be copied to the working directory of Yandex Data Processing drivers and distributed Hadoop tasks.
archive_uris[]	string URIs of archives to be extracted to the working directory of Yandex Data Processing drivers and tasks.
properties	object (map<string, string>) Property names and values, used to configure Yandex Data Processing and Spark.
main_jar_file_uri	string The HCFS URI of the JAR file containing the `main` class for the job.
main_class	string The name of the driver class.
packages[]	string List of maven coordinates of jars to include on the driver and executor classpaths.
repositories[]	string List of additional remote repositories to search for the maven coordinates given with --packages.
exclude_packages[]	string List of groupId:artifactId, to exclude while resolving the dependencies provided in --packages to avoid dependency conflicts.

PysparkJob

Field	Description
args[]	string Optional arguments to pass to the driver.
jar_file_uris[]	string JAR file URIs to add to CLASSPATH of the Yandex Data Processing driver and each task.
file_uris[]	string URIs of resource files to be copied to the working directory of Yandex Data Processing drivers and distributed Hadoop tasks.
archive_uris[]	string URIs of archives to be extracted to the working directory of Yandex Data Processing drivers and tasks.
properties	object (map<string, string>) Property names and values, used to configure Yandex Data Processing and PySpark.
main_python_file_uri	string URI of the file with the driver code. Must be a .py file.
python_file_uris[]	string URIs of Python files to pass to the PySpark framework.
packages[]	string List of maven coordinates of jars to include on the driver and executor classpaths.
repositories[]	string List of additional remote repositories to search for the maven coordinates given with --packages.
exclude_packages[]	string List of groupId:artifactId, to exclude while resolving the dependencies provided in --packages to avoid dependency conflicts.

HiveJob

Field	Description
properties	object (map<string, string>) Property names and values, used to configure Yandex Data Processing and Hive.
continue_on_failure	bool Flag indicating whether a job should continue to run if a query fails.
script_variables	object (map<string, string>) Query variables and their values.
jar_file_uris[]	string JAR file URIs to add to CLASSPATH of the Hive driver and each task.
query_file_uri	string URI of the script with all the necessary Hive queries. Includes only one of the fields `query_file_uri`, `query_list`.
query_list	QueryList List of Hive queries to be used in the job. Includes only one of the fields `query_file_uri`, `query_list`.

QueryList

Field

Description

queries[]

string

List of Hive queries.

ApplicationInfo

Field

Description

string

ID of YARN application

application_attempts[]

ApplicationAttempt

YARN application attempts

ApplicationAttempt

Field

Description

string

ID of YARN application attempt

am_container_id

string

ID of YARN Application Master container

Yandex Data Processing API, gRPC: JobService.Cancel

gRPC requestgRPC request

CancelJobRequestCancelJobRequest

operation.Operationoperation.Operation

CreateJobMetadataCreateJobMetadata

JobJob

MapreduceJobMapreduceJob

SparkJobSparkJob

PysparkJobPysparkJob

HiveJobHiveJob

QueryListQueryList

ApplicationInfoApplicationInfo

ApplicationAttemptApplicationAttempt

Was the article helpful?

gRPC request

CancelJobRequest

operation.Operation

CreateJobMetadata

Job

MapreduceJob

SparkJob

PysparkJob

HiveJob

QueryList

ApplicationInfo

ApplicationAttempt