diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2017-09-01-preview/job.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2017-09-01-preview/job.json index 3c35d8113534..6ec677ea4955 100644 --- a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2017-09-01-preview/job.json +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2017-09-01-preview/job.json @@ -618,195 +618,466 @@ } }, "definitions": { - "ResourceUsageStatistics": { + "JobInformation": { + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/JobInformationBasic" + } + ], "properties": { - "average": { - "type": "number", + "errorMessage": { "readOnly": true, - "format": "double", - "description": "the average value." + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetails" + }, + "description": "The error message details for the job, if the job failed." }, - "minimum": { - "type": "integer", + "stateAuditRecords": { "readOnly": true, - "format": "int64", - "description": "the minimum value." + "type": "array", + "items": { + "$ref": "#/definitions/JobStateAuditRecord" + }, + "description": "The job state audit records, indicating when various operations have been performed on this job." }, - "maximum": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The job specific properties." + } + }, + "description": "The extended Data Lake Analytics job information properties returned when retrieving a specific job." + }, + "JobInformationBasic": { + "required": [ + "name", + "type" + ], + "properties": { + "jobId": { + "readOnly": true, + "type": "string", + "format": "uuid", + "description": "The job's unique identifier (a GUID)." + }, + "name": { + "type": "string", + "description": "The friendly name of the job." + }, + "type": { + "type": "string", + "enum": [ + "USql", + "Hive", + "Scope" + ], + "x-ms-enum": { + "name": "JobType", + "modelAsString": false + }, + "description": "The job type of the current job (Hive, USql, or Scope (for internal use only))." + }, + "submitter": { + "readOnly": true, + "type": "string", + "description": "The user or account that submitted the job." + }, + "degreeOfParallelism": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The degree of parallelism used for this job. This must be greater than 0, if set to less than 0 it will default to 1." + }, + "priority": { "type": "integer", + "format": "int32", + "description": "The priority value for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0." + }, + "submitTime": { "readOnly": true, - "format": "int64", - "description": "the maximum value." + "type": "string", + "format": "date-time", + "description": "The time the job was submitted to the service." + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The start time of the job." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The completion time of the job." + }, + "state": { + "readOnly": true, + "type": "string", + "enum": [ + "Accepted", + "Compiling", + "Ended", + "New", + "Queued", + "Running", + "Scheduling", + "Starting", + "Paused", + "WaitingForCapacity" + ], + "x-ms-enum": { + "name": "JobState", + "modelAsString": false + }, + "description": "The job state. When the job is in the Ended state, refer to Result and ErrorMessage for details." + }, + "result": { + "readOnly": true, + "type": "string", + "enum": [ + "None", + "Succeeded", + "Cancelled", + "Failed" + ], + "x-ms-enum": { + "name": "JobResult", + "modelAsString": false + }, + "description": "The result of job execution or the current result of the running job." + }, + "logFolder": { + "readOnly": true, + "type": "string", + "description": "The log folder path to use in the following format: adl://.azuredatalakestore.net/system/jobservice/jobs/Usql/2016/03/13/17/18/5fe51957-93bc-4de0-8ddc-c5a4753b068b/logs/." + }, + "logFilePatterns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of log file name patterns to find in the logFolder. '*' is the only matching character allowed. Example format: jobExecution*.log or *mylog*.txt" + }, + "related": { + "$ref": "#/definitions/JobRelationshipProperties", + "description": "The recurring job relationship information properties." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The key-value pairs used to add additional metadata to the job information. (Only for use internally with Scope job type.)" } }, - "description": "the statistics information for resource usage." + "description": "The common Data Lake Analytics job information properties." }, - "JobStatisticsVertex": { + "JobProperties": { + "discriminator": "type", + "required": [ + "script", + "type" + ], "properties": { - "name": { + "runtimeVersion": { "type": "string", + "description": "The runtime version of the Data Lake Analytics engine to use for the specific type of job being run." + }, + "script": { + "type": "string", + "description": "The script to run. Please note that the maximum script size is 3 MB." + }, + "type": { + "type": "string", + "description": "The job type of the current job (Hive, USql, or Scope (for internal use only))." + } + }, + "description": "The common Data Lake Analytics job properties." + }, + "USqlJobProperties": { + "x-ms-discriminator-value": "USql", + "allOf": [ + { + "$ref": "#/definitions/JobProperties" + } + ], + "properties": { + "resources": { "readOnly": true, - "description": "the name of the vertex." + "type": "array", + "items": { + "$ref": "#/definitions/JobResource" + }, + "description": "The list of resources that are required by the job." }, - "vertexId": { + "statistics": { + "$ref": "#/definitions/JobStatistics", + "description": "The job specific statistics." + }, + "debugData": { + "$ref": "#/definitions/JobDataPath", + "description": "The job specific debug data locations." + }, + "diagnostics": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Diagnostics" + }, + "description": "The diagnostics for the job." + }, + "algebraFilePath": { + "readOnly": true, "type": "string", + "description": "The algebra file path after the job has completed." + }, + "totalCompilationTime": { "readOnly": true, - "format": "uuid", - "description": "the id of the vertex." + "type": "string", + "format": "duration", + "description": "The total time this job spent compiling. This value should not be set by the user and will be ignored if it is." }, - "executionTime": { + "totalQueuedTime": { + "readOnly": true, "type": "string", + "format": "duration", + "description": "The total time this job spent queued. This value should not be set by the user and will be ignored if it is." + }, + "totalRunningTime": { "readOnly": true, + "type": "string", "format": "duration", - "description": "the amount of execution time of the vertex." + "description": "The total time this job spent executing. This value should not be set by the user and will be ignored if it is." }, - "dataRead": { - "type": "integer", + "totalPausedTime": { "readOnly": true, - "format": "int64", - "description": "the amount of data read of the vertex, in bytes." + "type": "string", + "format": "duration", + "description": "The total time this job spent paused. This value should not be set by the user and will be ignored if it is." }, - "peakMemUsage": { - "type": "integer", + "rootProcessNodeId": { + "readOnly": true, + "type": "string", + "description": "The ID used to identify the job manager coordinating job execution. This value should not be set by the user and will be ignored if it is." + }, + "yarnApplicationId": { "readOnly": true, + "type": "string", + "description": "The ID used to identify the yarn application executing the job. This value should not be set by the user and will be ignored if it is." + }, + "yarnApplicationTimeStamp": { + "readOnly": true, + "type": "integer", "format": "int64", - "description": "the amount of peak memory usage of the vertex, in bytes." + "description": "The timestamp (in ticks) for the yarn application executing the job. This value should not be set by the user and will be ignored if it is." + }, + "compileMode": { + "readOnly": true, + "type": "string", + "enum": [ + "Semantic", + "Full", + "SingleBox" + ], + "x-ms-enum": { + "name": "CompileMode", + "modelAsString": false + }, + "description": "The specific compilation mode for the job used during execution. If this is not specified during submission, the server will determine the optimal compilation mode." } }, - "description": "the detailed information for a vertex." + "description": "U-SQL job properties used when retrieving U-SQL jobs." + }, + "JobResource": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "resourcePath": { + "type": "string", + "description": "The path to the resource." + }, + "type": { + "type": "string", + "enum": [ + "VertexResource", + "JobManagerResource", + "StatisticsResource", + "VertexResourceInUserFolder", + "JobManagerResourceInUserFolder", + "StatisticsResourceInUserFolder" + ], + "x-ms-enum": { + "name": "JobResourceType", + "modelAsString": false + }, + "description": "The job resource type." + } + }, + "description": "The Data Lake Analytics job resources." + }, + "JobStatistics": { + "properties": { + "lastUpdateTimeUtc": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The last update time for the statistics." + }, + "finalizingTimeUtc": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The job finalizing start time." + }, + "stages": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/JobStatisticsVertexStage" + }, + "description": "The list of stages for the job." + } + }, + "description": "The Data Lake Analytics job execution statistics." }, "JobStatisticsVertexStage": { "properties": { "dataRead": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int64", - "description": "the amount of data read, in bytes." + "description": "The amount of data read, in bytes." }, "dataReadCrossPod": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int64", - "description": "the amount of data read across multiple pods, in bytes." + "description": "The amount of data read across multiple pods, in bytes." }, "dataReadIntraPod": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int64", - "description": "the amount of data read in one pod, in bytes." + "description": "The amount of data read in one pod, in bytes." }, "dataToRead": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int64", - "description": "the amount of data remaining to be read, in bytes." + "description": "The amount of data remaining to be read, in bytes." }, "dataWritten": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int64", - "description": "the amount of data written, in bytes." + "description": "The amount of data written, in bytes." }, "duplicateDiscardCount": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int32", - "description": "the number of duplicates that were discarded." + "description": "The number of duplicates that were discarded." }, "failedCount": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int32", - "description": "the number of failures that occured in this stage." + "description": "The number of failures that occured in this stage." }, "maxVertexDataRead": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int64", - "description": "the maximum amount of data read in a single vertex, in bytes." + "description": "The maximum amount of data read in a single vertex, in bytes." }, "minVertexDataRead": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int64", - "description": "the minimum amount of data read in a single vertex, in bytes." + "description": "The minimum amount of data read in a single vertex, in bytes." }, "readFailureCount": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int32", - "description": "the number of read failures in this stage." + "description": "The number of read failures in this stage." }, "revocationCount": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int32", - "description": "the number of vertices that were revoked during this stage." + "description": "The number of vertices that were revoked during this stage." }, "runningCount": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int32", - "description": "the number of currently running vertices in this stage." + "description": "The number of currently running vertices in this stage." }, "scheduledCount": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int32", - "description": "the number of currently scheduled vertices in this stage" + "description": "The number of currently scheduled vertices in this stage." }, "stageName": { - "type": "string", "readOnly": true, - "description": "the name of this stage in job execution." + "type": "string", + "description": "The name of this stage in job execution." }, "succeededCount": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int32", - "description": "the number of vertices that succeeded in this stage." + "description": "The number of vertices that succeeded in this stage." }, "tempDataWritten": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int64", - "description": "the amount of temporary data written, in bytes." + "description": "The amount of temporary data written, in bytes." }, "totalCount": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int32", - "description": "the total vertex count for this stage." + "description": "The total vertex count for this stage." }, "totalFailedTime": { - "type": "string", "readOnly": true, + "type": "string", "format": "duration", - "description": "the amount of time that failed vertices took up in this stage." + "description": "The amount of time that failed vertices took up in this stage." }, "totalProgress": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int32", - "description": "the current progress of this stage, as a percentage." + "description": "The current progress of this stage, as a percentage." }, "totalSucceededTime": { - "type": "string", "readOnly": true, + "type": "string", "format": "duration", - "description": "the amount of time all successful vertices took in this stage." + "description": "The amount of time all successful vertices took in this stage." }, "totalPeakMemUsage": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int64", - "description": "the sum of the peak memory usage of all the vertices in the stage, in bytes." + "description": "The sum of the peak memory usage of all the vertices in the stage, in bytes." }, "totalExecutionTime": { - "type": "string", "readOnly": true, + "type": "string", "format": "duration", - "description": "the sum of the total execution time of all the vertices in the stage." + "description": "The sum of the total execution time of all the vertices in the stage." }, "maxDataReadVertex": { "$ref": "#/definitions/JobStatisticsVertex", @@ -821,252 +1092,206 @@ "description": "the vertex with the maximum peak memory usage." }, "estimatedVertexCpuCoreCount": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int32", - "description": "the estimated vertex CPU core count." + "description": "The estimated vertex CPU core count." }, "estimatedVertexPeakCpuCoreCount": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int32", - "description": "the estimated vertex peak CPU core count." + "description": "The estimated vertex peak CPU core count." }, "estimatedVertexMemSize": { - "type": "integer", "readOnly": true, + "type": "integer", "format": "int64", - "description": "the estimated vertex memory size, in bytes." + "description": "The estimated vertex memory size, in bytes." }, "allocatedContainerCpuCoreCount": { "$ref": "#/definitions/ResourceUsageStatistics", - "description": "the statistics information for the allocated container CPU core count." + "description": "The statistics information for the allocated container CPU core count." }, "allocatedContainerMemSize": { "$ref": "#/definitions/ResourceUsageStatistics", - "description": "the statistics information for the allocated container memory size." + "description": "The statistics information for the allocated container memory size." }, "usedVertexCpuCoreCount": { "$ref": "#/definitions/ResourceUsageStatistics", - "description": "the statistics information for the used vertex CPU core count." + "description": "The statistics information for the used vertex CPU core count." }, "usedVertexPeakMemSize": { "$ref": "#/definitions/ResourceUsageStatistics", - "description": "the statistics information for the used vertex peak memory size." + "description": "The statistics information for the used vertex peak memory size." } }, "description": "The Data Lake Analytics job statistics vertex stage information." }, - "JobStatistics": { + "JobStatisticsVertex": { "properties": { - "lastUpdateTimeUtc": { - "type": "string", + "name": { "readOnly": true, - "format": "date-time", - "description": "the last update time for the statistics." - }, - "finalizingTimeUtc": { "type": "string", - "readOnly": true, - "format": "date-time", - "description": "the job finalizing start time." + "description": "The name of the vertex." }, - "stages": { - "type": "array", + "vertexId": { "readOnly": true, - "items": { - "$ref": "#/definitions/JobStatisticsVertexStage" - }, - "description": "the list of stages for the job." - } - }, - "description": "The Data Lake Analytics job execution statistics." - }, - "JobDataPath": { - "properties": { - "jobId": { "type": "string", "format": "uuid", - "readOnly": true, - "description": "the id of the job this data is for." + "description": "The id of the vertex." }, - "command": { + "executionTime": { + "readOnly": true, "type": "string", + "format": "duration", + "description": "The amount of execution time of the vertex." + }, + "dataRead": { "readOnly": true, - "description": "the command that this job data relates to." + "type": "integer", + "format": "int64", + "description": "The amount of data read of the vertex, in bytes." }, - "paths": { - "type": "array", + "peakMemUsage": { "readOnly": true, - "items": { - "type": "string" - }, - "description": "the list of paths to all of the job data." + "type": "integer", + "format": "int64", + "description": "The amount of peak memory usage of the vertex, in bytes." } }, - "description": "A Data Lake Analytics job data path item." + "description": "The detailed information for a vertex." }, - "JobStateAuditRecord": { + "ResourceUsageStatistics": { "properties": { - "newState": { - "type": "string", - "readOnly": true, - "description": "the new state the job is in." - }, - "timeStamp": { - "type": "string", + "average": { "readOnly": true, - "format": "date-time", - "description": "the time stamp that the state change took place." + "type": "number", + "format": "double", + "description": "The average value." }, - "requestedByUser": { - "type": "string", + "minimum": { "readOnly": true, - "description": "the user who requests the change." + "type": "integer", + "format": "int64", + "description": "The minimum value." }, - "details": { - "type": "string", + "maximum": { "readOnly": true, - "description": "the details of the audit log." + "type": "integer", + "format": "int64", + "description": "The maximum value." } }, - "description": "The Data Lake Analytics job state audit records for tracking the lifecycle of a job." + "description": "The statistics information for resource usage." }, - "ScopeJobResource": { + "JobDataPath": { "properties": { - "name": { + "jobId": { + "readOnly": true, "type": "string", - "description": "the name of the resource." + "format": "uuid", + "description": "The ID of the job this data is for." }, - "path": { + "command": { + "readOnly": true, "type": "string", - "description": "the path to the resource." + "description": "The command that this job data relates to." + }, + "paths": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of paths to all of the job data." } }, - "description": "The Scope job resources. (Only for use internally with Scope job type.)" + "description": "A Data Lake Analytics job data path item." }, - "JobResource": { + "Diagnostics": { "properties": { - "name": { - "type": "string", - "description": "the name of the resource." - }, - "resourcePath": { + "message": { + "readOnly": true, "type": "string", - "description": "the path to the resource." + "description": "The error message." }, - "type": { + "severity": { + "readOnly": true, "type": "string", - "description": "the job resource type.", "enum": [ - "VertexResource", - "JobManagerResource", - "StatisticsResource", - "VertexResourceInUserFolder", - "JobManagerResourceInUserFolder", - "StatisticsResourceInUserFolder" + "Warning", + "Error", + "Info", + "SevereWarning", + "Deprecated", + "UserWarning" ], "x-ms-enum": { - "name": "JobResourceType", + "name": "SeverityTypes", "modelAsString": false - } + }, + "description": "The severity of the error." + }, + "lineNumber": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The line number the error occured on." + }, + "columnNumber": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The column where the error occured." + }, + "start": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The starting index of the error." + }, + "end": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The ending index of the error." } }, - "description": "The Data Lake Analytics job resources." + "description": "Error diagnostic information for failed jobs." }, - "USqlJobProperties": { - "x-ms-discriminator-value": "USql", + "HiveJobProperties": { + "x-ms-discriminator-value": "Hive", "allOf": [ { "$ref": "#/definitions/JobProperties" } ], "properties": { - "resources": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/JobResource" - }, - "description": "the list of resources that are required by the job" - }, - "statistics": { - "$ref": "#/definitions/JobStatistics", - "description": "the job specific statistics." - }, - "debugData": { - "$ref": "#/definitions/JobDataPath", - "description": "the job specific debug data locations." - }, - "diagnostics": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Diagnostics" - }, - "description": "the diagnostics for the job." - }, - "algebraFilePath": { - "type": "string", - "readOnly": true, - "description": "the algebra file path after the job has completed" - }, - "totalCompilationTime": { - "type": "string", - "format": "duration", - "readOnly": true, - "description": "the total time this job spent compiling. This value should not be set by the user and will be ignored if it is." - }, - "totalPausedTime": { - "type": "string", - "format": "duration", + "logsLocation": { "readOnly": true, - "description": "the total time this job spent paused. This value should not be set by the user and will be ignored if it is." - }, - "totalQueuedTime": { "type": "string", - "format": "duration", - "readOnly": true, - "description": "the total time this job spent queued. This value should not be set by the user and will be ignored if it is." + "description": "The Hive logs location." }, - "totalRunningTime": { - "type": "string", - "format": "duration", + "outputLocation": { "readOnly": true, - "description": "the total time this job spent executing. This value should not be set by the user and will be ignored if it is." - }, - "rootProcessNodeId": { "type": "string", - "readOnly": true, - "description": "the ID used to identify the job manager coordinating job execution. This value should not be set by the user and will be ignored if it is." + "description": "The location of Hive job output files (both execution output and results)." }, - "yarnApplicationId": { - "type": "string", + "statementCount": { "readOnly": true, - "description": "the ID used to identify the yarn application executing the job. This value should not be set by the user and will be ignored if it is." - }, - "yarnApplicationTimeStamp": { "type": "integer", - "readOnly": true, - "format": "int64", - "description": "the timestamp (in ticks) for the yarn application executing the job. This value should not be set by the user and will be ignored if it is." + "format": "int32", + "description": "The number of statements that will be run based on the script." }, - "compileMode": { - "type": "string", + "executedStatementCount": { "readOnly": true, - "description": "the specific compilation mode for the job used during execution. If this is not specified during submission, the server will determine the optimal compilation mode.", - "enum": [ - "Semantic", - "Full", - "SingleBox" - ], - "x-ms-enum": { - "name": "CompileMode", - "modelAsString": false - } + "type": "integer", + "format": "int32", + "description": "The number of statements that have been run based on the script." } }, - "description": "U-SQL job properties used when retrieving U-SQL jobs." + "description": "Hive job properties used when retrieving Hive jobs." }, "ScopeJobProperties": { "x-ms-discriminator-value": "Scope", @@ -1077,209 +1302,117 @@ ], "properties": { "resources": { - "type": "array", "readOnly": true, + "type": "array", "items": { "$ref": "#/definitions/ScopeJobResource" }, - "description": "the list of resources that are required by the job" + "description": "The list of resources that are required by the job." }, "userAlgebraPath": { - "type": "string", "readOnly": true, - "description": "the algebra file path after the job has completed" + "type": "string", + "description": "The algebra file path after the job has completed." }, "notifier": { "type": "string", - "description": "the list of email addresses, separated by semi-colons, to notify when the job reaches a terminal state." + "description": "The list of email addresses, separated by semi-colons, to notify when the job reaches a terminal state." }, "totalCompilationTime": { - "type": "string", - "format": "duration", "readOnly": true, - "description": "the total time this job spent compiling. This value should not be set by the user and will be ignored if it is." - }, - "totalPausedTime": { "type": "string", "format": "duration", - "readOnly": true, - "description": "the total time this job spent paused. This value should not be set by the user and will be ignored if it is." + "description": "The total time this job spent compiling. This value should not be set by the user and will be ignored if it is." }, "totalQueuedTime": { + "readOnly": true, "type": "string", "format": "duration", - "readOnly": true, - "description": "the total time this job spent queued. This value should not be set by the user and will be ignored if it is." + "description": "The total time this job spent queued. This value should not be set by the user and will be ignored if it is." }, "totalRunningTime": { + "readOnly": true, "type": "string", "format": "duration", + "description": "The total time this job spent executing. This value should not be set by the user and will be ignored if it is." + }, + "totalPausedTime": { "readOnly": true, - "description": "the total time this job spent executing. This value should not be set by the user and will be ignored if it is." + "type": "string", + "format": "duration", + "description": "The total time this job spent paused. This value should not be set by the user and will be ignored if it is." }, "rootProcessNodeId": { - "type": "string", "readOnly": true, - "description": "the ID used to identify the job manager coordinating job execution. This value should not be set by the user and will be ignored if it is." + "type": "string", + "description": "The ID used to identify the job manager coordinating job execution. This value should not be set by the user and will be ignored if it is." }, "yarnApplicationId": { - "type": "string", "readOnly": true, - "description": "the ID used to identify the yarn application executing the job. This value should not be set by the user and will be ignored if it is." + "type": "string", + "description": "The ID used to identify the yarn application executing the job. This value should not be set by the user and will be ignored if it is." } }, "description": "Scope job properties used when submitting and retrieving Scope jobs. (Only for use internally with Scope job type.)" }, - "HiveJobProperties": { - "x-ms-discriminator-value": "Hive", - "allOf": [ - { - "$ref": "#/definitions/JobProperties" - } - ], + "ScopeJobResource": { "properties": { - "logsLocation": { + "name": { "type": "string", - "readOnly": true, - "description": "the Hive logs location" + "description": "The name of the resource." }, - "outputLocation": { + "path": { "type": "string", - "readOnly": true, - "description": "the location of Hive job output files (both execution output and results)" - }, - "statementCount": { - "type": "integer", - "format": "int32", - "readOnly": true, - "description": "the number of statements that will be run based on the script" - }, - "executedStatementCount": { - "type": "integer", - "format": "int32", - "readOnly": true, - "description": "the number of statements that have been run based on the script" + "description": "The path to the resource." } }, - "description": "Hive job properties used when retrieving Hive jobs." + "description": "The Scope job resources. (Only for use internally with Scope job type.)" }, - "JobProperties": { - "discriminator": "type", + "JobRelationshipProperties": { "required": [ - "script", - "type" + "recurrenceId" ], "properties": { - "runtimeVersion": { + "pipelineId": { "type": "string", - "description": "the runtime version of the Data Lake Analytics engine to use for the specific type of job being run." + "format": "uuid", + "description": "The job relationship pipeline identifier (a GUID)." }, - "script": { + "pipelineName": { "type": "string", - "description": "the script to run. Please note that the maximum script size is 3 MB." + "maxLength": 260, + "description": "The friendly name of the job relationship pipeline, which does not need to be unique." }, - "type": { - "type": "string", - "description": "the job type of the current job (Hive, USql, or Scope (for internal use only))." - } - }, - "description": "The common Data Lake Analytics job properties." - }, - "CreateUSqlJobProperties": { - "x-ms-discriminator-value": "USql", - "allOf": [ - { - "$ref": "#/definitions/CreateJobProperties" - } - ], - "properties": { - "compileMode": { + "pipelineUri": { "type": "string", - "description": "the specific compilation mode for the job used during execution. If this is not specified during submission, the server will determine the optimal compilation mode.", - "enum": [ - "Semantic", - "Full", - "SingleBox" - ], - "x-ms-enum": { - "name": "CompileMode", - "modelAsString": false - } - } - }, - "description": "U-SQL job properties used when submitting U-SQL jobs." - }, - "CreateScopeJobProperties": { - "x-ms-discriminator-value": "Scope", - "allOf": [ - { - "$ref": "#/definitions/CreateJobProperties" - } - ], - "properties": { - "resources": { - "type": "array", - "items": { - "$ref": "#/definitions/ScopeJobResource" - }, - "description": "the list of resources that are required by the job." + "description": "The pipeline uri, unique, links to the originating service for this pipeline." }, - "notifier": { - "type": "string", - "description": "the list of email addresses, separated by semi-colons, to notify when the job reaches a terminal state." - } - }, - "description": "Scope job properties used when submitting Scope jobs." - }, - "CreateJobProperties": { - "discriminator": "type", - "required": [ - "script", - "type" - ], - "properties": { - "runtimeVersion": { + "runId": { "type": "string", - "description": "the runtime version of the Data Lake Analytics engine to use for the specific type of job being run." + "format": "uuid", + "description": "The run identifier (a GUID), unique identifier of the iteration of this pipeline." }, - "script": { + "recurrenceId": { "type": "string", - "description": "the script to run. Please note that the maximum script size is 3 MB." + "format": "uuid", + "description": "The recurrence identifier (a GUID), unique per activity/script, regardless of iterations. This is something to link different occurrences of the same job together." }, - "type": { + "recurrenceName": { "type": "string", - "description": "the job type of the current job (Hive, USql, or Scope (for internal use only))." + "maxLength": 260, + "description": "The recurrence name, user friendly name for the correlation between jobs." } }, - "description": "The common Data Lake Analytics job properties for job submission." + "description": "Job relationship information properties including pipeline information, correlation information, etc." }, - "Diagnostics": { + "JobErrorDetails": { "properties": { - "columnNumber": { - "description": "the column where the error occured.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "end": { - "description": "the ending index of the error.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "lineNumber": { - "description": "the line number the error occured on.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "message": { - "description": "the error message.", + "errorId": { + "readOnly": true, "type": "string", - "readOnly": true + "description": "The specific identifier for the type of error encountered in the job." }, "severity": { - "description": "the severity of the error.", "readOnly": true, "type": "string", "enum": [ @@ -1293,119 +1426,85 @@ "x-ms-enum": { "name": "SeverityTypes", "modelAsString": false - } + }, + "description": "The severity level of the failure." }, - "start": { - "description": "the starting index of the error.", - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "description": "Error diagnostic information for failed jobs." - }, - "JobErrorDetails": { - "properties": { - "description": { - "type": "string", + "source": { "readOnly": true, - "description": "the error message description" - }, - "details": { "type": "string", - "readOnly": true, - "description": "the details of the error message." + "description": "The ultimate source of the failure (usually either SYSTEM or USER)." }, - "endOffset": { - "type": "integer", + "message": { "readOnly": true, - "format": "int32", - "description": "the end offset in the job where the error was found." - }, - "errorId": { "type": "string", - "readOnly": true, - "description": "the specific identifier for the type of error encountered in the job." + "description": "The user friendly error message for the failure." }, - "filePath": { - "type": "string", + "description": { "readOnly": true, - "description": "the path to any supplemental error files, if any." - }, - "helpLink": { "type": "string", - "readOnly": true, - "description": "the link to MSDN or Azure help for this type of error, if any." + "description": "The error message description." }, - "internalDiagnostics": { - "type": "string", + "details": { "readOnly": true, - "description": "the internal diagnostic stack trace if the user requesting the job error details has sufficient permissions it will be retrieved, otherwise it will be empty." + "type": "string", + "description": "The details of the error message." }, "lineNumber": { + "readOnly": true, "type": "integer", + "format": "int32", + "description": "The specific line number in the job where the error occured." + }, + "startOffset": { "readOnly": true, + "type": "integer", "format": "int32", - "description": "the specific line number in the job where the error occured." + "description": "The start offset in the job where the error was found" }, - "message": { - "type": "string", + "endOffset": { "readOnly": true, - "description": "the user friendly error message for the failure." + "type": "integer", + "format": "int32", + "description": "The end offset in the job where the error was found." }, "resolution": { - "type": "string", "readOnly": true, - "description": "the recommended resolution for the failure, if any." + "type": "string", + "description": "The recommended resolution for the failure, if any." }, - "innerError": { - "$ref": "#/definitions/JobInnerError", + "filePath": { "readOnly": true, - "description": "the inner error of this specific job error message, if any." - }, - "severity": { "type": "string", - "readOnly": true, - "description": "the severity level of the failure.", - "enum": [ - "Warning", - "Error", - "Info", - "SevereWarning", - "Deprecated", - "UserWarning" - ], - "x-ms-enum": { - "name": "SeverityTypes", - "modelAsString": false - } + "description": "The path to any supplemental error files, if any." }, - "source": { + "helpLink": { + "readOnly": true, "type": "string", + "description": "The link to MSDN or Azure help for this type of error, if any." + }, + "internalDiagnostics": { "readOnly": true, - "description": "the ultimate source of the failure (usually either SYSTEM or USER)." + "type": "string", + "description": "The internal diagnostic stack trace if the user requesting the job error details has sufficient permissions it will be retrieved, otherwise it will be empty." }, - "startOffset": { - "type": "integer", + "innerError": { "readOnly": true, - "format": "int32", - "description": "the start offset in the job where the error was found" + "$ref": "#/definitions/JobInnerError", + "description": "The inner error of this specific job error message, if any." } }, "description": "The Data Lake Analytics job error details." }, "JobInnerError": { "properties": { - "diagnosticCode": { - "type": "integer", + "errorId": { "readOnly": true, - "format": "int32", - "description": "the diagnostic error code." + "type": "string", + "description": "The specific identifier for the type of error encountered in the job." }, "severity": { - "type": "string", "readOnly": true, - "description": "the severity level of the failure.", + "type": "string", "enum": [ "Warning", "Error", @@ -1417,308 +1516,329 @@ "x-ms-enum": { "name": "SeverityTypes", "modelAsString": false - } + }, + "description": "The severity level of the failure." }, - "details": { - "type": "string", + "source": { "readOnly": true, - "description": "the details of the error message." - }, - "component": { "type": "string", - "readOnly": true, - "description": "the component that failed." + "description": "The ultimate source of the failure (usually either SYSTEM or USER)." }, - "errorId": { - "type": "string", + "message": { "readOnly": true, - "description": "the specific identifier for the type of error encountered in the job." - }, - "helpLink": { "type": "string", + "description": "The user friendly error message for the failure." + }, + "description": { "readOnly": true, - "description": "the link to MSDN or Azure help for this type of error, if any." + "type": "string", + "description": "The error message description." }, - "internalDiagnostics": { + "details": { + "readOnly": true, "type": "string", + "description": "The details of the error message." + }, + "diagnosticCode": { "readOnly": true, - "description": "the internal diagnostic stack trace if the user requesting the job error details has sufficient permissions it will be retrieved, otherwise it will be empty." + "type": "integer", + "format": "int32", + "description": "The diagnostic error code." }, - "message": { - "type": "string", + "component": { "readOnly": true, - "description": "the user friendly error message for the failure." + "type": "string", + "description": "The component that failed." }, "resolution": { - "type": "string", "readOnly": true, - "description": "the recommended resolution for the failure, if any." - }, - "source": { "type": "string", - "readOnly": true, - "description": "the ultimate source of the failure (usually either SYSTEM or USER)." + "description": "The recommended resolution for the failure, if any." }, - "description": { + "helpLink": { + "readOnly": true, "type": "string", + "description": "The link to MSDN or Azure help for this type of error, if any." + }, + "internalDiagnostics": { "readOnly": true, - "description": "the error message description" + "type": "string", + "description": "The internal diagnostic stack trace if the user requesting the job error details has sufficient permissions it will be retrieved, otherwise it will be empty." }, "innerError": { - "$ref": "#/definitions/JobInnerError", "readOnly": true, - "description": "the inner error of this specific job error message, if any." + "$ref": "#/definitions/JobInnerError", + "description": "The inner error of this specific job error message, if any." } }, "description": "The Data Lake Analytics job error details." }, - "JobRelationshipProperties": { + "JobStateAuditRecord": { "properties": { - "pipelineId": { - "type": "string", - "format": "uuid", - "description": "the job relationship pipeline identifier (a GUID)." - }, - "pipelineName": { - "type": "string", - "maxLength": 260, - "description": "the friendly name of the job relationship pipeline, which does not need to be unique." - }, - "pipelineUri": { + "newState": { + "readOnly": true, "type": "string", - "description": "the pipeline uri, unique, links to the originating service for this pipeline." + "description": "The new state the job is in." }, - "runId": { + "timeStamp": { + "readOnly": true, "type": "string", - "format": "uuid", - "description": "the run identifier (a GUID), unique identifier of the iteration of this pipeline." + "format": "date-time", + "description": "The time stamp that the state change took place." }, - "recurrenceId": { + "requestedByUser": { + "readOnly": true, "type": "string", - "format": "uuid", - "description": "the recurrence identifier (a GUID), unique per activity/script, regardless of iterations. This is something to link different occurrences of the same job together." + "description": "The user who requests the change." }, - "recurrenceName": { + "details": { + "readOnly": true, "type": "string", - "maxLength": 260, - "description": "the recurrence name, user friendly name for the correlation between jobs." + "description": "The details of the audit log." } }, - "required": [ - "recurrenceId" - ], - "description": "Job relationship information properties including pipeline information, correlation information, etc." + "description": "The Data Lake Analytics job state audit records for tracking the lifecycle of a job." }, - "JobPipelineInformationListResult": { + "JobInfoListResult": { "properties": { "value": { - "type": "array", "readOnly": true, + "type": "array", "items": { - "$ref": "#/definitions/JobPipelineInformation" + "$ref": "#/definitions/JobInformationBasic" }, - "description": "the list of job pipeline information items." + "description": "The list of JobInfo items." }, "nextLink": { - "type": "string", "readOnly": true, - "description": "the link (url) to the next page of results." + "type": "string", + "description": "The link (url) to the next page of results." } }, - "description": "List of job pipeline information items." + "description": "List of JobInfo items." }, "JobPipelineInformation": { "properties": { "pipelineId": { + "readOnly": true, "type": "string", "format": "uuid", - "readOnly": true, - "description": "the job relationship pipeline identifier (a GUID)." + "description": "The job relationship pipeline identifier (a GUID)." }, "pipelineName": { + "readOnly": true, "type": "string", "maxLength": 260, - "readOnly": true, - "description": "the friendly name of the job relationship pipeline, which does not need to be unique." + "description": "The friendly name of the job relationship pipeline, which does not need to be unique." }, "pipelineUri": { - "type": "string", "readOnly": true, - "description": "the pipeline uri, unique, links to the originating service for this pipeline." + "type": "string", + "description": "The pipeline uri, unique, links to the originating service for this pipeline." }, "numJobsFailed": { + "readOnly": true, "type": "integer", "format": "int32", - "readOnly": true, - "description": "the number of jobs in this pipeline that have failed." + "description": "The number of jobs in this pipeline that have failed." }, "numJobsCanceled": { + "readOnly": true, "type": "integer", "format": "int32", - "readOnly": true, - "description": "the number of jobs in this pipeline that have been canceled." + "description": "The number of jobs in this pipeline that have been canceled." }, "numJobsSucceeded": { + "readOnly": true, "type": "integer", "format": "int32", - "readOnly": true, - "description": "the number of jobs in this pipeline that have succeeded." + "description": "The number of jobs in this pipeline that have succeeded." }, "auHoursFailed": { + "readOnly": true, "type": "number", "format": "double", - "readOnly": true, - "description": "the number of job execution hours that resulted in failed jobs." + "description": "The number of job execution hours that resulted in failed jobs." }, "auHoursCanceled": { + "readOnly": true, "type": "number", "format": "double", - "readOnly": true, - "description": "the number of job execution hours that resulted in canceled jobs." + "description": "The number of job execution hours that resulted in canceled jobs." }, "auHoursSucceeded": { + "readOnly": true, "type": "number", "format": "double", - "readOnly": true, - "description": "the number of job execution hours that resulted in successful jobs." + "description": "The number of job execution hours that resulted in successful jobs." }, "lastSubmitTime": { + "readOnly": true, "type": "string", "format": "date-time", - "readOnly": true, - "description": "the last time a job in this pipeline was submitted." + "description": "The last time a job in this pipeline was submitted." }, "runs": { - "type": "array", "readOnly": true, + "type": "array", "items": { "$ref": "#/definitions/JobPipelineRunInformation" }, - "description": "the list of recurrence identifiers representing each run of this pipeline." + "description": "The list of recurrence identifiers representing each run of this pipeline." }, "recurrences": { - "type": "array", "readOnly": true, + "type": "array", "items": { "type": "string", "format": "uuid" }, - "description": "the list of recurrence identifiers representing each run of this pipeline." + "description": "The list of recurrence identifiers representing each run of this pipeline." } }, "description": "Job Pipeline Information, showing the relationship of jobs and recurrences of those jobs in a pipeline." }, - "JobRecurrenceInformationListResult": { + "JobPipelineRunInformation": { + "properties": { + "runId": { + "readOnly": true, + "type": "string", + "format": "uuid", + "description": "The run identifier of an instance of pipeline executions (a GUID)." + }, + "lastSubmitTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time this instance was last submitted." + } + }, + "description": "Run info for a specific job pipeline." + }, + "JobPipelineInformationListResult": { "properties": { "value": { - "type": "array", "readOnly": true, + "type": "array", "items": { - "$ref": "#/definitions/JobRecurrenceInformation" + "$ref": "#/definitions/JobPipelineInformation" }, - "description": "the list of job recurrence information items." + "description": "The list of job pipeline information items." }, "nextLink": { - "type": "string", "readOnly": true, - "description": "the link (url) to the next page of results." + "type": "string", + "description": "The link (url) to the next page of results." } }, - "description": "List of job recurrence information items." + "description": "List of job pipeline information items." }, "JobRecurrenceInformation": { "properties": { "recurrenceId": { + "readOnly": true, "type": "string", "format": "uuid", - "readOnly": true, - "description": "the recurrence identifier (a GUID), unique per activity/script, regardless of iterations. This is something to link different occurrences of the same job together." + "description": "The recurrence identifier (a GUID), unique per activity/script, regardless of iterations. This is something to link different occurrences of the same job together." }, "recurrenceName": { - "type": "string", "readOnly": true, - "description": "the recurrence name, user friendly name for the correlation between jobs." + "type": "string", + "description": "The recurrence name, user friendly name for the correlation between jobs." }, "numJobsFailed": { + "readOnly": true, "type": "integer", "format": "int32", - "readOnly": true, - "description": "the number of jobs in this recurrence that have failed." + "description": "The number of jobs in this recurrence that have failed." }, "numJobsCanceled": { + "readOnly": true, "type": "integer", "format": "int32", - "readOnly": true, - "description": "the number of jobs in this recurrence that have been canceled." + "description": "The number of jobs in this recurrence that have been canceled." }, "numJobsSucceeded": { + "readOnly": true, "type": "integer", "format": "int32", - "readOnly": true, - "description": "the number of jobs in this recurrence that have succeeded." + "description": "The number of jobs in this recurrence that have succeeded." }, "auHoursFailed": { + "readOnly": true, "type": "number", "format": "double", - "readOnly": true, - "description": "the number of job execution hours that resulted in failed jobs." + "description": "The number of job execution hours that resulted in failed jobs." }, "auHoursCanceled": { + "readOnly": true, "type": "number", "format": "double", - "readOnly": true, - "description": "the number of job execution hours that resulted in canceled jobs." + "description": "The number of job execution hours that resulted in canceled jobs." }, "auHoursSucceeded": { + "readOnly": true, "type": "number", "format": "double", - "readOnly": true, - "description": "the number of job execution hours that resulted in successful jobs." + "description": "The number of job execution hours that resulted in successful jobs." }, "lastSubmitTime": { + "readOnly": true, "type": "string", "format": "date-time", - "readOnly": true, - "description": "the last time a job in this recurrence was submitted." + "description": "The last time a job in this recurrence was submitted." } }, "description": "Recurrence job information for a specific recurrence." }, - "JobPipelineRunInformation": { + "JobRecurrenceInformationListResult": { "properties": { - "runId": { - "type": "string", - "format": "uuid", + "value": { "readOnly": true, - "description": "the run identifier of an instance of pipeline executions (a GUID)." + "type": "array", + "items": { + "$ref": "#/definitions/JobRecurrenceInformation" + }, + "description": "The list of job recurrence information items." }, - "lastSubmitTime": { - "type": "string", - "format": "date-time", + "nextLink": { "readOnly": true, - "description": "the time this instance was last submitted." + "type": "string", + "description": "The link (url) to the next page of results." } }, - "description": "Run info for a specific job pipeline." + "description": "List of job recurrence information items." }, - "CreateScopeJobParameters": { - "allOf": [ - { - "$ref": "#/definitions/CreateJobParameters" - } + "BaseJobParameters": { + "required": [ + "type", + "properties" ], "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" + "type": { + "type": "string", + "enum": [ + "USql", + "Hive", + "Scope" + ], + "x-ms-enum": { + "name": "JobType", + "modelAsString": false }, - "description": "the key-value pairs used to add additional metadata to the job information. (Only for use internally with Scope job type.)" + "description": "The job type of the current job (Hive, USql, or Scope (for internal use only))." + }, + "properties": { + "$ref": "#/definitions/CreateJobProperties", + "description": "The job specific properties." } }, - "description": "The parameters used to submit a new Data Lake Analytics Scope job. (Only for use internally with Scope job type.)" + "description": "Data Lake Analytics Job Parameters base class for build and submit." }, "CreateJobParameters": { + "required": [ + "name" + ], "allOf": [ { "$ref": "#/definitions/BaseJobParameters" @@ -1727,283 +1847,157 @@ "properties": { "name": { "type": "string", - "description": "the friendly name of the job to submit." + "description": "The friendly name of the job to submit." }, "degreeOfParallelism": { "type": "integer", - "default": 1, "format": "int32", - "description": "the degree of parallelism to use for this job. This must be greater than 0, if set to less than 0 it will default to 1." + "default": 1, + "description": "The degree of parallelism to use for this job. This must be greater than 0, if set to less than 0 it will default to 1." }, "priority": { "type": "integer", "format": "int32", - "description": "the priority value to use for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0." + "description": "The priority value to use for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0." }, "logFilePatterns": { "type": "array", "items": { "type": "string" }, - "description": "the list of log file name patterns to find in the logFolder. '*' is the only matching character allowed. Example format: jobExecution*.log or *mylog*.txt" + "description": "The list of log file name patterns to find in the logFolder. '*' is the only matching character allowed. Example format: jobExecution*.log or *mylog*.txt" }, "related": { "$ref": "#/definitions/JobRelationshipProperties", - "description": "the recurring job relationship information properties." + "description": "The recurring job relationship information properties." } }, - "required": [ - "name" - ], + "description": "The parameters used to submit a new Data Lake Analytics job." }, - "BuildJobParameters": { + "CreateScopeJobParameters": { "allOf": [ { - "$ref": "#/definitions/BaseJobParameters" + "$ref": "#/definitions/CreateJobParameters" } ], "properties": { - "name": { - "type": "string", - "description": "the friendly name of the job to build." + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The key-value pairs used to add additional metadata to the job information." } }, - "description": "The parameters used to build a new Data Lake Analytics job." + "description": "The parameters used to submit a new Data Lake Analytics Scope job. (Only for use internally with Scope job type.)" }, - "BaseJobParameters": { - "properties": { - "type": { - "type": "string", - "description": "the job type of the current job (Hive, USql, or Scope (for internal use only)).", - "enum": [ - "USql", - "Hive", - "Scope" - ], - "x-ms-enum": { - "name": "JobType", - "modelAsString": false - } - }, - "properties": { - "$ref": "#/definitions/CreateJobProperties", - "description": "the job specific properties." - } - }, + "CreateJobProperties": { + "discriminator": "type", "required": [ - "type", - "properties" + "script", + "type" ], - "description": "Data Lake Analytics Job Parameters base class for build and submit." - }, - "JobInformationBasic": { "properties": { - "jobId": { + "runtimeVersion": { "type": "string", - "format": "uuid", - "readOnly": true, - "description": "the job's unique identifier (a GUID)." + "description": "The runtime version of the Data Lake Analytics engine to use for the specific type of job being run." }, - "name": { + "script": { "type": "string", - "description": "the friendly name of the job." + "description": "The script to run. Please note that the maximum script size is 3 MB." }, "type": { "type": "string", - "description": "the job type of the current job (Hive, USql, or Scope (for internal use only)).", - "enum": [ - "USql", - "Hive", - "Scope" - ], - "x-ms-enum": { - "name": "JobType", - "modelAsString": false - } - }, - "submitter": { - "type": "string", - "readOnly": true, - "description": "the user or account that submitted the job." - }, - "degreeOfParallelism": { - "type": "integer", - "default": 1, - "format": "int32", - "description": "the degree of parallelism used for this job. This must be greater than 0, if set to less than 0 it will default to 1." - }, - "priority": { - "type": "integer", - "format": "int32", - "description": "the priority value for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0." - }, - "submitTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "the time the job was submitted to the service." - }, - "startTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "the start time of the job." - }, - "endTime": { - "type": "string", - "readOnly": true, - "format": "date-time", - "description": "the completion time of the job." - }, - "state": { - "type": "string", - "readOnly": true, - "description": "the job state. When the job is in the Ended state, refer to Result and ErrorMessage for details.", - "enum": [ - "Accepted", - "Compiling", - "Ended", - "New", - "Queued", - "Running", - "Scheduling", - "Starting", - "Paused", - "WaitingForCapacity" - ], - "x-ms-enum": { - "name": "JobState", - "modelAsString": false - } - }, - "result": { + "description": "The job type of the current job (Hive, USql, or Scope (for internal use only))." + } + }, + "description": "The common Data Lake Analytics job properties for job submission." + }, + "CreateUSqlJobProperties": { + "x-ms-discriminator-value": "USql", + "allOf": [ + { + "$ref": "#/definitions/CreateJobProperties" + } + ], + "properties": { + "compileMode": { "type": "string", - "readOnly": true, - "description": "the result of job execution or the current result of the running job.", "enum": [ - "None", - "Succeeded", - "Cancelled", - "Failed" + "Semantic", + "Full", + "SingleBox" ], "x-ms-enum": { - "name": "JobResult", + "name": "CompileMode", "modelAsString": false - } - }, - "logFolder": { - "type": "string", - "readOnly": true, - "description": "the log folder path to use in the following format: adl://.azuredatalakestore.net/system/jobservice/jobs/Usql/2016/03/13/17/18/5fe51957-93bc-4de0-8ddc-c5a4753b068b/logs/." - }, - "logFilePatterns": { - "type": "array", - "items": { - "type": "string" - }, - "description": "the list of log file name patterns to find in the logFolder. '*' is the only matching character allowed. Example format: jobExecution*.log or *mylog*.txt" - }, - "related": { - "$ref": "#/definitions/JobRelationshipProperties", - "description": "the recurring job relationship information properties." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" }, - "description": "the key-value pairs used to add additional metadata to the job information. (Only for use internally with Scope job type.)" + "description": "The specific compilation mode for the job used during execution. If this is not specified during submission, the server will determine the optimal compilation mode." } }, - "required": [ - "name", - "type" - ], - "description": "The common Data Lake Analytics job information properties." + "description": "U-SQL job properties used when submitting U-SQL jobs." }, - "JobInformation": { + "CreateScopeJobProperties": { + "x-ms-discriminator-value": "Scope", "allOf": [ { - "$ref": "#/definitions/JobInformationBasic" + "$ref": "#/definitions/CreateJobProperties" } ], "properties": { - "errorMessage": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/JobErrorDetails" - }, - "description": "the error message details for the job, if the job failed." - }, - "stateAuditRecords": { + "resources": { "type": "array", - "readOnly": true, "items": { - "$ref": "#/definitions/JobStateAuditRecord" + "$ref": "#/definitions/ScopeJobResource" }, - "description": "the job state audit records, indicating when various operations have been performed on this job." + "description": "The list of resources that are required by the job." }, - "properties": { - "$ref": "#/definitions/JobProperties", - "description": "the job specific properties." + "notifier": { + "type": "string", + "description": "The list of email addresses, separated by semi-colons, to notify when the job reaches a terminal state." } }, - "required": [ - "properties" - ], - "description": "The extended Data Lake Analytics job information properties returned when retrieving a specific job." + "description": "Scope job properties used when submitting Scope jobs. (Only for use internally with Scope job type.)" }, - "JobInfoListResult": { + "BuildJobParameters": { + "allOf": [ + { + "$ref": "#/definitions/BaseJobParameters" + } + ], "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/JobInformationBasic" - }, - "description": "the list of JobInfo items." - }, - "nextLink": { + "name": { "type": "string", - "readOnly": true, - "description": "the link (url) to the next page of results." + "description": "The friendly name of the job to build." } }, - "description": "List of JobInfo items." + "description": "The parameters used to build a new Data Lake Analytics job." }, "UpdateJobParameters": { "properties": { "degreeOfParallelism": { "type": "integer", "format": "int32", - "description": "the degree of parallelism used for this job. This must be greater than 0, if set to less than 0 it will default to 1." + "description": "The degree of parallelism used for this job. This must be greater than 0, if set to less than 0 it will default to 1." }, "priority": { "type": "integer", "format": "int32", - "description": "the priority value for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0." + "description": "The priority value for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, - "description": "the key-value pairs used to add additional metadata to the job information. (Only for use internally with Scope job type.)" + "description": "The key-value pairs used to add additional metadata to the job information." } }, "description": "The parameters that can be used to update existing Data Lake Analytics job information properties. (Only for use internally with Scope job type.)" } }, "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - }, "adlaJobDnsSuffixInPath": { "name": "adlaJobDnsSuffix", "in": "path", @@ -2013,6 +2007,13 @@ "x-ms-skip-url-encoding": true, "description": "The DNS suffix used as the base for all Azure Data Lake Analytics Job service requests.", "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." } } }