Package org.azd.distributedtask

Class DistributedTaskApi

java.lang.Object

org.azd.utils.AzDAsyncApi<DistributedTaskApi>

org.azd.distributedtask.DistributedTaskApi

All Implemented Interfaces:

DistributedTaskDetails

public class DistributedTaskApi
extends AzDAsyncApi<DistributedTaskApi>
implements DistributedTaskDetails

DistributedTaskApi class to manage Agents, Deployment groups, Environments and Variable groups API

Constructor Summary

Constructors

Constructor	Description
DistributedTaskApi(Connection connection)	Pass the connection object

Method Summary

Modifier and Type	Method	Description
DeploymentGroup	addDeploymentGroup(String name, String description)	Create a deployment group.
DeploymentGroup	addDeploymentGroup(String name, String description, int poolId)	Create a deployment group.
EnvironmentInstance	addEnvironment(String name, String description)	Create an environment.
VariableGroup	addVariableGroup(String name, String description, VariableGroupMap variables)	Add a variable group.
VariableGroup	addVariableGroup(VariableGroupDefinition variableGroupDefinition)	Add a variable group.
Void	deleteAgent(int poolId, int agentId)	Delete an agent.
Void	deleteDeploymentGroup(int deploymentGroupId)	Delete a deployment group.
Void	deleteEnvironment(int environmentId)	Delete the specified environment.
Void	deleteVariableGroup(int variableGroupId, String[] projectIds)	Delete a variable group
TaskAgent	getAgent(int poolId, int agentId)	Get information about an agent.
TaskAgent	getAgent(int poolId, int agentId, boolean includeAssignedRequest, boolean includeCapabilities, boolean includeLastCompletedRequest, String[] propertyFilters)	Get information about an agent.
TaskAgents	getAgents(int poolId)	Get a list of agents.
TaskAgents	getAgents(int poolId, String agentName, String[] demands, boolean includeAssignedRequest, boolean includeCapabilities, boolean includeLastCompletedRequest, String[] propertyFilters)	Get a list of agents.
DeploymentGroup	getDeploymentGroup(int deploymentGroupId)	Get a deployment group by its ID.
DeploymentGroup	getDeploymentGroup(int deploymentGroupId, DeploymentGroupExpands expand, DeploymentGroupActionFilter actionFilter)	Get a deployment group by its ID.
DeploymentGroups	getDeploymentGroups()	Get a list of deployment groups by name or IDs.
DeploymentGroups	getDeploymentGroups(int top)	Get a list of deployment groups by name or IDs.
DeploymentGroups	getDeploymentGroups(int[] ids)	Get a list of deployment groups by name or IDs.
DeploymentGroups	getDeploymentGroups(String name)	Get a list of deployment groups by name or IDs.
DeploymentGroups	getDeploymentGroups(DeploymentGroupExpands expand)	Get a list of deployment groups by name or IDs.
DeploymentGroups	getDeploymentGroups(DeploymentGroupExpands expand, int top, DeploymentGroupActionFilter actionFilter, String continuationToken, int[] ids, String name)	Get a list of deployment groups by name or IDs.
EnvironmentInstance	getEnvironment(int environmentId)	Get an environment by its ID.
EnvironmentInstance	getEnvironment(int environmentId, EnvironmentExpands expands)	Get an environment by its ID.
EnvironmentInstances	getEnvironments()	Get all environments.
EnvironmentInstances	getEnvironments(int top)	Get all environments.
EnvironmentInstances	getEnvironments(int top, String continuationToken, String name)	Get all environments.
EnvironmentInstances	getEnvironments(String name)	Get all environments.
VariableGroup	getVariableGroup(int variableGroupId)	Get a variable group.
VariableGroups	getVariableGroups()	Get variable groups.
VariableGroups	getVariableGroups(int top)	Get variable groups.
VariableGroups	getVariableGroups(int top, VariableGroupActionFilter actionFilter, int continuationToken, String groupName, VariableGroupQueryOrder queryOrder)	Get variable groups.
VariableGroups	getVariableGroups(String groupName)	Get variable groups.
TaskAgent	updateAgent(int poolId, int agentId, TaskAgent requestBody)	Update agent details.
DeploymentGroup	updateDeploymentGroup(int deploymentGroupId, String name, String description)	Update a deployment group.
EnvironmentInstance	updateEnvironment(int environmentId, String name, String description)	Update the specified environment.
VariableGroup	updateVariableGroup(int groupId, String name, String description, VariableGroupMap variables)	Update a variable group.
VariableGroup	updateVariableGroup(int groupId, VariableGroupDefinition variableGroupDefinition)	Update a variable group.

