Custom jobs¶
Use the endpoints described below to manage custom jobs. Use custom jobs to implement automation (for example, custom tests) for your models and deployments. Each job serves as an automated workload, and the exit code determines if it passed or failed. You can run the custom jobs you create for one or more models or deployments. The automated workloads you define through custom jobs can make prediction requests, fetch inputs, and store outputs using DataRobot's Public API.
GET /api/v2/customJobLimits/¶
Retrieve custom job limits.
Example responses¶
200 Response
{
"properties": {
"maxCustomJobRuns": {
"description": "Number of custom jobs allowed to run in parallel.",
"type": "integer",
"x-versionadded": "v2.33"
},
"maxCustomJobTimeout": {
"description": "Execution time limit for the custom job in seconds.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"maxCustomJobRuns",
"maxCustomJobTimeout"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Custom job limits | CustomJobLimitsResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/customJobs/¶
List custom jobs.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | integer | true | This many results will be skipped. |
| limit | query | integer | true | At most this many results are returned. |
| onlyRunning | query | string | false | Whether only custom jobs that are currently being run should be returned. |
| search | query | string | false | If supplied, only include custom jobs whose name or description contain this string. |
| jobType | query | array[string] | false | The type of the custom job to filter by. |
Enumerated Values¶
| Parameter | Value |
|---|---|
| onlyRunning | [false, False, true, True] |
| jobType | [default, hostedCustomMetric, notification, retraining] |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer",
"x-versionadded": "v2.33"
},
"data": {
"description": "List of custom jobs.",
"items": {
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the custom job was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The ID of the entry point file to use.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobType": {
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string",
"x-versionadded": "v2.33"
},
"lastRun": {
"description": "The last custom job run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"updated": {
"description": "ISO-8601 timestamp of when custom job was last updated.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"environmentId",
"environmentVersionId",
"id",
"items",
"jobType",
"lastRun",
"name",
"resources",
"updated"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of custom jobs. | CustomJobListResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/customJobs/¶
Create a custom job.
Body parameter¶
{
"properties": {
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment to use for this custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version to use for this custom job. If not provided, the latest execution environment version will be used.",
"type": "string",
"x-versionadded": "v2.33"
},
"file": {
"description": "A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding `filePath` supplied that shows the relative location of the file. For example, you have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`. When uploading these files, you would _also_ need to include two `filePath` fields of, `\"main.py\"` and `\"helpers/helper.py\"`. If the supplied `file` already exists at the supplied `filePath`, the old file is replaced by the new file.",
"format": "binary",
"type": "string",
"x-versionadded": "v2.33"
},
"filePath": {
"description": "The local path of the file being uploaded. See the `file` field explanation for more details.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
}
],
"x-versionadded": "v2.33"
},
"jobType": {
"default": "default",
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string",
"x-versionadded": "v2.33"
},
"name": {
"description": "Name of the custom job.",
"maxLength": 255,
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameterValues": {
"description": "Ability to inject values into a custom job at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the metadata.yaml file. This list will be merged with any existing runtime values set from the prior version when issuing a PATCH request so it is possible to specify a `null` value to unset specific parameters and fall back to the defaultValue from the definition.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"name"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateCustomJob | false | none |
Example responses¶
201 Response
{
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the custom job was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The ID of the entry point file to use.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobType": {
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string",
"x-versionadded": "v2.33"
},
"lastRun": {
"description": "The last custom job run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"updated": {
"description": "ISO-8601 timestamp of when custom job was last updated.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"environmentId",
"environmentVersionId",
"id",
"items",
"jobType",
"lastRun",
"name",
"resources",
"updated"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created. | CustomJobResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
| 422 | Unprocessable Entity | Input parameters are invalid. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/customJobs/fromGalleryTemplate/¶
Create a custom job.
Notice: Endpoint is currently in [GA_ALL]. Do not use it in production workflows to reduce risk. See details:
This endpoint depends on the following features that are subject to change.
| Feature Flag | Maturity | Enabled by default | Description |
|---|---|---|---|
| CUSTOM_JOBS_TEMPLATE_GALLERY | PUBLIC_PREVIEW | true | Enables template gallery for generic and notification Custom Jobs and updates Custom Hosted Metrics gallery UI |
Body parameter¶
{
"properties": {
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string"
},
"environmentId": {
"description": "The ID of the execution environment to use for this custom job.",
"type": "string"
},
"environmentVersionId": {
"description": "The ID of the execution environment version to use for this custom job. If not provided, the latest execution environment version will be used.",
"type": "string"
},
"file": {
"description": "A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding `filePath` supplied that shows the relative location of the file. For example, you have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`. When uploading these files, you would _also_ need to include two `filePath` fields of, `\"main.py\"` and `\"helpers/helper.py\"`. If the supplied `file` already exists at the supplied `filePath`, the old file is replaced by the new file.",
"format": "binary",
"type": "string"
},
"filePath": {
"description": "The local path of the file being uploaded. See the `file` field explanation for more details.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
}
]
},
"jobType": {
"default": "default",
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameterValues": {
"description": "Ability to inject values into a custom job at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the metadata.yaml file. This list will be merged with any existing runtime values set from the prior version when issuing a PATCH request so it is possible to specify a `null` value to unset specific parameters and fall back to the defaultValue from the definition.",
"type": "string"
},
"templateId": {
"description": "Custom Job Template ID.",
"type": "string"
}
},
"required": [
"templateId"
],
"type": "object",
"x-versionadded": "v2.35"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateCustomJobFromTemplateGallery | false | none |
Example responses¶
201 Response
{
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the custom job was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The ID of the entry point file to use.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobType": {
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string",
"x-versionadded": "v2.33"
},
"lastRun": {
"description": "The last custom job run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"updated": {
"description": "ISO-8601 timestamp of when custom job was last updated.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"environmentId",
"environmentVersionId",
"id",
"items",
"jobType",
"lastRun",
"name",
"resources",
"updated"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created. | CustomJobResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
| 422 | Unprocessable Entity | Input parameters are invalid. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/customJobs/{customJobId}/¶
Delete custom job.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Custom job deleted. | None |
| 403 | Forbidden | Custom jobs are not enabled. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/customJobs/{customJobId}/¶
Retrieve custom job.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
Example responses¶
200 Response
{
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the custom job was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The ID of the entry point file to use.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobType": {
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string",
"x-versionadded": "v2.33"
},
"lastRun": {
"description": "The last custom job run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"updated": {
"description": "ISO-8601 timestamp of when custom job was last updated.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"environmentId",
"environmentVersionId",
"id",
"items",
"jobType",
"lastRun",
"name",
"resources",
"updated"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Custom job | CustomJobResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/customJobs/{customJobId}/¶
Update custom job.
Body parameter¶
{
"properties": {
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The ID of the entry point file to use.",
"type": "string",
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment to use for this custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version to use for this custom job. If not provided, the latest execution environment version will be used.",
"type": "string",
"x-versionadded": "v2.33"
},
"file": {
"description": "A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding `filePath` supplied that shows the relative location of the file. For example, you have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`. When uploading these files, you would _also_ need to include two `filePath` fields of, `\"main.py\"` and `\"helpers/helper.py\"`. If the supplied `file` already exists at the supplied `filePath`, the old file is replaced by the new file.",
"format": "binary",
"type": "string",
"x-versionadded": "v2.33"
},
"filePath": {
"description": "The local path of the file being uploaded. See the `file` field explanation for more details.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
}
],
"x-versionadded": "v2.33"
},
"filesToDelete": {
"description": "The IDs of the files to be deleted.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
],
"x-versionadded": "v2.33"
},
"name": {
"description": "Name of the custom job.",
"maxLength": 255,
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameterValues": {
"description": "Ability to inject values into a custom job at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the metadata.yaml file. This list will be merged with any existing runtime values set from the prior version when issuing a PATCH request so it is possible to specify a `null` value to unset specific parameters and fall back to the defaultValue from the definition.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
| body | body | UpdateCustomJob | false | none |
Example responses¶
201 Response
{
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the custom job was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The ID of the entry point file to use.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobType": {
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string",
"x-versionadded": "v2.33"
},
"lastRun": {
"description": "The last custom job run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"updated": {
"description": "ISO-8601 timestamp of when custom job was last updated.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"environmentId",
"environmentVersionId",
"id",
"items",
"jobType",
"lastRun",
"name",
"resources",
"updated"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Updated custom job | CustomJobResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
| 422 | Unprocessable Entity | Input parameters are invalid. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/customJobs/{customJobId}/items/{itemId}/¶
Retrieve custom job file content.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
| itemId | path | string | true | ID of the file item. |
Example responses¶
200 Response
{
"properties": {
"content": {
"description": "Content of the chosen file.",
"type": "string",
"x-versionadded": "v2.33"
},
"fileName": {
"description": "Name of the chosen file.",
"type": "string",
"x-versionadded": "v2.33"
},
"filePath": {
"description": "Path of the chosen file.",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"content",
"fileName",
"filePath",
"id"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Custom job file content | CustomJobFileResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
| 404 | Not Found | No file found. | None |
| 422 | Unprocessable Entity | File is not utf-8 encoded. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/customJobs/{customJobId}/runs/¶
List custom job runs.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | integer | false | This many results will be skipped. |
| limit | query | integer | false | At most this many results are returned. |
| scheduledJobId | query | string | false | If supplied, only include custom job runs that are scheduled with this scheduled job id. |
| customJobId | path | string | true | ID of the custom job. |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer",
"x-versionadded": "v2.33"
},
"data": {
"description": "List of custom job runs.",
"items": {
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the model was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"customJobId": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job run.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"duration": {
"description": "Duration of the custom test run is seconds.",
"type": "number",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The entry point file item ID in the custom job's workspace.",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobStatusId": {
"description": "ID to track the custom job run execution status.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"status": {
"description": "The status of the custom job run.",
"enum": [
"succeeded",
"failed",
"running",
"interrupted",
"canceling",
"canceled"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"customJobId",
"duration",
"id",
"items",
"jobStatusId",
"resources",
"status"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of custom job runs. | CustomJobRunListResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/customJobs/{customJobId}/runs/¶
Create a custom job run.
Body parameter¶
{
"properties": {
"description": {
"description": "The description of the custom job run.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"runtimeParameterValues": {
"description": "Ability to inject values at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the custom job metadata.yaml file. It has a priority over an existing runtime parameter overrides defined at the custom job level.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
},
"value": {
"anyOf": [
{
"description": "The value for the given field.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
{
"default": false,
"description": "The boolean value for the field (default False)",
"type": "boolean"
},
{
"default": null,
"description": "The numeric value for the field",
"type": [
"number",
"null"
]
}
],
"description": "The string, boolean or numeric value for the given field.",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
}
},
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
| body | body | CreateCustomJobRun | false | none |
Example responses¶
201 Response
{
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the model was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"customJobId": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job run.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"duration": {
"description": "Duration of the custom test run is seconds.",
"type": "number",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The entry point file item ID in the custom job's workspace.",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobStatusId": {
"description": "ID to track the custom job run execution status.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"status": {
"description": "The status of the custom job run.",
"enum": [
"succeeded",
"failed",
"running",
"interrupted",
"canceling",
"canceled"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"customJobId",
"duration",
"id",
"items",
"jobStatusId",
"resources",
"status"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created. | CustomJobRunResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
| 422 | Unprocessable Entity | Input parameters are invalid. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/customJobs/{customJobId}/runs/{customJobRunId}/¶
Cancel custom job run.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
| customJobRunId | path | string | true | ID of the custom job run. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Custom job run canceled | None |
| 403 | Forbidden | Custom jobs are not enabled. | None |
| 422 | Unprocessable Entity | Input parameters are invalid. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/customJobs/{customJobId}/runs/{customJobRunId}/¶
Retrieve custom job run.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
| customJobRunId | path | string | true | ID of the custom job run. |
Example responses¶
200 Response
{
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the model was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"customJobId": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job run.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"duration": {
"description": "Duration of the custom test run is seconds.",
"type": "number",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The entry point file item ID in the custom job's workspace.",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobStatusId": {
"description": "ID to track the custom job run execution status.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"status": {
"description": "The status of the custom job run.",
"enum": [
"succeeded",
"failed",
"running",
"interrupted",
"canceling",
"canceled"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"customJobId",
"duration",
"id",
"items",
"jobStatusId",
"resources",
"status"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Custom job run | CustomJobRunResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/customJobs/{customJobId}/runs/{customJobRunId}/¶
Update custom job run.
Body parameter¶
{
"properties": {
"description": {
"description": "The description of the custom job run.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"runtimeParameterValues": {
"description": "Ability to inject values at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the custom job metadata.yaml file. It has a priority over an existing runtime parameter overrides defined at the custom job level.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
},
"value": {
"anyOf": [
{
"description": "The value for the given field.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
{
"default": false,
"description": "The boolean value for the field (default False)",
"type": "boolean"
},
{
"default": null,
"description": "The numeric value for the field",
"type": [
"number",
"null"
]
}
],
"description": "The string, boolean or numeric value for the given field.",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
}
},
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
| customJobRunId | path | string | true | ID of the custom job run. |
| body | body | CreateCustomJobRun | false | none |
Example responses¶
201 Response
{
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the model was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"customJobId": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job run.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"duration": {
"description": "Duration of the custom test run is seconds.",
"type": "number",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The entry point file item ID in the custom job's workspace.",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobStatusId": {
"description": "ID to track the custom job run execution status.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"status": {
"description": "The status of the custom job run.",
"enum": [
"succeeded",
"failed",
"running",
"interrupted",
"canceling",
"canceled"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"customJobId",
"duration",
"id",
"items",
"jobStatusId",
"resources",
"status"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Updated custom job run | CustomJobRunResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
| 422 | Unprocessable Entity | Input parameters are invalid. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/customJobs/{customJobId}/runs/{customJobRunId}/items/{itemId}/¶
Retrieve custom job run file content.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
| customJobRunId | path | string | true | ID of the custom job run. |
| itemId | path | string | true | ID of the file item. |
Example responses¶
200 Response
{
"properties": {
"content": {
"description": "Content of the chosen file.",
"type": "string",
"x-versionadded": "v2.33"
},
"fileName": {
"description": "Name of the chosen file.",
"type": "string",
"x-versionadded": "v2.33"
},
"filePath": {
"description": "Path of the chosen file.",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"content",
"fileName",
"filePath",
"id"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Custom job run file content | CustomJobFileResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
| 404 | Not Found | No file found. | None |
| 422 | Unprocessable Entity | File is not utf-8 encoded. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
DELETE /api/v2/customJobs/{customJobId}/runs/{customJobRunId}/logs/¶
Delete custom job run logs.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
| customJobRunId | path | string | true | ID of the custom job run. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Custom job run logs deleted. | None |
| 404 | Not Found | No log found. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/customJobs/{customJobId}/runs/{customJobRunId}/logs/¶
Retrieve custom job run logs.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
| customJobRunId | path | string | true | ID of the custom job run. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The log file download. | None |
| 404 | Not Found | No log found. | None |
Response Headers¶
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 200 | Content-Disposition | string | Contains an auto generated filename for this download ("attachment;filename=custom-job-run- |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/customJobs/{customJobId}/sharedRoles/¶
Get a list of users, groups and organizations who have access to this custom job and their roles on the custom job.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | query | string | false | Only return roles for a user, group or organization with this identifier. |
| offset | query | integer | true | This many results will be skipped |
| limit | query | integer | true | At most this many results are returned |
| name | query | string | false | Only return roles for a user, group or organization with this name. |
| shareRecipientType | query | string | false | List access controls for recipients with this type. |
| customJobId | path | string | true | ID of the custom job. |
Enumerated Values¶
| Parameter | Value |
|---|---|
| shareRecipientType | [user, group, organization] |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "The number of items returned.",
"type": "integer"
},
"data": {
"description": "The access control list.",
"items": {
"properties": {
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The type of the recipient.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page.",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page.",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "Total number of items matching the condition.",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The Custom Job's access control list. | SharingListV2Response |
| 404 | Not Found | Either the Custom Job does not exist or the user does not have permissions to view the Custom Job. | None |
| 422 | Unprocessable Entity | Both username and userId were specified | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
PATCH /api/v2/customJobs/{customJobId}/sharedRoles/¶
Set roles for users on this custom job.
Body parameter¶
{
"properties": {
"operation": {
"description": "Name of the action being taken. The only operation is 'updateRoles'.",
"enum": [
"updateRoles"
],
"type": "string"
},
"roles": {
"description": "Array of GrantAccessControl objects., up to maximum 100 objects.",
"items": {
"oneOf": [
{
"properties": {
"role": {
"description": "The role of the recipient on this entity. One of OWNER, USER, OBSERVER.",
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
},
"username": {
"description": "Username of the user to update the access role for.",
"type": "string"
}
},
"required": [
"role",
"shareRecipientType",
"username"
],
"type": "object"
},
{
"properties": {
"id": {
"description": "The ID of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity. One of OWNER, USER, OBSERVER.",
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"role",
"shareRecipientType"
],
"type": "object"
}
]
},
"maxItems": 100,
"minItems": 1,
"type": "array"
}
},
"required": [
"operation",
"roles"
],
"type": "object"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
| body | body | SharedRolesUpdate | false | none |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Roles updated successfully. | None |
| 409 | Conflict | The request would leave the custom job without an owner. | None |
| 422 | Unprocessable Entity | One of the users in the request does not exist, or the request is otherwise invalid | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
POST /api/v2/customJobsCleanup/{customJobId}/¶
Permanently delete custom job.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| customJobId | path | string | true | ID of the custom job. |
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Custom job permanently deleted. | None |
| 401 | Unauthorized | Permadelete not enabled or user not permitted to permadelete. | None |
| 403 | Forbidden | Custom jobs are not enabled. | None |
| 409 | Conflict | At least one of the custom job componenets are not soft-deleted, therefore can not permanently delete. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
GET /api/v2/deletedCustomJobs/¶
List deleted custom jobs.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| offset | query | integer | false | This many results will be skipped. |
| limit | query | integer | false | At most this many results are returned. |
Example responses¶
200 Response
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer",
"x-versionadded": "v2.33"
},
"data": {
"description": "List of custom jobs.",
"items": {
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the custom job was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The ID of the entry point file to use.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobType": {
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string",
"x-versionadded": "v2.33"
},
"lastRun": {
"description": "The last custom job run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"updated": {
"description": "ISO-8601 timestamp of when custom job was last updated.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"environmentId",
"environmentVersionId",
"id",
"items",
"jobType",
"lastRun",
"name",
"resources",
"updated"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Responses¶
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of deleted custom jobs. | CustomJobListResponse |
| 403 | Forbidden | Custom jobs are not enabled. | None |
To perform this operation, you must be authenticated by means of one of the following methods:
BearerAuth
Schemas¶
AccessControlV2
{
"properties": {
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The type of the recipient.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The identifier of the recipient. | |
| name | string | true | The name of the recipient. | |
| role | string | true | The role of the recipient on this entity. | |
| shareRecipientType | string | true | The type of the recipient. |
Enumerated Values¶
| Property | Value |
|---|---|
| role | [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER] |
| shareRecipientType | [user, group, organization] |
CreateCustomJob
{
"properties": {
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment to use for this custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version to use for this custom job. If not provided, the latest execution environment version will be used.",
"type": "string",
"x-versionadded": "v2.33"
},
"file": {
"description": "A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding `filePath` supplied that shows the relative location of the file. For example, you have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`. When uploading these files, you would _also_ need to include two `filePath` fields of, `\"main.py\"` and `\"helpers/helper.py\"`. If the supplied `file` already exists at the supplied `filePath`, the old file is replaced by the new file.",
"format": "binary",
"type": "string",
"x-versionadded": "v2.33"
},
"filePath": {
"description": "The local path of the file being uploaded. See the `file` field explanation for more details.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
}
],
"x-versionadded": "v2.33"
},
"jobType": {
"default": "default",
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string",
"x-versionadded": "v2.33"
},
"name": {
"description": "Name of the custom job.",
"maxLength": 255,
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameterValues": {
"description": "Ability to inject values into a custom job at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the metadata.yaml file. This list will be merged with any existing runtime values set from the prior version when issuing a PATCH request so it is possible to specify a `null` value to unset specific parameters and fall back to the defaultValue from the definition.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"name"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | maxLength: 10000 |
The description of the custom job. |
| environmentId | string | false | The ID of the execution environment to use for this custom job. | |
| environmentVersionId | string | false | The ID of the execution environment version to use for this custom job. If not provided, the latest execution environment version will be used. | |
| file | string(binary) | false | A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding filePath supplied that shows the relative location of the file. For example, you have two files: /home/username/custom-task/main.py and /home/username/custom-task/helpers/helper.py. When uploading these files, you would also need to include two filePath fields of, "main.py" and "helpers/helper.py". If the supplied file already exists at the supplied filePath, the old file is replaced by the new file. |
|
| filePath | any | false | The local path of the file being uploaded. See the file field explanation for more details. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | maxItems: 1000 |
none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| jobType | string | false | Type of the custom job. | |
| name | string | true | maxLength: 255 |
Name of the custom job. |
| resources | CustomJobResources | false | The custom job resources that will be applied in the k8s cluster. | |
| runtimeParameterValues | string | false | Ability to inject values into a custom job at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the metadata.yaml file. This list will be merged with any existing runtime values set from the prior version when issuing a PATCH request so it is possible to specify a null value to unset specific parameters and fall back to the defaultValue from the definition. |
Enumerated Values¶
| Property | Value |
|---|---|
| jobType | [default, hostedCustomMetric, notification, retraining] |
CreateCustomJobFromTemplateGallery
{
"properties": {
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string"
},
"environmentId": {
"description": "The ID of the execution environment to use for this custom job.",
"type": "string"
},
"environmentVersionId": {
"description": "The ID of the execution environment version to use for this custom job. If not provided, the latest execution environment version will be used.",
"type": "string"
},
"file": {
"description": "A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding `filePath` supplied that shows the relative location of the file. For example, you have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`. When uploading these files, you would _also_ need to include two `filePath` fields of, `\"main.py\"` and `\"helpers/helper.py\"`. If the supplied `file` already exists at the supplied `filePath`, the old file is replaced by the new file.",
"format": "binary",
"type": "string"
},
"filePath": {
"description": "The local path of the file being uploaded. See the `file` field explanation for more details.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
}
]
},
"jobType": {
"default": "default",
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameterValues": {
"description": "Ability to inject values into a custom job at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the metadata.yaml file. This list will be merged with any existing runtime values set from the prior version when issuing a PATCH request so it is possible to specify a `null` value to unset specific parameters and fall back to the defaultValue from the definition.",
"type": "string"
},
"templateId": {
"description": "Custom Job Template ID.",
"type": "string"
}
},
"required": [
"templateId"
],
"type": "object",
"x-versionadded": "v2.35"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | maxLength: 10000 |
The description of the custom job. |
| environmentId | string | false | The ID of the execution environment to use for this custom job. | |
| environmentVersionId | string | false | The ID of the execution environment version to use for this custom job. If not provided, the latest execution environment version will be used. | |
| file | string(binary) | false | A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding filePath supplied that shows the relative location of the file. For example, you have two files: /home/username/custom-task/main.py and /home/username/custom-task/helpers/helper.py. When uploading these files, you would also need to include two filePath fields of, "main.py" and "helpers/helper.py". If the supplied file already exists at the supplied filePath, the old file is replaced by the new file. |
|
| filePath | any | false | The local path of the file being uploaded. See the file field explanation for more details. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | maxItems: 1000 |
none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| jobType | string | false | Type of the custom job. | |
| resources | CustomJobResources | false | The custom job resources that will be applied in the k8s cluster. | |
| runtimeParameterValues | string | false | Ability to inject values into a custom job at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the metadata.yaml file. This list will be merged with any existing runtime values set from the prior version when issuing a PATCH request so it is possible to specify a null value to unset specific parameters and fall back to the defaultValue from the definition. |
|
| templateId | string | true | Custom Job Template ID. |
Enumerated Values¶
| Property | Value |
|---|---|
| jobType | [default, hostedCustomMetric, notification, retraining] |
CreateCustomJobRun
{
"properties": {
"description": {
"description": "The description of the custom job run.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"runtimeParameterValues": {
"description": "Ability to inject values at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the custom job metadata.yaml file. It has a priority over an existing runtime parameter overrides defined at the custom job level.",
"items": {
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
},
"value": {
"anyOf": [
{
"description": "The value for the given field.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
{
"default": false,
"description": "The boolean value for the field (default False)",
"type": "boolean"
},
{
"default": null,
"description": "The numeric value for the field",
"type": [
"number",
"null"
]
}
],
"description": "The string, boolean or numeric value for the given field.",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type",
"value"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
}
},
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | maxLength: 10000 |
The description of the custom job run. |
| runtimeParameterValues | [RuntimeParameterValue] | false | maxItems: 100 |
Ability to inject values at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the custom job metadata.yaml file. It has a priority over an existing runtime parameter overrides defined at the custom job level. |
CustomJobFileResponse
{
"properties": {
"content": {
"description": "Content of the chosen file.",
"type": "string",
"x-versionadded": "v2.33"
},
"fileName": {
"description": "Name of the chosen file.",
"type": "string",
"x-versionadded": "v2.33"
},
"filePath": {
"description": "Path of the chosen file.",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"content",
"fileName",
"filePath",
"id"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| content | string | true | Content of the chosen file. | |
| fileName | string | true | Name of the chosen file. | |
| filePath | string | true | Path of the chosen file. | |
| id | string | true | The ID of the custom job. |
CustomJobLimitsResponse
{
"properties": {
"maxCustomJobRuns": {
"description": "Number of custom jobs allowed to run in parallel.",
"type": "integer",
"x-versionadded": "v2.33"
},
"maxCustomJobTimeout": {
"description": "Execution time limit for the custom job in seconds.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"maxCustomJobRuns",
"maxCustomJobTimeout"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| maxCustomJobRuns | integer | true | Number of custom jobs allowed to run in parallel. | |
| maxCustomJobTimeout | integer | true | Execution time limit for the custom job in seconds. |
CustomJobListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer",
"x-versionadded": "v2.33"
},
"data": {
"description": "List of custom jobs.",
"items": {
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the custom job was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The ID of the entry point file to use.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobType": {
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string",
"x-versionadded": "v2.33"
},
"lastRun": {
"description": "The last custom job run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"updated": {
"description": "ISO-8601 timestamp of when custom job was last updated.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"environmentId",
"environmentVersionId",
"id",
"items",
"jobType",
"lastRun",
"name",
"resources",
"updated"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | Number of items returned on this page. | |
| data | [CustomJobResponse] | true | maxItems: 1000 |
List of custom jobs. |
| next | string,null(uri) | true | URL pointing to the next page (if null, there is no next page). | |
| previous | string,null(uri) | true | URL pointing to the previous page (if null, there is no previous page). | |
| totalCount | integer | true | The total number of items across all pages. |
CustomJobResources
{
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
}
The custom job resources that will be applied in the k8s cluster.
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| egressNetworkPolicy | string | true | Egress network policy. | |
| resourceBundleId | string,null | false | A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint. |
Enumerated Values¶
| Property | Value |
|---|---|
| egressNetworkPolicy | [none, public] |
CustomJobResponse
{
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the custom job was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The ID of the entry point file to use.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version used for this custom job.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobType": {
"description": "Type of the custom job.",
"enum": [
"default",
"hostedCustomMetric",
"notification",
"retraining"
],
"type": "string",
"x-versionadded": "v2.33"
},
"lastRun": {
"description": "The last custom job run.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"name": {
"description": "The name of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"updated": {
"description": "ISO-8601 timestamp of when custom job was last updated.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"environmentId",
"environmentVersionId",
"id",
"items",
"jobType",
"lastRun",
"name",
"resources",
"updated"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| created | string | true | ISO-8601 timestamp of when the custom job was created. | |
| description | string | false | maxLength: 10000 |
The description of the custom job. |
| entryPoint | string,null | false | The ID of the entry point file to use. | |
| environmentId | string,null | true | The ID of the execution environment used for this custom job. | |
| environmentVersionId | string,null | true | The ID of the execution environment version used for this custom job. | |
| id | string | true | The ID of the custom job. | |
| items | [WorkspaceItemResponse] | true | maxItems: 1000 |
List of file items. |
| jobType | string | true | Type of the custom job. | |
| lastRun | string,null | true | The last custom job run. | |
| name | string | true | The name of the custom job. | |
| resources | CustomJobResources | true | The custom job resources that will be applied in the k8s cluster. | |
| runtimeParameters | [RuntimeParameterUnified] | false | maxItems: 100 |
Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition. |
| updated | string | true | ISO-8601 timestamp of when custom job was last updated. |
Enumerated Values¶
| Property | Value |
|---|---|
| jobType | [default, hostedCustomMetric, notification, retraining] |
CustomJobRunListResponse
{
"properties": {
"count": {
"description": "Number of items returned on this page.",
"type": "integer",
"x-versionadded": "v2.33"
},
"data": {
"description": "List of custom job runs.",
"items": {
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the model was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"customJobId": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job run.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"duration": {
"description": "Duration of the custom test run is seconds.",
"type": "number",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The entry point file item ID in the custom job's workspace.",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobStatusId": {
"description": "ID to track the custom job run execution status.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"status": {
"description": "The status of the custom job run.",
"enum": [
"succeeded",
"failed",
"running",
"interrupted",
"canceling",
"canceled"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"customJobId",
"duration",
"id",
"items",
"jobStatusId",
"resources",
"status"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"next": {
"description": "URL pointing to the next page (if null, there is no next page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"previous": {
"description": "URL pointing to the previous page (if null, there is no previous page).",
"format": "uri",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"totalCount": {
"description": "The total number of items across all pages.",
"type": "integer",
"x-versionadded": "v2.33"
}
},
"required": [
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | false | Number of items returned on this page. | |
| data | [CustomJobRunResponse] | true | maxItems: 1000 |
List of custom job runs. |
| next | string,null(uri) | true | URL pointing to the next page (if null, there is no next page). | |
| previous | string,null(uri) | true | URL pointing to the previous page (if null, there is no previous page). | |
| totalCount | integer | true | The total number of items across all pages. |
CustomJobRunResponse
{
"properties": {
"created": {
"description": "ISO-8601 timestamp of when the model was created.",
"type": "string",
"x-versionadded": "v2.33"
},
"customJobId": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"description": {
"description": "The description of the custom job run.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"duration": {
"description": "Duration of the custom test run is seconds.",
"type": "number",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The entry point file item ID in the custom job's workspace.",
"type": "string",
"x-versionadded": "v2.33"
},
"id": {
"description": "The ID of the custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"items": {
"description": "List of file items.",
"items": {
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
},
"maxItems": 1000,
"type": "array",
"x-versionadded": "v2.33"
},
"jobStatusId": {
"description": "ID to track the custom job run execution status.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameters": {
"description": "Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition.",
"items": {
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
},
"maxItems": 100,
"type": "array",
"x-versionadded": "v2.33"
},
"status": {
"description": "The status of the custom job run.",
"enum": [
"succeeded",
"failed",
"running",
"interrupted",
"canceling",
"canceled"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"created",
"customJobId",
"duration",
"id",
"items",
"jobStatusId",
"resources",
"status"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| created | string | true | ISO-8601 timestamp of when the model was created. | |
| customJobId | string | true | The ID of the custom job. | |
| description | string | false | maxLength: 10000 |
The description of the custom job run. |
| duration | number | true | Duration of the custom test run is seconds. | |
| entryPoint | string | false | The entry point file item ID in the custom job's workspace. | |
| id | string | true | The ID of the custom job. | |
| items | [WorkspaceItemResponse] | true | maxItems: 1000 |
List of file items. |
| jobStatusId | string,null | true | ID to track the custom job run execution status. | |
| resources | CustomJobResources | true | The custom job resources that will be applied in the k8s cluster. | |
| runtimeParameters | [RuntimeParameterUnified] | false | maxItems: 100 |
Unified view of the defined runtime parameters for this custom job along with any values that are currently set that override the default value from their definition. |
| status | string | true | The status of the custom job run. |
Enumerated Values¶
| Property | Value |
|---|---|
| status | [succeeded, failed, running, interrupted, canceling, canceled] |
GrantAccessControlWithId
{
"properties": {
"id": {
"description": "The ID of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity. One of OWNER, USER, OBSERVER.",
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"role",
"shareRecipientType"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | The ID of the recipient. | |
| role | string | true | The role of the recipient on this entity. One of OWNER, USER, OBSERVER. | |
| shareRecipientType | string | true | Describes the recipient type, either user, group, or organization. |
Enumerated Values¶
| Property | Value |
|---|---|
| shareRecipientType | [user, group, organization] |
GrantAccessControlWithUsername
{
"properties": {
"role": {
"description": "The role of the recipient on this entity. One of OWNER, USER, OBSERVER.",
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
},
"username": {
"description": "Username of the user to update the access role for.",
"type": "string"
}
},
"required": [
"role",
"shareRecipientType",
"username"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| role | string | true | The role of the recipient on this entity. One of OWNER, USER, OBSERVER. | |
| shareRecipientType | string | true | Describes the recipient type, either user, group, or organization. | |
| username | string | true | Username of the user to update the access role for. |
Enumerated Values¶
| Property | Value |
|---|---|
| shareRecipientType | [user, group, organization] |
RuntimeParameterUnified
{
"properties": {
"allowEmpty": {
"default": true,
"description": "Indicates whether the param must be set before registration",
"type": "boolean",
"x-versionadded": "v2.33"
},
"credentialType": {
"description": "The type of credential, required only for credentials parameters.",
"enum": [
"adlsGen2Oauth",
"apiToken",
"azure",
"azureServicePrincipal",
"basic",
"bearer",
"databricksAccessTokenAccount",
"databricksServicePrincipalAccount",
"gcp",
"oauth",
"rsa",
"s3",
"sapOauth",
"snowflakeKeyPairUserAccount",
"snowflakeOauthUserAccount",
"tableauAccessToken"
],
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"currentValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Given the default and the override, this is the actual current value of the parameter.",
"x-versionadded": "v2.33"
},
"defaultValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "The default value for the given field.",
"x-versionadded": "v2.33"
},
"description": {
"description": "Description how this parameter impacts the running model.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
},
"fieldName": {
"description": "The parameter name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"maxValue": {
"description": "The maximum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"minValue": {
"description": "The minimum value for a numeric field.",
"type": [
"number",
"null"
],
"x-versionadded": "v2.33"
},
"overrideValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
],
"description": "Value set by the user that overrides the default set in the definition.",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| allowEmpty | boolean | false | Indicates whether the param must be set before registration | |
| credentialType | string,null | false | The type of credential, required only for credentials parameters. | |
| currentValue | any | false | Given the default and the override, this is the actual current value of the parameter. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | number | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | boolean | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| defaultValue | any | false | The default value for the given field. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | number | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | boolean | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string,null | false | Description how this parameter impacts the running model. | |
| fieldName | string | true | The parameter name. This value will be added as an environment variable when running custom models. | |
| maxValue | number,null | false | The maximum value for a numeric field. | |
| minValue | number,null | false | The minimum value for a numeric field. | |
| overrideValue | any | false | Value set by the user that overrides the default set in the definition. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | number | false | none |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | boolean | false | none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | true | The type of this value. |
Enumerated Values¶
| Property | Value |
|---|---|
| credentialType | [adlsGen2Oauth, apiToken, azure, azureServicePrincipal, basic, bearer, databricksAccessTokenAccount, databricksServicePrincipalAccount, gcp, oauth, rsa, s3, sapOauth, snowflakeKeyPairUserAccount, snowflakeOauthUserAccount, tableauAccessToken] |
| type | [boolean, credential, customMetric, deployment, modelPackage, numeric, string] |
RuntimeParameterValue
{
"properties": {
"fieldName": {
"description": "The required field name. This value will be added as an environment variable when running custom models.",
"type": "string",
"x-versionadded": "v2.33"
},
"type": {
"description": "The type of this value.",
"enum": [
"boolean",
"credential",
"customMetric",
"deployment",
"modelPackage",
"numeric",
"string"
],
"type": "string",
"x-versionadded": "v2.33"
},
"value": {
"anyOf": [
{
"description": "The value for the given field.",
"maxLength": 4096,
"type": [
"string",
"null"
]
},
{
"default": false,
"description": "The boolean value for the field (default False)",
"type": "boolean"
},
{
"default": null,
"description": "The numeric value for the field",
"type": [
"number",
"null"
]
}
],
"description": "The string, boolean or numeric value for the given field.",
"x-versionadded": "v2.33"
}
},
"required": [
"fieldName",
"type",
"value"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fieldName | string | true | The required field name. This value will be added as an environment variable when running custom models. | |
| type | string | true | The type of this value. | |
| value | any | true | The string, boolean or numeric value for the given field. |
anyOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string,null | false | maxLength: 4096 |
The value for the given field. |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | boolean | false | The boolean value for the field (default False) |
or
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | number,null | false | The numeric value for the field |
Enumerated Values¶
| Property | Value |
|---|---|
| type | [boolean, credential, customMetric, deployment, modelPackage, numeric, string] |
SharedRolesUpdate
{
"properties": {
"operation": {
"description": "Name of the action being taken. The only operation is 'updateRoles'.",
"enum": [
"updateRoles"
],
"type": "string"
},
"roles": {
"description": "Array of GrantAccessControl objects., up to maximum 100 objects.",
"items": {
"oneOf": [
{
"properties": {
"role": {
"description": "The role of the recipient on this entity. One of OWNER, USER, OBSERVER.",
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
},
"username": {
"description": "Username of the user to update the access role for.",
"type": "string"
}
},
"required": [
"role",
"shareRecipientType",
"username"
],
"type": "object"
},
{
"properties": {
"id": {
"description": "The ID of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity. One of OWNER, USER, OBSERVER.",
"type": "string"
},
"shareRecipientType": {
"description": "Describes the recipient type, either user, group, or organization.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"role",
"shareRecipientType"
],
"type": "object"
}
]
},
"maxItems": 100,
"minItems": 1,
"type": "array"
}
},
"required": [
"operation",
"roles"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | string | true | Name of the action being taken. The only operation is 'updateRoles'. | |
| roles | [oneOf] | true | maxItems: 100 minItems: 1 |
Array of GrantAccessControl objects., up to maximum 100 objects. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | GrantAccessControlWithUsername | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | GrantAccessControlWithId | false | none |
Enumerated Values¶
| Property | Value |
|---|---|
| operation | updateRoles |
SharingListV2Response
{
"properties": {
"count": {
"description": "The number of items returned.",
"type": "integer"
},
"data": {
"description": "The access control list.",
"items": {
"properties": {
"id": {
"description": "The identifier of the recipient.",
"type": "string"
},
"name": {
"description": "The name of the recipient.",
"type": "string"
},
"role": {
"description": "The role of the recipient on this entity.",
"enum": [
"ADMIN",
"CONSUMER",
"DATA_SCIENTIST",
"EDITOR",
"OBSERVER",
"OWNER",
"READ_ONLY",
"READ_WRITE",
"USER"
],
"type": "string"
},
"shareRecipientType": {
"description": "The type of the recipient.",
"enum": [
"user",
"group",
"organization"
],
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"shareRecipientType"
],
"type": "object"
},
"maxItems": 1000,
"type": "array"
},
"next": {
"description": "URL pointing to the next page.",
"type": [
"string",
"null"
]
},
"previous": {
"description": "URL pointing to the previous page.",
"type": [
"string",
"null"
]
},
"totalCount": {
"description": "Total number of items matching the condition.",
"type": "integer"
}
},
"required": [
"count",
"data",
"next",
"previous",
"totalCount"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | true | The number of items returned. | |
| data | [AccessControlV2] | true | maxItems: 1000 |
The access control list. |
| next | string,null | true | URL pointing to the next page. | |
| previous | string,null | true | URL pointing to the previous page. | |
| totalCount | integer | true | Total number of items matching the condition. |
UpdateCustomJob
{
"properties": {
"description": {
"description": "The description of the custom job.",
"maxLength": 10000,
"type": "string",
"x-versionadded": "v2.33"
},
"entryPoint": {
"description": "The ID of the entry point file to use.",
"type": "string",
"x-versionadded": "v2.33"
},
"environmentId": {
"description": "The ID of the execution environment to use for this custom job.",
"type": "string",
"x-versionadded": "v2.33"
},
"environmentVersionId": {
"description": "The ID of the execution environment version to use for this custom job. If not provided, the latest execution environment version will be used.",
"type": "string",
"x-versionadded": "v2.33"
},
"file": {
"description": "A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding `filePath` supplied that shows the relative location of the file. For example, you have two files: `/home/username/custom-task/main.py` and `/home/username/custom-task/helpers/helper.py`. When uploading these files, you would _also_ need to include two `filePath` fields of, `\"main.py\"` and `\"helpers/helper.py\"`. If the supplied `file` already exists at the supplied `filePath`, the old file is replaced by the new file.",
"format": "binary",
"type": "string",
"x-versionadded": "v2.33"
},
"filePath": {
"description": "The local path of the file being uploaded. See the `file` field explanation for more details.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
}
],
"x-versionadded": "v2.33"
},
"filesToDelete": {
"description": "The IDs of the files to be deleted.",
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"maxItems": 100,
"type": "array"
}
],
"x-versionadded": "v2.33"
},
"name": {
"description": "Name of the custom job.",
"maxLength": 255,
"type": "string",
"x-versionadded": "v2.33"
},
"resources": {
"description": "The custom job resources that will be applied in the k8s cluster.",
"properties": {
"egressNetworkPolicy": {
"description": "Egress network policy.",
"enum": [
"none",
"public"
],
"type": "string",
"x-versionadded": "v2.33"
},
"resourceBundleId": {
"description": "A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc. A list of available bundles can be obtained via the resource bundles endpoint.",
"type": [
"string",
"null"
],
"x-versionadded": "v2.33"
}
},
"required": [
"egressNetworkPolicy"
],
"type": "object"
},
"runtimeParameterValues": {
"description": "Ability to inject values into a custom job at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the metadata.yaml file. This list will be merged with any existing runtime values set from the prior version when issuing a PATCH request so it is possible to specify a `null` value to unset specific parameters and fall back to the defaultValue from the definition.",
"type": "string",
"x-versionadded": "v2.33"
}
},
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | false | maxLength: 10000 |
The description of the custom job. |
| entryPoint | string | false | The ID of the entry point file to use. | |
| environmentId | string | false | The ID of the execution environment to use for this custom job. | |
| environmentVersionId | string | false | The ID of the execution environment version to use for this custom job. If not provided, the latest execution environment version will be used. | |
| file | string(binary) | false | A file with code for a custom task or a custom model. For each file supplied as form data, you must have a corresponding filePath supplied that shows the relative location of the file. For example, you have two files: /home/username/custom-task/main.py and /home/username/custom-task/helpers/helper.py. When uploading these files, you would also need to include two filePath fields of, "main.py" and "helpers/helper.py". If the supplied file already exists at the supplied filePath, the old file is replaced by the new file. |
|
| filePath | any | false | The local path of the file being uploaded. See the file field explanation for more details. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | maxItems: 1000 |
none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| filesToDelete | any | false | The IDs of the files to be deleted. |
oneOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | string | false | none |
xor
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | [string] | false | maxItems: 100 |
none |
continued
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | false | maxLength: 255 |
Name of the custom job. |
| resources | CustomJobResources | false | The custom job resources that will be applied in the k8s cluster. | |
| runtimeParameterValues | string | false | Ability to inject values into a custom job at runtime. The fieldName must match a fieldName that is listed in the runtimeParameterDefinitions section of the metadata.yaml file. This list will be merged with any existing runtime values set from the prior version when issuing a PATCH request so it is possible to specify a null value to unset specific parameters and fall back to the defaultValue from the definition. |
WorkspaceItemResponse
{
"properties": {
"commitSha": {
"description": "SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories).",
"type": [
"string",
"null"
]
},
"created": {
"description": "ISO-8601 timestamp of when the file item was created.",
"type": "string"
},
"fileName": {
"description": "Name of the file item.",
"type": "string"
},
"filePath": {
"description": "Path of the file item.",
"type": "string"
},
"fileSource": {
"description": "Source of the file item.",
"type": "string"
},
"id": {
"description": "ID of the file item.",
"type": "string"
},
"ref": {
"description": "Remote reference (branch, commit, tag). Branch \"master\", if not specified.",
"type": [
"string",
"null"
]
},
"repositoryFilePath": {
"description": "Full path to the file in the remote repository.",
"type": [
"string",
"null"
]
},
"repositoryLocation": {
"description": "URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name).",
"type": [
"string",
"null"
]
},
"repositoryName": {
"description": "Name of the repository from which the file was pulled.",
"type": [
"string",
"null"
]
}
},
"required": [
"created",
"fileName",
"filePath",
"fileSource",
"id"
],
"type": "object"
}
Properties¶
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| commitSha | string,null | false | SHA1 hash pointing to the original file revision (set only for files pulled from Git-like repositories). | |
| created | string | true | ISO-8601 timestamp of when the file item was created. | |
| fileName | string | true | Name of the file item. | |
| filePath | string | true | Path of the file item. | |
| fileSource | string | true | Source of the file item. | |
| id | string | true | ID of the file item. | |
| ref | string,null | false | Remote reference (branch, commit, tag). Branch "master", if not specified. | |
| repositoryFilePath | string,null | false | Full path to the file in the remote repository. | |
| repositoryLocation | string,null | false | URL to remote repository from which the file was pulled (e.g. Git server or S3 Bucket name). | |
| repositoryName | string,null | false | Name of the repository from which the file was pulled. |