Package org.azd.release.releases

Class ReleaseLogsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.release.releases.ReleaseLogsRequestBuilder

public class ReleaseLogsRequestBuilder
extends BaseRequestBuilder

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

Method Summary

Modifier and Type	Method	Description
InputStream	get(int releaseId)	Get logs for a release Id.
CompletableFuture<InputStream>	getAsync(int releaseId)	Get logs for a release Id.

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

ReleaseLogsRequestBuilder

public ReleaseLogsRequestBuilder(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<InputStream> getAsync(int releaseId)
                                        throws AzDException

Get logs for a release Id. Example:

          // Create AzDServiceClient object first.
          var logs = client.release().releases().logs().getAsync(1234).join(); // release Id
         StreamHelper.download("logs.zip", logs);
 

Parameters:

releaseId - Id of the release.

Returns:

Input stream of logs. Use StreamHelper to download the logs.

Throws:

AzDException

get

public InputStream get(int releaseId)
                throws AzDException

Get logs for a release Id. Example:

          // Create AzDServiceClient object first.
          var logs = client.release().releases().logs().get(1234); // release Id
         StreamHelper.download("logs.zip", logs);
 

Parameters:

releaseId - Id of the release.

Returns:

Input stream of logs. Use StreamHelper to download the logs.

Throws:

AzDException