Package org.azd.build.definitions

Class DefinitionsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.build.definitions.DefinitionsRequestBuilder

public class DefinitionsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Build Definitions Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefinitionsRequestBuilder.DefinitionQueryParameters	Represents the query parameter for Create Definition.
static class	DefinitionsRequestBuilder.DefinitionRequestConfiguration
static class	DefinitionsRequestBuilder.GetQueryParameters
static class	DefinitionsRequestBuilder.GetRequestConfiguration
static class	DefinitionsRequestBuilder.ListQueryParameters
static class	DefinitionsRequestBuilder.ListRequestConfiguration
static class	DefinitionsRequestBuilder.UpdateQueryParameters	Represents the query parameter for Create Definition.
static class	DefinitionsRequestBuilder.UpdateRequestConfiguration

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

Method Summary

Modifier and Type	Method	Description
BuildDefinition	create(BuildDefinition buildDefinition, Consumer<DefinitionsRequestBuilder.DefinitionRequestConfiguration> definitionRequestConfiguration)	Creates a new definition.
CompletableFuture<BuildDefinition>	createAsync(BuildDefinition buildDefinition, Consumer<DefinitionsRequestBuilder.DefinitionRequestConfiguration> definitionRequestConfiguration)	Creates a new definition.
Void	delete(int definitionId)	Deletes a definition and all associated builds.
CompletableFuture<Void>	deleteAsync(int definitionId)	Deletes a definition and all associated builds.
BuildDefinition	get(int definitionId)	Gets a definition
BuildDefinition	get(int definitionId, Consumer<DefinitionsRequestBuilder.GetRequestConfiguration> requestConfiguration)	Gets a definition
CompletableFuture<BuildDefinition>	getAsync(int definitionId)	Gets a definition
CompletableFuture<BuildDefinition>	getAsync(int definitionId, Consumer<DefinitionsRequestBuilder.GetRequestConfiguration> requestConfiguration)	Gets a definition
BuildDefinitionRevisions	getRevisions(int definitionId)	Gets a definition revisions.
CompletableFuture<BuildDefinitionRevisions>	getRevisionsAsync(int definitionId)	Gets a definition revisions.
BuildDefinitions	list()	Gets a list of definitions.
BuildDefinitions	list(Consumer<DefinitionsRequestBuilder.ListRequestConfiguration> requestConfiguration)	Gets a list of definitions.
CompletableFuture<BuildDefinitions>	listAsync()	Gets a list of definitions.
CompletableFuture<BuildDefinitions>	listAsync(Consumer<DefinitionsRequestBuilder.ListRequestConfiguration> requestConfiguration)	Gets a list of definitions.
BuildDefinition	restore(int definitionId, boolean deleted)	Restores a deleted definition
CompletableFuture<BuildDefinition>	restoreAsync(int definitionId, boolean deleted)	Restores a deleted definition
BuildDefinition	update(int definitionId, BuildDefinition buildDefinition, Consumer<DefinitionsRequestBuilder.UpdateRequestConfiguration> requestConfiguration)	Updates an existing build definition.
CompletableFuture<BuildDefinition>	updateAsync(int definitionId, BuildDefinition buildDefinition, Consumer<DefinitionsRequestBuilder.UpdateRequestConfiguration> requestConfiguration)	Updates an existing build definition.

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

DefinitionsRequestBuilder

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

createAsync

public CompletableFuture<BuildDefinition> createAsync(BuildDefinition buildDefinition,
 Consumer<DefinitionsRequestBuilder.DefinitionRequestConfiguration> definitionRequestConfiguration)
                                               throws AzDException

Creates a new definition.

Parameters:

buildDefinition - Build definition object.

definitionRequestConfiguration - Consumer of query parameters to clone the definition if exists.

Returns:

build definition BuildDefinition

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(int definitionId)
                                    throws AzDException

Deletes a definition and all associated builds.

Parameters:

definitionId - pass the definition id

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<BuildDefinition> getAsync(int definitionId,
 Consumer<DefinitionsRequestBuilder.GetRequestConfiguration> requestConfiguration)
                                            throws AzDException

Gets a definition

Parameters:

definitionId - pass the definition id

requestConfiguration - Consumer of query request parameters.

Returns:

build definition BuildDefinition

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<BuildDefinition> getAsync(int definitionId)
                                            throws AzDException

Gets a definition

Parameters:

definitionId - pass the definition id.

Returns:

build definition BuildDefinition

Throws:

AzDException - Default Api Exception handler.

getRevisionsAsync

public CompletableFuture<BuildDefinitionRevisions> getRevisionsAsync(int definitionId)
                                                              throws AzDException

