Конвейер

Для взаимодействия с конвейером определен объект pipelineService

Сущность конвейер содержит в себе следующие данные:

class Pipeline {...}

Название	Тип данных	Описание
id	string	UUID конвейера
status	string	Статус конвейера. Возможные значения: CREATED, PENDING, RUNNING, SUCCESS, FAILED, CANCELED, SKIPPED, MANUAL, SCHEDULED, PREPARING, WAITING_FOR_RESOURCE
duration	number	Время выполнения конвейера в миллисекундах
projectId	string	UUID проекта, в котором создан конвейер
userId	string	UUID пользователя, запустившего конвейер
localId	number	Локальный номер конвейера
mergeRequestId	string	UUID связанного запроса на слияние
commitId	string	Хеш коммита, на котором создан конвейер
beforeCommitId	string	Хеш предыдущего коммита
sourceCommitId	string	Хеш исходного коммита
ref	string	git-ссылка на тег или ветку
isTag	boolean	Конвейер создан из тега true или нет false
yamlErrors	string	Ошибки в файле конфигурации
source	string	Источник запуска. Возможные значения: PUSH, TRIGGER, SCHEDULE, WEB, API, PARENTT_PIPELINE, MERGE_REQUEST_EVENT и SCRIPT
configSource	number	Числовое обозначение источника запуска
failureReason	string	Причина ошибки конвейера
startedAt	string	Время запуска конвейера
finishedAt	string	Время завершения конвейера
createdAt	string	Время создания конвейера
isMergedResults	boolean	Конвейер является результатом слияния true или нет false

Методы для работы с конвейерами

Для работы с сущностью конвейер существуют следующие методы:

Создание конвейера

pipelineService.create({projectId}, {ref}) => Pipeline

Метод создает конвейер по стандартной ветке проекта и возвращает его. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
projectId	string	UUID проекта, в котором будет создан конвейер
ref	string	git-ссылка на тег или ветку

Создание пустого конвейера

Данный конвейер невозможно запустить в GitFlic

pipelineService.createBlank({projectId}, {ref}) => Pipeline

Метод создает пустой конвейер и возвращает его. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
projectId	string	UUID проекта, в котором будет создан конвейер
ref	string	git-ссылка на тег или ветку

Получение списка всех конвейеров

pipelineService.findAllByProject({projectId}, {startPage}, {pageSize}) => Page<Pipeline>

Метод возвращает объект со всеми конвейерами проекта. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
projectId	string	UUID проекта, в котором будет осуществлен поиск
startPage	number	Номер запрашиваемой страницы
pageSize	number	Размер страницы

Получение списка конвейеров по ветке или тегу

pipelineService.findByProjectIdAndRef({projectId}, {ref}, {startPage}, {pageSize}) => Page<Pipeline>

Метод возвращает объект с конвейерами, которые были созданы по указанной ветке или тегу. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
projectId	string	UUID проекта, в котором будет осуществлен поиск
ref	string	git-ссылка на тег или ветку
startPage	number	Номер запрашиваемой страницы
pageSize	number	Размер страницы

Получение конвейера по локальному номеру

pipelineService.findByLocalId({projectId}, {localId}) => Pipeline

Метод возвращает конвейер с указанным номером в проекте. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
projectId	string	UUID проекта, в котором будет осуществлен поиск
localId	number	Локальный номер конвейера

Получение конвейера по UUID

pipelineService.findById({pipelineId}) => Pipeline

Метод возвращает конвейер с указанным UUID. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
pipelineId	string	UUID конвейера

Получение списка конвейеров в запросе на слияние

pipelineService.findByMergeRequestId({mergeRequestId}, {startPage}, {pageSize}) => Page<Pipeline>

Метод возвращает объект со всеми конвейерами, связанными с указанным запросом на слияние. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
mergeRequestId	string	UUID запроса на слияние
startPage	number	Номер запрашиваемой страницы
pageSize	number	Размер страницы

Перезапуск конвейера

pipelineService.restart({pipelineId}) => void

Метод перезапускает указанный конвейер. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
pipelineId	string	UUID конвейера

Отмена конвейера

pipelineService.cancelPipeline({pipelineId}) => void

Метод отменяет указанный конвейер. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
pipelineId	string	UUID конвейера

Изменение статуса конвейера

pipelineService.changeStatus({pipelineId}, {status}) => void

Метод изменяет статус указанного конвейера. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
pipelineId	string	UUID конвейера
status	string	Статус конвейера. Возможные значения: CREATED, PENDING, RUNNING, SUCCESS, FAILED, CANCELED, SKIPPED, MANUAL, SCHEDULED, PREPARING, WAITING_FOR_RESOURCE

Обновление времени начала выполнения конвейера

pipelineService.setStartTime({pipelineId}, {startTimeMillis}) => void

Метод изменяет время начала выполнения указанного конвейера. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
pipelineId	string	UUID конвейера
startTimeMillis	number	UnixTime до тысячных долей секунды

Обновление времени окончания выполнения конвейера

pipelineService.setFinishTime({pipelineId}, {finishTimeMillis}) => void

Метод изменяет время окончания выполнения указанного конвейера. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
pipelineId	string	UUID конвейера
finishTimeMillis	number	UnixTime до тысячных долей секунды

Изменение времени выполнения конвейера

pipelineService.setExecutionTime({pipelineId}, {duration}) => void

Метод изменяет время выполнения указанного конвейера. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
pipelineId	string	UUID конвейера
duration	number	Время выполнения в миллисекундах

Создание стадии

pipelineService.createStage({pipelineId}, {name}, {status}) => Stage

Метод создает новую пустую стадию в конвейера и возвращает ее. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
pipelineId	string	UUID конвейера
name	string	Название стадии
status	string	Статус конвейера. Возможные значения: CREATED, PENDING, RUNNING, SUCCESS, FAILED, CANCELED, SKIPPED, MANUAL, SCHEDULED, PREPARING, WAITING_FOR_RESOURCE

Изменение статуса стадии

pipelineService.changeStageStatus({stageId}, {status}) => Stage

Метод изменяет статус стадии в конвейере и возвращает ее. Необходимо передать следующие значения в методе

Название	Тип данных	Описание
stageId	string	UUID стадии
status	string	Статус конвейера. Возможные значения: CREATED, PENDING, RUNNING, SUCCESS, FAILED, CANCELED, SKIPPED, MANUAL, SCHEDULED, PREPARING, WAITING_FOR_RESOURCE