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

Provides API endpoints related to pipeline

Summary

Types

Link to this type

get_pipeline_by_id_default_json_resp()

View Source
@type get_pipeline_by_id_default_json_resp() :: %{message: String.t() | nil}
Link to this type

get_pipeline_by_number_default_json_resp()

View Source
@type get_pipeline_by_number_default_json_resp() :: %{message: String.t() | nil}
@type t() :: %CircleCI.Pipeline{
  created_at: DateTime.t(),
  errors: [CircleCI.PipelineErrors.t()],
  id: String.t(),
  number: integer(),
  project_slug: String.t(),
  state: String.t(),
  trigger: CircleCI.PipelineTrigger.t(),
  trigger_parameters: CircleCI.PipelineTriggerParameters.t() | nil,
  updated_at: DateTime.t() | nil,
  vcs: CircleCI.PipelineVcs.t() | nil
}

Functions

Link to this function

get_pipeline_by_id(pipeline_id, opts \\ [])

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

Get a pipeline by ID

Returns a pipeline by the pipeline ID.

Link to this function

get_pipeline_by_number(project_slug, pipeline_number, opts \\ [])

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

Get a pipeline by pipeline number

Returns a pipeline by the pipeline number.