BuildHttpClientBase.GetBuildsAsync Method
Definition
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
GetBuildsAsync(IEnumerable<Int32>, IEnumerable<Int32>, String, Nullable<DateTime>, Nullable<DateTime>, String, Nullable<BuildReason>, Nullable<BuildStatus>, Nullable<BuildResult>, IEnumerable<String>, IEnumerable<String>, Nullable<Int32>, String, Nullable<Int32>, Nullable<QueryDeletedOption>, Nullable<BuildQueryOrder>, String, IEnumerable<Int32>, String, String, Object, CancellationToken)
Gets a list of builds.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>> GetBuildsAsync (System.Collections.Generic.IEnumerable<int> definitions = null, System.Collections.Generic.IEnumerable<int> queues = null, string buildNumber = null, Nullable<DateTime> minTime = null, Nullable<DateTime> maxTime = null, string requestedFor = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> reasonFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> statusFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> resultFilter = null, System.Collections.Generic.IEnumerable<string> tagFilters = null, System.Collections.Generic.IEnumerable<string> properties = null, Nullable<int> top = null, string continuationToken = null, Nullable<int> maxBuildsPerDefinition = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> deletedFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> queryOrder = null, string branchName = null, System.Collections.Generic.IEnumerable<int> buildIds = null, string repositoryId = null, string repositoryType = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetBuildsAsync : seq<int> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> * seq<string> * seq<string> * Nullable<int> * string * Nullable<int> * Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> * string * seq<int> * string * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>>Parameters
- definitions
- IEnumerable<Int32>
A comma-delimited list of definition IDs. If specified, filters to builds for these definitions.
- queues
- IEnumerable<Int32>
A comma-delimited list of queue IDs. If specified, filters to builds that ran against these queues.
- buildNumber
- String
If specified, filters to builds that match this build number. Append * to do a prefix search.
If specified, filters to builds that finished/started/queued after this date based on the queryOrder specified.
If specified, filters to builds that finished/started/queued before this date based on the queryOrder specified.
- requestedFor
- String
If specified, filters to builds requested for the specified user.
- reasonFilter
- Nullable<BuildReason>
If specified, filters to builds that match this reason.
- statusFilter
- Nullable<BuildStatus>
If specified, filters to builds that match this status.
- resultFilter
- Nullable<BuildResult>
If specified, filters to builds that match this result.
- tagFilters
- IEnumerable<String>
A comma-delimited list of tags. If specified, filters to builds that have the specified tags.
- properties
- IEnumerable<String>
A comma-delimited list of properties to retrieve.
- continuationToken
- String
A continuation token, returned by a previous call to this method, that can be used to return the next set of builds.
- deletedFilter
- Nullable<QueryDeletedOption>
Indicates whether to exclude, include, or only return deleted builds.
- queryOrder
- Nullable<BuildQueryOrder>
The order in which builds should be returned.
- branchName
- String
If specified, filters to builds that built branches that built this branch.
- buildIds
- IEnumerable<Int32>
A comma-delimited list that specifies the IDs of builds to retrieve.
- repositoryId
- String
If specified, filters to builds that built from this repository.
- repositoryType
- String
If specified, filters to builds that built from repositories of this type.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBuildsAsync(Guid, IEnumerable<Int32>, IEnumerable<Int32>, String, Nullable<DateTime>, Nullable<DateTime>, String, Nullable<BuildReason>, Nullable<BuildStatus>, Nullable<BuildResult>, IEnumerable<String>, IEnumerable<String>, Nullable<Int32>, String, Nullable<Int32>, Nullable<QueryDeletedOption>, Nullable<BuildQueryOrder>, String, IEnumerable<Int32>, String, String, Object, CancellationToken)
[Preview API] Gets a list of builds.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>> GetBuildsAsync (Guid project, System.Collections.Generic.IEnumerable<int> definitions = null, System.Collections.Generic.IEnumerable<int> queues = null, string buildNumber = null, Nullable<DateTime> minTime = null, Nullable<DateTime> maxTime = null, string requestedFor = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> reasonFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> statusFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> resultFilter = null, System.Collections.Generic.IEnumerable<string> tagFilters = null, System.Collections.Generic.IEnumerable<string> properties = null, Nullable<int> top = null, string continuationToken = null, Nullable<int> maxBuildsPerDefinition = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> deletedFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> queryOrder = null, string branchName = null, System.Collections.Generic.IEnumerable<int> buildIds = null, string repositoryId = null, string repositoryType = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetBuildsAsync : Guid * seq<int> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> * seq<string> * seq<string> * Nullable<int> * string * Nullable<int> * Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> * string * seq<int> * string * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>>Parameters
- project
- Guid
Project ID
- definitions
- IEnumerable<Int32>
A comma-delimited list of definition IDs. If specified, filters to builds for these definitions.
- queues
- IEnumerable<Int32>
A comma-delimited list of queue IDs. If specified, filters to builds that ran against these queues.
- buildNumber
- String
If specified, filters to builds that match this build number. Append * to do a prefix search.
If specified, filters to builds that finished/started/queued after this date based on the queryOrder specified.
If specified, filters to builds that finished/started/queued before this date based on the queryOrder specified.
- requestedFor
- String
If specified, filters to builds requested for the specified user.
- reasonFilter
- Nullable<BuildReason>
If specified, filters to builds that match this reason.
- statusFilter
- Nullable<BuildStatus>
If specified, filters to builds that match this status.
- resultFilter
- Nullable<BuildResult>
If specified, filters to builds that match this result.
- tagFilters
- IEnumerable<String>
A comma-delimited list of tags. If specified, filters to builds that have the specified tags.
- properties
- IEnumerable<String>
A comma-delimited list of properties to retrieve.
- continuationToken
- String
A continuation token, returned by a previous call to this method, that can be used to return the next set of builds.
- deletedFilter
- Nullable<QueryDeletedOption>
Indicates whether to exclude, include, or only return deleted builds.
- queryOrder
- Nullable<BuildQueryOrder>
The order in which builds should be returned.
- branchName
- String
If specified, filters to builds that built branches that built this branch.
- buildIds
- IEnumerable<Int32>
A comma-delimited list that specifies the IDs of builds to retrieve.
- repositoryId
- String
If specified, filters to builds that built from this repository.
- repositoryType
- String
If specified, filters to builds that built from repositories of this type.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBuildsAsync(String, IEnumerable<Int32>, IEnumerable<Int32>, String, Nullable<DateTime>, Nullable<DateTime>, String, Nullable<BuildReason>, Nullable<BuildStatus>, Nullable<BuildResult>, IEnumerable<String>, IEnumerable<String>, Nullable<Int32>, String, Nullable<Int32>, Nullable<QueryDeletedOption>, Nullable<BuildQueryOrder>, String, IEnumerable<Int32>, String, String, Object, CancellationToken)
[Preview API] Gets a list of builds.
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>> GetBuildsAsync (string project, System.Collections.Generic.IEnumerable<int> definitions = null, System.Collections.Generic.IEnumerable<int> queues = null, string buildNumber = null, Nullable<DateTime> minTime = null, Nullable<DateTime> maxTime = null, string requestedFor = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> reasonFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> statusFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> resultFilter = null, System.Collections.Generic.IEnumerable<string> tagFilters = null, System.Collections.Generic.IEnumerable<string> properties = null, Nullable<int> top = null, string continuationToken = null, Nullable<int> maxBuildsPerDefinition = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> deletedFilter = null, Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> queryOrder = null, string branchName = null, System.Collections.Generic.IEnumerable<int> buildIds = null, string repositoryId = null, string repositoryType = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetBuildsAsync : string * seq<int> * seq<int> * string * Nullable<DateTime> * Nullable<DateTime> * string * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildReason> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildStatus> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildResult> * seq<string> * seq<string> * Nullable<int> * string * Nullable<int> * Nullable<Microsoft.TeamFoundation.Build.WebApi.QueryDeletedOption> * Nullable<Microsoft.TeamFoundation.Build.WebApi.BuildQueryOrder> * string * seq<int> * string * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.Build.WebApi.Build>>Parameters
- project
- String
Project ID or project name
- definitions
- IEnumerable<Int32>
A comma-delimited list of definition IDs. If specified, filters to builds for these definitions.
- queues
- IEnumerable<Int32>
A comma-delimited list of queue IDs. If specified, filters to builds that ran against these queues.
- buildNumber
- String
If specified, filters to builds that match this build number. Append * to do a prefix search.
If specified, filters to builds that finished/started/queued after this date based on the queryOrder specified.
If specified, filters to builds that finished/started/queued before this date based on the queryOrder specified.
- requestedFor
- String
If specified, filters to builds requested for the specified user.
- reasonFilter
- Nullable<BuildReason>
If specified, filters to builds that match this reason.
- statusFilter
- Nullable<BuildStatus>
If specified, filters to builds that match this status.
- resultFilter
- Nullable<BuildResult>
If specified, filters to builds that match this result.
- tagFilters
- IEnumerable<String>
A comma-delimited list of tags. If specified, filters to builds that have the specified tags.
- properties
- IEnumerable<String>
A comma-delimited list of properties to retrieve.
- continuationToken
- String
A continuation token, returned by a previous call to this method, that can be used to return the next set of builds.
- deletedFilter
- Nullable<QueryDeletedOption>
Indicates whether to exclude, include, or only return deleted builds.
- queryOrder
- Nullable<BuildQueryOrder>
The order in which builds should be returned.
- branchName
- String
If specified, filters to builds that built branches that built this branch.
- buildIds
- IEnumerable<Int32>
A comma-delimited list that specifies the IDs of builds to retrieve.
- repositoryId
- String
If specified, filters to builds that built from this repository.
- repositoryType
- String
If specified, filters to builds that built from repositories of this type.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for