Yandex Data Processing API, REST: Job.Create

Field

Description

clusterId

string

Required field. ID of the cluster to create a job for.

The maximum string length in characters is 50.

Field

Description

name

string

Name of the job.

The string length in characters must be less than 256. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].

mapreduceJob

MapreduceJob

Specification for a MapReduce job.

Includes only one of the fields mapreduceJob, sparkJob, pysparkJob, hiveJob.

Specification for the job.

sparkJob

SparkJob

Specification for a Spark job.

Includes only one of the fields mapreduceJob, sparkJob, pysparkJob, hiveJob.

Specification for the job.

pysparkJob

PysparkJob

Specification for a PySpark job.

Includes only one of the fields mapreduceJob, sparkJob, pysparkJob, hiveJob.

Specification for the job.

hiveJob

HiveJob

Specification for a Hive job.

Includes only one of the fields mapreduceJob, sparkJob, pysparkJob, hiveJob.

Specification for the job.

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.

jarFileUris[]

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.

fileUris[]

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.

archiveUris[]

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.

mainJarFileUri

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 mainJarFileUri, mainClass.

mainClass

string

The name of the driver class.

The string length in characters must be less than 256.

Includes only one of the fields mainJarFileUri, mainClass.

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.

jarFileUris[]

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.

fileUris[]

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.

archiveUris[]

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.

mainJarFileUri

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.

mainClass

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.

excludePackages[]

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.

jarFileUris[]

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.

fileUris[]

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.

archiveUris[]

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.

mainPythonFileUri

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.

pythonFileUris[]

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.

excludePackages[]

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.

continueOnFailure

boolean

Flag indicating whether a job should continue to run if a query fails.

scriptVariables

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.

jarFileUris[]

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.

queryFileUri

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 queryFileUri, queryList.

queryList

QueryList

List of Hive queries to be used in the job.

Includes only one of the fields queryFileUri, queryList.

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 the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

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

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

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

object

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

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

object

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.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.