swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Job API
schemes:
- https
tags:
- name: Job
paths:
  /jobs:
    get:
      tags:
      - Job
      operationId: microsoftAzureJobList
      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.
      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-examples:
        Lists the jobs, if any, associated with the specified Data Lake Analytics account:
          $ref: ./examples/Job_List.json
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/JobInformationBasic'
      summary: Microsoft Azure Get Jobs
  /jobs/{jobIdentity}:
    put:
      tags:
      - Job
      operationId: microsoftAzureJobCreate
      description: Submits a job to the specified Data Lake Analytics account.
      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'
      x-ms-examples:
        Submits a job to the specified Data Lake Analytics account:
          $ref: ./examples/Job_Create.json
      summary: Microsoft Azure Put Jobs Jobidentity
    get:
      tags:
      - Job
      operationId: microsoftAzureJobGet
      description: Gets the job information for the specified job ID.
      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'
      x-ms-examples:
        Gets the job information for the specified job ID:
          $ref: ./examples/Job_Get.json
      summary: Microsoft Azure Get Jobs Jobidentity
    patch:
      tags:
      - Job
      operationId: microsoftAzureJobUpdate
      description: Updates the job information for the specified job ID. (Only for use internally with Scope job type.)
      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: false
        schema:
          $ref: '#/definitions/UpdateJobParameters'
        description: The parameters to update a job.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully updated the details of the specified job.
          schema:
            $ref: '#/definitions/JobInformation'
        '201':
          description: Successfully initiated an update of the specified job.
        '202':
          description: Successfully initiated an update of the specified job.
      x-ms-examples:
        Updates the job information for the specified job ID. (Only for use internally with Scope job type.):
          $ref: ./examples/Job_Update.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Jobs Jobidentity
  /jobs/{jobIdentity}/GetStatistics:
    get:
      tags:
      - Job
      operationId: microsoftAzureJobGetstatistics
      description: Gets statistics of the specified job.
      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'
      x-ms-examples:
        Gets statistics of the specified job:
          $ref: ./examples/Job_GetStatistics.json
      summary: Microsoft Azure Get Jobs Jobidentity Getstatistics
  /jobs/{jobIdentity}/GetDebugDataPath:
    get:
      tags:
      - Job
      operationId: microsoftAzureJobGetdebugdatapath
      description: Gets the job debug data information specified by the job ID.
      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'
      x-ms-examples:
        Gets the job debug data information specified by the job ID:
          $ref: ./examples/Job_GetDebugDataPath.json
      summary: Microsoft Azure Get Jobs Jobidentity Getdebugdatapath
  /jobs/{jobIdentity}/CancelJob:
    post:
      tags:
      - Job
      operationId: microsoftAzureJobCancel
      description: Cancels the running job specified by the job ID.
      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.
        '202':
          description: Successfully initiated the cancellation of the specified job.
        '204':
          description: The specified job was not found.
      x-ms-examples:
        Cancels the running job specified by the job ID:
          $ref: ./examples/Job_Cancel.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Jobs Jobidentity Canceljob
  /jobs/{jobIdentity}/YieldJob:
    post:
      tags:
      - Job
      operationId: microsoftAzureJobYield
      description: Pauses the specified job and places it back in the job queue, behind other jobs of equal or higher importance, based on priority. (Only for use internally with Scope job type.)
      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 yielded the specified job.
        '202':
          description: Successfully initiated the yielding of the specified job.
        '204':
          description: The specified job was not found.
      x-ms-examples:
        ? Pauses the specified job and places it back in the job queue, behind other jobs of equal or higher importance, based on priority. (Only for use internally with Scope job type.)
        : $ref: ./examples/Job_Yield.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Jobs Jobidentity Yieldjob
  /buildJob:
    post:
      tags:
      - Job
      operationId: microsoftAzureJobBuild
      description: Builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation.
      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'
      x-ms-examples:
        Builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation:
          $ref: ./examples/Job_Build.json
      summary: Microsoft Azure Post Buildjob
  /livy/batches:
    get:
      tags:
      - Job
      description: List all spark batch jobs
      operationId: microsoftAzureJobListsparkbatchjob
      x-ms-examples:
        List all spark batch jobs:
          $ref: ./examples/HDI_Job_ListSparkBatchJob.json
      produces:
      - application/json
      parameters:
      - name: from
        in: query
        description: Optional param specifying which index the list should begin from.
        required: false
        type: integer
        format: int32
      - name: size
        in: query
        description: "Optional param specifying the size of the returned list.\r\n            By default it is 20 and that is the maximum."
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkBatchJobCollection'
      summary: Microsoft Azure Get Livy Batches
    post:
      tags:
      - Job
      description: Create a new spark batch job.
      operationId: microsoftAzureJobSubmitsparkbatchjob
      x-ms-examples:
        Create a spark batch job:
          $ref: ./examples/HDI_Job_SubmitSparkBatchJob.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/requestedByParameter'
      - name: sparkBatchJobRequest
        in: body
        description: Livy compatible batch job request payload.
        required: true
        schema:
          $ref: '#/definitions/SparkBatchJobRequest'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/SparkBatchJob'
      summary: Microsoft Azure Post Livy Batches
  /livy/batches/{batchId}:
    get:
      tags:
      - Job
      description: Gets a single spark batch job.
      operationId: microsoftAzureJobGetsparkbatchjob
      x-ms-examples:
        Gets a single spark batch job:
          $ref: ./examples/HDI_Job_GetSparkBatchJob.json
      produces:
      - application/json
      parameters:
      - name: batchId
        in: path
        description: Identifier for the batch job.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkBatchJob'
      summary: Microsoft Azure Get Livy Batches Batchid
    delete:
      tags:
      - Job
      description: Cancels a running spark batch job.
      operationId: microsoftAzureJobDeletesparkbatch
      x-ms-examples:
        Cancels a running spark batch job:
          $ref: ./examples/HDI_Job_DeleteSparkBatch.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/requestedByParameter'
      - name: batchId
        in: path
        description: Identifier for the batch job.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkJobDeletedResult'
      summary: Microsoft Azure Delete Livy Batches Batchid
  /livy/batches/{batchId}/log:
    get:
      tags:
      - Job
      description: Gets a single spark batch job logs.
      operationId: microsoftAzureJobGetsparkbatchlog
      x-ms-examples:
        Gets a single spark batch job logs:
          $ref: ./examples/HDI_Job_GetSparkBatchLog.json
      produces:
      - application/json
      parameters:
      - name: batchId
        in: path
        description: Identifier for the batch job.
        required: true
        type: integer
        format: int32
      - name: from
        in: query
        description: Optional param specifying which index the list should begin from.
        required: false
        type: integer
        format: int32
      - name: size
        in: query
        description: "Optional param specifying the size of the returned list.\r\n            By default it is 20 and that is the maximum."
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkJobLog'
      summary: Microsoft Azure Get Livy Batches Batchid Log
  /livy/batches/{batchId}/state:
    get:
      tags:
      - Job
      description: Gets a single spark batch state.
      operationId: microsoftAzureJobGetsparkbatchstate
      x-ms-examples:
        Gets a single spark batch state:
          $ref: ./examples/HDI_Job_GetSparkBatchState.json
      produces:
      - application/json
      parameters:
      - name: batchId
        in: path
        description: Identifier for the batch job.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkJobState'
      summary: Microsoft Azure Get Livy Batches Batchid State
  /livy/sessions:
    get:
      tags:
      - Job
      description: List all spark sessions.
      operationId: microsoftAzureJobListsparksessionjob
      x-ms-examples:
        List all spark sessions:
          $ref: ./examples/HDI_Job_ListSparkSessionJob.json
      produces:
      - application/json
      parameters:
      - name: from
        in: query
        description: Optional param specifying which index the list should begin from.
        required: false
        type: integer
        format: int32
      - name: size
        in: query
        description: "Optional param specifying the size of the returned list.\r\n            By default it is 20 and that is the maximum."
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkSessionCollection'
      summary: Microsoft Azure Get Livy Sessions
    post:
      tags:
      - Job
      description: Create a new spark session.
      operationId: microsoftAzureJobSubmitsparksessionjob
      x-ms-examples:
        Create a new spark session:
          $ref: ./examples/HDI_Job_SubmitSparkSessionJob.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/requestedByParameter'
      - name: sparkSessionJobRequest
        in: body
        description: Livy compatible session job request payload.
        required: true
        schema:
          $ref: '#/definitions/SparkSessionJobRequest'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/SparkSessionJob'
      summary: Microsoft Azure Post Livy Sessions
  /livy/sessions/{sessionId}:
    get:
      tags:
      - Job
      description: Gets a single spark session.
      operationId: microsoftAzureJobGetsparksessionjob
      x-ms-examples:
        Gets a single spark session:
          $ref: ./examples/HDI_Job_GetSparkSessionJob.json
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: Identifier for the session.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkSessionJob'
      summary: Microsoft Azure Get Livy Sessions Sessionid
    delete:
      tags:
      - Job
      description: Cancels a running spark session.
      operationId: microsoftAzureJobDeletesparksessionjob
      x-ms-examples:
        Cancels a running spark session:
          $ref: ./examples/HDI_Job_DeleteSparkSessionJob.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/requestedByParameter'
      - name: sessionId
        in: path
        description: Identifier for the session.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkJobDeletedResult'
      summary: Microsoft Azure Delete Livy Sessions Sessionid
  /livy/sessions/{sessionId}/log:
    get:
      tags:
      - Job
      description: Gets a single spark session job logs.
      operationId: microsoftAzureJobGetsparksessionlog
      x-ms-examples:
        Gets a single spark session job logs:
          $ref: ./examples/HDI_Job_GetSparkSessionLog.json
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: Identifier for the session job.
        required: true
        type: integer
        format: int32
      - name: from
        in: query
        description: Optional param specifying which index the list should begin from.
        required: false
        type: integer
        format: int32
      - name: size
        in: query
        description: "Optional param specifying the size of the returned list.\r\n            By default it is 20 and that is the maximum."
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkJobLog'
      summary: Microsoft Azure Get Livy Sessions Sessionid Log
  /livy/sessions/{sessionId}/state:
    get:
      tags:
      - Job
      description: Gets a single spark session job state.
      operationId: microsoftAzureJobGetsparksessionstate
      x-ms-examples:
        Gets a single spark session job state:
          $ref: ./examples/HDI_Job_GetSparkSessionState.json
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: Identifier for the session job.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkJobState'
      summary: Microsoft Azure Get Livy Sessions Sessionid State
  /livy/sessions/{sessionId}/statements:
    get:
      tags:
      - Job
      description: Gets a list of statements within a spark session.
      operationId: microsoftAzureJobListsparkstatementjob
      x-ms-examples:
        Gets a list of statements within a spark session:
          $ref: ./examples/HDI_Job_ListSparkStatementJob.json
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: Identifier for the session.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkStatementCollection'
      summary: Microsoft Azure Get Livy Sessions Sessionid Statements
    post:
      tags:
      - Job
      description: Create a statement within a spark session.
      operationId: microsoftAzureJobSubmitsparkstatementjob
      x-ms-examples:
        Create a statement within a spark session:
          $ref: ./examples/HDI_Job_SubmitSparkStatementJob.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/requestedByParameter'
      - name: sessionId
        in: path
        description: Identifier for the session.
        required: true
        type: integer
        format: int32
      - name: sparkStatementRequest
        in: body
        description: Livy compatible batch job request payload.
        required: true
        schema:
          $ref: '#/definitions/SparkStatementRequest'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/SparkStatement'
      summary: Microsoft Azure Post Livy Sessions Sessionid Statements
  /livy/sessions/{sessionId}/statements/{statementId}:
    get:
      tags:
      - Job
      description: Gets a single statement within a spark session.
      operationId: microsoftAzureJobGetsparkstatementjob
      x-ms-examples:
        Gets a single statement within a spark session:
          $ref: ./examples/HDI_Job_GetSparkStatementJob.json
      produces:
      - application/json
      parameters:
      - name: sessionId
        in: path
        description: Identifier for the session.
        required: true
        type: integer
        format: int32
      - name: statementId
        in: path
        description: Identifier for the statement.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkStatement'
      summary: Microsoft Azure Get Livy Sessions Sessionid Statements Statementid
  /livy/sessions/{sessionId}/statements/{statementId}/cancel:
    post:
      tags:
      - Job
      description: Kill a statement within a session.
      operationId: microsoftAzureJobDeletesparkstatementjob
      x-ms-examples:
        Kill a statement within a session:
          $ref: ./examples/HDI_Job_DeleteSparkStatementJob.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/requestedByParameter'
      - name: sessionId
        in: path
        description: Identifier for the session.
        required: true
        type: integer
        format: int32
      - name: statementId
        in: path
        description: Identifier for the statement.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SparkStatementCancellationResult'
      summary: Microsoft Azure Post Livy Sessions Sessionid Statements Statementid Cancel
