Jump to

• Request
• Response

Submit a Spark Compute Job

post

/bdcsce/api/v1.1/clustermgmt/{identityDomainId}/instances/{clusterId}/jobs/spark

Request

Path Parameters

• clusterId: string
  Identifier for the Cluster
• identityDomainId: string
  Identity domain ID of the Oracle Cloud Service instance, used for authentication.

Body ()

Definition of the Spark Job that you want to submit.

Root Schema : SparkJobHttpRequest

Type: object

Show Source

• job(optional): object SparkJob

{
    "type":"object",
    "properties":{
        "job":{
            "description":"Spark Job Specification",
            "$ref":"#/definitions/SparkJob"
        }
    }
}

Nested Schema : SparkJob

Type: object

Show Source

• applicationArchives(optional): array applicationArchives
  Archives to be uncompressed in the executor working directory (YARN mode only)
• applicationArguments(optional): array applicationArguments
  Arguments that need to be sent to the _Application Main_ or the _Application Script_.
• applicationClass(optional): string
  In case of an application that runs inside the JVM this will specify the qualified name of the Class that will be used to call Spark-Submit.
• applicationFile: string
  The name of the file, script, or jar file that will be used to submit the Job.
• applicationJarFiles(optional): array applicationJarFiles
  List of jars that will be downloaded and collocated for the given Job.
• applicationName: string
  The name given to the application, mainly used for UI or Audit Logs.
• applicationPyFiles(optional): array applicationPyFiles
  List of python files that will be downloaded and collocated for the given Job.
• applicationSupportFiles(optional): array applicationSupportFiles
  List of files that will be downloaded and collocated for the given Job.
• applicationType(optional): string
  Allowed Values: [ "hive", "mapreduce", "spark", "tez", "yarn", "unkown" ]
• clusterId(optional): string
  The Cluster where the given Job is assigned to run.
• driverClasspath(optional): array driverClasspath
  Driver classpath.
• driverCores(optional): integer(int32)
  Number of cores used by driver.
• driverLibraryPath(optional): string
  Extra library path entries to pass to the driver.
• driverMaxResults(optional): string
  Limit of total size of serialized results of all partitions for each Spark action (e.g. collect). Should be at least 1M, or 0 for unlimited. Jobs will be aborted if the total size is above this limit. Having a high limit may cause out-of-memory errors in driver (depends on spark.driver.memory and memory overhead of objects in JVM). Setting a proper limit can protect the driver from out-of-memory errors.

  Example: 2G
• driverMemory(optional): string
  Memory for driver (e.g. 1000M, 2G).

  Example: 2G
• excludePackages(optional): array excludePackages
  Comma-separated list of groupId:artifactId, to exclude while resolving the dependencies provided in `packages`.
• executorCores(optional): integer(int32)
  Number of cores used by executor.
• executorEnv(optional): object executorEnv
  Additional Properties Allowed: additionalProperties

  Map of environment variable that should be available to the Executor process. For example, the maximum waiting period that the requester is willing to wait for the job to actually start running inside a cluster before the Job is considered failed, REQUEST_TIMEOUT.
• executorExtraClasspath(optional): array executorExtraClasspath
  Extra classpath entries to prepend to the classpath of executors.This exists primarily for backwards-compatibility with older versions of Spark.Users typically should not need to set this option.
• executorExtraLibraryPath(optional): string
  Set a special library path to use when launching executor JVM's.
• executorMemory(optional): string
  Memory for executor (e.g. 1000M, 2G).

  Example: 2G
• extraJavaOptions(optional): array extraJavaOptions
  A map of extra JVM options to pass to executors and driver. For instance, GC settings or other logging. Note that it is illegal to set Spark properties or heap size settings with this option. Spark properties should be set using a SparkConf object or the spark-defaults.conf file used with the spark-submit script. Heap size settings can be set with spark.executor.memory.
• extraListeners(optional): array extraListeners
  Extra listeners
• id(optional): string
  Unique Identifier of this Job.
