GitPullRequest interface

Paket:

azure-devops-extension-api

Stellt alle Daten dar, die einer Pullanforderung zugeordnet sind.

Eigenschaften

artifactId	Eine Zeichenfolge, die diese Pullanforderung eindeutig identifiziert. Um eine Artefakt-ID für eine Pullanforderung zu generieren, verwenden Sie diese Vorlage: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy	Wenn diese Einstellung festgelegt ist, ist autovervollständigen für diese Pullanforderung aktiviert, und dies ist die Identität, die sie aktiviert hat.
closedBy	Der Benutzer, der die Pullanforderung geschlossen hat.
closedDate	Das Datum, an dem die Pullanforderung geschlossen wurde (abgeschlossen, abgebrochen oder extern zusammengeführt).
codeReviewId	Die Codeüberprüfungs-ID der Pullanforderung. Intern verwendet.
commits	Die in der Pullanforderung enthaltenen Commits.
completionOptions	Optionen, die sich darauf auswirken, wie die Pullanforderung zusammengeführt wird, wenn sie abgeschlossen ist.
completionQueueTime	Das letzte Datum, an dem die Pullanforderung die Warteschlange eingegeben hat, die abgeschlossen werden soll. Intern verwendet.
createdBy	Die Identität des Benutzers, der die Pullanforderung erstellt hat.
creationDate	Das Datum, an dem die Pullanforderung erstellt wurde.
description	Die Beschreibung der Pullanforderung.
forkSource	Wenn es sich um eine PR aus einer Verzweigung handelt, enthält dies Informationen über seine Quelle.
hasMultipleMergeBases	Warnung für mehrere Mergebases
ignoreTargetRefAndChooseDynamically	Mit diesem optionalen Parameter können Clients serverseitige dynamische Auswahlmöglichkeiten für den Zielverweisen verwenden. Aufgrund vorhandener Verträge müssen Benutzer einen Zielverweisen angeben. Diese Option bewirkt jedoch, dass der Server sie ignoriert und dynamisch aus den Favoriten des Benutzers (oder der Standardverzweigung) ausgewählt wird.
isDraft	Entwurf/WIP-Pullanforderung.
labels	Die Bezeichnungen, die der Pullanforderung zugeordnet sind.
lastMergeCommit	Der Commit des letzten Pullanforderungszusammenführungsvorgangs. Wenn leer, wird die letzte Zusammenführung ausgeführt oder war nicht erfolgreich.
lastMergeSourceCommit	Der Commit am Anfang der Quell-Verzweigung zum Zeitpunkt des letzten Zusammenführens der Pullanforderung.
lastMergeTargetCommit	Der Commit an der Kopfzeile der Ziel-Verzweigung zum Zeitpunkt des letzten Zusammenführens der Pullanforderung.
mergeFailureMessage	Bei Festlegung ist der Zusammenführungsvorgang der Pullanforderung aus diesem Grund fehlgeschlagen.
mergeFailureType	Der Typ des Fehlers (falls vorhanden) des Zusammenführens der Pullanforderung.
mergeId	Die ID des Auftrags, der zum Ausführen des Seriendrucks der Pullanforderung verwendet wird. Intern verwendet.
mergeOptions	Optionen, die verwendet werden, wenn der Seriendruck der Pullanforderung ausgeführt wird. Diese unterscheiden sich von den Abschlussoptionen, da der Abschluss nur einmal erfolgt und bei jeder Änderung des Quellzweigs der Pullanforderung ein neuer Seriendruck ausgeführt wird.
mergeStatus	Der aktuelle Status des Pullanforderungszusammenführungsvorgangs.
pullRequestId	Die ID der Pullanforderung.
remoteUrl	Intern verwendet.
repository	Das Repository, das den Zielzweig der Pullanforderung enthält.
reviewers	Eine Liste der Prüfer auf dem Pull-Antrag zusammen mit dem Status ihrer Stimmen.
sourceRefName	Der Name des Quellzweigs der Pullanforderung.
status	Der Status der Pullanforderung.
supportsIterations	Wenn dies der Fall ist, unterstützt diese Pullanforderung mehrere Iterationen. Iterationsunterstützung bedeutet, dass einzelne Pushs an den Quellzweig der Pullanforderung überprüft werden können und Kommentare in einer Iteration in zukünftigen Iterationen nachverfolgt werden.
targetRefName	Der Name des Zielzweigs der Pullanforderung.
title	Der Titel der Pullanforderung.
url	Intern verwendet.
workItemRefs	Alle Arbeitsaufgabenverweise, die dieser Pullanforderung zugeordnet sind.