Methods inherited from class org.azd.utils.AzDAsyncApi

createAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DistributedTaskApi

public DistributedTaskApi(Connection connection)

Pass the connection object

Parameters:

connection - Connection object

Method Details

deleteAgent

public Void deleteAgent(int poolId,
 int agentId)
                 throws AzDException

Delete an agent.

Specified by:

deleteAgent in interface DistributedTaskDetails

Parameters:

poolId - The pool ID to remove the agent from

agentId - The agent ID to remove

Throws:

AzDException - Default Api Exception handler.

getAgent

public TaskAgent getAgent(int poolId,
 int agentId)
                   throws AzDException

Get information about an agent.

Specified by:

getAgent in interface DistributedTaskDetails

Parameters:

poolId - The agent pool containing the agent

agentId - The agent ID to get information about

Returns:

A TaskAgent object TaskAgent

Throws:

AzDException - Default Api Exception handler.

getAgent

public TaskAgent getAgent(int poolId,
 int agentId,
 boolean includeAssignedRequest,
 boolean includeCapabilities,
 boolean includeLastCompletedRequest,
 String[] propertyFilters)
                   throws AzDException

Get information about an agent.

Specified by:

getAgent in interface DistributedTaskDetails

Parameters:

poolId - The agent pool containing the agent

agentId - The agent ID to get information about

includeAssignedRequest - Whether to include details about the agent's current work

includeCapabilities - Whether to include the agent's capabilities in the response

includeLastCompletedRequest - Whether to include details about the agents' most recent completed work

propertyFilters - Filter which custom properties will be returned

Returns:

A TaskAgent object TaskAgent

Throws:

AzDException - Default Api Exception handler.

getAgents

public TaskAgents getAgents(int poolId)
                     throws AzDException

Get a list of agents.

Specified by:

getAgents in interface DistributedTaskDetails

Parameters:

poolId - The agent pool containing the agents

Returns:

TaskAgents object TaskAgents

Throws:

AzDException - Default Api Exception handler.

getAgents

public TaskAgents getAgents(int poolId,
 String agentName,
 String[] demands,
 boolean includeAssignedRequest,
 boolean includeCapabilities,
 boolean includeLastCompletedRequest,
 String[] propertyFilters)
                     throws AzDException

Get a list of agents.

Specified by:

getAgents in interface DistributedTaskDetails

Parameters:

poolId - The agent pool containing the agents

agentName - Filter on agent name

demands - Filter by demands the agents can satisfy

includeAssignedRequest - Whether to include details about the agents' current work

includeCapabilities - Whether to include the agents' capabilities in the response

includeLastCompletedRequest - Whether to include details about the agents' most recent completed work

propertyFilters - Filter which custom properties will be returned

Returns:

TaskAgents object TaskAgents

Throws:

AzDException - Default Api Exception handler.

updateAgent

public TaskAgent updateAgent(int poolId,
 int agentId,
 TaskAgent requestBody)
                      throws AzDException

Update agent details.

Specified by:

updateAgent in interface DistributedTaskDetails

Parameters:

poolId - The agent pool to use

agentId - The agent to update

requestBody - Map of request body.

Visit https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/update?view=azure-devops-rest-7.1#request-body for more details.

Returns:

A TaskAgent object TaskAgent

Throws:

AzDException - Default Api Exception handler.

addDeploymentGroup

public DeploymentGroup addDeploymentGroup(String name,
 String description)
                                   throws AzDException

Create a deployment group.

