Package org.azd.build.timeline

Class TimelineRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.build.timeline.TimelineRequestBuilder

public class TimelineRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Build Timeline Api.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Timeline	get(int buildId)	Gets details for a build.
Timeline	get(int buildId, String timelineId)	Gets details for a build.
Timeline	get(int buildId, String timelineId, Consumer<TimelineRequestBuilder.RequestConfiguration> requestConfiguration)	Gets details for a build.
CompletableFuture<Timeline>	getAsync(int buildId)	Gets details for a build.
CompletableFuture<Timeline>	getAsync(int buildId, String timelineId)	Gets details for a build.
CompletableFuture<Timeline>	getAsync(int buildId, String timelineId, Consumer<TimelineRequestBuilder.RequestConfiguration> requestConfiguration)	Gets details for a build.

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

TimelineRequestBuilder

public TimelineRequestBuilder(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<Timeline> getAsync(int buildId)
                                     throws AzDException

Gets details for a build.

Parameters:

buildId - Id of the build. use getBuilds() to list all the builds.

Returns:

a timeline object. Timeline

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<Timeline> getAsync(int buildId,
 String timelineId)
                                     throws AzDException

Gets details for a build.

Parameters:

buildId - Id of the build. use getBuilds() to list all the builds.

timelineId - Id of the build timeline.

Returns:

a timeline object. Timeline

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<Timeline> getAsync(int buildId,
 String timelineId,
 Consumer<TimelineRequestBuilder.RequestConfiguration> requestConfiguration)
                                     throws AzDException

Gets details for a build.

Parameters:

buildId - Id of the build. use getBuilds() to list all the builds.

timelineId - Id of the build timeline.

requestConfiguration - Consumer of query parameters to filter.

Returns:

a timeline object. Timeline

Throws:

AzDException - Default Api Exception handler.

get

public Timeline get(int buildId)
             throws AzDException

Gets details for a build.

Parameters:

buildId - Id of the build. use getBuilds() to list all the builds.

Returns:

a timeline object. Timeline

Throws:

AzDException - Default Api Exception handler.

get

public Timeline get(int buildId,
 String timelineId)
             throws AzDException

Gets details for a build.

Parameters:

buildId - Id of the build. use getBuilds() to list all the builds.

timelineId - Id of the build timeline.

Returns:

a timeline object. Timeline

Throws:

AzDException - Default Api Exception handler.

get

public Timeline get(int buildId,
 String timelineId,
 Consumer<TimelineRequestBuilder.RequestConfiguration> requestConfiguration)
             throws AzDException

Gets details for a build.

Parameters:

buildId - Id of the build. use getBuilds() to list all the builds.

timelineId - Id of the build timeline.

requestConfiguration - Consumer of query parameters to filter.

Returns:

a timeline object. Timeline

Throws:

AzDException - Default Api Exception handler.