• maxJobDurationInSecs(optional): object maxJobDurationInSecs
  Maximum duration of a Job in seconds. When a Job exceeds the amount of time the Job will be terminated.
• maxSubmissionLatencyInSecs(optional): object maxSubmissionLatencyInSecs
  The maximum waiting period that the requester is willing to wait for the job to actually start running inside a cluster before the Job is considered failed, REQUEST_TIMEOUT.
• numExecutors(optional): integer(int32)
  Number of executors.
• packages(optional): array packages
  Comma-separated list of maven coordinates of jars to include on the driver and executor classpaths. Will search the local maven repo, then maven central and any additional remote repository The format for the coordinates should be `groupId:artifactId:version`.
• queue(optional): string
  Server queue used to submit too.
• repositories(optional): array repositories
  Comma-separated list of additional remote repositories to search for the maven coordinates given with `packages`.
• sparkConf(optional): object sparkConf
  Additional Properties Allowed: additionalProperties

  Map of Spark configuration options that were used to submit the Job.
• sparkJobType: string
  Allowed Values: [ "batch", "interactive", "streaming" ]

  Type of the Spark Job
• sparkSessionType: string
  Allowed Values: [ "spark", "pyspark", "sparkr" ]

  Type of the Spark session used to run the Job.

{
    "type":"object",
    "required":[
        "applicationFile",
        "applicationName",
        "sparkJobType",
        "sparkSessionType"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique Identifier of this Job."
        },
        "sparkJobType":{
            "type":"string",
            "description":"Type of the Spark Job",
            "enum":[
                "batch",
                "interactive",
                "streaming"
            ]
        },
        "sparkSessionType":{
            "type":"string",
            "description":"Type of the Spark session used to run the Job.",
            "enum":[
                "spark",
                "pyspark",
                "sparkr"
            ]
        },
        "applicationName":{
            "type":"string",
            "description":"The name given to the application, mainly used for UI or Audit Logs."
        },
        "applicationFile":{
            "type":"string",
            "description":"The name of the file, script, or jar file that will be used to submit the Job."
        },
        "packages":{
            "type":"array",
            "description":"Comma-separated list of maven coordinates of jars to include on the driver and executor classpaths. Will search the local maven repo, then maven central and any additional remote repository\nThe format for the coordinates should be `groupId:artifactId:version`.",
            "items":{
                "type":"string"
            }
        },
        "excludePackages":{
            "type":"array",
            "description":"Comma-separated list of groupId:artifactId, to exclude while resolving the dependencies provided in `packages`.",
            "items":{
                "type":"string"
            }
        },
        "repositories":{
            "type":"array",
            "description":"Comma-separated list of additional remote repositories to search for the maven coordinates given with `packages`.",
            "items":{
                "type":"string"
            }
        },
        "clusterId":{
            "type":"string",
            "description":"The Cluster where the given Job is assigned to run."
        },
        "extraListeners":{
            "type":"array",
            "description":"Extra listeners",
            "items":{
                "type":"string"
            }
        },
        "applicationClass":{
            "type":"string",
            "description":"In case of an application that runs inside the JVM this will specify the qualified name of the Class that will be used to call Spark-Submit."
        },
        "applicationArguments":{
            "type":"array",
            "description":"Arguments that need to be sent to the _Application Main_ or the _Application Script_.",
            "items":{
                "type":"string"
            }
        },
        "applicationJarFiles":{
            "type":"array",
            "description":"List of jars that will be downloaded and collocated for the given Job.",
            "items":{
                "type":"string"
            }
        },
        "applicationPyFiles":{
            "type":"array",
            "description":"List of python files that will be downloaded and collocated for the given Job.",
            "items":{
                "type":"string"
            }
        },
        "applicationSupportFiles":{
            "type":"array",
            "description":"List of files that will be downloaded and collocated for the given Job.",
            "items":{
                "type":"string"
            }
        },
        "applicationArchives":{
            "type":"array",
            "description":"Archives to be uncompressed in the executor working directory (YARN mode only)",
            "items":{
                "type":"string"
            }
        },
        "driverMemory":{
            "type":"string",
            "example":"2G",
            "description":"Memory for driver (e.g. 1000M, 2G)."
        },
        "driverLibraryPath":{
            "type":"string",
            "description":"Extra library path entries to pass to the driver."
        },
        "driverMaxResults":{
            "type":"string",
            "example":"2G",
            "description":"Limit of total size of serialized results of all partitions for each Spark action (e.g. collect). Should be at least 1M, or 0 for unlimited. Jobs will be aborted if the total size is above this limit. Having a high limit may cause out-of-memory errors in driver (depends on spark.driver.memory and memory overhead of objects in JVM). Setting a proper limit can protect the driver from out-of-memory errors."
        },
        "driverCores":{
            "type":"integer",
            "format":"int32",
            "description":"Number of cores used by driver. "
        },
        "driverClasspath":{
            "type":"array",
            "description":"Driver classpath.",
            "items":{
                "type":"string"
            }
        },
        "executorExtraClasspath":{
            "type":"array",
            "description":"Extra classpath entries to prepend to the classpath of executors.This exists primarily for backwards-compatibility with older versions of Spark.Users typically should not need to set this option.",
            "items":{
                "type":"string"
            }
        },
        "executorExtraLibraryPath":{
            "type":"string",
            "description":"Set a special library path to use when launching executor JVM's."
        },
        "extraJavaOptions":{
            "type":"array",
            "description":"A map of extra JVM options to pass to executors and driver. For instance, GC settings or other logging. Note that it is illegal to set Spark properties or heap size settings with this option. Spark properties should be set using a SparkConf object or the spark-defaults.conf file used with the spark-submit script. Heap size settings can be set with spark.executor.memory.",
            "items":{
                "type":"string"
            }
        },
        "executorEnv":{
            "type":"object",
            "description":"Map of environment variable that should be available to the Executor process. For example, the maximum waiting period that the requester is willing to wait for the job to actually start running inside a cluster before the Job is considered failed, REQUEST_TIMEOUT.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "executorMemory":{
            "type":"string",
            "example":"2G",
            "description":"Memory for executor (e.g. 1000M, 2G)."
        },
        "executorCores":{
            "type":"integer",
            "format":"int32",
            "description":"Number of cores used by executor."
        },
        "numExecutors":{
            "type":"integer",
            "format":"int32",
            "description":"Number of executors."
        },
        "sparkConf":{
            "type":"object",
            "description":"Map of Spark configuration options that were used to submit the Job.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "queue":{
            "type":"string",
            "description":"Server queue used to submit too."
        },
        "maxJobDurationInSecs":{
            "type":"object",
            "description":"Maximum duration of a Job in seconds. When a Job exceeds the amount of time the Job will be terminated."
        },
        "maxSubmissionLatencyInSecs":{
            "type":"object",
            "description":"The maximum waiting period that the requester is willing to wait for the job to actually start running inside a cluster before the Job is considered failed, REQUEST_TIMEOUT."
        },
        "applicationType":{
            "type":"string",
            "enum":[
                "hive",
                "mapreduce",
                "spark",
                "tez",
                "yarn",
                "unkown"
            ]
        }
    }
}

