Register job template

POST 
/metalakes/:metalake/jobs/templates

Registers a job template in the metalake. The response carries only the status code.

Sign in with a bearer token or a local user's password; see Authentication.

Request

Path Parameters

metalake stringrequired

The name of the metalake

application/vnd.gravitino.v1+json

Body

jobTemplate

object

required

oneOf

ShellJobTemplate

A job template object for shell jobs

name stringrequired

The name of the job template

jobType stringrequired

Possible values: [shell]

The type of the job template

comment stringnullable

A comment about the job template

executable stringrequired

The executable command of the job template

arguments string[]nullable

The arguments of the job template

environments

object

Configured string to string map of environment variables for the job template

property name* string

customFields

object

Configured string to string map of custom fields for the job template

property name* string

scripts string[]nullable

The scripts of the job template

audit

object

Audit information for a Gravitino resource.

creator string

The user who created the resource

createTime date-time

The time the resource was created

lastModifier string

The user who last modified the resource

lastModifiedTime date-time

The time the resource was last modified

SparkJobTemplate

A job template object for Spark jobs

name stringrequired

The name of the job template

jobType stringrequired

Possible values: [spark]

The type of the job template

comment stringnullable

A comment about the job template

executable stringrequired

The executable command of the job template

arguments string[]nullable

The arguments of the job template

environments

object

Configured string to string map of environment variables for the job template

property name* string

customFields

object

Configured string to string map of custom fields for the job template

property name* string

className stringnullable

The main class of the Spark job template. Required for Java/Scala Spark applications, optional for PySpark applications

jars string[]nullable

The JAR files of the Spark job template

files string[]nullable

The files of the Spark job template

archives string[]nullable

The archives of the Spark job template

configs

object

Configured string to string map of Spark configurations for the job template

property name* string

audit

object

Audit information for a Gravitino resource.

creator string

The user who created the resource

createTime date-time

The time the resource was created

lastModifier string

The user who last modified the resource

lastModifiedTime date-time

The time the resource was last modified

Responses

200

The operation succeeded. The body carries only code, which is 0.

application/vnd.gravitino.v1+json

Schema

Schema

code int32required

Possible values: [0]

Status code of the response

Example (from schema)

{
  "code": 0
}

Example

{
  "code": 0
}

409

A job template with the same name already exists in the metalake.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

JobTemplateAlreadyExistsException

{
  "code": 1004,
  "type": "JobTemplateAlreadyExistsException",
  "message": "Failed to operate job template(s) [my_job] operation [REGISTER], reason [JobTemplateAlreadyExistsException]",
  "stack": [
    "org.apache.gravitino.exceptions.JobTemplateAlreadyExistsException: job template xxx already exists",
    "..."
  ]
}

5xx

The server hit an internal error that the client usually cannot fix by changing the request.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...