Package org.azd.artifactspackagetypes.maven

Class MavenRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.artifactspackagetypes.maven.MavenRequestBuilder

public class MavenRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Azure DevOps Graph Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MavenRequestBuilder.MavenPathParameters	Represents the Path values for Maven Api.

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

Method Summary

Modifier and Type	Method	Description
Void	delete(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters)	Delete a package version from the feed and move it to the feed's recycle bin.
CompletableFuture<Void>	deleteAsync(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters)	Delete a package version from the feed and move it to the feed's recycle bin.
InputStream	download(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters)	Fulfills Maven package file download requests by either returning the URL of the requested package file or, in the case of Azure DevOps Server (OnPrem), returning the content as a stream.
CompletableFuture<InputStream>	downloadAsync(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters)	Fulfills Maven package file download requests by either returning the URL of the requested package file or, in the case of Azure DevOps Server (OnPrem), returning the content as a stream.
Package	get(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters)	Get information about a package version.
Package	get(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters, Predicate<ArtifactsPackageTypesRequestBuilder.DeletedPackagePredicate> showDeleted)	Get information about a package version.
CompletableFuture<Package>	getAsync(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters)	Get information about a package version.
CompletableFuture<Package>	getAsync(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters, Predicate<ArtifactsPackageTypesRequestBuilder.DeletedPackagePredicate> showDeleted)	Get information about a package version.
PackageFromRecycleBinRequestBuilder	recycleBin()	Provides functionality to manage Package version from recycle bin Api.
Void	update(String feedId, MavenPackagesBatchRequest batchRequest)	Update several packages from a single feed in a single request.
Void	update(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters, PackageVersionDetails packageVersionDetails)	Update state for a package version.
CompletableFuture<Void>	updateAsync(String feedId, MavenPackagesBatchRequest batchRequest)	Update several packages from a single feed in a single request.
CompletableFuture<Void>	updateAsync(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters, PackageVersionDetails packageVersionDetails)	Update state for a package version.
UpstreamingBehaviorRequestBuilder	upstreamingBehavior()	Provides functionality to manage Package version from upstreaming behaviour Api.

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

MavenRequestBuilder

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

recycleBin

public PackageFromRecycleBinRequestBuilder recycleBin()

Provides functionality to manage Package version from recycle bin Api.

Returns:

PackageFromRecycleBinRequestBuilder PackageFromRecycleBinRequestBuilder

upstreamingBehavior

public UpstreamingBehaviorRequestBuilder upstreamingBehavior()

Provides functionality to manage Package version from upstreaming behaviour Api.

Returns:

UpstreamingBehaviorRequestBuilder UpstreamingBehaviorRequestBuilder

downloadAsync

public CompletableFuture<InputStream> downloadAsync(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters)
                                             throws AzDException

Fulfills Maven package file download requests by either returning the URL of the requested package file or, in the case of Azure DevOps Server (OnPrem), returning the content as a stream.

Parameters:

pathParameters - Represents the path parameters to download artifact.

Returns:

Input stream of the artifact. Use StreamHelper and download(filename, inputStream) to download the artifact.

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters)
                                    throws AzDException

Delete a package version from the feed and move it to the feed's recycle bin.

Parameters:

pathParameters - Represents the path parameters to delete artifact.

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<Package> getAsync(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters)
                                    throws AzDException

Get information about a package version.

Parameters:

pathParameters - Represents the path parameters to get artifact.

Returns:

Package object Package

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<Package> getAsync(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters,
 Predicate<ArtifactsPackageTypesRequestBuilder.DeletedPackagePredicate> showDeleted)
                                    throws AzDException

Get information about a package version.

Parameters:

pathParameters - Represents the path parameters to get artifact.

showDeleted - Specify to include the deleted packages.

Example:

                       client.artifactsPackageTypes().maven().getAsync(r -> {
                          r.artifactId = "MyPackage";
                          r.groupId = "org.example.com";
                          r.feedId = "ID of the feed";
                          r.version = "1.0.0";
                       }, x -> x.showDeleted).join());
                       

Returns:

Package object Package

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<Void> updateAsync(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters,
 PackageVersionDetails packageVersionDetails)
                                    throws AzDException

Update state for a package version.

Parameters:

pathParameters - Represents the path parameters to update artifact.

packageVersionDetails - package version details to update.

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<Void> updateAsync(String feedId,
 MavenPackagesBatchRequest batchRequest)
                                    throws AzDException

Update several packages from a single feed in a single request. The updates to the packages do not happen atomically.

Parameters:

feedId - Feed which contains the packages to update.

batchRequest - Maven batch request with package details to update the packages.

Throws:

AzDException - Default Api Exception handler.

download

public InputStream download(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters)
                     throws AzDException

Fulfills Maven package file download requests by either returning the URL of the requested package file or, in the case of Azure DevOps Server (OnPrem), returning the content as a stream.

Parameters:

pathParameters - Represents the path parameters to download artifact.

Returns:

Input stream of the artifact. Use StreamHelper and download(filename, inputStream) to download the artifact.

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters)
            throws AzDException

Delete a package version from the feed and move it to the feed's recycle bin.

Parameters:

pathParameters - Represents the path parameters to delete artifact.

Throws:

AzDException - Default Api Exception handler.

get

public Package get(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters)
            throws AzDException

Get information about a package version.

Parameters:

pathParameters - Represents the path parameters to get artifact.

Returns:

Package object Package

Throws:

AzDException - Default Api Exception handler.

get

public Package get(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters,
 Predicate<ArtifactsPackageTypesRequestBuilder.DeletedPackagePredicate> showDeleted)
            throws AzDException

Get information about a package version.

Parameters:

pathParameters - Represents the path parameters to get artifact.

showDeleted - Specify to include the deleted packages.

Example:

                       client.artifactsPackageTypes().maven().get(r -> {
                          r.artifactId = "MyPackage";
                          r.groupId = "org.example.com";
                          r.feedId = "ID of the feed";
                          r.version = "1.0.0";
                       }, x -> x.showDeleted).join());
                       

Returns:

Package object Package

Throws:

AzDException - Default Api Exception handler.

update

public Void update(Consumer<MavenRequestBuilder.MavenPathParameters> pathParameters,
 PackageVersionDetails packageVersionDetails)
            throws AzDException

Update state for a package version.

Parameters:

pathParameters - Represents the path parameters to update artifact.

packageVersionDetails - package version details to update.

Throws:

AzDException - Default Api Exception handler.

update

public Void update(String feedId,
 MavenPackagesBatchRequest batchRequest)
            throws AzDException

Update several packages from a single feed in a single request. The updates to the packages do not happen atomically.

Parameters:

feedId - Feed which contains the packages to update.

batchRequest - Maven batch request with package details to update the packages.

Throws:

AzDException - Default Api Exception handler.