GitPullRequest interface

Pakiet:

azure-devops-extension-api

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

Właściwości

artifactId	Ciąg, 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	W przypadku ustawienia autouzupełnianie jest włączone dla tego żądania ściągnięcia i jest to tożsamość, która ją włączyła.
closedBy	Użytkownik, który zamknął żądanie ściągnięcia.
closedDate	Data zamknięcia żądania ściągnięcia (ukończona, porzucona lub scalona zewnętrznie).
codeReviewId	Identyfikator przeglądu kodu żądania ściągnięcia. Używane wewnętrznie.
commits	Zatwierdzenia zawarte w żądaniu ściągnięcia.
completionOptions	Opcje wpływające na sposób scalania żądania ściągnięcia po jego zakończeniu.
completionQueueTime	Ostatnia data zakończenia żądania ściągnięcia wprowadzona do kolejki. Używane 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 zawierać informacje o jego źródle.
hasMultipleMergeBases	Ostrzeżenie o wielu bazach scalania
isDraft	Żądanie ściągnięcia draft/WIP.
labels	Etykiety skojarzone z żądaniem ściągnięcia.
lastMergeCommit	Zatwierdzenie najnowszego scalania żądania ściągnięcia. Jeśli jest puste, najnowsze scalanie jest w toku lub zakończyło się niepowodzeniem.
lastMergeSourceCommit	Zatwierdzenie w nagłówku gałęzi źródłowej w momencie ostatniego scalania żądania ściągnięcia.
lastMergeTargetCommit	Zatwierdzenie w nagłówku gałęzi docelowej w momencie ostatniego scalania żądania ściągnięcia.
mergeFailureMessage	W przypadku ustawienia scalanie żądania ściągnięcia nie powiodło się z tego powodu.
mergeFailureType	Typ błędu (jeśli istnieje) scalania żądania ściągnięcia.
mergeId	Identyfikator zadania użytego do uruchomienia scalania żądania ściągnięcia. Używane wewnętrznie.
mergeOptions	Opcje używane podczas uruchamiania scalania żądania ściągnięcia. Są one oddzielone od opcji uzupełniania, ponieważ ukończenie odbywa się tylko raz, a nowe scalanie będzie uruchamiane za każdym razem, gdy zmienia 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żywane wewnętrznie.
repository	Repozytorium zawierające gałąź docelową żądania ściągnięcia.
reviewers	Lista recenzentów żądania ś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 to prawda, to żądanie ściągnięcia obsługuje wiele iteracji. Obsługa iteracji oznacza, że poszczególne wypychania do gałęzi źródłowej żądania ściągnięcia można przeglądać, a komentarze pozostawione w jednej iteracji będą śledzone w przyszłych iteracji.
targetRefName	Nazwa gałęzi docelowej żądania ściągnięcia.
title	Tytuł żądania ściągnięcia.
url	Używane 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, 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

W przypadku ustawienia autouzupełnianie jest włączone dla tego żądania ściągnięcia i jest to tożsamość, która ją włączył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ńczona, porzucona lub scalona zewnętrznie).

closedDate: Date

Wartość właściwości

Date

codeReviewId

Identyfikator przeglądu kodu żądania ściągnięcia. Używane 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 wpływające na sposób scalania żądania ściągnięcia po jego zakończeniu.

completionOptions: GitPullRequestCompletionOptions

Wartość właściwości

GitPullRequestCompletionOptions

completionQueueTime

Ostatnia data zakończenia żądania ściągnięcia wprowadzona do kolejki. Używane 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 zawierać 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

isDraft

Żądanie ściągnięcia draft/WIP.

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 jest puste, najnowsze scalanie jest w toku lub zakończyło się niepowodzeniem.

lastMergeCommit: GitCommitRef

Wartość właściwości

GitCommitRef

lastMergeSourceCommit

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

lastMergeSourceCommit: GitCommitRef

Wartość właściwości

GitCommitRef

lastMergeTargetCommit

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

lastMergeTargetCommit: GitCommitRef

Wartość właściwości

GitCommitRef

mergeFailureMessage

W przypadku ustawienia scalanie żądania ściągnięcia nie powiodło się z tego powodu.

mergeFailureMessage: string

Wartość właściwości

string

mergeFailureType

Typ błędu (jeśli istnieje) 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żywane wewnętrznie.

mergeId: string

Wartość właściwości

string

mergeOptions

Opcje używane podczas uruchamiania scalania żądania ściągnięcia. Są one oddzielone od opcji uzupełniania, ponieważ ukończenie odbywa się tylko raz, a nowe scalanie będzie uruchamiane za każdym razem, gdy zmienia 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żywane 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 żądania ś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 to prawda, to żądanie ściągnięcia obsługuje wiele iteracji. Obsługa iteracji oznacza, że poszczególne wypychania do gałęzi źródłowej żądania ściągnięcia można przeglądać, a komentarze pozostawione w jednej iteracji będą śledzone w przyszłych iteracji.

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żywane 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[]