Nested Schema : applicationArchives

Type: array

Archives to be uncompressed in the executor working directory (YARN mode only)

Show Source

• [0]: string

{
    "type":"array",
    "description":"Archives to be uncompressed in the executor working directory (YARN mode only)",
    "items":{
        "type":"string"
    }
}

Nested Schema : applicationArguments

Type: array

Arguments that need to be sent to the _Application Main_ or the _Application Script_.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Arguments that need to be sent to the _Application Main_ or the _Application Script_.",
    "items":{
        "type":"string"
    }
}

Nested Schema : applicationJarFiles

Type: array

List of jars that will be downloaded and collocated for the given Job.

Show Source

• [0]: string

{
    "type":"array",
    "description":"List of jars that will be downloaded and collocated for the given Job.",
    "items":{
        "type":"string"
    }
}

Nested Schema : applicationPyFiles

Type: array

List of python files that will be downloaded and collocated for the given Job.

Show Source

• [0]: string

{
    "type":"array",
    "description":"List of python files that will be downloaded and collocated for the given Job.",
    "items":{
        "type":"string"
    }
}

Nested Schema : applicationSupportFiles

Type: array

List of files that will be downloaded and collocated for the given Job.

Show Source

• [0]: string

{
    "type":"array",
    "description":"List of files that will be downloaded and collocated for the given Job.",
    "items":{
        "type":"string"
    }
}