Gets a definition revisions.

Parameters:

definitionId - pass the definition id

Returns:

build definition revisions object BuildDefinitionRevisions

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<BuildDefinitions> listAsync()
                                              throws AzDException

Gets a list of definitions.

Returns:

build definitions object BuildDefinitions

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<BuildDefinitions> listAsync(Consumer<DefinitionsRequestBuilder.ListRequestConfiguration> requestConfiguration)
                                              throws AzDException

Gets a list of definitions.

Parameters:

requestConfiguration - Consumer of query request parameters.

Returns:

build definitions object BuildDefinitions

Throws:

AzDException - Default Api Exception handler.

restoreAsync

public CompletableFuture<BuildDefinition> restoreAsync(int definitionId,
 boolean deleted)
                                                throws AzDException

Restores a deleted definition

Parameters:

definitionId - pass the build definition id

deleted - When false, restores a deleted definition.

Returns:

a BuildDefinition object

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<BuildDefinition> updateAsync(int definitionId,
 BuildDefinition buildDefinition,
 Consumer<DefinitionsRequestBuilder.UpdateRequestConfiguration> requestConfiguration)
                                               throws AzDException

Updates an existing build definition. In order for this operation to succeed, the value of the "Revision" property of the request body must match the existing build definition's. It is recommended that you obtain the existing build definition by using GET, modify the build definition as necessary, and then submit the modified definition with PUT.

Parameters:

definitionId - pass the build definition id

buildDefinition - Build definition object to update.

Returns:

a BuildDefinition object

Throws:

AzDException - Default Api Exception handler.

create

public BuildDefinition create(BuildDefinition buildDefinition,
 Consumer<DefinitionsRequestBuilder.DefinitionRequestConfiguration> definitionRequestConfiguration)
                       throws AzDException

Creates a new definition.

Parameters:

buildDefinition - Build definition object.

definitionRequestConfiguration - Consumer of query parameters to clone the definition if exists.

Returns:

build definition BuildDefinition

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(int definitionId)
            throws AzDException

Deletes a definition and all associated builds.

Parameters:

definitionId - pass the definition id

Throws:

AzDException - Default Api Exception handler.

get

public BuildDefinition get(int definitionId,
 Consumer<DefinitionsRequestBuilder.GetRequestConfiguration> requestConfiguration)
                    throws AzDException

Gets a definition

Parameters:

definitionId - pass the definition id

requestConfiguration - Consumer of query request parameters.

Returns:

build definition BuildDefinition

Throws:

AzDException - Default Api Exception handler.

get

public BuildDefinition get(int definitionId)
                    throws AzDException

Gets a definition

Parameters:

definitionId - pass the definition id.

Returns:

build definition BuildDefinition

Throws:

AzDException - Default Api Exception handler.

getRevisions

public BuildDefinitionRevisions getRevisions(int definitionId)
                                      throws AzDException

Gets a definition revisions.

Parameters:

definitionId - pass the definition id

Returns:

build definition revisions object BuildDefinitionRevisions

Throws:

AzDException - Default Api Exception handler.

list

public BuildDefinitions list()
                      throws AzDException

Gets a list of definitions.

Returns:

build definitions object BuildDefinitions

Throws:

AzDException - Default Api Exception handler.

list

public BuildDefinitions list(Consumer<DefinitionsRequestBuilder.ListRequestConfiguration> requestConfiguration)
                      throws AzDException

Gets a list of definitions.

Parameters:

requestConfiguration - Consumer of query request parameters.

Returns:

build definitions object BuildDefinitions

Throws:

AzDException - Default Api Exception handler.

restore

public BuildDefinition restore(int definitionId,
 boolean deleted)
                        throws AzDException

Restores a deleted definition

Parameters:

definitionId - pass the build definition id

deleted - When false, restores a deleted definition.

Returns:

a BuildDefinition object

Throws:

AzDException - Default Api Exception handler.

update

public BuildDefinition update(int definitionId,
 BuildDefinition buildDefinition,
 Consumer<DefinitionsRequestBuilder.UpdateRequestConfiguration> requestConfiguration)
                       throws AzDException

Updates an existing build definition. In order for this operation to succeed, the value of the "Revision" property of the request body must match the existing build definition's. It is recommended that you obtain the existing build definition by using GET, modify the build definition as necessary, and then submit the modified definition with PUT.

Parameters:

definitionId - pass the build definition id

buildDefinition - Build definition object to update.

Returns:

a BuildDefinition object

Throws:

AzDException - Default Api Exception handler.