Package org.azd.pipelines.logs

Class LogsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.pipelines.logs.LogsRequestBuilder

public class LogsRequestBuilder
extends BaseRequestBuilder

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

Method Summary

Modifier and Type	Method	Description
PipelineLog	get(int pipelineId, int runId, int logId)	Get a specific log from a pipeline run
PipelineLog	get(int pipelineId, int runId, int logId, GetLogExpandOptions logExpandOptions)	Get a specific log from a pipeline run
CompletableFuture<PipelineLog>	getAsync(int pipelineId, int runId, int logId)	Get a specific log from a pipeline run
CompletableFuture<PipelineLog>	getAsync(int pipelineId, int runId, int logId, GetLogExpandOptions logExpandOptions)	Get a specific log from a pipeline run
LogCollection	list(int pipelineId, int runId)	Get a list of logs from a pipeline run.
LogCollection	list(int pipelineId, int runId, GetLogExpandOptions logExpandOptions)	Get a list of logs from a pipeline run.
CompletableFuture<LogCollection>	listAsync(int pipelineId, int runId)	Get a list of logs from a pipeline run.
CompletableFuture<LogCollection>	listAsync(int pipelineId, int runId, GetLogExpandOptions logExpandOptions)	Get a list of logs from a pipeline run.

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

LogsRequestBuilder

public LogsRequestBuilder(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<PipelineLog> getAsync(int pipelineId,
 int runId,
 int logId)
                                        throws AzDException

Get a specific log from a pipeline run

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

logId - ID of the log.

Returns:

Pipeline log object PipelineLog.

Throws:

AzDException - Default Api exception handler.

getAsync

public CompletableFuture<PipelineLog> getAsync(int pipelineId,
 int runId,
 int logId,
 GetLogExpandOptions logExpandOptions)
                                        throws AzDException

Get a specific log from a pipeline run

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

logId - ID of the log.

logExpandOptions - Expand options. Default is None.

Returns:

Pipeline log object PipelineLog.

Throws:

AzDException - Default Api exception handler.

listAsync

public CompletableFuture<LogCollection> listAsync(int pipelineId,
 int runId)
                                           throws AzDException

Get a list of logs from a pipeline run.

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

Returns:

Pipeline log object PipelineLog.

Throws:

AzDException - Default Api exception handler.

listAsync

public CompletableFuture<LogCollection> listAsync(int pipelineId,
 int runId,
 GetLogExpandOptions logExpandOptions)
                                           throws AzDException

Get a list of logs from a pipeline run.

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

logExpandOptions - Expand options. Default is None.

Returns:

Pipeline log object PipelineLog.

Throws:

AzDException - Default Api exception handler.

get

public PipelineLog get(int pipelineId,
 int runId,
 int logId)
                throws AzDException

Get a specific log from a pipeline run

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

logId - ID of the log.

Returns:

Pipeline log object PipelineLog.

Throws:

AzDException - Default Api exception handler.

get

public PipelineLog get(int pipelineId,
 int runId,
 int logId,
 GetLogExpandOptions logExpandOptions)
                throws AzDException

Get a specific log from a pipeline run

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

logId - ID of the log.

logExpandOptions - Expand options. Default is None.

Returns:

Pipeline log object PipelineLog.

Throws:

AzDException - Default Api exception handler.

list

public LogCollection list(int pipelineId,
 int runId)
                   throws AzDException

Get a list of logs from a pipeline run.

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

Returns:

Pipeline log object PipelineLog.

Throws:

AzDException - Default Api exception handler.

list

public LogCollection list(int pipelineId,
 int runId,
 GetLogExpandOptions logExpandOptions)
                   throws AzDException

Get a list of logs from a pipeline run.

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

logExpandOptions - Expand options. Default is None.

Returns:

Pipeline log object PipelineLog.

Throws:

AzDException - Default Api exception handler.