Nested Schema : driverClasspath

Type: array

Driver classpath.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Driver classpath.",
    "items":{
        "type":"string"
    }
}

Nested Schema : excludePackages

Type: array

Comma-separated list of groupId:artifactId, to exclude while resolving the dependencies provided in `packages`.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Comma-separated list of groupId:artifactId, to exclude while resolving the dependencies provided in `packages`.",
    "items":{
        "type":"string"
    }
}

Nested Schema : executorEnv

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Map of environment variable that should be available to the Executor process. For example, the maximum waiting period that the requester is willing to wait for the job to actually start running inside a cluster before the Job is considered failed, REQUEST_TIMEOUT.",
    "additionalProperties":{
        "type":"string"
    }
}

Map of environment variable that should be available to the Executor process. For example, the maximum waiting period that the requester is willing to wait for the job to actually start running inside a cluster before the Job is considered failed, REQUEST_TIMEOUT.

Nested Schema : executorExtraClasspath

Type: array

Extra classpath entries to prepend to the classpath of executors.This exists primarily for backwards-compatibility with older versions of Spark.Users typically should not need to set this option.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Extra classpath entries to prepend to the classpath of executors.This exists primarily for backwards-compatibility with older versions of Spark.Users typically should not need to set this option.",
    "items":{
        "type":"string"
    }
}

Nested Schema : extraJavaOptions

Type: array

A map of extra JVM options to pass to executors and driver. For instance, GC settings or other logging. Note that it is illegal to set Spark properties or heap size settings with this option. Spark properties should be set using a SparkConf object or the spark-defaults.conf file used with the spark-submit script. Heap size settings can be set with spark.executor.memory.

Show Source

• [0]: string

{
    "type":"array",
    "description":"A map of extra JVM options to pass to executors and driver. For instance, GC settings or other logging. Note that it is illegal to set Spark properties or heap size settings with this option. Spark properties should be set using a SparkConf object or the spark-defaults.conf file used with the spark-submit script. Heap size settings can be set with spark.executor.memory.",
    "items":{
        "type":"string"
    }
}

Nested Schema : extraListeners

Type: array

Extra listeners

Show Source

• [0]: string

{
    "type":"array",
    "description":"Extra listeners",
    "items":{
        "type":"string"
    }
}

Nested Schema : maxJobDurationInSecs

Type: object

Maximum duration of a Job in seconds. When a Job exceeds the amount of time the Job will be terminated.

Nested Schema : maxSubmissionLatencyInSecs

Type: object

The maximum waiting period that the requester is willing to wait for the job to actually start running inside a cluster before the Job is considered failed, REQUEST_TIMEOUT.

Nested Schema : packages

Type: array

Comma-separated list of maven coordinates of jars to include on the driver and executor classpaths. Will search the local maven repo, then maven central and any additional remote repository The format for the coordinates should be `groupId:artifactId:version`.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Comma-separated list of maven coordinates of jars to include on the driver and executor classpaths. Will search the local maven repo, then maven central and any additional remote repository\nThe format for the coordinates should be `groupId:artifactId:version`.",
    "items":{
        "type":"string"
    }
}

Nested Schema : repositories

Type: array

Comma-separated list of additional remote repositories to search for the maven coordinates given with `packages`.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Comma-separated list of additional remote repositories to search for the maven coordinates given with `packages`.",
    "items":{
        "type":"string"
    }
}

Nested Schema : sparkConf

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"Map of Spark configuration options that were used to submit the Job.",
    "additionalProperties":{
        "type":"string"
    }
}

