Package org.azd.build.builds

Class BuildLogsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.build.builds.BuildLogsRequestBuilder

public class BuildLogsRequestBuilder
extends BaseRequestBuilder

Provides the functionality to manage Build Logs Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BuildLogsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	BuildLogsRequestBuilder.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
BuildLogsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
BuildLogs	get(int buildId)	Gets the logs for a build.
String	get(int buildId, int logId)	Gets an individual log file for a build.
String	get(int buildId, int logId, Consumer<BuildLogsRequestBuilder.RequestConfiguration> requestConfiguration)	Gets an individual log file for a build as plain text.
CompletableFuture<BuildLogs>	getAsync(int buildId)	Gets the logs for a build.
CompletableFuture<String>	getAsync(int buildId, int logId)	Gets an individual log file for a build.
CompletableFuture<String>	getAsync(int buildId, int logId, Consumer<BuildLogsRequestBuilder.RequestConfiguration> requestConfiguration)	Gets an individual log file for a build as plain text.
InputStream	getAsZip(int buildId)	Gets the logs for a build as zip content.
InputStream	getAsZip(int buildId, int logId)	Gets an individual log file for a build as a zip file.
CompletableFuture<InputStream>	getAsZipAsync(int buildId)	Gets the logs for a build as zip content.
CompletableFuture<InputStream>	getAsZipAsync(int buildId, int logId)	Gets an individual log file for a build as a zip file.

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

BuildLogsRequestBuilder

public BuildLogsRequestBuilder(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<String> getAsync(int buildId,
 int logId)
                                   throws AzDException

Gets an individual log file for a build.

Parameters:

buildId - ID of the build.

logId - ID of the log file.

Returns:

Future string object or plain text.

Throws:

AzDException - Default Api exception handler.

getAsync

public CompletableFuture<String> getAsync(int buildId,
 int logId,
 Consumer<BuildLogsRequestBuilder.RequestConfiguration> requestConfiguration)
                                   throws AzDException

Gets an individual log file for a build as plain text.

Parameters:

buildId - ID of the build.

logId - ID of the log file.

requestConfiguration - Consumer of query parameters.

Returns:

String object or plain text.

Throws:

AzDException - Default Api exception handler.

getAsZipAsync

public CompletableFuture<InputStream> getAsZipAsync(int buildId,
 int logId)
                                             throws AzDException

Gets an individual log file for a build as a zip file.

Parameters:

buildId - ID of the build.

logId - ID of the log file.

Returns:

Input stream of logs.

Throws:

AzDException - Default Api exception handler.

getAsync

public CompletableFuture<BuildLogs> getAsync(int buildId)
                                      throws AzDException

Gets the logs for a build.

Parameters:

buildId - ID of the build.

Returns:

BuildLogs future object BuildLogs

Throws:

AzDException - Default Api exception handler.

getAsZipAsync

public CompletableFuture<InputStream> getAsZipAsync(int buildId)
                                             throws AzDException

Gets the logs for a build as zip content.

Parameters:

buildId - ID of the build.

Returns:

CompletableFuture of Input stream of logs.

Throws:

AzDException - Default Api exception handler.

get

public String get(int buildId,
 int logId)
           throws AzDException

Gets an individual log file for a build.

Parameters:

buildId - ID of the build.

logId - ID of the log file.

Returns:

String object or plain text.

Throws:

AzDException - Default Api exception handler.

get

public String get(int buildId,
 int logId,
 Consumer<BuildLogsRequestBuilder.RequestConfiguration> requestConfiguration)
           throws AzDException

Gets an individual log file for a build as plain text.

Parameters:

buildId - ID of the build.

logId - ID of the log file.

requestConfiguration - Consumer of query parameters.

Returns:

String object or plain text.

Throws:

AzDException - Default Api exception handler.

getAsZip

public InputStream getAsZip(int buildId,
 int logId)
                     throws AzDException

Gets an individual log file for a build as a zip file.

Parameters:

buildId - ID of the build.

logId - ID of the log file.

Returns:

Input stream of logs.

Throws:

AzDException - Default Api exception handler.

get

public BuildLogs get(int buildId)
              throws AzDException

Gets the logs for a build.

Parameters:

buildId - ID of the build.

Returns:

BuildLogs future object BuildLogs

Throws:

AzDException - Default Api exception handler.

getAsZip

public InputStream getAsZip(int buildId)
                     throws AzDException

Gets the logs for a build as zip content.

Parameters:

buildId - ID of the build.

Returns:

Input stream of logs.

Throws:

AzDException - Default Api exception handler.