Specified by:

addDeploymentGroup in interface DistributedTaskDetails

Parameters:

name - Name of the deployment group.

description - Description of the deployment group.

Returns:

Deployment group object DeploymentGroup

Throws:

AzDException - Default Api Exception handler.

addDeploymentGroup

public DeploymentGroup addDeploymentGroup(String name,
 String description,
 int poolId)
                                   throws AzDException

Create a deployment group.

Specified by:

addDeploymentGroup in interface DistributedTaskDetails

Parameters:

name - Name of the deployment group.

description - Description of the deployment group.

poolId - Identifier of the deployment pool in which deployment agents are registered.

Returns:

Deployment group object DeploymentGroup

Throws:

AzDException - Default Api Exception handler.

deleteDeploymentGroup

public Void deleteDeploymentGroup(int deploymentGroupId)
                           throws AzDException

Delete a deployment group.

Specified by:

deleteDeploymentGroup in interface DistributedTaskDetails

Parameters:

deploymentGroupId - ID of the deployment group to be deleted.

Throws:

AzDException - Default Api Exception handler.

getDeploymentGroup

public DeploymentGroup getDeploymentGroup(int deploymentGroupId)
                                   throws AzDException

Get a deployment group by its ID.

Specified by:

getDeploymentGroup in interface DistributedTaskDetails

Parameters:

deploymentGroupId - ID of the deployment group to be deleted.

Returns:

Deployment group object DeploymentGroup

Throws:

AzDException - Default Api Exception handler.

getDeploymentGroup

public DeploymentGroup getDeploymentGroup(int deploymentGroupId,
 DeploymentGroupExpands expand,
 DeploymentGroupActionFilter actionFilter)
                                   throws AzDException

Get a deployment group by its ID.

Specified by:

getDeploymentGroup in interface DistributedTaskDetails

Parameters:

deploymentGroupId - ID of the deployment group to be deleted.

expand - Include these additional details in the returned object.

actionFilter - Get the deployment group only if this action can be performed on it.

Returns:

Deployment group object DeploymentGroup

Throws:

AzDException - Default Api Exception handler.

getDeploymentGroups

public DeploymentGroups getDeploymentGroups()
                                     throws AzDException

Get a list of deployment groups by name or IDs.

Specified by:

getDeploymentGroups in interface DistributedTaskDetails

Returns:

Deployment groups object DeploymentGroups

Throws:

AzDException - Default Api Exception handler.

getDeploymentGroups

public DeploymentGroups getDeploymentGroups(int top)
                                     throws AzDException

Get a list of deployment groups by name or IDs.

Specified by:

getDeploymentGroups in interface DistributedTaskDetails

Parameters:

top - Maximum number of deployment groups to return. Default is 1000.

Returns:

Deployment groups object DeploymentGroups

Throws:

AzDException - Default Api Exception handler.

getDeploymentGroups

public DeploymentGroups getDeploymentGroups(int[] ids)
                                     throws AzDException

Get a list of deployment groups by name or IDs.

Specified by:

getDeploymentGroups in interface DistributedTaskDetails

Parameters:

ids - Array of Id of deployment groups.

Returns:

Deployment groups object DeploymentGroups

Throws:

AzDException - Default Api Exception handler.

getDeploymentGroups

public DeploymentGroups getDeploymentGroups(String name)
                                     throws AzDException

Get a list of deployment groups by name or IDs.

Specified by:

getDeploymentGroups in interface DistributedTaskDetails

Parameters:

name - Name of the deployment group.

Returns:

Deployment groups object DeploymentGroups

Throws:

AzDException - Default Api Exception handler.

getDeploymentGroups

public DeploymentGroups getDeploymentGroups(DeploymentGroupExpands expand)
                                     throws AzDException

Get a list of deployment groups by name or IDs.

Specified by:

getDeploymentGroups in interface DistributedTaskDetails

Parameters:

expand - Include these additional details in the returned objects. DeploymentGroupExpands

Returns:

Deployment groups object DeploymentGroups

Throws:

AzDException - Default Api Exception handler.

