{ "swagger": "2.0", "info": { "title": "DataLakeAnalyticsJobManagementClient", "description": "Creates an Azure Data Lake Analytics job client.", "version": "2016-11-01", "x-ms-code-generation-settings": { "useDateTimeOffset": true, "internalConstructors": true } }, "x-ms-parameterized-host": { "hostTemplate": "{accountName}.{adlaJobDnsSuffix}", "parameters": [ { "name": "accountName", "description": "The Azure Data Lake Analytics account to execute job operations on.", "required": true, "type": "string", "in": "path", "x-ms-skip-url-encoding": true }, { "$ref": "#/parameters/adlaJobDnsSuffixInPath" } ] }, "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/pipelines": { "get": { "tags": [ "Pipeline" ], "operationId": "Pipeline_List", "description": "Lists all pipelines.", "x-ms-examples": { "Lists all pipelines": { "$ref": "./examples/Adla_Pipeline_List.json" } }, "parameters": [ { "name": "startDateTime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "The start date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart." }, { "name": "endDateTime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "The end date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart." }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved the list of pipelines.", "schema": { "$ref": "#/definitions/JobPipelineInformationListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/pipelines/{pipelineIdentity}": { "get": { "tags": [ "Pipeline" ], "operationId": "Pipeline_Get", "description": "Gets the Pipeline information for the specified pipeline ID.", "x-ms-examples": { "Gets the Pipeline information for the specified pipeline ID": { "$ref": "./examples/Adla_Pipeline_Get.json" } }, "parameters": [ { "name": "pipelineIdentity", "in": "path", "required": true, "type": "string", "format": "uuid", "description": "Pipeline ID." }, { "name": "startDateTime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "The start date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart." }, { "name": "endDateTime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "The end date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart." }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved details of the specified pipeline.", "schema": { "$ref": "#/definitions/JobPipelineInformation" } } } } }, "/recurrences": { "get": { "tags": [ "Recurrence" ], "operationId": "Recurrence_List", "description": "Lists all recurrences.", "x-ms-examples": { "Lists all recurrences": { "$ref": "./examples/Adla_Recurrence_List.json" } }, "parameters": [ { "name": "startDateTime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "The start date for when to get the list of recurrences. The startDateTime and endDateTime can be no more than 30 days apart." }, { "name": "endDateTime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "The end date for when to get the list of recurrences. The startDateTime and endDateTime can be no more than 30 days apart." }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved the list of recurrences.", "schema": { "$ref": "#/definitions/JobRecurrenceInformationListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/recurrences/{recurrenceIdentity}": { "get": { "tags": [ "Recurrence" ], "operationId": "Recurrence_Get", "description": "Gets the recurrence information for the specified recurrence ID.", "x-ms-examples": { "Gets the recurrence information for the specified recurrence ID": { "$ref": "./examples/Adla_Recurrence_Get.json" } }, "parameters": [ { "name": "recurrenceIdentity", "in": "path", "required": true, "type": "string", "format": "uuid", "description": "Recurrence ID." }, { "name": "startDateTime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "The start date for when to get the recurrence and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart." }, { "name": "endDateTime", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "The end date for when to get recurrence and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart." }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved details of the specified pipeline.", "schema": { "$ref": "#/definitions/JobRecurrenceInformation" } } } } }, "/Jobs/{jobIdentity}/GetStatistics": { "get": { "tags": [ "Job" ], "operationId": "Job_GetStatistics", "description": "Gets statistics of the specified job.", "x-ms-examples": { "Gets statistics of the specified job": { "$ref": "./examples/Adla_Job_GetStatistics.json" } }, "parameters": [ { "name": "jobIdentity", "in": "path", "required": true, "type": "string", "format": "uuid", "description": "Job Information ID." }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved job statistics of the specified job.", "schema": { "$ref": "#/definitions/JobStatistics" } } } } }, "/Jobs/{jobIdentity}/GetDebugDataPath": { "get": { "tags": [ "Job" ], "operationId": "Job_GetDebugDataPath", "description": "Gets the job debug data information specified by the job ID.", "x-ms-examples": { "Gets the job debug data information specified by the job ID": { "$ref": "./examples/Adla_Job_GetDebugDataPath.json" } }, "parameters": [ { "name": "jobIdentity", "in": "path", "required": true, "type": "string", "format": "uuid", "description": "Job identifier. Uniquely identifies the job across all jobs submitted to the service." }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved debug data paths of the specified job.", "schema": { "$ref": "#/definitions/JobDataPath" } } } } }, "/BuildJob": { "post": { "tags": [ "Job" ], "operationId": "Job_Build", "description": "Builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation.", "x-ms-examples": { "Builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation": { "$ref": "./examples/Adla_Job_Build.json" } }, "parameters": [ { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BuildJobParameters" }, "description": "The parameters to build a job." }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully built the job script.", "schema": { "$ref": "#/definitions/JobInformation" } } } } }, "/Jobs/{jobIdentity}/CancelJob": { "post": { "tags": [ "Job" ], "operationId": "Job_Cancel", "description": "Cancels the running job specified by the job ID.", "x-ms-examples": { "Cancels the running job specified by the job ID": { "$ref": "./examples/Adla_Job_Cancel.json" } }, "parameters": [ { "name": "jobIdentity", "in": "path", "required": true, "type": "string", "format": "uuid", "description": "Job identifier. Uniquely identifies the job across all jobs submitted to the service." }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully cancelled the job." } } } }, "/Jobs/{jobIdentity}": { "put": { "tags": [ "Job" ], "operationId": "Job_Create", "description": "Submits a job to the specified Data Lake Analytics account.", "x-ms-examples": { "Submits a job to the specified Data Lake Analytics account": { "$ref": "./examples/Adla_Job_Create.json" } }, "parameters": [ { "name": "jobIdentity", "in": "path", "required": true, "type": "string", "format": "uuid", "description": "Job identifier. Uniquely identifies the job across all jobs submitted to the service." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateJobParameters" }, "description": "The parameters to submit a job." }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully submitted the job.", "schema": { "$ref": "#/definitions/JobInformation" } } } }, "get": { "tags": [ "Job" ], "operationId": "Job_Get", "description": "Gets the job information for the specified job ID.", "x-ms-examples": { "Gets the job information for the specified job ID": { "$ref": "./examples/Adla_Job_Get.json" } }, "parameters": [ { "name": "jobIdentity", "in": "path", "required": true, "type": "string", "format": "uuid", "description": "JobInfo ID." }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved details of the specified job.", "schema": { "$ref": "#/definitions/JobInformation" } } } } }, "/Jobs": { "get": { "tags": [ "Job" ], "operationId": "Job_List", "description": "Lists the jobs, if any, associated with the specified Data Lake Analytics account. The response includes a link to the next page of results, if any.", "x-ms-examples": { "Lists the jobs, if any, associated with the specified Data Lake Analytics account": { "$ref": "./examples/Adla_Job_List.json" } }, "parameters": [ { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "OData filter. Optional." }, { "name": "$top", "in": "query", "required": false, "type": "integer", "format": "int32", "minimum": 1, "description": "The number of items to return. Optional." }, { "name": "$skip", "in": "query", "required": false, "type": "integer", "format": "int32", "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." }, { "name": "$select", "in": "query", "required": false, "type": "string", "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." }, { "name": "$orderby", "in": "query", "required": false, "type": "string", "description": "OrderBy clause. One or more comma-separated expressions with an optional \"asc\" (the default) or \"desc\" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." }, { "name": "$count", "in": "query", "required": false, "type": "boolean", "description": "The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." }, { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved the list of jobs.", "schema": { "$ref": "#/definitions/JobInfoListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/JobInformationBasic" } } }, "definitions": { "JobStatisticsVertexStage": { "properties": { "dataRead": { "type": "integer", "readOnly": true, "format": "int64", "description": "the amount of data read, in bytes." }, "dataReadCrossPod": { "type": "integer", "readOnly": true, "format": "int64", "description": "the amount of data read across multiple pods, in bytes." }, "dataReadIntraPod": { "type": "integer", "readOnly": true, "format": "int64", "description": "the amount of data read in one pod, in bytes." }, "dataToRead": { "type": "integer", "readOnly": true, "format": "int64", "description": "the amount of data remaining to be read, in bytes." }, "dataWritten": { "type": "integer", "readOnly": true, "format": "int64", "description": "the amount of data written, in bytes." }, "duplicateDiscardCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "the number of duplicates that were discarded." }, "failedCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "the number of failures that occurred in this stage." }, "maxVertexDataRead": { "type": "integer", "readOnly": true, "format": "int64", "description": "the maximum amount of data read in a single vertex, in bytes." }, "minVertexDataRead": { "type": "integer", "readOnly": true, "format": "int64", "description": "the minimum amount of data read in a single vertex, in bytes." }, "readFailureCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "the number of read failures in this stage." }, "revocationCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "the number of vertices that were revoked during this stage." }, "runningCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "the number of currently running vertices in this stage." }, "scheduledCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "the number of currently scheduled vertices in this stage" }, "stageName": { "type": "string", "readOnly": true, "description": "the name of this stage in job execution." }, "succeededCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "the number of vertices that succeeded in this stage." }, "tempDataWritten": { "type": "integer", "readOnly": true, "format": "int64", "description": "the amount of temporary data written, in bytes." }, "totalCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "the total vertex count for this stage." }, "totalFailedTime": { "type": "string", "readOnly": true, "format": "duration", "description": "the amount of time that failed vertices took up in this stage." }, "totalProgress": { "type": "integer", "readOnly": true, "format": "int32", "description": "the current progress of this stage, as a percentage." }, "totalSucceededTime": { "type": "string", "readOnly": true, "format": "duration", "description": "the amount of time all successful vertices took in this stage." } }, "description": "The Data Lake Analytics job statistics vertex stage information." }, "JobStatistics": { "properties": { "lastUpdateTimeUtc": { "type": "string", "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." }, "stages": { "type": "array", "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." }, "command": { "type": "string", "readOnly": true, "description": "the command that this job data relates to." }, "paths": { "type": "array", "readOnly": true, "items": { "type": "string" }, "description": "the list of paths to all of the job data." } }, "description": "A Data Lake Analytics job data path item." }, "JobStateAuditRecord": { "properties": { "newState": { "type": "string", "readOnly": true, "description": "the new state the job is in." }, "timeStamp": { "type": "string", "readOnly": true, "format": "date-time", "description": "the time stamp that the state change took place." }, "requestedByUser": { "type": "string", "readOnly": true, "description": "the user who requests the change." }, "details": { "type": "string", "readOnly": true, "description": "the details of the audit log." } }, "description": "The Data Lake Analytics job state audit records for tracking the lifecycle of a job." }, "JobResource": { "properties": { "name": { "type": "string", "description": "the name of the resource." }, "resourcePath": { "type": "string", "description": "the path to the resource." }, "type": { "type": "string", "description": "the job resource type.", "enum": [ "VertexResource", "JobManagerResource", "StatisticsResource", "VertexResourceInUserFolder", "JobManagerResourceInUserFolder", "StatisticsResourceInUserFolder" ], "x-ms-enum": { "name": "JobResourceType", "modelAsString": false } } }, "description": "The Data Lake Analytics job resources." }, "USqlJobProperties": { "x-ms-discriminator-value": "USql", "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." }, "totalPauseTime": { "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." }, "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." }, "totalRunningTime": { "type": "string", "format": "duration", "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." }, "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." }, "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." }, "compileMode": { "type": "string", "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 } } }, "description": "U-SQL job properties used when retrieving U-SQL jobs." }, "HiveJobProperties": { "x-ms-discriminator-value": "Hive", "allOf": [ { "$ref": "#/definitions/JobProperties" } ], "properties": { "logsLocation": { "type": "string", "readOnly": true, "description": "the Hive logs location" }, "outputLocation": { "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": "Hive job properties used when retrieving Hive jobs." }, "JobProperties": { "discriminator": "type", "required": [ "script", "type" ], "properties": { "runtimeVersion": { "type": "string", "readOnly": true, "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 (i.e. Hive or USql)." } }, "description": "The common Data Lake Analytics job properties." }, "CreateUSqlJobProperties": { "x-ms-discriminator-value": "USql", "allOf": [ { "$ref": "#/definitions/CreateJobProperties" } ], "properties": { "compileMode": { "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." }, "CreateJobProperties": { "discriminator": "type", "required": [ "script", "type" ], "properties": { "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 (i.e. USql)." } }, "description": "The common Data Lake Analytics job properties for job submission." }, "Diagnostics": { "properties": { "columnNumber": { "description": "the column where the error occurred.", "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 occurred on.", "type": "integer", "format": "int32", "readOnly": true }, "message": { "description": "the error message.", "type": "string", "readOnly": true }, "severity": { "description": "the severity of the error.", "readOnly": true, "type": "string", "enum": [ "Warning", "Error", "Info", "SevereWarning", "Deprecated", "UserWarning" ], "x-ms-enum": { "name": "SeverityTypes", "modelAsString": false } }, "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", "readOnly": true, "description": "the error message description" }, "details": { "type": "string", "readOnly": true, "description": "the details of the error message." }, "endOffset": { "type": "integer", "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." }, "filePath": { "type": "string", "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." }, "internalDiagnostics": { "type": "string", "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." }, "lineNumber": { "type": "integer", "readOnly": true, "format": "int32", "description": "the specific line number in the job where the error occurred." }, "message": { "type": "string", "readOnly": true, "description": "the user friendly error message for the failure." }, "resolution": { "type": "string", "readOnly": true, "description": "the recommended resolution for the failure, if any." }, "innerError": { "$ref": "#/definitions/JobInnerError", "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 } }, "source": { "type": "string", "readOnly": true, "description": "the ultimate source of the failure (usually either SYSTEM or USER)." }, "startOffset": { "type": "integer", "readOnly": true, "format": "int32", "description": "the start offset in the job where the error was found" } }, "description": "The Data Lake Analytics job error details." }, "JobInnerError": { "properties": { "diagnosticCode": { "type": "integer", "readOnly": true, "format": "int32", "description": "the diagnostic error code." }, "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 } }, "details": { "type": "string", "readOnly": true, "description": "the details of the error message." }, "component": { "type": "string", "readOnly": true, "description": "the component that failed." }, "errorId": { "type": "string", "readOnly": true, "description": "the specific identifier for the type of error encountered in the job." }, "helpLink": { "type": "string", "readOnly": true, "description": "the link to MSDN or Azure help for this type of error, if any." }, "internalDiagnostics": { "type": "string", "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." }, "message": { "type": "string", "readOnly": true, "description": "the user friendly error message for the failure." }, "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": { "type": "string", "readOnly": true, "description": "the error message description" }, "innerError": { "$ref": "#/definitions/JobInnerError", "readOnly": true, "description": "the inner error of this specific job error message, if any." } }, "description": "The Data Lake Analytics job error details." }, "JobRelationshipProperties": { "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": { "type": "string", "description": "the pipeline uri, unique, links to the originating service for this pipeline." }, "runId": { "type": "string", "format": "uuid", "description": "the run identifier (a GUID), unique identifier of the iteration of this pipeline." }, "recurrenceId": { "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." }, "recurrenceName": { "type": "string", "maxLength": 260, "description": "the recurrence name, user friendly name for the correlation between jobs." } }, "required": [ "recurrenceId" ], "description": "Job relationship information properties including pipeline information, correlation information, etc." }, "JobPipelineInformationListResult": { "properties": { "value": { "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/JobPipelineInformation" }, "description": "the list of job pipeline information items." }, "nextLink": { "type": "string", "readOnly": true, "description": "the link (url) to the next page of results." } }, "description": "List of job pipeline information items." }, "JobPipelineInformation": { "properties": { "pipelineId": { "type": "string", "format": "uuid", "readOnly": true, "description": "the job relationship pipeline identifier (a GUID)." }, "pipelineName": { "type": "string", "maxLength": 260, "readOnly": true, "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." }, "numJobsFailed": { "type": "integer", "format": "int32", "readOnly": true, "description": "the number of jobs in this pipeline that have failed." }, "numJobsCanceled": { "type": "integer", "format": "int32", "readOnly": true, "description": "the number of jobs in this pipeline that have been canceled." }, "numJobsSucceeded": { "type": "integer", "format": "int32", "readOnly": true, "description": "the number of jobs in this pipeline that have succeeded." }, "auHoursFailed": { "type": "number", "format": "double", "readOnly": true, "description": "the number of job execution hours that resulted in failed jobs." }, "auHoursCanceled": { "type": "number", "format": "double", "readOnly": true, "description": "the number of job execution hours that resulted in canceled jobs." }, "auHoursSucceeded": { "type": "number", "format": "double", "readOnly": true, "description": "the number of job execution hours that resulted in successful jobs." }, "lastSubmitTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "the last time a job in this pipeline was submitted." }, "runs": { "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/JobPipelineRunInformation" }, "description": "the list of run identifiers representing each run of this pipeline." }, "recurrences": { "type": "array", "readOnly": true, "items": { "type": "string", "format": "uuid" }, "description": "the list of recurrence identifiers representing each recurrence in this pipeline." } }, "description": "Job Pipeline Information, showing the relationship of jobs and recurrences of those jobs in a pipeline." }, "JobRecurrenceInformationListResult": { "properties": { "value": { "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/JobRecurrenceInformation" }, "description": "the list of job recurrence information items." }, "nextLink": { "type": "string", "readOnly": true, "description": "the link (url) to the next page of results." } }, "description": "List of job recurrence information items." }, "JobRecurrenceInformation": { "properties": { "recurrenceId": { "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." }, "recurrenceName": { "type": "string", "readOnly": true, "description": "the recurrence name, user friendly name for the correlation between jobs." }, "numJobsFailed": { "type": "integer", "format": "int32", "readOnly": true, "description": "the number of jobs in this recurrence that have failed." }, "numJobsCanceled": { "type": "integer", "format": "int32", "readOnly": true, "description": "the number of jobs in this recurrence that have been canceled." }, "numJobsSucceeded": { "type": "integer", "format": "int32", "readOnly": true, "description": "the number of jobs in this recurrence that have succeeded." }, "auHoursFailed": { "type": "number", "format": "double", "readOnly": true, "description": "the number of job execution hours that resulted in failed jobs." }, "auHoursCanceled": { "type": "number", "format": "double", "readOnly": true, "description": "the number of job execution hours that resulted in canceled jobs." }, "auHoursSucceeded": { "type": "number", "format": "double", "readOnly": true, "description": "the number of job execution hours that resulted in successful jobs." }, "lastSubmitTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "the last time a job in this recurrence was submitted." } }, "description": "Recurrence job information for a specific recurrence." }, "JobPipelineRunInformation": { "properties": { "runId": { "type": "string", "format": "uuid", "readOnly": true, "description": "the run identifier of an instance of pipeline executions (a GUID)." }, "lastSubmitTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "the time this instance was last submitted." } }, "description": "Run info for a specific job pipeline." }, "CreateJobParameters": { "allOf": [ { "$ref": "#/definitions/BaseJobParameters" } ], "properties": { "name": { "type": "string", "description": "the friendly name of the job to submit." }, "degreeOfParallelism": { "type": "integer", "default": 1, "format": "int32", "description": "the degree of parallelism used for this job. At most one of degreeOfParallelism and degreeOfParallelismPercent should be specified. If none, a default value of 1 will be used." }, "degreeOfParallelismPercent": { "type": "number", "format": "double", "description": "the degree of parallelism in percentage used for this job. At most one of degreeOfParallelism and degreeOfParallelismPercent should be specified. If none, a default value of 1 will be used for degreeOfParallelism." }, "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." }, "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." } }, "required": [ "name" ], "description": "The parameters used to submit a new Data Lake Analytics job." }, "BuildJobParameters": { "allOf": [ { "$ref": "#/definitions/BaseJobParameters" } ], "properties": { "name": { "type": "string", "description": "the friendly name of the job to build." } }, "description": "The parameters used to build a new Data Lake Analytics job." }, "BaseJobParameters": { "properties": { "type": { "type": "string", "description": "the job type of the current job (Hive or USql).", "enum": [ "USql", "Hive" ], "x-ms-enum": { "name": "JobType", "modelAsString": false } }, "properties": { "$ref": "#/definitions/CreateJobProperties", "description": "the job specific properties." } }, "required": [ "type", "properties" ], "description": "Data Lake Analytics Job Parameters base class for build and submit." }, "JobInformationBasic": { "properties": { "jobId": { "type": "string", "format": "uuid", "readOnly": true, "description": "the job's unique identifier (a GUID)." }, "name": { "type": "string", "description": "the friendly name of the job." }, "type": { "type": "string", "description": "the job type of the current job (Hive or USql).", "enum": [ "USql", "Hive" ], "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", "readOnly": true, "description": "the degree of parallelism used for this job." }, "degreeOfParallelismPercent": { "type": "number", "format": "double", "readOnly": true, "description": "the degree of parallelism in percentage used for this job." }, "priority": { "type": "integer", "format": "int32", "readOnly": true, "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": { "type": "string", "readOnly": true, "description": "the result of job execution or the current result of the running job.", "enum": [ "None", "Succeeded", "Cancelled", "Failed" ], "x-ms-enum": { "name": "JobResult", "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" }, "readOnly": true, "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." }, "hierarchyQueueNode": { "type": "string", "readOnly": true, "description": "the name of hierarchy queue node this job is assigned to, null if job has not been assigned yet or the account doesn't have hierarchy queue." } }, "required": [ "name", "type" ], "description": "The common Data Lake Analytics job information properties." }, "JobInformation": { "allOf": [ { "$ref": "#/definitions/JobInformationBasic" } ], "properties": { "errorMessage": { "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/JobErrorDetails" }, "description": "the error message details for the job, if the job failed." }, "stateAuditRecords": { "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/JobStateAuditRecord" }, "description": "the job state audit records, indicating when various operations have been performed on this job." }, "properties": { "$ref": "#/definitions/JobProperties", "description": "the job specific properties." } }, "required": [ "properties" ], "description": "The extended Data Lake Analytics job information properties returned when retrieving a specific job." }, "JobInfoListResult": { "properties": { "value": { "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/JobInformationBasic" }, "description": "the list of JobInfo items." }, "nextLink": { "type": "string", "readOnly": true, "description": "the link (url) to the next page of results." } }, "description": "List of JobInfo items." } }, "parameters": { "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "Client Api Version." }, "adlaJobDnsSuffixInPath": { "name": "adlaJobDnsSuffix", "in": "path", "required": true, "type": "string", "default": "azuredatalakeanalytics.net", "x-ms-skip-url-encoding": true, "description": "Gets the DNS suffix used as the base for all Azure Data Lake Analytics Job service requests.", "x-ms-parameter-location": "client" } } }