PipelinesRestClient class
Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's
- Extends
Constructors
| Pipelines |
Methoden
| create |
Maak een pijplijn. |
| get |
Een specifiek artefact ophalen uit een pijplijnuitvoering |
| get |
Een specifiek logboek ophalen uit een pijplijnuitvoering |
| get |
Haalt een pijplijn op, optioneel op de opgegeven versie |
| get |
Hiermee wordt een uitvoering voor een bepaalde pijplijn uitgevoerd. |
| list |
Een lijst met logboeken ophalen van een pijplijnuitvoering. |
| list |
Een lijst met pijplijnen ophalen. |
| list |
Hiermee worden de top 10000 uitvoeringen voor een bepaalde pijplijn weergegeven. |
| preview(Run |
Hiermee wordt een droge uitvoering van de pijplijn in de wachtrij geplaatst en wordt een object geretourneerd dat de uiteindelijke yaml bevat. |
| run |
Voert een pijplijn uit. |
Constructordetails
PipelinesRestClient(IVssRestClientOptions)
Methodedetails
createPipeline(CreatePipelineParameters, string)
Maak een pijplijn.
function createPipeline(inputParameters: CreatePipelineParameters, project: string): Promise<Pipeline>Parameters
- inputParameters
- CreatePipelineParameters
Invoerparameters.
- project
-
string
Project-id of projectnaam
Retouren
Promise<Pipeline>
getArtifact(string, number, number, string, GetArtifactExpandOptions)
Een specifiek artefact ophalen uit een pijplijnuitvoering
function getArtifact(project: string, pipelineId: number, runId: number, artifactName: string, expand?: GetArtifactExpandOptions): Promise<Artifact>Parameters
- project
-
string
Project-id of projectnaam
- pipelineId
-
number
Id van de pijplijn.
- runId
-
number
Id van de uitvoering van die pijplijn.
- artifactName
-
string
Naam van het artefact.
- expand
- GetArtifactExpandOptions
Opties uitvouwen. De standaardwaarde is Geen.
Retouren
Promise<Artifact>
getLog(string, number, number, number, GetLogExpandOptions)
Een specifiek logboek ophalen uit een pijplijnuitvoering
function getLog(project: string, pipelineId: number, runId: number, logId: number, expand?: GetLogExpandOptions): Promise<Log>Parameters
- project
-
string
Project-id of projectnaam
- pipelineId
-
number
Id van de pijplijn.
- runId
-
number
Id van de uitvoering van die pijplijn.
- logId
-
number
Id van het logboek.
- expand
- GetLogExpandOptions
Opties uitvouwen. De standaardwaarde is Geen.
Retouren
Promise<Log>
getPipeline(string, number, number)
Haalt een pijplijn op, optioneel op de opgegeven versie
function getPipeline(project: string, pipelineId: number, pipelineVersion?: number): Promise<Pipeline>Parameters
- project
-
string
Project-id of projectnaam
- pipelineId
-
number
De pijplijn-id
- pipelineVersion
-
number
De pijplijnversie
Retouren
Promise<Pipeline>
getRun(string, number, number)
Hiermee wordt een uitvoering voor een bepaalde pijplijn uitgevoerd.
function getRun(project: string, pipelineId: number, runId: number): Promise<Run>Parameters
- project
-
string
Project-id of projectnaam
- pipelineId
-
number
De pijplijn-id
- runId
-
number
De uitvoerings-id
Retouren
Promise<Run>
listLogs(string, number, number, GetLogExpandOptions)
Een lijst met logboeken ophalen van een pijplijnuitvoering.
function listLogs(project: string, pipelineId: number, runId: number, expand?: GetLogExpandOptions): Promise<LogCollection>Parameters
- project
-
string
Project-id of projectnaam
- pipelineId
-
number
Id van de pijplijn.
- runId
-
number
Id van de uitvoering van die pijplijn.
- expand
- GetLogExpandOptions
Opties uitvouwen. De standaardwaarde is Geen.
Retouren
Promise<LogCollection>
listPipelines(string, string, number, string)
Een lijst met pijplijnen ophalen.
function listPipelines(project: string, orderBy?: string, top?: number, continuationToken?: string): Promise<Pipeline[]>Parameters
- project
-
string
Project-id of projectnaam
- orderBy
-
string
Een sorteerexpressie. Standaard ingesteld op 'name asc'
- top
-
number
Het maximum aantal pijplijnen dat moet worden geretourneerd
- continuationToken
-
string
Een vervolgtoken van een eerdere aanvraag om de volgende pagina met resultaten op te halen
Retouren
Promise<Pipeline[]>
listRuns(string, number)
Hiermee worden de top 10000 uitvoeringen voor een bepaalde pijplijn weergegeven.
function listRuns(project: string, pipelineId: number): Promise<Run[]>Parameters
- project
-
string
Project-id of projectnaam
- pipelineId
-
number
De pijplijn-id
Retouren
Promise<Run[]>
preview(RunPipelineParameters, string, number, number)
Hiermee wordt een droge uitvoering van de pijplijn in de wachtrij geplaatst en wordt een object geretourneerd dat de uiteindelijke yaml bevat.
function preview(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<PreviewRun>Parameters
- runParameters
- RunPipelineParameters
Optionele aanvullende parameters voor deze uitvoering.
- project
-
string
Project-id of projectnaam
- pipelineId
-
number
De pijplijn-id.
- pipelineVersion
-
number
De pijplijnversie.
Retouren
Promise<PreviewRun>
runPipeline(RunPipelineParameters, string, number, number)
Voert een pijplijn uit.
function runPipeline(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<Run>Parameters
- runParameters
- RunPipelineParameters
Optionele aanvullende parameters voor deze uitvoering.
- project
-
string
Project-id of projectnaam
- pipelineId
-
number
De pijplijn-id.
- pipelineVersion
-
number
De pijplijnversie.
Retouren
Promise<Run>