Map of Spark configuration options that were used to submit the Job.

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

200 Response

Body ()

Root Schema : AsyncJobStatus

Type: object

Show Source

• aggregatedLogs(optional): object JobAggregatedLogs
• aggregatedStoredLogs(optional): object JobAggregatedStoredLogs
• allocatedMB(optional): integer(int32)
  Sum of memory in MB allocated to the job's running containers.
• allocatedOCores(optional): object allocatedOCores
  Read Only: true

  Sum of virtual cores allocated to the job???s running containers.
• allocatedVCores(optional): integer(int32)
  Sum of virtual cores allocated to the job's running containers.
• applicationTags(optional): array applicationTags
  A collection of tags or labels associated with this job.
• applicationType(optional): string
  Allowed Values: [ "hive", "mapreduce", "spark", "tez", "yarn", "unkown" ]

  The kind of application that this job represents.
• completed(optional): object completed
  Read Only: true

  Specifies whether the job has been completed. It can be used to determine whether the client needs to keep polling the -progress- status.
• completedPercentage(optional): integer(int32)
  A value between 0 and 100 that specifies the percentage that the job is complete.
• connectors(optional): array connectors
  Connecting interfaces that this Job offers. An example of this connector will be the Spark UI.
• containerLogs(optional): array containerLogs
  Location of log file(s) for a running job.
• displayName(optional): string
  Read Only: true
• elapsedTime(optional): integer(int64)
  Time since the job started (in ms)
• endTime(optional): string(date-time)
  Read Only: true

  Specifies the time at which the job has ended. This property is available only after a job has ended.
• endTimeMillis(optional): integer(int64)
  Time in which job ended (in ms since epoch)
• error(optional): object Error
• id(optional): string
  Read Only: true

  Unique Job Identifier
• intervalToPoll(optional): integer(int64)
  Specifies the number of milliseconds to wait before rechecking the status of a job.
• jobType(optional): string
  Read Only: true
• links(optional): array links
  Hyperlinks to other associated resources.
• memorySeconds(optional): integer(int64)
  The amount of memory the job has allocated
• message(optional): string
  Human-readable message that describes the current processing status.
• name(optional): string
  Name of the Job, used for visual identification. It is not unique.
• nameAlias(optional): string
  Read Only: true
• progress(optional): string
  Allowed Values: [ "aborted", "aborting", "accepted", "failed", "paused", "pending", "processing", "succeeded", "undefined" ]

  Current progress of the Job.
• queue(optional): string
  Job Queue where this job was scheduled to run.
• runningContainers(optional): integer(int32)
  Number of containers currently running for the job.
• sessionType(optional): string
  Read Only: true
• snapshotTime(optional): integer(int64)
• startTime(optional): string(date-time)
  Read Only: true

  Specifies the time at which the job started.
• startTimeMillis(optional): integer(int64)
  Time in which job started (in ms since epoch)
