Package org.azd.work.capacities

Class CapacitiesRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.work.capacities.CapacitiesRequestBuilder

public class CapacitiesRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Work capacities 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
CapacitiesRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
TeamCapacity	get(String iterationId, String team)	Get a team's capacity including total capacity and days off
TeamMemberCapacityIdentityRef	get(String iterationId, String teamMemberId, String team)	Get a team member's capacity
CompletableFuture<TeamCapacity>	getAsync(String iterationId, String team)	Get a team's capacity including total capacity and days off
CompletableFuture<TeamMemberCapacityIdentityRef>	getAsync(String iterationId, String teamMemberId, String team)	Get a team member's capacity
TeamMemberCapacityIdentityRefs	replace(String iterationId, String team, List<TeamMemberCapacityIdentityRef> teamMemberCapacityIdentityRefs)	Replace a team's capacity
CompletableFuture<TeamMemberCapacityIdentityRefs>	replaceAsync(String iterationId, String team, List<TeamMemberCapacityIdentityRef> teamMemberCapacityIdentityRefs)	Replace a team's capacity
TeamMemberCapacityIdentityRef	update(String iterationId, String team, String teamMemberId, TeamMemberCapacityIdentityRef teamMemberCapacityIdentityRef)	Update a team member's capacity
CompletableFuture<TeamMemberCapacityIdentityRef>	updateAsync(String iterationId, String team, String teamMemberId, TeamMemberCapacityIdentityRef teamMemberCapacityIdentityRef)	Update a team member's capacity

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

CapacitiesRequestBuilder

public CapacitiesRequestBuilder(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

getAsync

public CompletableFuture<TeamCapacity> getAsync(String iterationId,
 String team)
                                         throws AzDException

Get a team's capacity including total capacity and days off

Parameters:

iterationId - Pass the iteration id.

team - The name of the Azure DevOps organization.

Returns:

TeamCapacity Object TeamCapacity

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<TeamMemberCapacityIdentityRef> getAsync(String iterationId,
 String teamMemberId,
 String team)
                                                          throws AzDException

Get a team member's capacity

Parameters:

iterationId - Pass the team iteration id.

teamMemberId - Id of the team member.

team - Name of Azure DevOps team.

Returns:

TeamMemberCapacityIdentityRef Object TeamMemberCapacityIdentityRef

Throws:

AzDException - Default Api Exception handler.

replaceAsync

public CompletableFuture<TeamMemberCapacityIdentityRefs> replaceAsync(String iterationId,
 String team,
 List<TeamMemberCapacityIdentityRef> teamMemberCapacityIdentityRefs)
                                                               throws AzDException

Replace a team's capacity

Parameters:

iterationId - Pass the team iteration id.

team - Name or id of the Azure DevOps team.

teamMemberCapacityIdentityRefs - A list of team members capacity to update.

Returns:

Collection of TeamMemberCapacityIdentityRef Object TeamMemberCapacityIdentityRefs

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<TeamMemberCapacityIdentityRef> updateAsync(String iterationId,
 String team,
 String teamMemberId,
 TeamMemberCapacityIdentityRef teamMemberCapacityIdentityRef)
                                                             throws AzDException

Update a team member's capacity

Parameters:

iterationId - Pass the team iteration id.

team - Name of id of the Azure DevOps team.

teamMemberId - Id of the team member.

teamMemberCapacityIdentityRef - Team member capacity object to update. You can only pass the list of activities and optionally days off.

Returns:

TeamMemberCapacityIdentityRef Object TeamMemberCapacityIdentityRef

Throws:

AzDException - Default Api Exception handler.

get

public TeamCapacity get(String iterationId,
 String team)
                 throws AzDException

Get a team's capacity including total capacity and days off

Parameters:

iterationId - Pass the iteration id.

team - The name of the Azure DevOps organization.

Returns:

TeamCapacity Object TeamCapacity

Throws:

AzDException - Default Api Exception handler.

get

public TeamMemberCapacityIdentityRef get(String iterationId,
 String teamMemberId,
 String team)
                                  throws AzDException

Get a team member's capacity

Parameters:

iterationId - Pass the team iteration id.

teamMemberId - Id of the team member.

team - Name of Azure DevOps team.

Returns:

TeamMemberCapacityIdentityRef Object TeamMemberCapacityIdentityRef

Throws:

AzDException - Default Api Exception handler.

replace

public TeamMemberCapacityIdentityRefs replace(String iterationId,
 String team,
 List<TeamMemberCapacityIdentityRef> teamMemberCapacityIdentityRefs)
                                       throws AzDException

Replace a team's capacity

Parameters:

iterationId - Pass the team iteration id.

team - Name or id of the Azure DevOps team.

teamMemberCapacityIdentityRefs - A list of team members capacity to update.

Returns:

Collection of TeamMemberCapacityIdentityRef Object TeamMemberCapacityIdentityRefs

Throws:

AzDException - Default Api Exception handler.

update

public TeamMemberCapacityIdentityRef update(String iterationId,
 String team,
 String teamMemberId,
 TeamMemberCapacityIdentityRef teamMemberCapacityIdentityRef)
                                     throws AzDException

Update a team member's capacity

Parameters:

iterationId - Pass the team iteration id.

team - Name of id of the Azure DevOps team.

teamMemberId - Id of the team member.

teamMemberCapacityIdentityRef - Team member capacity object to update. You can only pass the list of activities and optionally days off.

Returns:

TeamMemberCapacityIdentityRef Object TeamMemberCapacityIdentityRef

Throws:

AzDException - Default Api Exception handler.