BuildHttpClientBase.GetDefinitionAsync Method

Definition

Namespace:

Microsoft.TeamFoundation.Build.WebApi

Assembly:

Microsoft.TeamFoundation.Build2.WebApi.dll

Overloads

GetDefinitionAsync(Int32, Nullable<Int32>, Nullable<DateTime>, IEnumerable<String>, Nullable<Boolean>, Object, CancellationToken)	Gets a definition, optionally at a specific revision.
GetDefinitionAsync(Guid, Int32, Nullable<Int32>, Nullable<DateTime>, IEnumerable<String>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Gets a definition, optionally at a specific revision.
GetDefinitionAsync(String, Int32, Nullable<Int32>, Nullable<DateTime>, IEnumerable<String>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Gets a definition, optionally at a specific revision.

GetDefinitionAsync(Int32, Nullable<Int32>, Nullable<DateTime>, IEnumerable<String>, Nullable<Boolean>, Object, CancellationToken)

Gets a definition, optionally at a specific revision.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Build.WebApi.BuildDefinition> GetDefinitionAsync(int definitionId, Nullable<int> revision = null, Nullable<DateTime> minMetricsTime = null, System.Collections.Generic.IEnumerable<string> propertyFilters = null, Nullable<bool> includeLatestBuilds = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

override this.GetDefinitionAsync : int * Nullable<int> * Nullable<DateTime> * seq<string> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Build.WebApi.BuildDefinition>

Parameters

definitionId

Int32

The ID of the definition.

revision

Nullable<Int32>

The revision number to retrieve. If this is not specified, the latest version will be returned.

minMetricsTime

Nullable<DateTime>

If specified, indicates the date from which metrics should be included.

propertyFilters

IEnumerable<String>

A comma-delimited list of properties to include in the results.

includeLatestBuilds

Nullable<Boolean>

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<BuildDefinition>

GetDefinitionAsync(Guid, Int32, Nullable<Int32>, Nullable<DateTime>, IEnumerable<String>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Gets a definition, optionally at a specific revision.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Build.WebApi.BuildDefinition> GetDefinitionAsync(Guid project, int definitionId, Nullable<int> revision = null, Nullable<DateTime> minMetricsTime = null, System.Collections.Generic.IEnumerable<string> propertyFilters = null, Nullable<bool> includeLatestBuilds = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

override this.GetDefinitionAsync : Guid * int * Nullable<int> * Nullable<DateTime> * seq<string> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Build.WebApi.BuildDefinition>

Parameters

project

Guid

Project ID

definitionId

Int32

The ID of the definition.

revision

Nullable<Int32>

The revision number to retrieve. If this is not specified, the latest version will be returned.

minMetricsTime

Nullable<DateTime>

If specified, indicates the date from which metrics should be included.

propertyFilters

IEnumerable<String>

A comma-delimited list of properties to include in the results.

includeLatestBuilds

Nullable<Boolean>

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<BuildDefinition>

GetDefinitionAsync(String, Int32, Nullable<Int32>, Nullable<DateTime>, IEnumerable<String>, Nullable<Boolean>, Object, CancellationToken)

[Preview API] Gets a definition, optionally at a specific revision.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Build.WebApi.BuildDefinition> GetDefinitionAsync(string project, int definitionId, Nullable<int> revision = null, Nullable<DateTime> minMetricsTime = null, System.Collections.Generic.IEnumerable<string> propertyFilters = null, Nullable<bool> includeLatestBuilds = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

override this.GetDefinitionAsync : string * int * Nullable<int> * Nullable<DateTime> * seq<string> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Build.WebApi.BuildDefinition>

Parameters

project

String

Project ID or project name

definitionId

Int32

The ID of the definition.

revision

Nullable<Int32>

The revision number to retrieve. If this is not specified, the latest version will be returned.

minMetricsTime

Nullable<DateTime>

If specified, indicates the date from which metrics should be included.

propertyFilters

IEnumerable<String>

A comma-delimited list of properties to include in the results.

includeLatestBuilds

Nullable<Boolean>

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<BuildDefinition>