• vcoreSeconds(optional): integer(int64)
  The amount of CPU resources the job has allocated

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique Job Identifier",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"Name of the Job, used for visual identification. It is not unique."
        },
        "applicationType":{
            "type":"string",
            "description":"The kind of application that this job represents.",
            "enum":[
                "hive",
                "mapreduce",
                "spark",
                "tez",
                "yarn",
                "unkown"
            ]
        },
        "applicationTags":{
            "type":"array",
            "description":"A collection of tags or labels associated with this job.",
            "items":{
                "type":"string"
            }
        },
        "queue":{
            "type":"string",
            "description":"Job Queue where this job was scheduled to run."
        },
        "intervalToPoll":{
            "type":"integer",
            "format":"int64",
            "description":"Specifies the number of milliseconds to wait before rechecking the status of a job."
        },
        "completedPercentage":{
            "type":"integer",
            "format":"int32",
            "description":"A value between 0 and 100 that specifies the percentage that the job is complete."
        },
        "startTimeMillis":{
            "type":"integer",
            "format":"int64",
            "description":"Time in which job started (in ms since epoch)"
        },
        "endTimeMillis":{
            "type":"integer",
            "format":"int64",
            "description":"Time in which job ended (in ms since epoch)"
        },
        "elapsedTime":{
            "type":"integer",
            "format":"int64",
            "description":"Time since the job started (in ms)"
        },
        "allocatedMB":{
            "type":"integer",
            "format":"int32",
            "description":"Sum of memory in MB allocated to the job's running containers."
        },
        "allocatedVCores":{
            "type":"integer",
            "format":"int32",
            "description":"Sum of virtual cores allocated to the job's running containers."
        },
        "runningContainers":{
            "type":"integer",
            "format":"int32",
            "description":"Number of containers currently running for the job."
        },
        "progress":{
            "type":"string",
            "description":"Current progress of the Job.",
            "enum":[
                "aborted",
                "aborting",
                "accepted",
                "failed",
                "paused",
                "pending",
                "processing",
                "succeeded",
                "undefined"
            ]
        },
        "message":{
            "type":"string",
            "description":"Human-readable message that describes the current processing status."
        },
        "error":{
            "description":"Specifies the exception detail of the original request. This value is available only when a job has completed and failed.",
            "$ref":"#/definitions/Error"
        },
        "memorySeconds":{
            "type":"integer",
            "format":"int64",
            "description":"The amount of memory the job has allocated"
        },
        "vcoreSeconds":{
            "type":"integer",
            "format":"int64",
            "description":"The amount of CPU resources the job has allocated"
        },
        "containerLogs":{
            "type":"array",
            "description":"Location of log file(s) for a running job.",
            "items":{
                "$ref":"#/definitions/JobContainerLogs"
            }
        },
        "aggregatedLogs":{
            "description":"Aggregated log file(s) for a completed job available in the cluster.",
            "$ref":"#/definitions/JobAggregatedLogs"
        },
        "aggregatedStoredLogs":{
            "description":"Location of the aggregated log file(s) that have been copied to long term storage.",
            "$ref":"#/definitions/JobAggregatedStoredLogs"
        },
        "connectors":{
            "type":"array",
            "description":"Connecting interfaces that this Job offers. An example of this connector will be the Spark UI.",
            "items":{
                "$ref":"#/definitions/JobConnectorReference"
            }
        },
        "links":{
            "type":"array",
            "description":"Hyperlinks to other associated resources.",
            "items":{
                "$ref":"#/definitions/ModelLink"
            }
        },
        "snapshotTime":{
            "type":"integer",
            "format":"int64"
        },
        "startTime":{
            "type":"string",
            "format":"date-time",
            "description":"Specifies the time at which the job started.",
            "readOnly":true
        },
        "endTime":{
            "type":"string",
            "format":"date-time",
            "description":"Specifies the time at which the job has ended. This property is available only after a job has ended.",
            "readOnly":true
        },
        "sessionType":{
            "type":"string",
            "readOnly":true
        },
        "jobType":{
            "type":"string",
            "readOnly":true
        },
        "nameAlias":{
            "type":"string",
            "readOnly":true
        },
        "displayName":{
            "type":"string",
            "readOnly":true
        },
        "allocatedOCores":{
            "type":"object",
            "description":"Sum of virtual cores allocated to the job???s running containers.",
            "readOnly":true
        },
        "completed":{
            "type":"object",
            "description":"Specifies whether the job has been completed. It can be used to determine whether the client needs to keep polling the -progress- status.",
            "readOnly":true
        }
    }
}

Nested Schema : JobAggregatedLogs

Type: object

Show Source

• files(optional): array files

{
    "type":"object",
    "properties":{
        "files":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/JobLogFileReference"
            }
        }
    }
}

Nested Schema : JobAggregatedStoredLogs

Type: object

Show Source

• containerHref(optional): string
• containerName(optional): string
• containerPath(optional): string
• files(optional): array files

{
    "type":"object",
    "properties":{
        "containerName":{
            "type":"string"
        },
        "containerPath":{
            "type":"string"
        },
        "containerHref":{
            "type":"string"
        },
        "files":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/JobLogFileReference"
            }
        }
    }
}

