Yandex Data Processing API, gRPC: JobService.List

Field

Description

cluster_id

string

Required field. ID of the cluster to list jobs for.

The maximum string length in characters is 50.

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListJobsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

The maximum value is 1000.

page_token

string

Page token. To get the next page of results, set page_token to the
ListJobsResponse.next_page_token returned by a previous list request.

The maximum string length in characters is 100.

filter

string

A filter expression that filters jobs listed in the response.
The expression must specify:

1. The field name. Currently you can use filtering only on Job.name field.
2. An = operator.
3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].
   Example of a filter: name=my-job.

The maximum string length in characters is 1000.

Field

Description

jobs[]

Job

List of jobs for the specified cluster.

next_page_token

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListJobsRequest.page_size, use next_page_token as the value
for the ListJobsRequest.page_token parameter in the next list request.
Each subsequent page will have its own next_page_token to continue paging through the results.

The maximum string length in characters is 200.

Field

Description

id

string

Required field. ID of the job. Generated at creation time.

The maximum string length in characters is 50.

cluster_id

string

Required field. ID of the Yandex Data Processing cluster that the job belongs to.

The maximum string length in characters is 50.

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.

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

Field

Description

args[]

string

Optional arguments to pass to the driver.

The maximum string length in characters for each value is 1024. The maximum number of elements is 32.

jar_file_uris[]

string

JAR file URIs to add to CLASSPATH of the Yandex Data Processing driver and each task.

The string length in characters for each value must be less than 2048. The maximum number of elements is 100.

file_uris[]

string

URIs of resource files to be copied to the working directory of Yandex Data Processing drivers
and distributed Hadoop tasks.

The string length in characters for each value must be less than 2048. The maximum number of elements is 100.

archive_uris[]

string

URIs of archives to be extracted to the working directory of Yandex Data Processing drivers and tasks.

The string length in characters for each value must be less than 2048. The maximum number of elements is 100.

properties

object (map<string, string>)

Property names and values, used to configure Yandex Data Processing and MapReduce.

The maximum string length in characters for each value is 256. The string length in characters for each key must be 1-128. Each key must match the regular expression [a-zA-Z][-_0-9a-zA-Z.]*. No more than 100 per resource.

main_jar_file_uri

string

HCFS URI of the .jar file containing the driver class.

The string length in characters must be less than 2048.

Includes only one of the fields main_jar_file_uri, main_class.

main_class

string

The name of the driver class.

The string length in characters must be less than 256.

Includes only one of the fields main_jar_file_uri, main_class.

Field

Description

args[]

string

Optional arguments to pass to the driver.

The maximum string length in characters for each value is 10000. The maximum number of elements is 256.

jar_file_uris[]

string

JAR file URIs to add to CLASSPATH of the Yandex Data Processing driver and each task.

The string length in characters for each value must be less than 2048. The maximum number of elements is 100.

file_uris[]

string

URIs of resource files to be copied to the working directory of Yandex Data Processing drivers
and distributed Hadoop tasks.

The string length in characters for each value must be less than 2048. The maximum number of elements is 100.

archive_uris[]

string

URIs of archives to be extracted to the working directory of Yandex Data Processing drivers and tasks.

The string length in characters for each value must be less than 2048. The maximum number of elements is 100.

properties

object (map<string, string>)

Property names and values, used to configure Yandex Data Processing and Spark.

The maximum string length in characters for each value is 256. The string length in characters for each key must be 1-128. Each key must match the regular expression [a-zA-Z][-_0-9a-zA-Z.]*. No more than 100 per resource.

main_jar_file_uri

string

Required field. The HCFS URI of the JAR file containing the main class for the job.

The string length in characters must be less than 2048.

main_class

string

The name of the driver class.

The string length in characters must be less than 256.

packages[]

string

List of maven coordinates of jars to include on the driver and executor classpaths.

The string length in characters for each value must be less than 256. The maximum number of elements is 100.

repositories[]

string

List of additional remote repositories to search for the maven coordinates given with --packages.

The string length in characters for each value must be less than 2048. The maximum number of elements is 10.

exclude_packages[]

string

List of groupId:artifactId, to exclude while resolving the dependencies provided in --packages to avoid dependency conflicts.

The string length in characters for each value must be less than 256. The maximum number of elements is 100.

Field

Description

args[]

string

Optional arguments to pass to the driver.

The maximum string length in characters for each value is 100000. The maximum number of elements is 2500.

jar_file_uris[]

string

JAR file URIs to add to CLASSPATH of the Yandex Data Processing driver and each task.

The string length in characters for each value must be less than 2048. The maximum number of elements is 100.

file_uris[]

string

URIs of resource files to be copied to the working directory of Yandex Data Processing drivers
and distributed Hadoop tasks.

The string length in characters for each value must be less than 2048. The maximum number of elements is 100.

archive_uris[]

string

URIs of archives to be extracted to the working directory of Yandex Data Processing drivers and tasks.

The string length in characters for each value must be less than 2048. The maximum number of elements is 100.

properties

object (map<string, string>)

Property names and values, used to configure Yandex Data Processing and PySpark.

The maximum string length in characters for each value is 10000. The string length in characters for each key must be 1-128. Each key must match the regular expression [a-zA-Z][-_0-9a-zA-Z.]*. No more than 100 per resource.

main_python_file_uri

string

Required field. URI of the file with the driver code. Must be a .py file.

The string length in characters must be less than 2048.

python_file_uris[]

string

URIs of Python files to pass to the PySpark framework.

The string length in characters for each value must be less than 2048. The maximum number of elements is 100.

packages[]

string

List of maven coordinates of jars to include on the driver and executor classpaths.

The string length in characters for each value must be less than 256. The maximum number of elements is 100.

repositories[]

string

List of additional remote repositories to search for the maven coordinates given with --packages.

The string length in characters for each value must be less than 2048. The maximum number of elements is 10.

exclude_packages[]

string

List of groupId:artifactId, to exclude while resolving the dependencies provided in --packages to avoid dependency conflicts.

The string length in characters for each value must be less than 256. The maximum number of elements is 100.

Field

Description

properties

object (map<string, string>)

Property names and values, used to configure Yandex Data Processing and Hive.

The maximum string length in characters for each value is 256. The string length in characters for each key must be 1-128. Each key must match the regular expression [a-zA-Z][-_0-9a-zA-Z.]*. No more than 100 per resource.

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.

The maximum string length in characters for each value is 2048. The string length in characters for each key must be 1-128. Each key must match the regular expression [a-zA-Z][_0-9a-zA-Z]*. No more than 100 per resource.

jar_file_uris[]

string

JAR file URIs to add to CLASSPATH of the Hive driver and each task.

The string length in characters for each value must be less than 2048. The maximum number of elements is 100.

query_file_uri

string

URI of the script with all the necessary Hive queries.

The string length in characters must be less than 2048.

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.

Field

Description

queries[]

string

List of Hive queries.

The string length in characters for each value must be less than 10240. The maximum number of elements is 100.

Field

Description

id

string

ID of YARN application

application_attempts[]

ApplicationAttempt

YARN application attempts

Field

Description

id

string

ID of YARN application attempt

am_container_id

string

ID of YARN Application Master container