Package org.azd.release.releases

Class ReleaseEnvironmentRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.release.releases.ReleaseEnvironmentRequestBuilder

public class ReleaseEnvironmentRequestBuilder
extends BaseRequestBuilder

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

Method Summary

Modifier and Type	Method	Description
ReleaseEnvironment	get(int environmentId, int releaseId)	Get a release environment.
ReleaseEnvironment	get(int environmentId, int releaseId, ReleaseEnvironmentExpands expand)	Get a release environment.
CompletableFuture<ReleaseEnvironment>	getAsync(int environmentId, int releaseId)	Get a release environment.
CompletableFuture<ReleaseEnvironment>	getAsync(int environmentId, int releaseId, ReleaseEnvironmentExpands expand)	Get a release environment.
ReleaseEnvironment	update(int environmentId, int releaseId, ReleaseEnvironmentUpdateMetadata updateMetadata)	Update the status of a release environment
CompletableFuture<ReleaseEnvironment>	updateAsync(int environmentId, int releaseId, ReleaseEnvironmentUpdateMetadata updateMetadata)	Update the status of a release environment

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

ReleaseEnvironmentRequestBuilder

public ReleaseEnvironmentRequestBuilder(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<ReleaseEnvironment> getAsync(int environmentId,
 int releaseId)
                                               throws AzDException

Get a release environment.

Parameters:

environmentId - Id of the release environment.

releaseId - pass the release id

Returns:

Release Environment ReleaseEnvironment

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<ReleaseEnvironment> getAsync(int environmentId,
 int releaseId,
 ReleaseEnvironmentExpands expand)
                                               throws AzDException

Get a release environment.

Parameters:

environmentId - Id of the release environment.

releaseId - pass the release id

Returns:

Release Environment ReleaseEnvironment

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<ReleaseEnvironment> updateAsync(int environmentId,
 int releaseId,
 ReleaseEnvironmentUpdateMetadata updateMetadata)
                                                  throws AzDException

Update the status of a release environment

Parameters:

environmentId - Id of the release environment.

releaseId - pass the release id

updateMetadata - Request metadata to update.

Returns:

Release Environment ReleaseEnvironment

Throws:

AzDException - Default Api Exception handler.

get

public ReleaseEnvironment get(int environmentId,
 int releaseId)
                       throws AzDException

Get a release environment.

Parameters:

environmentId - Id of the release environment.

releaseId - pass the release id

Returns:

Release Environment ReleaseEnvironment

Throws:

AzDException - Default Api Exception handler.

get

public ReleaseEnvironment get(int environmentId,
 int releaseId,
 ReleaseEnvironmentExpands expand)
                       throws AzDException

Get a release environment.

Parameters:

environmentId - Id of the release environment.

releaseId - pass the release id

Returns:

Release Environment ReleaseEnvironment

Throws:

AzDException - Default Api Exception handler.

update

public ReleaseEnvironment update(int environmentId,
 int releaseId,
 ReleaseEnvironmentUpdateMetadata updateMetadata)
                          throws AzDException

Update the status of a release environment

Parameters:

environmentId - Id of the release environment.

releaseId - pass the release id

updateMetadata - Request metadata to update.

Returns:

Release Environment ReleaseEnvironment

Throws:

AzDException - Default Api Exception handler.