Package org.azd.distributedtask.deploymentgroups

Class DeploymentGroupsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.distributedtask.deploymentgroups.DeploymentGroupsRequestBuilder

public class DeploymentGroupsRequestBuilder
extends BaseRequestBuilder

Builder class that constructs requests for Distributed tasks deployment groups Api.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
DeploymentGroup	add(DeploymentGroupsRequestBuilder.DeploymentGroupRequest deploymentGroup)	Create a deployment group.
CompletableFuture<DeploymentGroup>	addAsync(DeploymentGroupsRequestBuilder.DeploymentGroupRequest deploymentGroup)	Create a deployment group.
Void	delete(int deploymentGroupId)	Delete a deployment group.
CompletableFuture<Void>	deleteAsync(int deploymentGroupId)	Delete a deployment group.
DeploymentGroup	get(int deploymentGroupId)	Get a deployment group by its ID.
DeploymentGroup	get(int deploymentGroupId, Consumer<DeploymentGroupsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a deployment group by its ID.
CompletableFuture<DeploymentGroup>	getAsync(int deploymentGroupId)	Get a deployment group by its ID.
CompletableFuture<DeploymentGroup>	getAsync(int deploymentGroupId, Consumer<DeploymentGroupsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a deployment group by its ID.
DeploymentGroups	list()	Get a list of deployment groups by name or IDs.
DeploymentGroups	list(Consumer<DeploymentGroupsRequestBuilder.ListRequestConfiguration> requestConfiguration)	Get a list of deployment groups by name or IDs.
CompletableFuture<DeploymentGroups>	listAsync()	Get a list of deployment groups by name or IDs.
CompletableFuture<DeploymentGroups>	listAsync(Consumer<DeploymentGroupsRequestBuilder.ListRequestConfiguration> requestConfiguration)	Get a list of deployment groups by name or IDs.
DeploymentGroup	update(int deploymentGroupId, String name, String description)	Update a deployment group.
CompletableFuture<DeploymentGroup>	updateAsync(int deploymentGroupId, String name, String description)	Update a deployment group.

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

DeploymentGroupsRequestBuilder

public DeploymentGroupsRequestBuilder(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

addAsync

public CompletableFuture<DeploymentGroup> addAsync(DeploymentGroupsRequestBuilder.DeploymentGroupRequest deploymentGroup)
                                            throws AzDException

Create a deployment group.

Parameters:

deploymentGroup - DeploymentGroupRequest object DeploymentGroupsRequestBuilder.DeploymentGroupRequest.

Returns:

Deployment group object DeploymentGroup

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(int deploymentGroupId)
                                    throws AzDException

Delete a deployment group.

Parameters:

deploymentGroupId - ID of the deployment group to be deleted.

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<DeploymentGroup> getAsync(int deploymentGroupId)
                                            throws AzDException

Get a deployment group by its ID.

Parameters:

deploymentGroupId - ID of the deployment group to be deleted.

Returns:

Deployment group object DeploymentGroup

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<DeploymentGroup> getAsync(int deploymentGroupId,
 Consumer<DeploymentGroupsRequestBuilder.RequestConfiguration> requestConfiguration)
                                            throws AzDException

Get a deployment group by its ID.

Parameters:

deploymentGroupId - ID of the deployment group to be deleted.

requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.

Returns:

Deployment group object DeploymentGroup

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<DeploymentGroups> listAsync()
                                              throws AzDException

Get a list of deployment groups by name or IDs.

Returns:

Deployment groups object DeploymentGroups

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<DeploymentGroups> listAsync(Consumer<DeploymentGroupsRequestBuilder.ListRequestConfiguration> requestConfiguration)
                                              throws AzDException

Get a list of deployment groups by name or IDs.

Parameters:

requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.

Returns:

Deployment groups object DeploymentGroups

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<DeploymentGroup> updateAsync(int deploymentGroupId,
 String name,
 String description)
                                               throws AzDException

Update a deployment group.

Parameters:

deploymentGroupId - ID of the deployment group.

name - Name of the deployment group.

description - Description of the deployment group.

Returns:

Deployment group object DeploymentGroup

Throws:

AzDException - Default Api Exception handler.

add

public DeploymentGroup add(DeploymentGroupsRequestBuilder.DeploymentGroupRequest deploymentGroup)
                    throws AzDException

Create a deployment group.

Parameters:

deploymentGroup - DeploymentGroupRequest object DeploymentGroupsRequestBuilder.DeploymentGroupRequest.

Returns:

Deployment group object DeploymentGroup

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(int deploymentGroupId)
            throws AzDException

Delete a deployment group.

Parameters:

deploymentGroupId - ID of the deployment group to be deleted.

Throws:

AzDException - Default Api Exception handler.

get

public DeploymentGroup get(int deploymentGroupId)
                    throws AzDException

Get a deployment group by its ID.

Parameters:

deploymentGroupId - ID of the deployment group to be deleted.

Returns:

Deployment group object DeploymentGroup

Throws:

AzDException - Default Api Exception handler.

get

public DeploymentGroup get(int deploymentGroupId,
 Consumer<DeploymentGroupsRequestBuilder.RequestConfiguration> requestConfiguration)
                    throws AzDException

Get a deployment group by its ID.

Parameters:

deploymentGroupId - ID of the deployment group to be deleted.

requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.

Returns:

Deployment group object DeploymentGroup

Throws:

AzDException - Default Api Exception handler.

list

public DeploymentGroups list()
                      throws AzDException

Get a list of deployment groups by name or IDs.

Returns:

Deployment groups object DeploymentGroups

Throws:

AzDException - Default Api Exception handler.

list

public DeploymentGroups list(Consumer<DeploymentGroupsRequestBuilder.ListRequestConfiguration> requestConfiguration)
                      throws AzDException

Get a list of deployment groups by name or IDs.

Parameters:

requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.

Returns:

Deployment groups object DeploymentGroups

Throws:

AzDException - Default Api Exception handler.

update

public DeploymentGroup update(int deploymentGroupId,
 String name,
 String description)
                       throws AzDException

Update a deployment group.

Parameters:

deploymentGroupId - ID of the deployment group.

name - Name of the deployment group.

description - Description of the deployment group.

Returns:

Deployment group object DeploymentGroup

Throws:

AzDException - Default Api Exception handler.