Nested Schema : allocatedOCores

Type: object

Read Only: true

Sum of virtual cores allocated to the job???s running containers.

Nested Schema : applicationTags

Type: array

A collection of tags or labels associated with this job.

Show Source

• [0]: string

{
    "type":"array",
    "description":"A collection of tags or labels associated with this job.",
    "items":{
        "type":"string"
    }
}

Nested Schema : completed

Type: object

Read Only: true

Specifies whether the job has been completed. It can be used to determine whether the client needs to keep polling the -progress- status.

Nested Schema : connectors

Type: array

Connecting interfaces that this Job offers. An example of this connector will be the Spark UI.

Show Source

• [0]: object JobConnectorReference

{
    "type":"array",
    "description":"Connecting interfaces that this Job offers. An example of this connector will be the Spark UI.",
    "items":{
        "$ref":"#/definitions/JobConnectorReference"
    }
}

Nested Schema : containerLogs

Type: array

Location of log file(s) for a running job.

Show Source

• [0]: object JobContainerLogs

{
    "type":"array",
    "description":"Location of log file(s) for a running job.",
    "items":{
        "$ref":"#/definitions/JobContainerLogs"
    }
}

Nested Schema : Error

Type: object

Show Source

• detail(optional): string
  detail
• instance(optional): string
  instance
• o:errorCode(optional): string
  Read Only: true

  error code
• o:errorDetails(optional): array o:errorDetails
  Read Only: true

  error details
• o:errorPath(optional): string
  Read Only: true

  error path
• status: integer(int32)
  status
• title: string
  title
• type(optional): string
  Read Only: true

  RFC Link

{
    "type":"object",
    "required":[
        "status",
        "title"
    ],
    "properties":{
        "title":{
            "type":"string",
            "description":"title"
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"status"
        },
        "detail":{
            "type":"string",
            "description":"detail"
        },
        "instance":{
            "type":"string",
            "description":"instance"
        },
        "o:errorCode":{
            "type":"string",
            "description":"error code",
            "readOnly":true
        },
        "o:errorPath":{
            "type":"string",
            "description":"error path",
            "readOnly":true
        },
        "o:errorDetails":{
            "type":"array",
            "description":"error details",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Error"
            }
        },
        "type":{
            "type":"string",
            "description":"RFC Link",
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Hyperlinks to other associated resources.

Show Source

• [0]: object ModelLink

{
    "type":"array",
    "description":"Hyperlinks to other associated resources.",
    "items":{
        "$ref":"#/definitions/ModelLink"
    }
}

Nested Schema : files

Type: array

Show Source

• [0]: object JobLogFileReference

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/JobLogFileReference"
    }
}

Nested Schema : JobLogFileReference

Type: object

Show Source

• name(optional): string
• sizeBytes(optional): integer(int64)
• uri(optional): string(uri)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "uri":{
            "type":"string",
            "format":"uri"
        },
        "sizeBytes":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : files

Type: array

Show Source

• [0]: object JobLogFileReference

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/JobLogFileReference"
    }
}

Nested Schema : JobConnectorReference

Type: object

Show Source

• description: string
  The description of the interface.
• name: string
  The name of the interface. e.g. Spark UI
• rel: string(uri)
  Related uri
• type(optional): string
  Read Only: true

  The media type to apply to the URI
• uris: array uris
  The URI of the linked resource

{
    "type":"object",
    "required":[
        "description",
        "name",
        "rel",
        "uris"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the interface. e.g. Spark UI"
        },
        "description":{
            "type":"string",
            "description":"The description of the interface."
        },
        "uris":{
            "type":"array",
            "description":"The URI of the linked resource",
            "items":{
                "$ref":"#/definitions/JobConnectorResourceIdentifier"
            }
        },
        "rel":{
            "type":"string",
            "format":"uri",
            "description":"Related uri"
        },
        "type":{
            "type":"string",
            "description":"The media type to apply to the URI",
            "readOnly":true
        }
    }
}

