Package org.azd.core.teams

Class TeamsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.core.teams.TeamsRequestBuilder

public class TeamsRequestBuilder
extends BaseRequestBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TeamsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	TeamsRequestBuilder.RequestConfiguration	Request configuration object for the query parameters.

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
TeamsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
WebApiTeam	create(String projectId, String teamName)	Create a team in a team project.
CompletableFuture<WebApiTeam>	createAsync(String projectId, String teamName)	Create a team in a team project.
Void	delete(String projectId, String teamId)	Delete a team.
CompletableFuture<Void>	deleteAsync(String projectId, String teamId)	Delete a team.
WebApiTeams	get(String projectId)	Get a list of teams.
WebApiTeam	get(String projectId, String teamId)	Get a specific team.
WebApiTeam	get(String projectId, String teamId, boolean expandIdentity)	Get a specific team.
WebApiTeams	get(String projectId, Consumer<TeamsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of teams.
CompletableFuture<WebApiTeams>	getAsync(String projectId)	Get a list of teams.
CompletableFuture<WebApiTeam>	getAsync(String projectId, String teamId)	Get a specific team.
CompletableFuture<WebApiTeam>	getAsync(String projectId, String teamId, boolean expandIdentity)	Get a specific team.
CompletableFuture<WebApiTeams>	getAsync(String projectId, Consumer<TeamsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of teams.
WebApiTeams	list()	Get a list of all teams.
WebApiTeams	list(Consumer<TeamsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of all teams.
CompletableFuture<WebApiTeams>	listAsync()	Get a list of all teams.
CompletableFuture<WebApiTeams>	listAsync(Consumer<TeamsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of all teams.
TeamsMembersRequestBuilder	members()	Provides functionality to manage Teams members Api.
WebApiTeam	update(String projectId, String teamId, WebApiTeam team)	Update a team's name and/or description.
CompletableFuture<WebApiTeam>	updateAsync(String projectId, String teamId, WebApiTeam team)	Update a team's name and/or description.

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

TeamsRequestBuilder

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

members

public TeamsMembersRequestBuilder members()

Provides functionality to manage Teams members Api.

Returns:

TeamsMembersRequestBuilder TeamsMembersRequestBuilder

createAsync

public CompletableFuture<WebApiTeam> createAsync(String projectId,
 String teamName)
                                          throws AzDException

Create a team in a team project.

Parameters:

projectId - project name or GUID

teamName - pass the team name

Returns:

returns web api object

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(String projectId,
 String teamId)
                                    throws AzDException

Delete a team.

Parameters:

projectId - pass the project name or id

teamId - pass the team name

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<WebApiTeam> getAsync(String projectId,
 String teamId)
                                       throws AzDException

Get a specific team.

Parameters:

projectId - pass the project name or id

teamId - pass the team name

Returns:

team object

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<WebApiTeam> getAsync(String projectId,
 String teamId,
 boolean expandIdentity)
                                       throws AzDException

Get a specific team.

Parameters:

projectId - pass the project name or id

teamId - pass the team name

expandIdentity - if true gets the identity object

Returns:

team object

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<WebApiTeams> listAsync()
                                         throws AzDException

Get a list of all teams.

Returns:

array of team WebApiTeams.

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<WebApiTeams> listAsync(Consumer<TeamsRequestBuilder.RequestConfiguration> requestConfiguration)
                                         throws AzDException

Get a list of all teams.

Returns:

array of team WebApiTeams.

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<WebApiTeams> getAsync(String projectId)
                                        throws AzDException

Get a list of teams.

Parameters:

projectId - Project name.

Returns:

array of team WebApiTeams.

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<WebApiTeams> getAsync(String projectId,
 Consumer<TeamsRequestBuilder.RequestConfiguration> requestConfiguration)
                                        throws AzDException

Get a list of teams.

Parameters:

projectId - Project name.

requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.

Returns:

array of team WebApiTeams.

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<WebApiTeam> updateAsync(String projectId,
 String teamId,
 WebApiTeam team)
                                          throws AzDException

Update a team's name and/or description.

Parameters:

projectId - Project name.

teamId - The name or ID (GUID) of the team.

team - WebApiTeam object to update WebApiTeam.

Returns:

array of team WebApiTeams.

Throws:

AzDException - Default Api Exception handler.

create

public WebApiTeam create(String projectId,
 String teamName)
                  throws AzDException

Create a team in a team project.

Parameters:

projectId - project name or GUID

teamName - pass the team name

Returns:

returns web api object

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(String projectId,
 String teamId)
            throws AzDException

Delete a team.

Parameters:

projectId - pass the project name or id

teamId - pass the team name

Throws:

AzDException - Default Api Exception handler.

get

public WebApiTeam get(String projectId,
 String teamId)
               throws AzDException

Get a specific team.

Parameters:

projectId - pass the project name or id

teamId - pass the team name

Returns:

team object

Throws:

AzDException - Default Api Exception handler.

get

public WebApiTeam get(String projectId,
 String teamId,
 boolean expandIdentity)
               throws AzDException

Get a specific team.

Parameters:

projectId - pass the project name or id

teamId - pass the team name

expandIdentity - if true gets the identity object

Returns:

team object

Throws:

AzDException - Default Api Exception handler.

list

public WebApiTeams list()
                 throws AzDException

Get a list of all teams.

Returns:

array of team WebApiTeams.

Throws:

AzDException - Default Api Exception handler.

list

public WebApiTeams list(Consumer<TeamsRequestBuilder.RequestConfiguration> requestConfiguration)
                 throws AzDException

Get a list of all teams.

Returns:

array of team WebApiTeams.

Throws:

AzDException - Default Api Exception handler.

get

public WebApiTeams get(String projectId)
                throws AzDException

Get a list of teams.

Parameters:

projectId - Project name.

Returns:

array of team WebApiTeams.

Throws:

AzDException - Default Api Exception handler.

get

public WebApiTeams get(String projectId,
 Consumer<TeamsRequestBuilder.RequestConfiguration> requestConfiguration)
                throws AzDException

Get a list of teams.

Parameters:

projectId - Project name.

requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.

Returns:

array of team WebApiTeams.

Throws:

AzDException - Default Api Exception handler.

update

public WebApiTeam update(String projectId,
 String teamId,
 WebApiTeam team)
                  throws AzDException

Update a team's name and/or description.

Parameters:

projectId - Project name.

teamId - The name or ID (GUID) of the team.

team - WebApiTeam object to update WebApiTeam.

Returns:

array of team WebApiTeams.

Throws:

AzDException - Default Api Exception handler.