getDeploymentGroups

public DeploymentGroups getDeploymentGroups(DeploymentGroupExpands expand,
 int top,
 DeploymentGroupActionFilter actionFilter,
 String continuationToken,
 int[] ids,
 String name)
                                     throws AzDException

Get a list of deployment groups by name or IDs.

Specified by:

getDeploymentGroups in interface DistributedTaskDetails

Parameters:

expand - Include these additional details in the returned objects. DeploymentGroupExpands

top - Maximum number of deployment groups to return. Default is 1000.

actionFilter - Get only deployment groups on which this action can be performed. DeploymentGroupActionFilter

continuationToken - Get deployment groups with names greater than this continuationToken lexicographically.

ids - Comma separated list of IDs of the deployment groups.

name - Name of the deployment group.

Returns:

Deployment groups object DeploymentGroups

Throws:

AzDException - Default Api Exception handler.

updateDeploymentGroup

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

Update a deployment group.

Specified by:

updateDeploymentGroup in interface DistributedTaskDetails

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.

addEnvironment

public EnvironmentInstance addEnvironment(String name,
 String description)
                                   throws AzDException

Create an environment.

Specified by:

addEnvironment in interface DistributedTaskDetails

Parameters:

name - Name of the environment.

description - Description of the environment.

Returns:

Environment instance EnvironmentInstance

Throws:

AzDException - Default Api Exception handler.

deleteEnvironment

public Void deleteEnvironment(int environmentId)
                       throws AzDException

Delete the specified environment.

Specified by:

deleteEnvironment in interface DistributedTaskDetails

Parameters:

environmentId - ID of the environment.

Throws:

AzDException - Default Api Exception handler.

getEnvironment

public EnvironmentInstance getEnvironment(int environmentId)
                                   throws AzDException

Get an environment by its ID.

Specified by:

getEnvironment in interface DistributedTaskDetails

Parameters:

environmentId - ID of the environment.

Returns:

Environment instance EnvironmentInstance

Throws:

AzDException - Default Api Exception handler.

getEnvironment

public EnvironmentInstance getEnvironment(int environmentId,
 EnvironmentExpands expands)
                                   throws AzDException

Get an environment by its ID.

Specified by:

getEnvironment in interface DistributedTaskDetails

Parameters:

environmentId - ID of the environment.

expands - Include these additional details in the returned objects. EnvironmentExpands

Returns:

Environment instance EnvironmentInstance

Throws:

AzDException - Default Api Exception handler.

getEnvironments

public EnvironmentInstances getEnvironments()
                                     throws AzDException

Get all environments.

Specified by:

getEnvironments in interface DistributedTaskDetails

Returns:

Environment instances array EnvironmentInstances

Throws:

AzDException - Default Api Exception handler.

getEnvironments

public EnvironmentInstances getEnvironments(int top)
                                     throws AzDException

Get all environments.

Specified by:

getEnvironments in interface DistributedTaskDetails

Parameters:

top - Top environments to list

Returns:

Environment instances array EnvironmentInstances

Throws:

AzDException - Default Api Exception handler.

getEnvironments

public EnvironmentInstances getEnvironments(String name)
                                     throws AzDException

Get all environments.

Specified by:

getEnvironments in interface DistributedTaskDetails

Parameters:

name - Name of the environment.

Returns:

Environment instances array EnvironmentInstances

Throws:

AzDException - Default Api Exception handler.

getEnvironments

public EnvironmentInstances getEnvironments(int top,
 String continuationToken,
 String name)
                                     throws AzDException

Get all environments.

Specified by:

getEnvironments in interface DistributedTaskDetails

Parameters:

top - Top environments to list.

continuationToken - Get the list of environments paginated.

name - Name of the environment.

Returns:

Environment instances array EnvironmentInstances

Throws:

AzDException - Default Api Exception handler.

updateEnvironment

public EnvironmentInstance updateEnvironment(int environmentId,
 String name,
 String description)
                                      throws AzDException

Update the specified environment.

Specified by:

updateEnvironment in interface DistributedTaskDetails

