Package org.azd.distributedtask.agents

Class AgentsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.distributedtask.agents.AgentsRequestBuilder

public class AgentsRequestBuilder
extends BaseRequestBuilder

Builder class that constructs requests for Distributed tasks agents Api.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Void	delete(int poolId, int agentId)	Delete an agent.
CompletableFuture<Void>	deleteAsync(int poolId, int agentId)	Delete an agent.
TaskAgent	get(int poolId, int agentId)	Get information about an agent.
TaskAgent	get(int poolId, int agentId, Consumer<AgentsRequestBuilder.RequestConfiguration> requestConfiguration)	Get information about an agent.
CompletableFuture<TaskAgent>	getAsync(int poolId, int agentId)	Get information about an agent.
CompletableFuture<TaskAgent>	getAsync(int poolId, int agentId, Consumer<AgentsRequestBuilder.RequestConfiguration> requestConfiguration)	Get information about an agent.
Boolean	getPermission(int poolId, int agentId, boolean isCheckPermissions)	Get Permissions on Pool.
CompletableFuture<Boolean>	getPermissionAsync(int poolId, int agentId, boolean isCheckPermissions)	Get Permissions on Pool.
TaskAgents	list(int poolId)	Get a list of agents.
TaskAgents	list(int poolId, Consumer<AgentsRequestBuilder.ListRequestConfiguration> requestConfiguration)	Get a list of agents.
CompletableFuture<TaskAgents>	listAsync(int poolId)	Get a list of agents.
CompletableFuture<TaskAgents>	listAsync(int poolId, Consumer<AgentsRequestBuilder.ListRequestConfiguration> requestConfiguration)	Get a list of agents.
TaskAgent	update(int poolId, int agentId, TaskAgent taskAgent)	Update agent details.
CompletableFuture<TaskAgent>	updateAsync(int poolId, int agentId, TaskAgent taskAgent)	Update agent details.

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

AgentsRequestBuilder

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

deleteAsync

public CompletableFuture<Void> deleteAsync(int poolId,
 int agentId)
                                    throws AzDException

Delete an agent.

Parameters:

poolId - The pool ID to remove the agent from

agentId - The agent ID to remove

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<TaskAgent> getAsync(int poolId,
 int agentId)
                                      throws AzDException

Get information about an agent.

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.

getAsync

public CompletableFuture<TaskAgent> getAsync(int poolId,
 int agentId,
 Consumer<AgentsRequestBuilder.RequestConfiguration> requestConfiguration)
                                      throws AzDException

Get information about an agent.

Parameters:

poolId - The agent pool containing the agent.

agentId - The agent ID to get information about.

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

Returns:

A TaskAgent object TaskAgent.

Throws:

AzDException - Default Api Exception handler.

getPermissionAsync

public CompletableFuture<Boolean> getPermissionAsync(int poolId,
 int agentId,
 boolean isCheckPermissions)
                                              throws AzDException

Get Permissions on Pool.

Parameters:

poolId - The agent pool containing the agent.

agentId - The agent ID to get information about.

isCheckPermissions - Set to true to check permission.

Returns:

Returns a boolean.

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<TaskAgents> listAsync(int poolId)
                                        throws AzDException

Get a list of agents.

Parameters:

poolId - The agent pool containing the agents

Returns:

TaskAgents object TaskAgents

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<TaskAgents> listAsync(int poolId,
 Consumer<AgentsRequestBuilder.ListRequestConfiguration> requestConfiguration)
                                        throws AzDException

Get a list of agents.

Parameters:

poolId - The agent pool containing the agents

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

Returns:

TaskAgents object TaskAgents

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<TaskAgent> updateAsync(int poolId,
 int agentId,
 TaskAgent taskAgent)
                                         throws AzDException

Update agent details.

Parameters:

poolId - The agent pool to use

agentId - The agent to update

taskAgent - Task agent object.

Returns:

A TaskAgent object TaskAgent

Throws:

AzDException - Default Api Exception handler.

See Also:

• Agents - Update

delete

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

Delete an agent.

Parameters:

poolId - The pool ID to remove the agent from

agentId - The agent ID to remove

Throws:

AzDException - Default Api Exception handler.

get

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

Get information about an agent.

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.

get

public TaskAgent get(int poolId,
 int agentId,
 Consumer<AgentsRequestBuilder.RequestConfiguration> requestConfiguration)
              throws AzDException

Get information about an agent.

Parameters:

poolId - The agent pool containing the agent.

agentId - The agent ID to get information about.

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

Returns:

A TaskAgent object TaskAgent.

Throws:

AzDException - Default Api Exception handler.

getPermission

public Boolean getPermission(int poolId,
 int agentId,
 boolean isCheckPermissions)
                      throws AzDException

Get Permissions on Pool.

Parameters:

poolId - The agent pool containing the agent.

agentId - The agent ID to get information about.

isCheckPermissions - Set to true to check permission.

Returns:

Returns a boolean.

Throws:

AzDException - Default Api Exception handler.

list

public TaskAgents list(int poolId)
                throws AzDException

Get a list of agents.

Parameters:

poolId - The agent pool containing the agents

Returns:

TaskAgents object TaskAgents

Throws:

AzDException - Default Api Exception handler.

list

public TaskAgents list(int poolId,
 Consumer<AgentsRequestBuilder.ListRequestConfiguration> requestConfiguration)
                throws AzDException

Get a list of agents.

Parameters:

poolId - The agent pool containing the agents

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

Returns:

TaskAgents object TaskAgents

Throws:

AzDException - Default Api Exception handler.

update

public TaskAgent update(int poolId,
 int agentId,
 TaskAgent taskAgent)
                 throws AzDException

Update agent details.

Parameters:

poolId - The agent pool to use

agentId - The agent to update

taskAgent - Task agent object.

Returns:

A TaskAgent object TaskAgent

Throws:

AzDException - Default Api Exception handler.

See Also:

• Agents - Update