Package org.azd.work.iterations

Class IterationsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.work.iterations.IterationsRequestBuilder

public class IterationsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Work iterations Api.

Nested Class Summary

Nested classes/interfaces inherited from class org.azd.abstractions.BaseRequestBuilder

BaseRequestBuilder.ProjectExcludeParameter

Field Summary

Fields inherited from class org.azd.abstractions.BaseRequestBuilder

accessTokenCredential, apiVersion, area, locationId, organizationUrl, serializer

Constructor Summary

Constructors

Constructor	Description
IterationsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
Void	delete(String id, String team)	Delete a team's iteration by iterationId
CompletableFuture<Void>	deleteAsync(String id, String team)	Delete a team's iteration by iterationId
TeamSettingsIteration	get(String id, String team)	Get team's iteration by iterationId
CompletableFuture<TeamSettingsIteration>	getAsync(String id, String team)	Get team's iteration by iterationId
IterationWorkItems	getWorkItems(String iterationId, String team)	Get work items for iteration
CompletableFuture<IterationWorkItems>	getWorkItemsAsync(String iterationId, String team)	Get work items for iteration
TeamSettingsIterations	list(String team)	Get a team's iterations using timeframe filter
TeamSettingsIterations	list(String team, IterationsTimeFrame timeFrame)	Get a team's iterations using timeframe filter
CompletableFuture<TeamSettingsIterations>	listAsync(String team)	Get a team's iterations using timeframe filter
CompletableFuture<TeamSettingsIterations>	listAsync(String team, IterationsTimeFrame timeFrame)	Get a team's iterations using timeframe filter
TeamSettingsIteration	post(String team, TeamSettingsIteration teamSettingsIteration)	Add an iteration to the team
CompletableFuture<TeamSettingsIteration>	postAsync(String team, TeamSettingsIteration teamSettingsIteration)	Add an iteration to the team

Methods inherited from class org.azd.abstractions.BaseRequestBuilder

builder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IterationsRequestBuilder

public IterationsRequestBuilder(String organizationUrl,
 AccessTokenCredential accessTokenCredential)

Instantiates a new RequestBuilder instance and sets the default values.

Parameters:

organizationUrl - Represents organization location request url.

accessTokenCredential - Access token credential object.

Method Details

deleteAsync

public CompletableFuture<Void> deleteAsync(String id,
 String team)
                                    throws AzDException

Delete a team's iteration by iterationId

Parameters:

id - ID of the iteration

team - Team ID or team name

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<TeamSettingsIteration> getAsync(String id,
 String team)
                                                  throws AzDException

Get team's iteration by iterationId

Parameters:

id - Team ID or team name

team - ID of the iteration

Returns:

TeamSettingsIteration object TeamSettingsIteration

Throws:

AzDException - Default Api Exception handler.

getWorkItemsAsync

public CompletableFuture<IterationWorkItems> getWorkItemsAsync(String iterationId,
 String team)
                                                        throws AzDException

Get work items for iteration

Parameters:

iterationId - ID of the iteration

team - Team ID or team name

Returns:

Collection of iteration work items IterationWorkItems

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<TeamSettingsIterations> listAsync(String team)
                                                    throws AzDException

Get a team's iterations using timeframe filter

Parameters:

team - Team ID or team name

Returns:

Collection of TeamSettingsIteration object TeamSettingsIterations

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<TeamSettingsIterations> listAsync(String team,
 IterationsTimeFrame timeFrame)
                                                    throws AzDException

Get a team's iterations using timeframe filter

Parameters:

team - Team ID or team name

timeFrame - A filter for which iterations are returned based on relative time. Only 'Current' is supported currently. IterationsTimeFrame

Returns:

Collection of TeamSettingsIteration object TeamSettingsIterations

Throws:

AzDException - Default Api Exception handler.

postAsync

public CompletableFuture<TeamSettingsIteration> postAsync(String team,
 TeamSettingsIteration teamSettingsIteration)
                                                   throws AzDException

Add an iteration to the team

Parameters:

team - Team ID or team name

teamSettingsIteration - Team settings iteration object to add iteration to the team.

Returns:

TeamSettingsIteration object TeamSettingsIteration

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(String id,
 String team)
            throws AzDException

Delete a team's iteration by iterationId

Parameters:

id - ID of the iteration

team - Team ID or team name

Throws:

AzDException - Default Api Exception handler.

get

public TeamSettingsIteration get(String id,
 String team)
                          throws AzDException

Get team's iteration by iterationId

Parameters:

id - Team ID or team name

team - ID of the iteration

Returns:

TeamSettingsIteration object TeamSettingsIteration

Throws:

AzDException - Default Api Exception handler.

getWorkItems

public IterationWorkItems getWorkItems(String iterationId,
 String team)
                                throws AzDException

Get work items for iteration

Parameters:

iterationId - ID of the iteration

team - Team ID or team name

Returns:

Collection of iteration work items IterationWorkItems

Throws:

AzDException - Default Api Exception handler.

list

public TeamSettingsIterations list(String team)
                            throws AzDException

Get a team's iterations using timeframe filter

Parameters:

team - Team ID or team name

Returns:

Collection of TeamSettingsIteration object TeamSettingsIterations

Throws:

AzDException - Default Api Exception handler.

list

public TeamSettingsIterations list(String team,
 IterationsTimeFrame timeFrame)
                            throws AzDException

Get a team's iterations using timeframe filter

Parameters:

team - Team ID or team name

timeFrame - A filter for which iterations are returned based on relative time. Only 'Current' is supported currently. IterationsTimeFrame

Returns:

Collection of TeamSettingsIteration object TeamSettingsIterations

Throws:

AzDException - Default Api Exception handler.

post

public TeamSettingsIteration post(String team,
 TeamSettingsIteration teamSettingsIteration)
                           throws AzDException

Add an iteration to the team

Parameters:

team - Team ID or team name

teamSettingsIteration - Team settings iteration object to add iteration to the team.

Returns:

TeamSettingsIteration object TeamSettingsIteration

Throws:

AzDException - Default Api Exception handler.