Update job template

PUT 
/metalakes/:metalake/jobs/templates/:jobTemplate

Applies the requested changes to a job template and returns the updated template.

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

Request

Path Parameters

metalake stringrequired

The name of the metalake

jobTemplate stringrequired

The name of the job template

application/vnd.gravitino.v1+json

Body

updates

object[]

required

Array [

oneOf

RenameJobTemplateRequest

@type stringrequired

Possible values: [rename]

newName stringrequired

The new name of the job template

UpdateJobTemplateCommentRequest

@type stringrequired

Possible values: [updateComment]

newComment stringrequired

The new comment of the job template

UpdateJobTemplateContentRequest

@type stringrequired

Possible values: [updateTemplate]

newTemplate

object

required

oneOf

ShellTemplateUpdate

A job template update object for shell jobs

@type stringrequired

Possible values: [shell]

The type of the job template

newExecutable stringnullable

The new executable command of the job template

newArguments string[]nullable

The new arguments of the job template

newEnvironments

object

nullable

The new configured string to string map of environment variables for the job template

property name* string

newCustomFields

object

nullable

The new configured string to string map of custom fields for the job template

property name* string

newScripts string[]nullable

The new scripts of the job template

SparkTemplateUpdate

A job template update object for Spark jobs

@type stringrequired

Possible values: [spark]

The type of the job template

newExecutable stringnullable

The new executable command of the job template

newArguments string[]nullable

The new arguments of the job template

newEnvironments

object

nullable

The new configured string to string map of environment variables for the job template

property name* string

newCustomFields

object

nullable

The new configured string to string map of custom fields for the job template

property name* string

newClassName stringnullable

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

newJars string[]nullable

The new JAR files of the Spark job template

newFiles string[]nullable

The new files of the Spark job template

newArchives string[]nullable

The new archives of the Spark job template

newConfigs

object

nullable

The new configured string to string map of Spark configurations for the job template

property name* string

]

Responses

200

The updated job template, with its job type, executable, arguments, other run settings and audit information.

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

jobTemplate

object

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

Example (from schema)

{
  "code": 0,
  "jobTemplate": {}
}

JobTemplateResponse

{
  "code": 0,
  "jobTemplate": {
    "name": "test_run_get",
    "jobType": "shell",
    "comment": "Test shell job template",
    "executable": "/var/folders/90/v1d9hxsd6pj8m0jnn6f22tkr0000gn/T/tmpy65fiugc/test-job.sh",
    "arguments": [
      "{{arg1}}",
      "{{arg2}}"
    ],
    "environments": {
      "ENV_VAR": "{{env_var}}"
    },
    "customFields": {},
    "scripts": [
      "/var/folders/90/v1d9hxsd6pj8m0jnn6f22tkr0000gn/T/tmpy65fiugc/common.sh"
    ],
    "audit": {
      "createTime": "2025-08-12T02:14:28.205023Z",
      "creator": "anonymous"
    }
  }
}

400

A change cannot be applied to the job template, for example a Spark update sent for a shell template.

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"
}

IllegalArgumentException

{
  "code": 1001,
  "type": "IllegalArgumentException",
  "message": "Failed to operate job template(s) [my_job] operation [UPDATE], reason [IllegalArgumentException]",
  "stack": [
    "java.lang.IllegalArgumentException: Invalid argument xxx",
    "..."
  ]
}

404

The metalake or job template does not exist.

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"
}

NoSuchMetalakeException

{
  "code": 1003,
  "type": "NoSuchMetalakeException",
  "message": "Failed to operate metalake(s) [test] operation [LOAD], reason [NoSuchMetalakeException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchMetalakeException: Metalake test does not exist",
    "..."
  ]
}

NoSuchJobTemplateException

{
  "code": 1003,
  "type": "NoSuchJobTemplateException",
  "message": "Failed to operate job template(s) [my_job] operation [GET] under metalake [my_test_metalake], reason [NoSuchJobTemplateException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchJobTemplateException: Job template xxx does not exist",
    "..."
  ]
}

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