definitions:
  JobDataPath:
    properties:
      jobId:
        readOnly: true
        type: string
        format: uuid
        description: The ID of the job this data is for.
      command:
        readOnly: true
        type: string
        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: A Data Lake Analytics job data path item.
  SparkJobState:
    type: object
    properties:
      id:
        description: The livy id of the spark job.
        format: int32
        type: integer
      state:
        description: The current state of the spark job
        $ref: '#/definitions/JobState'
  SparkSessionCollection:
    type: object
    properties:
      from:
        description: The start index to fetch spark sessions.
        format: int32
        type: integer
      total:
        description: Number of spark sessions to fetch.
        format: int32
        type: integer
      sessions:
        description: List of spark sessions.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/SparkSessionJob'
  SparkSessionJobRequest:
    type: object
    properties:
      kind:
        description: Spark session job kind.
        $ref: '#/definitions/SessionJobKind'
      proxyUser:
        description: User to impersonate when starting the session.
        type: string
      jars:
        description: Jars to be used in this session.
        uniqueItems: false
        type: array
        items:
          type: string
      pyFiles:
        description: Python files to be used in this session.
        x-ms-client-name: pythonFiles
        uniqueItems: false
        type: array
        items:
          type: string
      files:
        description: Files to be used in this session.
        uniqueItems: false
        type: array
        items:
          type: string
      driverMemory:
        description: Amount of memory to use for the driver process.
        type: string
      driverCores:
        description: Number of cores to use for the driver process.
        format: int32
        type: integer
      executorMemory:
        description: Amount of memory to use per executor process.
        type: string
      executorCores:
        description: Number of cores to use for each executor.
        format: int32
        type: integer
      numExecutors:
        description: Number of executors to launch for this session.
        x-ms-client-name: executorCount
        format: int32
        type: integer
      archives:
        description: Archives to be used in this session.
        uniqueItems: false
        type: array
        items:
          type: string
      queue:
        description: The name of the YARN queue to which submitted.
        type: string
      name:
        description: The name of this session.
        type: string
      conf:
        description: Spark configuration properties.
        x-ms-client-name: configuration
        type: object
        additionalProperties:
          type: string
      heartbeatTimeoutInSecond:
        description: Timeout in second to which session be orphaned.
        format: int32
        type: integer
  SparkStatement:
    type: object
    properties:
      id:
        description: The livy id of the spark statement job.
        format: int32
        type: integer
      code:
        description: The execution code.
        type: string
      state:
        description: The current state of the spark statement.
        $ref: '#/definitions/StatementState'
      output:
        description: The execution output.
        $ref: '#/definitions/SparkStatementOutput'
      progress:
        description: The execution progress.
        type: number
        format: double
  JobState:
    type: string
    x-ms-enum:
      name: JobState
      modelAsString: true
    enum:
    - not_started
    - starting
    - idle
    - running
    - busy
    - shutting_down
    - error
    - dead
    - killed
    - success
    - recovering
  SessionJobKind:
    type: string
    x-ms-enum:
      name: SessionJobKind
      modelAsString: true
    enum:
    - spark
    - pyspark
    - sparkr
    - sql
  SparkBatchJobCollection:
    type: object
    properties:
      from:
        description: The start index to fetch Spark Batch jobs.
        format: int32
        type: integer
      total:
        description: Number of Spark Batch jobs to fetch.
        format: int32
        type: integer
      sessions:
        description: List of spark batch jobs.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/SparkBatchJob'
  JobInformation:
    required:
    - properties
    allOf:
    - $ref: '#/definitions/JobInformationBasic'
    properties:
      errorMessage:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/JobErrorDetails'
        description: The error message details for the job, if the job failed.
      stateAuditRecords:
        readOnly: true
        type: array
        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.
    description: The extended Data Lake Analytics job information properties returned when retrieving a specific job.
  SparkJobLog:
    type: object
    properties:
      id:
        description: The livy id of the spark job.
        format: int32
        type: integer
      from:
        description: Offset from start of log.
        format: int32
        type: integer
      size:
        description: Max number of log lines.
        format: int32
        type: integer
      total:
        description: Total number of log lines.
        format: int64
        type: integer
      log:
        description: The log lines.
        x-ms-client-name: logLines
        uniqueItems: false
        type: array
        items:
          type: string
  JobStatisticsVertexStage:
    properties:
      dataRead:
        readOnly: true
        type: integer
        format: int64
        description: The amount of data read, in bytes.
      dataReadCrossPod:
        readOnly: true
        type: integer
        format: int64
        description: The amount of data read across multiple pods, in bytes.
      dataReadIntraPod:
        readOnly: true
        type: integer
        format: int64
        description: The amount of data read in one pod, in bytes.
      dataToRead:
        readOnly: true
        type: integer
        format: int64
        description: The amount of data remaining to be read, in bytes.
      dataWritten:
        readOnly: true
        type: integer
        format: int64
        description: The amount of data written, in bytes.
      duplicateDiscardCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of duplicates that were discarded.
      failedCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of failures that occurred in this stage.
      maxVertexDataRead:
        readOnly: true
        type: integer
        format: int64
        description: The maximum amount of data read in a single vertex, in bytes.
      minVertexDataRead:
        readOnly: true
        type: integer
        format: int64
        description: The minimum amount of data read in a single vertex, in bytes.
      readFailureCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of read failures in this stage.
      revocationCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of vertices that were revoked during this stage.
      runningCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of currently running vertices in this stage.
      scheduledCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of currently scheduled vertices in this stage.
      stageName:
        readOnly: true
        type: string
        description: The name of this stage in job execution.
      succeededCount:
        readOnly: true
        type: integer
        format: int32
        description: The number of vertices that succeeded in this stage.
      tempDataWritten:
        readOnly: true
        type: integer
        format: int64
        description: The amount of temporary data written, in bytes.
      totalCount:
        readOnly: true
        type: integer
        format: int32
        description: The total vertex count for this stage.
      totalFailedTime:
        readOnly: true
        type: string
        format: duration
        description: The amount of time that failed vertices took up in this stage.
      totalProgress:
        readOnly: true
        type: integer
        format: int32
        description: The current progress of this stage, as a percentage.
      totalSucceededTime:
        readOnly: true
        type: string
        format: duration
        description: The amount of time all successful vertices took in this stage.
      totalPeakMemUsage:
        readOnly: true
        type: integer
        format: int64
        description: The sum of the peak memory usage of all the vertices in the stage, in bytes.
      totalExecutionTime:
        readOnly: true
        type: string
        format: duration
        description: The sum of the total execution time of all the vertices in the stage.
      maxDataReadVertex:
        $ref: '#/definitions/JobStatisticsVertex'
        description: the vertex with the maximum amount of data read.
      maxExecutionTimeVertex:
        $ref: '#/definitions/JobStatisticsVertex'
        description: the vertex with the maximum execution time.
      maxPeakMemUsageVertex:
        $ref: '#/definitions/JobStatisticsVertex'
        description: the vertex with the maximum peak memory usage.
      estimatedVertexCpuCoreCount:
        readOnly: true
        type: integer
        format: int32
        description: The estimated vertex CPU core count.
      estimatedVertexPeakCpuCoreCount:
        readOnly: true
        type: integer
        format: int32
        description: The estimated vertex peak CPU core count.
      estimatedVertexMemSize:
        readOnly: true
        type: integer
        format: int64
        description: The estimated vertex memory size, in bytes.
      allocatedContainerCpuCoreCount:
        $ref: '#/definitions/ResourceUsageStatistics'
        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.
      usedVertexCpuCoreCount:
        $ref: '#/definitions/ResourceUsageStatistics'
        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 Data Lake Analytics job statistics vertex stage information.
  CreateJobParameters:
    required:
    - name
    allOf:
    - $ref: '#/definitions/BaseJobParameters'
    properties:
      name:
        type: string
        description: The friendly name of the job to submit.
      degreeOfParallelism:
        type: integer
        format: int32
        default: 1
        description: The degree of parallelism to use 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.
      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.
    description: The parameters used to submit a new Data Lake Analytics job.
  SparkStatementCancellationResult:
    type: object
    properties:
      msg:
        x-ms-client-name: cancelMessage
        type: string
  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.
  JobProperties:
    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 (Hive, USql, or Scope (for internal use only)).
    description: The common Data Lake Analytics job properties.
  SparkStatementCollection:
    type: object
    properties:
      statements:
        description: List of spark statements.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/SparkStatement'
  SparkStatementOutput:
    type: object
    properties:
      status:
        description: Execution status.
        $ref: '#/definitions/StatementExecutionStatus'
      execution_count:
        description: A monotonically increasing number.
        format: int32
        type: integer
      data:
        description: Statement output.
        type: object
  SparkBatchJob:
    type: object
    properties:
      id:
        description: The livy id of the spark batch job.
        format: int32
        type: integer
      appId:
        description: The application id of this job.
        type: string
      appInfo:
        description: The detailed application info.
        type: object
        additionalProperties:
          type: string
      state:
        description: The current state of the spark batch job
        $ref: '#/definitions/JobState'
      log:
        description: The log lines.
        x-ms-client-name: logLines
        uniqueItems: false
        type: array
        items:
          type: string
  ResourceUsageStatistics:
    properties:
      average:
        readOnly: true
        type: number
        format: double
        description: The average value.
      minimum:
        readOnly: true
        type: integer
        format: int64
        description: The minimum value.
      maximum:
        readOnly: true
        type: integer
        format: int64
        description: The maximum value.
    description: The statistics information for resource usage.
  SparkJobDeletedResult:
    type: object
    properties:
      msg:
        x-ms-client-name: deletedMessage
        type: string
  SparkBatchJobRequest:
    type: object
    properties:
      file:
        description: File containing the application to execute.
        type: string
      proxyUser:
        description: User to impersonate when running the job.
        type: string
      className:
        description: Application Java/Spark main class.
        type: string
      args:
        description: Command line arguments for the application.
        x-ms-client-name: arguments
        uniqueItems: false
        type: array
        items:
          type: string
      jars:
        description: Jars to be used in this batch job.
        uniqueItems: false
        type: array
        items:
          type: string
      pyFiles:
        description: Python files to be used in this batch job.
        x-ms-client-name: pythonFiles
        uniqueItems: false
        type: array
        items:
          type: string
      files:
        description: Files to be used in this batch job.
        uniqueItems: false
        type: array
        items:
          type: string
      driverMemory:
        description: Amount of memory to use for the driver process.
        type: string
      driverCores:
        description: Number of cores to use for the driver process.
        format: int32
        type: integer
      executorMemory:
        description: Amount of memory to use per executor process.
        type: string
      executorCores:
        description: Number of cores to use for each executor.
        format: int32
        type: integer
      numExecutors:
        description: Number of executors to launch for this batch job.
        x-ms-client-name: executorCount
        format: int32
        type: integer
      archives:
        description: Archives to be used in this batch job.
        uniqueItems: false
        type: array
        items:
          type: string
      queue:
        description: The name of the YARN queue to which submitted.
        type: string
      name:
        description: The name of this batch job.
        type: string
      conf:
        description: Spark configuration properties.
        x-ms-client-name: configuration
        type: object
        additionalProperties:
          type: string
  SparkStatementRequest:
    type: object
    properties:
      code:
        type: string
      kind:
        $ref: '#/definitions/SessionJobKind'
  SparkSessionJob:
    type: object
    properties:
      id:
        description: The livy id of the spark session job.
        format: int32
        type: integer
      appId:
        description: The application id of this job.
        type: string
      owner:
        description: Remote user who submitted this job.
        type: string
      proxyUser:
        description: User to impersonate when running.
        type: string
      kind:
        description: Spark session job kind.
        $ref: '#/definitions/SessionJobKind'
      log:
        description: The log lines.
        x-ms-client-name: logLines
        uniqueItems: false
        type: array
        items:
          type: string
      state:
        description: The current state of the spark session job
        $ref: '#/definitions/JobState'
      appInfo:
        description: The detailed application info.
        type: object
        additionalProperties:
          type: string
  JobInfoListResult:
    properties:
      value:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/JobInformationBasic'
        description: The list of JobInfo items.
      nextLink:
        readOnly: true
        type: string
        description: The link (url) to the next page of results.
    description: List of JobInfo items.
  StatementExecutionStatus:
    type: string
    x-ms-enum:
      name: StatementExecutionStatus
      modelAsString: true
    enum:
    - ok
    - error
    - abort
  StatementState:
    type: string
    x-ms-enum:
      name: StatementState
      modelAsString: true
    enum:
    - waiting
    - running
    - available
    - error
    - cancelling
    - cancelled
  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 (Hive, USql, or Scope (for internal use only)).
    description: The common Data Lake Analytics job properties for job submission.
  BaseJobParameters:
    required:
    - type
    - properties
    properties:
      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)).
      properties:
        $ref: '#/definitions/CreateJobProperties'
        description: The job specific properties.
    description: Data Lake Analytics Job Parameters base class for build and submit.
  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.
      degreeOfParallelismPercent:
        type: number
        format: double
        readOnly: true
        description: the degree of parallelism in percentage used for this job.
      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
        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
        - Yielded
        - Finalizing
        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://<accountName>.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.)
      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.
    description: The common Data Lake Analytics job information properties.
  JobRelationshipProperties:
    required:
    - recurrenceId
    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.
    description: Job relationship information properties including pipeline information, correlation information, etc.
  JobErrorDetails:
    properties:
      errorId:
        readOnly: true
        type: string
        description: The specific identifier for the type of error encountered in the job.
      severity:
        readOnly: true
        type: string
        enum:
        - Warning
        - Error
        - Info
        - SevereWarning
        - Deprecated
        - UserWarning
        x-ms-enum:
          name: SeverityTypes
          modelAsString: false
        description: The severity level of the failure.
      source:
        readOnly: true
        type: string
        description: The ultimate source of the failure (usually either SYSTEM or USER).
      message:
        readOnly: true
        type: string
        description: The user friendly error message for the failure.
      description:
        readOnly: true
        type: string
        description: The error message description.
      details:
        readOnly: true
        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 occurred.
      startOffset:
        readOnly: true
        type: integer
        format: int32
        description: The start offset in the job where the error was found
      endOffset:
        readOnly: true
        type: integer
        format: int32
        description: The end offset in the job where the error was found.
      resolution:
        readOnly: true
        type: string
        description: The recommended resolution for the failure, if any.
      filePath:
        readOnly: true
        type: string
        description: The path to any supplemental error files, if any.
      helpLink:
        readOnly: true
        type: string
        description: The link to MSDN or Azure help for this type of error, if any.
      internalDiagnostics:
        readOnly: true
        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:
        readOnly: true
        $ref: '#/definitions/JobInnerError'
        description: The inner error of this specific job error message, if any.
    description: The Data Lake Analytics job error details.
  UpdateJobParameters:
    properties:
      degreeOfParallelism:
        type: integer
        format: int32
        description: The degree of parallelism used for this job.
      degreeOfParallelismPercent:
        type: number
        format: double
        description: the degree of parallelism in percentage used for this job.
      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.
      tags:
        type: object
        additionalProperties:
          type: string
        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.)
  JobStateAuditRecord:
    properties:
      newState:
        readOnly: true
        type: string
        description: The new state the job is in.
      timeStamp:
        readOnly: true
        type: string
        format: date-time
        description: The time stamp that the state change took place.
      requestedByUser:
        readOnly: true
        type: string
        description: The user who requests the change.
      details:
        readOnly: true
        type: string
        description: The details of the audit log.
    description: The Data Lake Analytics job state audit records for tracking the lifecycle of a job.
  JobStatisticsVertex:
    properties:
      name:
        readOnly: true
        type: string
        description: The name of the vertex.
      vertexId:
        readOnly: true
        type: string
        format: uuid
        description: The id of the vertex.
      executionTime:
        readOnly: true
        type: string
        format: duration
        description: The amount of execution time of the vertex.
      dataRead:
        readOnly: true
        type: integer
        format: int64
        description: The amount of data read of the vertex, in bytes.
      peakMemUsage:
        readOnly: true
        type: integer
        format: int64
        description: The amount of peak memory usage of the vertex, in bytes.
    description: The detailed information for a vertex.
  JobInnerError:
    properties:
      errorId:
        readOnly: true
        type: string
        description: The specific identifier for the type of error encountered in the job.
      severity:
        readOnly: true
        type: string
        enum:
        - Warning
        - Error
        - Info
        - SevereWarning
        - Deprecated
        - UserWarning
        x-ms-enum:
          name: SeverityTypes
          modelAsString: false
        description: The severity level of the failure.
      source:
        readOnly: true
        type: string
        description: The ultimate source of the failure (usually either SYSTEM or USER).
      message:
        readOnly: true
        type: string
        description: The user friendly error message for the failure.
      description:
        readOnly: true
        type: string
        description: The error message description.
      details:
        readOnly: true
        type: string
        description: The details of the error message.
      diagnosticCode:
        readOnly: true
        type: integer
        format: int32
        description: The diagnostic error code.
      component:
        readOnly: true
        type: string
        description: The component that failed.
      resolution:
        readOnly: true
        type: string
        description: The recommended resolution for the failure, if any.
      helpLink:
        readOnly: true
        type: string
        description: The link to MSDN or Azure help for this type of error, if any.
      internalDiagnostics:
        readOnly: true
        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:
        readOnly: true
        $ref: '#/definitions/JobInnerError'
        description: The inner error of this specific job error message, if any.
    description: The Data Lake Analytics job error details.
  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.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  requestedByParameter:
    name: X-Requested-By
    x-ms-parameter-location: method
    x-ms-client-name: requestedBy
    description: Add default value for X-Requested-By in header.
    in: header
    required: false
    default: ambari
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'