GitPullRequest interface

Pakiet:

azure-devops-extension-api

Reprezentuje wszystkie dane skojarzone z żądaniem ściągnięcia.

Właściwości

artifactId	Ciąg znaków, który jednoznacznie identyfikuje to żądanie ściągnięcia. Aby wygenerować identyfikator artefaktu dla żądania ściągnięcia, użyj tego szablonu: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy	Jeśli ta wartość jest ustawiona, autouzupełnianie jest włączone dla tego żądania ściągnięcia i jest to tożsamość, która je umożliwiła.
closedBy	Użytkownik, który zamknął żądanie ściągnięcia.
closedDate	Data zamknięcia żądania ściągnięcia (ukończenia, porzucenia lub scalenia zewnętrznego).
codeReviewId	Identyfikator przeglądu kodu żądania ściągnięcia. Używany wewnętrznie.
commits	Zatwierdzenia zawarte w żądaniu ściągnięcia.
completionOptions	Opcje, które wpływają na sposób scalania żądania ściągnięcia po jego zakończeniu.
completionQueueTime	Ostatnia data, w której żądanie ściągnięcia zostało wprowadzone do kolejki do ukończenia. Używany wewnętrznie.
createdBy	Tożsamość użytkownika, który utworzył żądanie ściągnięcia.
creationDate	Data utworzenia żądania ściągnięcia.
description	Opis żądania ściągnięcia.
forkSource	Jeśli jest to żądanie ściągnięcia z rozwidlenia, będzie ono zawierało informacje o jego źródle.
hasMultipleMergeBases	Ostrzeżenie o wielu bazach scalania
ignoreTargetRefAndChooseDynamically	Ten opcjonalny parametr umożliwia klientom korzystanie z opcji dynamicznych po stronie serwera dla referencji docelowej. Ze względu na istniejące wcześniej kontrakty, użytkownicy muszą określić referencję docelową, ale ta opcja spowoduje, że serwer zignoruje ją i wybierze dynamicznie z ulubionych (lub gałęzi domyślnej) użytkownika.
isDraft	Żądanie ściągnięcia wersji roboczej / PWT.
labels	Etykiety skojarzone z żądaniem ściągnięcia.
lastMergeCommit	Zatwierdzenie najnowszego scalania żądania ściągnięcia. Jeśli to pole jest puste, oznacza to, że ostatnie scalanie jest w toku lub zakończyło się niepowodzeniem.
lastMergeSourceCommit	Zatwierdzenie na początku gałęzi źródłowej w momencie ostatniego scalania żądania ściągnięcia.
lastMergeTargetCommit	Zatwierdzenie w czołówce gałęzi docelowej w momencie ostatniego scalania żądania ściągnięcia.
mergeFailureMessage	Jeśli ta opcja jest ustawiona, scalanie żądania ściągnięcia nie powiodło się z tego powodu.
mergeFailureType	Typ niepowodzenia (jeśli występuje) scalania żądania ściągnięcia.
mergeId	Identyfikator zadania użytego do uruchomienia scalania żądania ściągnięcia. Używany wewnętrznie.
mergeOptions	Opcje używane podczas scalania żądania ściągnięcia. Są one niezależne od opcji ukończenia, ponieważ ukończenie odbywa się tylko raz, a nowe scalanie będzie uruchamiane za każdym razem, gdy zmieni się gałąź źródłowa żądania ściągnięcia.
mergeStatus	Bieżący stan scalania żądania ściągnięcia.
pullRequestId	Identyfikator żądania ściągnięcia.
remoteUrl	Używany wewnętrznie.
repository	Repozytorium zawierające gałąź docelową żądania ściągnięcia.
reviewers	Lista recenzentów w żądaniu ściągnięcia wraz ze stanem ich głosów.
sourceRefName	Nazwa gałęzi źródłowej żądania ściągnięcia.
status	Stan żądania ściągnięcia.
supportsIterations	Jeśli ma wartość true, to żądanie ściągnięcia obsługuje wiele iteracji. Obsługa iteracji oznacza, że poszczególne wypchnięcia do gałęzi źródłowej żądania ściągnięcia mogą być przeglądane, a komentarze pozostawione w jednej iteracji będą śledzone w przyszłych iteracjach.
targetRefName	Nazwa gałęzi docelowej żądania ściągnięcia.
title	Tytuł żądania ściągnięcia.
url	Używany wewnętrznie.
workItemRefs	Wszystkie odwołania do elementów roboczych skojarzone z tym żądaniem ściągnięcia.

Szczegóły właściwości

artifactId

Ciąg znaków, który jednoznacznie identyfikuje to żądanie ściągnięcia. Aby wygenerować identyfikator artefaktu dla żądania ściągnięcia, użyj tego szablonu: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

artifactId: string

Wartość właściwości

string

autoCompleteSetBy

Jeśli ta wartość jest ustawiona, autouzupełnianie jest włączone dla tego żądania ściągnięcia i jest to tożsamość, która je umożliwiła.

autoCompleteSetBy: IdentityRef

Wartość właściwości

IdentityRef

closedBy

Użytkownik, który zamknął żądanie ściągnięcia.

closedBy: IdentityRef

Wartość właściwości

IdentityRef

closedDate

Data zamknięcia żądania ściągnięcia (ukończenia, porzucenia lub scalenia zewnętrznego).

closedDate: Date

Wartość właściwości

Date

codeReviewId

Identyfikator przeglądu kodu żądania ściągnięcia. Używany wewnętrznie.

codeReviewId: number

Wartość właściwości

number

commits

Zatwierdzenia zawarte w żądaniu ściągnięcia.

commits: GitCommitRef[]

