Package org.azd.core.projects

Class ProjectsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.core.projects.ProjectsRequestBuilder

public class ProjectsRequestBuilder
extends BaseRequestBuilder

Builder class that constructs requests for Core Projects Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProjectsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	ProjectsRequestBuilder.ListQueryParameters	Represents the query parameters.
static class	ProjectsRequestBuilder.ListRequestConfiguration	Request configuration object for the query parameters.
static class	ProjectsRequestBuilder.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
ProjectsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
OperationReference	create(ProjectCreationParameters projectCreationParameters)	Creates a project for given process id
CompletableFuture<OperationReference>	createAsync(ProjectCreationParameters projectCreationParameters)	Creates a project for given process id
OperationReference	delete(String projectId)	Queues a project to be deleted.
CompletableFuture<OperationReference>	deleteAsync(String projectId)	Queues a project to be deleted.
Project	get()	Get the current project.
Project	get(String projectId)	Get project with the specified id or name
Project	get(String projectId, Consumer<ProjectsRequestBuilder.RequestConfiguration> requestConfiguration)	Get project with the specified id or name
CompletableFuture<Project>	getAsync()	Get the current project.
CompletableFuture<Project>	getAsync(String projectId)	Get project with the specified id or name
CompletableFuture<Project>	getAsync(String projectId, Consumer<ProjectsRequestBuilder.RequestConfiguration> requestConfiguration)	Get project with the specified id or name
Projects	list()	Get all projects in the organization that the authenticated user has access to.
Projects	list(Consumer<ProjectsRequestBuilder.ListRequestConfiguration> requestConfiguration)	Get all projects in the organization that the authenticated user has access to.
CompletableFuture<Projects>	listAsync()	Get all projects in the organization that the authenticated user has access to.
CompletableFuture<Projects>	listAsync(Consumer<ProjectsRequestBuilder.ListRequestConfiguration> requestConfiguration)	Get all projects in the organization that the authenticated user has access to.
PropertiesRequestBuilder	properties()	Provides functionality to manage Project properties Api.
OperationReference	update(String projectId, Project project)	Update an existing project's name, abbreviation, description, or restore a project.
CompletableFuture<OperationReference>	updateAsync(String projectId, Project project)	Update an existing project's name, abbreviation, description, or restore a project.

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

ProjectsRequestBuilder

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

properties

public PropertiesRequestBuilder properties()

Provides functionality to manage Project properties Api.

Returns:

PropertiesRequestBuilder PropertiesRequestBuilder

createAsync

public CompletableFuture<OperationReference> createAsync(ProjectCreationParameters projectCreationParameters)
                                                  throws AzDException

Creates a project for given process id

Parameters:

projectCreationParameters - Request body to create a new project.

Returns:

object with link to the project

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<OperationReference> deleteAsync(String projectId)
                                                  throws AzDException

Queues a project to be deleted.

You should pass the project id to delete it. Passing the project name won't delete. To get the project id run getProject() with projectName and get the Id.

Parameters:

projectId - pass the project id

Returns:

object of deleted project with url

Throws:

AzDException - Default Api Exception handler.

getAsync

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

Get project with the specified id or name

Parameters:

projectId - pass the project name or id

Returns:

project object Project

Throws:

AzDException - Default Api Exception handler.

getAsync

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

Get project with the specified id or name

Parameters:

projectId - pass the project name or id

Returns:

project object Project

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<Project> getAsync()
                                    throws AzDException

Get the current project. This should be set when creating the service client object using AzureDevOpsServices AzDService

Returns:

project object Project

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<Projects> listAsync()
                                      throws AzDException

Get all projects in the organization that the authenticated user has access to.

Returns:

array of project Projects

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<Projects> listAsync(Consumer<ProjectsRequestBuilder.ListRequestConfiguration> requestConfiguration)
                                      throws AzDException

Get all projects in the organization that the authenticated user has access to.

Parameters:

requestConfiguration - Consumer of request configuration that represent the query parameters.

Returns:

array of project Projects

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<OperationReference> updateAsync(String projectId,
 Project project)
                                                  throws AzDException

Update an existing project's name, abbreviation, description, or restore a project.

Parameters:

projectId - The project id of the project to update.

project - Project object to perform update operation.

Returns:

OperationReference object OperationReference

Throws:

AzDException - Default Api Exception handler.

create

public OperationReference create(ProjectCreationParameters projectCreationParameters)
                          throws AzDException

Creates a project for given process id

Parameters:

projectCreationParameters - Request body to create a new project.

Returns:

object with link to the project

Throws:

AzDException - Default Api Exception handler.

delete

public OperationReference delete(String projectId)
                          throws AzDException

Queues a project to be deleted.

You should pass the project id to delete it. Passing the project name won't delete. To get the project id run getProject() with projectName and get the Id.

Parameters:

projectId - pass the project id

Returns:

object of deleted project with url

Throws:

AzDException - Default Api Exception handler.

get

public Project get(String projectId)
            throws AzDException

Get project with the specified id or name

Parameters:

projectId - pass the project name or id

Returns:

project object Project

Throws:

AzDException - Default Api Exception handler.

get

public Project get(String projectId,
 Consumer<ProjectsRequestBuilder.RequestConfiguration> requestConfiguration)
            throws AzDException

Get project with the specified id or name

Parameters:

projectId - pass the project name or id

Returns:

project object Project

Throws:

AzDException - Default Api Exception handler.

get

public Project get()
            throws AzDException

Get the current project. This should be set when creating the service client object using AzureDevOpsServices AzDService

Returns:

project object Project

Throws:

AzDException - Default Api Exception handler.

list

public Projects list()
              throws AzDException

Get all projects in the organization that the authenticated user has access to.

Returns:

array of project Projects

Throws:

AzDException - Default Api Exception handler.

list

public Projects list(Consumer<ProjectsRequestBuilder.ListRequestConfiguration> requestConfiguration)
              throws AzDException

Get all projects in the organization that the authenticated user has access to.

Parameters:

requestConfiguration - Consumer of request configuration that represent the query parameters.

Returns:

array of project Projects

Throws:

AzDException - Default Api Exception handler.

update

public OperationReference update(String projectId,
 Project project)
                          throws AzDException

Update an existing project's name, abbreviation, description, or restore a project.

Parameters:

projectId - The project id of the project to update.

project - Project object to perform update operation.

Returns:

OperationReference object OperationReference

Throws:

AzDException - Default Api Exception handler.