Package org.azd.build.yaml

Class YamlRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.build.yaml.YamlRequestBuilder

public class YamlRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Build Yaml Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YamlRequestBuilder.GetQueryParameters
static class	YamlRequestBuilder.RequestConfiguration

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

Method Summary

Modifier and Type	Method	Description
YamlBuild	get(int definitionId)	Converts a definition to YAML.
YamlBuild	get(int definitionId, Consumer<YamlRequestBuilder.RequestConfiguration> requestConfiguration)	Converts a definition to YAML.
CompletableFuture<YamlBuild>	getAsync(int definitionId)	Converts a definition to YAML.
CompletableFuture<YamlBuild>	getAsync(int definitionId, Consumer<YamlRequestBuilder.RequestConfiguration> requestConfiguration)	Converts a definition to YAML.

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

YamlRequestBuilder

public YamlRequestBuilder(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<YamlBuild> getAsync(int definitionId)
                                      throws AzDException

Converts a definition to YAML.

Parameters:

definitionId - The ID of the definition.

Returns:

Yaml build object YamlBuild

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<YamlBuild> getAsync(int definitionId,
 Consumer<YamlRequestBuilder.RequestConfiguration> requestConfiguration)
                                      throws AzDException

Converts a definition to YAML.

Parameters:

definitionId - The ID of the definition.

requestConfiguration - Consumer of query parameters to filter.

Returns:

Yaml build object YamlBuild

Throws:

AzDException - Default Api Exception handler.

get

public YamlBuild get(int definitionId)
              throws AzDException

Converts a definition to YAML.

Parameters:

definitionId - The ID of the definition.

Returns:

Yaml build object YamlBuild

Throws:

AzDException - Default Api Exception handler.

get

public YamlBuild get(int definitionId,
 Consumer<YamlRequestBuilder.RequestConfiguration> requestConfiguration)
              throws AzDException

Converts a definition to YAML.

Parameters:

definitionId - The ID of the definition.

requestConfiguration - Consumer of query parameters to filter.

Returns:

Yaml build object YamlBuild

Throws:

AzDException - Default Api Exception handler.