Nested Schema : uris

Type: array

The URI of the linked resource

Show Source

• [0]: object JobConnectorResourceIdentifier

{
    "type":"array",
    "description":"The URI of the linked resource",
    "items":{
        "$ref":"#/definitions/JobConnectorResourceIdentifier"
    }
}

Nested Schema : JobConnectorResourceIdentifier

Type: object

Show Source

• description: string
  The description of the interface.
• id: string
  The id of the interface. e.g. 1
• uri: string(uri)
  The URI of the linked resource

{
    "type":"object",
    "required":[
        "description",
        "id",
        "uri"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the interface. e.g. 1"
        },
        "description":{
            "type":"string",
            "description":"The description of the interface."
        },
        "uri":{
            "type":"string",
            "format":"uri",
            "description":"The URI of the linked resource"
        }
    }
}

Nested Schema : JobContainerLogs

Type: object

Show Source

• containerId: string
  Unique Identifier of the Container that is generating the Log.
• files: array files
  Log files with path relative to the Container.

{
    "type":"object",
    "required":[
        "containerId",
        "files"
    ],
    "properties":{
        "containerId":{
            "type":"string",
            "description":"Unique Identifier of the Container that is generating the Log."
        },
        "files":{
            "type":"array",
            "description":"Log files with path relative to the Container.",
            "items":{
                "$ref":"#/definitions/JobLogFileReference"
            }
        }
    }
}

Nested Schema : files

Type: array

Log files with path relative to the Container.

Show Source

• [0]: object JobLogFileReference

{
    "type":"array",
    "description":"Log files with path relative to the Container.",
    "items":{
        "$ref":"#/definitions/JobLogFileReference"
    }
}

Nested Schema : o:errorDetails

Type: array

Read Only: true

error details

Show Source

• [0]: object Error

{
    "type":"array",
    "description":"error details",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Nested Schema : ModelLink

Type: object

Show Source

• href: string
  The URI of the linked resource
• mediaType(optional): string
  The media type to apply to the URI
• method(optional): string
  The method to apply to the URI
• profile(optional): string
  The profile
• rel: string
  Relation link
• templated(optional): object templated
  Is the URI a template

{
    "type":"object",
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI of the linked resource"
        },
        "rel":{
            "type":"string",
            "description":"Relation link"
        },
        "method":{
            "type":"string",
            "description":"The method to apply to the URI"
        },
        "templated":{
            "type":"object",
            "description":"Is the URI a template"
        },
        "mediaType":{
            "type":"string",
            "description":"The media type to apply to the URI"
        },
        "profile":{
            "type":"string",
            "description":"The profile"
        }
    }
}

Nested Schema : templated

Type: object

Is the URI a template

400 Response

List of errors related to the request.

Body ()

Root Schema : schema

Type: array

Show Source

• [0]: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

The Compute Job was not found.

500 Response

An internal error occurred.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  detail
• instance(optional): string
  instance
• o:errorCode(optional): string
  Read Only: true

  error code
• o:errorDetails(optional): array o:errorDetails
  Read Only: true

  error details
• o:errorPath(optional): string
  Read Only: true

  error path
• status: integer(int32)
  status
• title: string
  title
• type(optional): string
  Read Only: true

  RFC Link

{
    "type":"object",
    "required":[
        "status",
        "title"
    ],
    "properties":{
        "title":{
            "type":"string",
            "description":"title"
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"status"
        },
        "detail":{
            "type":"string",
            "description":"detail"
        },
        "instance":{
            "type":"string",
            "description":"instance"
        },
        "o:errorCode":{
            "type":"string",
            "description":"error code",
            "readOnly":true
        },
        "o:errorPath":{
            "type":"string",
            "description":"error path",
            "readOnly":true
        },
        "o:errorDetails":{
            "type":"array",
            "description":"error details",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Error"
            }
        },
        "type":{
            "type":"string",
            "description":"RFC Link",
            "readOnly":true
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Read Only: true

error details

Show Source

• [0]: object Error

{
    "type":"array",
    "description":"error details",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top