GitHttpClientBase.GetPushAsync Method

Definition

Namespace:: Microsoft.TeamFoundation.SourceControl.WebApi

Assembly:: Microsoft.TeamFoundation.SourceControl.WebApi.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

GetPushAsync(String, String, Int32, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieves a particular push.
GetPushAsync(String, Guid, Int32, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieves a particular push.
GetPushAsync(Guid, String, Int32, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieves a particular push.
GetPushAsync(String, Int32, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieves a particular push.
GetPushAsync(Guid, Int32, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieves a particular push.
GetPushAsync(Guid, Guid, Int32, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieves a particular push.

GetPushAsync(String, String, Int32, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Retrieves a particular push.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush> GetPushAsync(string project, string repositoryId, int pushId, Nullable<int> includeCommits = null, Nullable<bool> includeRefUpdates = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPushAsync : string * string * int * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush>
override this.GetPushAsync : string * string * int * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush>

Parameters

project: String

Project ID or project name

repositoryId: String

The name or ID of the repository.

pushId: Int32

ID of the push.

includeCommits: Nullable<Int32>

The number of commits to include in the result.

includeRefUpdates: Nullable<Boolean>

If true, include the list of refs that were updated by the push.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<GitPush>

Applies to

GetPushAsync(String, Guid, Int32, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Retrieves a particular push.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush> GetPushAsync(string project, Guid repositoryId, int pushId, Nullable<int> includeCommits = null, Nullable<bool> includeRefUpdates = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPushAsync : string * Guid * int * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush>
override this.GetPushAsync : string * Guid * int * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush>

Parameters

project: String

Project ID or project name

repositoryId: Guid

The name or ID of the repository.

pushId: Int32

ID of the push.

includeCommits: Nullable<Int32>

The number of commits to include in the result.

includeRefUpdates: Nullable<Boolean>

If true, include the list of refs that were updated by the push.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<GitPush>

Applies to

GetPushAsync(Guid, String, Int32, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Retrieves a particular push.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush> GetPushAsync(Guid project, string repositoryId, int pushId, Nullable<int> includeCommits = null, Nullable<bool> includeRefUpdates = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPushAsync : Guid * string * int * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush>
override this.GetPushAsync : Guid * string * int * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush>

Parameters

project: Guid

Project ID

repositoryId: String

The name or ID of the repository.

pushId: Int32

ID of the push.

includeCommits: Nullable<Int32>

The number of commits to include in the result.

includeRefUpdates: Nullable<Boolean>

If true, include the list of refs that were updated by the push.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<GitPush>

Applies to

GetPushAsync(String, Int32, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Retrieves a particular push.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush> GetPushAsync(string repositoryId, int pushId, Nullable<int> includeCommits = null, Nullable<bool> includeRefUpdates = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPushAsync : string * int * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush>
override this.GetPushAsync : string * int * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush>

Parameters

repositoryId: String

The name or ID of the repository.

pushId: Int32

ID of the push.

includeCommits: Nullable<Int32>

The number of commits to include in the result.

includeRefUpdates: Nullable<Boolean>

If true, include the list of refs that were updated by the push.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<GitPush>

Applies to

GetPushAsync(Guid, Int32, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Retrieves a particular push.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush> GetPushAsync(Guid repositoryId, int pushId, Nullable<int> includeCommits = null, Nullable<bool> includeRefUpdates = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPushAsync : Guid * int * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush>
override this.GetPushAsync : Guid * int * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush>

Parameters

repositoryId: Guid

The name or ID of the repository.

pushId: Int32

ID of the push.

includeCommits: Nullable<Int32>

The number of commits to include in the result.

includeRefUpdates: Nullable<Boolean>

If true, include the list of refs that were updated by the push.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<GitPush>

Applies to

GetPushAsync(Guid, Guid, Int32, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Retrieves a particular push.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush> GetPushAsync(Guid project, Guid repositoryId, int pushId, Nullable<int> includeCommits = null, Nullable<bool> includeRefUpdates = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPushAsync : Guid * Guid * int * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush>
override this.GetPushAsync : Guid * Guid * int * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.SourceControl.WebApi.GitPush>

Parameters

project: Guid

Project ID

repositoryId: Guid

The name or ID of the repository.

pushId: Int32

ID of the push.

includeCommits: Nullable<Int32>

The number of commits to include in the result.

includeRefUpdates: Nullable<Boolean>

If true, include the list of refs that were updated by the push.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<GitPush>

Applies to

Feedback

Was this page helpful?