Package org.azd.build.controllers

Class ControllersRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.build.controllers.ControllersRequestBuilder

public class ControllersRequestBuilder
extends BaseRequestBuilder

Provides the functionality to manage Build Controllers 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
ControllersRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
BuildController	get(int controllerId)	Gets a controller
CompletableFuture<BuildController>	getAsync(int controllerId)	Gets a controller
BuildControllers	list()	Gets controllers
BuildControllers	list(String name)	Gets controller, optionally filtered by name
CompletableFuture<BuildControllers>	listAsync()	Gets controllers
CompletableFuture<BuildControllers>	listAsync(String name)	Gets controller, optionally filtered by name

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

ControllersRequestBuilder

public ControllersRequestBuilder(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<BuildController> getAsync(int controllerId)
                                            throws AzDException

Gets a controller

Parameters:

controllerId - pass the controller id

Returns:

build controller BuildController

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<BuildControllers> listAsync()
                                              throws AzDException

Gets controllers

Returns:

array of build controller BuildControllers

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<BuildControllers> listAsync(String name)
                                              throws AzDException

Gets controller, optionally filtered by name

Parameters:

name - pass the controller name

Returns:

array of build controller BuildControllers

Throws:

AzDException - Default Api Exception handler.

get

public BuildController get(int controllerId)
                    throws AzDException

Gets a controller

Parameters:

controllerId - pass the controller id

Returns:

build controller BuildController

Throws:

AzDException - Default Api Exception handler.

list

public BuildControllers list()
                      throws AzDException

Gets controllers

Returns:

array of build controller BuildControllers

Throws:

AzDException - Default Api Exception handler.

list

public BuildControllers list(String name)
                      throws AzDException

Gets controller, optionally filtered by name

Parameters:

name - pass the controller name

Returns:

array of build controller BuildControllers

Throws:

AzDException - Default Api Exception handler.