Details zur Eigenschaft

artifactId

Eine Zeichenfolge, die diese Pullanforderung eindeutig identifiziert. Um eine Artefakt-ID für eine Pullanforderung zu generieren, verwenden Sie diese Vorlage: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

artifactId: string

Eigenschaftswert

string

autoCompleteSetBy

Wenn diese Einstellung festgelegt ist, ist autovervollständigen für diese Pullanforderung aktiviert, und dies ist die Identität, die sie aktiviert hat.

autoCompleteSetBy: IdentityRef

Eigenschaftswert

IdentityRef

closedBy

Der Benutzer, der die Pullanforderung geschlossen hat.

closedBy: IdentityRef

Eigenschaftswert

IdentityRef

closedDate

Das Datum, an dem die Pullanforderung geschlossen wurde (abgeschlossen, abgebrochen oder extern zusammengeführt).

closedDate: Date

Eigenschaftswert

Date

codeReviewId

Die Codeüberprüfungs-ID der Pullanforderung. Intern verwendet.

codeReviewId: number

Eigenschaftswert

number

commits

Die in der Pullanforderung enthaltenen Commits.

commits: GitCommitRef[]

Eigenschaftswert

GitCommitRef[]

completionOptions

Optionen, die sich darauf auswirken, wie die Pullanforderung zusammengeführt wird, wenn sie abgeschlossen ist.

completionOptions: GitPullRequestCompletionOptions

Eigenschaftswert

GitPullRequestCompletionOptions

completionQueueTime

Das letzte Datum, an dem die Pullanforderung die Warteschlange eingegeben hat, die abgeschlossen werden soll. Intern verwendet.

completionQueueTime: Date

Eigenschaftswert

Date

createdBy

Die Identität des Benutzers, der die Pullanforderung erstellt hat.

createdBy: IdentityRef

Eigenschaftswert

IdentityRef

creationDate

Das Datum, an dem die Pullanforderung erstellt wurde.

creationDate: Date

Eigenschaftswert

Date

description

Die Beschreibung der Pullanforderung.

description: string

Eigenschaftswert

string

forkSource

Wenn es sich um eine PR aus einer Verzweigung handelt, enthält dies Informationen über seine Quelle.

forkSource: GitForkRef

Eigenschaftswert

GitForkRef

hasMultipleMergeBases

Warnung für mehrere Mergebases

hasMultipleMergeBases: boolean

Eigenschaftswert

boolean

ignoreTargetRefAndChooseDynamically

Mit diesem optionalen Parameter können Clients serverseitige dynamische Auswahlmöglichkeiten für den Zielverweisen verwenden. Aufgrund vorhandener Verträge müssen Benutzer einen Zielverweisen angeben. Diese Option bewirkt jedoch, dass der Server sie ignoriert und dynamisch aus den Favoriten des Benutzers (oder der Standardverzweigung) ausgewählt wird.

ignoreTargetRefAndChooseDynamically: boolean

Eigenschaftswert

boolean

isDraft

Entwurf/WIP-Pullanforderung.

isDraft: boolean

Eigenschaftswert

boolean

labels

Die Bezeichnungen, die der Pullanforderung zugeordnet sind.

