View Source CircleCI.Job (CircleCI API Client v0.1.0)

Provides API endpoint related to job

Summary

Types

Link to this type

get_job_details_200_json_resp()

View Source
@type get_job_details_200_json_resp() :: %{
  contexts: [CircleCI.JobContexts.get_job_details_200_json_resp()],
  created_at: DateTime.t(),
  duration: integer(),
  executor: CircleCI.JobExecutor.get_job_details_200_json_resp(),
  latest_workflow: CircleCI.JobLatestWorkflow.get_job_details_200_json_resp(),
  messages: [CircleCI.JobMessages.get_job_details_200_json_resp()],
  name: String.t(),
  number: integer(),
  organization: CircleCI.JobOrganization.get_job_details_200_json_resp(),
  parallel_runs: [CircleCI.JobParallelRuns.get_job_details_200_json_resp()],
  parallelism: integer(),
  pipeline: CircleCI.JobPipeline.get_job_details_200_json_resp(),
  project: CircleCI.JobProject.get_job_details_200_json_resp(),
  queued_at: DateTime.t(),
  started_at: DateTime.t() | nil,
  status: String.t(),
  stopped_at: DateTime.t() | nil,
  web_url: String.t()
}
Link to this type

get_job_details_default_json_resp()

View Source
@type get_job_details_default_json_resp() :: %{message: String.t() | nil}
@type t() :: %CircleCI.Job{
  approval_request_id: String.t() | nil,
  approved_by: String.t() | nil,
  canceled_by: String.t() | nil,
  dependencies: [String.t()],
  id: String.t(),
  job_number: integer() | nil,
  name: String.t(),
  project_slug: String.t(),
  started_at: DateTime.t() | nil,
  status: String.t(),
  stopped_at: DateTime.t() | nil,
  type: String.t()
}

Functions

Link to this function

get_job_details(job_number, project_slug, opts \\ [])

View Source
@spec get_job_details(map(), String.t(), keyword()) :: {:ok, map()} | {:error, map()}

Get job details

Returns job details.