Package org.azd.release.definitions

Class DefinitionsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.release.definitions.DefinitionsRequestBuilder

public class DefinitionsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Release Definitions Api.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
ReleaseDefinition	create(ReleaseDefinition releaseDefinition)	Create a release definition
CompletableFuture<ReleaseDefinition>	createAsync(ReleaseDefinition releaseDefinition)	Create a release definition
Void	delete(int definitionId)	Delete a release definition.
Void	delete(int definitionId, Consumer<DefinitionsRequestBuilder.DeleteRequestConfiguration> requestConfiguration)	Delete a release definition.
CompletableFuture<Void>	deleteAsync(int definitionId)	Delete a release definition.
CompletableFuture<Void>	deleteAsync(int definitionId, Consumer<DefinitionsRequestBuilder.DeleteRequestConfiguration> requestConfiguration)	Delete a release definition.
ReleaseDefinition	get(int definitionId)	Get a release definition.
ReleaseDefinition	get(int definitionId, Consumer<DefinitionsRequestBuilder.GetRequestConfiguration> requestConfiguration)	Get a release definition.
CompletableFuture<ReleaseDefinition>	getAsync(int definitionId)	Get a release definition.
CompletableFuture<ReleaseDefinition>	getAsync(int definitionId, Consumer<DefinitionsRequestBuilder.GetRequestConfiguration> requestConfiguration)	Get a release definition.
ReleaseDefinitions	list()	Get a list of release definitions.
ReleaseDefinitions	list(Consumer<DefinitionsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of release definitions.
CompletableFuture<ReleaseDefinitions>	listAsync()	Get a list of release definitions.
CompletableFuture<ReleaseDefinitions>	listAsync(Consumer<DefinitionsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of release definitions.
DefinitionsRevisionRequestBuilder	revision()	Provides functionality to work with Release Definition revisions Api.
ReleaseDefinition	update(ReleaseDefinition releaseDefinition)	Update a release definition.
CompletableFuture<ReleaseDefinition>	updateAsync(ReleaseDefinition releaseDefinition)	Update a release 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

revision

public DefinitionsRevisionRequestBuilder revision()

Provides functionality to work with Release Definition revisions Api.

Returns:

DefinitionsRevisionRequestBuilder DefinitionsRevisionRequestBuilder

createAsync

public CompletableFuture<ReleaseDefinition> createAsync(ReleaseDefinition releaseDefinition)
                                                 throws AzDException

Create a release definition

Parameters:

releaseDefinition - Release definition object to create the definition.

Returns:

ReleaseDefinition ReleaseDefinition

Throws:

AzDException - Default Api Exception handler.

deleteAsync

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

Delete a release definition.

Parameters:

definitionId - Id of the release definition/pipeline.

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(int definitionId,
 Consumer<DefinitionsRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
                                    throws AzDException

Delete a release definition.

Parameters:

definitionId - Id of the release definition/pipeline.

requestConfiguration - Request configuration of query parameters.

Throws:

AzDException - Default Api Exception handler.

getAsync

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

Get a release definition.

Parameters:

definitionId - Id of the release definition/pipeline.

Returns:

ReleaseDefinition ReleaseDefinition

Throws:

AzDException - Default Api Exception handler.

getAsync

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

Get a release definition.

Parameters:

definitionId - Id of the release definition/pipeline.

Returns:

ReleaseDefinition ReleaseDefinition

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<ReleaseDefinitions> listAsync()
                                                throws AzDException

Get a list of release definitions.

Returns:

ReleaseDefinitions ReleaseDefinitions

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<ReleaseDefinitions> listAsync(Consumer<DefinitionsRequestBuilder.RequestConfiguration> requestConfiguration)
                                                throws AzDException

Get a list of release definitions.

Returns:

ReleaseDefinitions ReleaseDefinitions

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<ReleaseDefinition> updateAsync(ReleaseDefinition releaseDefinition)
                                                 throws AzDException

Update a release definition.

Parameters:

releaseDefinition - Pass the release definition ReleaseDefinition object. You can get it by running either getReleaseDefinitions() or getReleaseDefinition(int definitionId)

Returns:

a ReleaseDefinition ReleaseDefinition object.

Throws:

AzDException - Default Api exception handler.

create

public ReleaseDefinition create(ReleaseDefinition releaseDefinition)
                         throws AzDException

Create a release definition

Parameters:

releaseDefinition - Release definition object to create the definition.

Returns:

ReleaseDefinition ReleaseDefinition

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(int definitionId)
            throws AzDException

Delete a release definition.

Parameters:

definitionId - Id of the release definition/pipeline.

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(int definitionId,
 Consumer<DefinitionsRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
            throws AzDException

Delete a release definition.

Parameters:

definitionId - Id of the release definition/pipeline.

requestConfiguration - Request configuration of query parameters.

Throws:

AzDException - Default Api Exception handler.

get

public ReleaseDefinition get(int definitionId)
                      throws AzDException

Get a release definition.

Parameters:

definitionId - Id of the release definition/pipeline.

Returns:

ReleaseDefinition ReleaseDefinition

Throws:

AzDException - Default Api Exception handler.

get

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

Get a release definition.

Parameters:

definitionId - Id of the release definition/pipeline.

Returns:

ReleaseDefinition ReleaseDefinition

Throws:

AzDException - Default Api Exception handler.

list

public ReleaseDefinitions list()
                        throws AzDException

Get a list of release definitions.

Returns:

ReleaseDefinitions ReleaseDefinitions

Throws:

AzDException - Default Api Exception handler.

list

public ReleaseDefinitions list(Consumer<DefinitionsRequestBuilder.RequestConfiguration> requestConfiguration)
                        throws AzDException

Get a list of release definitions.

Returns:

ReleaseDefinitions ReleaseDefinitions

Throws:

AzDException - Default Api Exception handler.

update

public ReleaseDefinition update(ReleaseDefinition releaseDefinition)
                         throws AzDException

Update a release definition.

Parameters:

releaseDefinition - Pass the release definition ReleaseDefinition object. You can get it by running either getReleaseDefinitions() or getReleaseDefinition(int definitionId)

Returns:

a ReleaseDefinition ReleaseDefinition object.

Throws:

AzDException - Default Api exception handler.