Wartość właściwości

GitCommitRef[]

completionOptions

Opcje, które wpływają na sposób scalania żądania ściągnięcia po jego zakończeniu.

completionOptions: GitPullRequestCompletionOptions

Wartość właściwości

GitPullRequestCompletionOptions

completionQueueTime

Ostatnia data, w której żądanie ściągnięcia zostało wprowadzone do kolejki do ukończenia. Używany wewnętrznie.

completionQueueTime: Date

Wartość właściwości

Date

createdBy

Tożsamość użytkownika, który utworzył żądanie ściągnięcia.

createdBy: IdentityRef

Wartość właściwości

IdentityRef

creationDate

Data utworzenia żądania ściągnięcia.

creationDate: Date

Wartość właściwości

Date

description

Opis żądania ściągnięcia.

description: string

Wartość właściwości

string

forkSource

Jeśli jest to żądanie ściągnięcia z rozwidlenia, będzie ono zawierało informacje o jego źródle.

forkSource: GitForkRef

Wartość właściwości

GitForkRef

hasMultipleMergeBases

Ostrzeżenie o wielu bazach scalania

hasMultipleMergeBases: boolean

Wartość właściwości

boolean

ignoreTargetRefAndChooseDynamically

Ten opcjonalny parametr umożliwia klientom korzystanie z opcji dynamicznych po stronie serwera dla referencji docelowej. Ze względu na istniejące wcześniej kontrakty, użytkownicy muszą określić referencję docelową, ale ta opcja spowoduje, że serwer zignoruje ją i wybierze dynamicznie z ulubionych (lub gałęzi domyślnej) użytkownika.

ignoreTargetRefAndChooseDynamically: boolean

Wartość właściwości

boolean

isDraft

Żądanie ściągnięcia wersji roboczej / PWT.

isDraft: boolean

Wartość właściwości

boolean

labels

Etykiety skojarzone z żądaniem ściągnięcia.

labels: WebApiTagDefinition[]

Wartość właściwości

WebApiTagDefinition[]

lastMergeCommit

Zatwierdzenie najnowszego scalania żądania ściągnięcia. Jeśli to pole jest puste, oznacza to, że ostatnie scalanie jest w toku lub zakończyło się niepowodzeniem.

lastMergeCommit: GitCommitRef

Wartość właściwości

GitCommitRef

lastMergeSourceCommit

Zatwierdzenie na początku gałęzi źródłowej w momencie ostatniego scalania żądania ściągnięcia.

lastMergeSourceCommit: GitCommitRef

Wartość właściwości

GitCommitRef

lastMergeTargetCommit

Zatwierdzenie w czołówce gałęzi docelowej w momencie ostatniego scalania żądania ściągnięcia.

lastMergeTargetCommit: GitCommitRef

Wartość właściwości

GitCommitRef

mergeFailureMessage

Jeśli ta opcja jest ustawiona, scalanie żądania ściągnięcia nie powiodło się z tego powodu.

mergeFailureMessage: string

Wartość właściwości

string

mergeFailureType

Typ niepowodzenia (jeśli występuje) scalania żądania ściągnięcia.

mergeFailureType: PullRequestMergeFailureType

Wartość właściwości

PullRequestMergeFailureType

mergeId

Identyfikator zadania użytego do uruchomienia scalania żądania ściągnięcia. Używany wewnętrznie.

mergeId: string

Wartość właściwości

string

mergeOptions

Opcje używane podczas scalania żądania ściągnięcia. Są one niezależne od opcji ukończenia, ponieważ ukończenie odbywa się tylko raz, a nowe scalanie będzie uruchamiane za każdym razem, gdy zmieni się gałąź źródłowa żądania ściągnięcia.

mergeOptions: GitPullRequestMergeOptions

Wartość właściwości

GitPullRequestMergeOptions

mergeStatus

Bieżący stan scalania żądania ściągnięcia.

mergeStatus: PullRequestAsyncStatus

Wartość właściwości

PullRequestAsyncStatus

pullRequestId

Identyfikator żądania ściągnięcia.

pullRequestId: number

Wartość właściwości

number

remoteUrl

Używany wewnętrznie.

remoteUrl: string

Wartość właściwości

string

repository

Repozytorium zawierające gałąź docelową żądania ściągnięcia.

repository: GitRepository

Wartość właściwości

GitRepository

reviewers

Lista recenzentów w żądaniu ściągnięcia wraz ze stanem ich głosów.

reviewers: IdentityRefWithVote[]

Wartość właściwości

IdentityRefWithVote[]

sourceRefName

Nazwa gałęzi źródłowej żądania ściągnięcia.

sourceRefName: string

Wartość właściwości

string

status

Stan żądania ściągnięcia.

status: PullRequestStatus

Wartość właściwości

PullRequestStatus

supportsIterations

Jeśli ma wartość true, to żądanie ściągnięcia obsługuje wiele iteracji. Obsługa iteracji oznacza, że poszczególne wypchnięcia do gałęzi źródłowej żądania ściągnięcia mogą być przeglądane, a komentarze pozostawione w jednej iteracji będą śledzone w przyszłych iteracjach.

supportsIterations: boolean

Wartość właściwości

boolean

targetRefName

Nazwa gałęzi docelowej żądania ściągnięcia.

targetRefName: string

Wartość właściwości

string

title

Tytuł żądania ściągnięcia.

title: string

Wartość właściwości

string

url

Używany wewnętrznie.

url: string

Wartość właściwości

string

workItemRefs

Wszystkie odwołania do elementów roboczych skojarzone z tym żądaniem ściągnięcia.

workItemRefs: ResourceRef[]

Wartość właściwości

ResourceRef[]