Parameters:

environmentId - ID of the environment.

name - Name of the environment.

description - Description of the environment.

Returns:

Environment instance EnvironmentInstance

Throws:

AzDException - Default Api Exception handler.

addVariableGroup

public VariableGroup addVariableGroup(VariableGroupDefinition variableGroupDefinition)
                               throws AzDException

Add a variable group.

Specified by:

addVariableGroup in interface DistributedTaskDetails

Parameters:

variableGroupDefinition - Variable group definition VariableGroupDefinition

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

addVariableGroup

public VariableGroup addVariableGroup(String name,
 String description,
 VariableGroupMap variables)
                               throws AzDException

Add a variable group.

Specified by:

addVariableGroup in interface DistributedTaskDetails

Parameters:

name - Name of the variable group.

description - Description for the variable group.

variables - Map of variables to add.

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

deleteVariableGroup

public Void deleteVariableGroup(int variableGroupId,
 String[] projectIds)
                         throws AzDException

Delete a variable group

Specified by:

deleteVariableGroup in interface DistributedTaskDetails

Parameters:

variableGroupId - Id of the variable group.

projectIds - String array of project ids.

Throws:

AzDException - Default Api Exception handler.

getVariableGroup

public VariableGroup getVariableGroup(int variableGroupId)
                               throws AzDException

Get a variable group.

Specified by:

getVariableGroup in interface DistributedTaskDetails

Parameters:

variableGroupId - Id of the variable group.

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

getVariableGroups

public VariableGroups getVariableGroups()
                                 throws AzDException

Get variable groups.

Specified by:

getVariableGroups in interface DistributedTaskDetails

Returns:

Variable groups object VariableGroups

Throws:

AzDException - Default Api Exception handler.

getVariableGroups

public VariableGroups getVariableGroups(int top)
                                 throws AzDException

Get variable groups.

Specified by:

getVariableGroups in interface DistributedTaskDetails

Parameters:

top - Number of variable groups to get.

Returns:

Variable groups object VariableGroups

Throws:

AzDException - Default Api Exception handler.

getVariableGroups

public VariableGroups getVariableGroups(String groupName)
                                 throws AzDException

Get variable groups.

Specified by:

getVariableGroups in interface DistributedTaskDetails

Parameters:

groupName - Name of variable group.

Returns:

Variable groups object VariableGroups

Throws:

AzDException - Default Api Exception handler.

getVariableGroups

public VariableGroups getVariableGroups(int top,
 VariableGroupActionFilter actionFilter,
 int continuationToken,
 String groupName,
 VariableGroupQueryOrder queryOrder)
                                 throws AzDException

Get variable groups.

Specified by:

getVariableGroups in interface DistributedTaskDetails

Parameters:

top - Number of variable groups to get.

actionFilter - Action filter for the variable group. It specifies the action which can be performed on the variable groups. VariableGroupActionFilter

continuationToken - Gets the variable groups after the continuation token provided.

groupName - Name of variable group.

queryOrder - Gets the results in the defined order. Default is 'IdDescending'. VariableGroupQueryOrder

Returns:

Variable groups object VariableGroups

Throws:

AzDException - Default Api Exception handler.

updateVariableGroup

public VariableGroup updateVariableGroup(int groupId,
 String name,
 String description,
 VariableGroupMap variables)
                                  throws AzDException

Update a variable group.

Specified by:

updateVariableGroup in interface DistributedTaskDetails

Parameters:

groupId - Id of the variable group to update.

name - Sets name of the variable group.

description - Sets description of the variable group.

variables - Sets variables contained in the variable group.

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.

updateVariableGroup

public VariableGroup updateVariableGroup(int groupId,
 VariableGroupDefinition variableGroupDefinition)
                                  throws AzDException

Update a variable group.

Specified by:

updateVariableGroup in interface DistributedTaskDetails

Parameters:

groupId - Id of the variable group to update.

variableGroupDefinition - Variable group definition VariableGroupDefinition

Returns:

Variable group VariableGroup

Throws:

AzDException - Default Api Exception handler.