labels: WebApiTagDefinition[]

Eigenschaftswert

WebApiTagDefinition[]

lastMergeCommit

Der Commit des letzten Pullanforderungszusammenführungsvorgangs. Wenn leer, wird die letzte Zusammenführung ausgeführt oder war nicht erfolgreich.

lastMergeCommit: GitCommitRef

Eigenschaftswert

GitCommitRef

lastMergeSourceCommit

Der Commit am Anfang der Quell-Verzweigung zum Zeitpunkt des letzten Zusammenführens der Pullanforderung.

lastMergeSourceCommit: GitCommitRef

Eigenschaftswert

GitCommitRef

lastMergeTargetCommit

Der Commit an der Kopfzeile der Ziel-Verzweigung zum Zeitpunkt des letzten Zusammenführens der Pullanforderung.

lastMergeTargetCommit: GitCommitRef

Eigenschaftswert

GitCommitRef

mergeFailureMessage

Bei Festlegung ist der Zusammenführungsvorgang der Pullanforderung aus diesem Grund fehlgeschlagen.

mergeFailureMessage: string

Eigenschaftswert

string

mergeFailureType

Der Typ des Fehlers (falls vorhanden) des Zusammenführens der Pullanforderung.

mergeFailureType: PullRequestMergeFailureType

Eigenschaftswert

PullRequestMergeFailureType

mergeId

Die ID des Auftrags, der zum Ausführen des Seriendrucks der Pullanforderung verwendet wird. Intern verwendet.

mergeId: string

Eigenschaftswert

string

mergeOptions

Optionen, die verwendet werden, wenn der Seriendruck der Pullanforderung ausgeführt wird. Diese unterscheiden sich von den Abschlussoptionen, da der Abschluss nur einmal erfolgt und bei jeder Änderung des Quellzweigs der Pullanforderung ein neuer Seriendruck ausgeführt wird.

mergeOptions: GitPullRequestMergeOptions

Eigenschaftswert

GitPullRequestMergeOptions

mergeStatus

Der aktuelle Status des Pullanforderungszusammenführungsvorgangs.

mergeStatus: PullRequestAsyncStatus

Eigenschaftswert

PullRequestAsyncStatus

pullRequestId

Die ID der Pullanforderung.

pullRequestId: number

Eigenschaftswert

number

remoteUrl

Intern verwendet.

remoteUrl: string

Eigenschaftswert

string

repository

Das Repository, das den Zielzweig der Pullanforderung enthält.

repository: GitRepository

Eigenschaftswert

GitRepository

reviewers

Eine Liste der Prüfer auf dem Pull-Antrag zusammen mit dem Status ihrer Stimmen.

reviewers: IdentityRefWithVote[]

Eigenschaftswert

IdentityRefWithVote[]

sourceRefName

Der Name des Quellzweigs der Pullanforderung.

sourceRefName: string

Eigenschaftswert

string

status

Der Status der Pullanforderung.

status: PullRequestStatus

Eigenschaftswert

PullRequestStatus

supportsIterations

Wenn dies der Fall ist, unterstützt diese Pullanforderung mehrere Iterationen. Iterationsunterstützung bedeutet, dass einzelne Pushs an den Quellzweig der Pullanforderung überprüft werden können und Kommentare in einer Iteration in zukünftigen Iterationen nachverfolgt werden.

supportsIterations: boolean

Eigenschaftswert

boolean

targetRefName

Der Name des Zielzweigs der Pullanforderung.

targetRefName: string

Eigenschaftswert

string

title

Der Titel der Pullanforderung.

title: string

Eigenschaftswert

string

url

Intern verwendet.

url: string

Eigenschaftswert

string

workItemRefs

Alle Arbeitsaufgabenverweise, die dieser Pullanforderung zugeordnet sind.

workItemRefs: ResourceRef[]

Eigenschaftswert

ResourceRef[]