Package com.okta.sdk.resource.api

Class AgentPoolsApi

java.lang.Object

com.okta.sdk.resource.api.AgentPoolsApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]",
           comments="Generator version: 7.15.0")
public class AgentPoolsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AgentPoolsApi()
AgentPoolsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AgentPoolUpdate	activateAgentPoolsUpdate(String poolId, String updateId)	Activate an agent pool update Activates a scheduled agent pool update
AgentPoolUpdate	activateAgentPoolsUpdate(String poolId, String updateId, Map<String,String> additionalHeaders)	Activate an agent pool update Activates a scheduled agent pool update
AgentPoolUpdate	createAgentPoolsUpdate(String poolId, AgentPoolUpdate agentPoolUpdate)	Create an agent pool update Creates an agent pool update
AgentPoolUpdate	createAgentPoolsUpdate(String poolId, AgentPoolUpdate agentPoolUpdate, Map<String,String> additionalHeaders)	Create an agent pool update Creates an agent pool update
AgentPoolUpdate	deactivateAgentPoolsUpdate(String poolId, String updateId)	Deactivate an agent pool update Deactivates scheduled agent pool update
AgentPoolUpdate	deactivateAgentPoolsUpdate(String poolId, String updateId, Map<String,String> additionalHeaders)	Deactivate an agent pool update Deactivates scheduled agent pool update
void	deleteAgentPoolsUpdate(String poolId, String updateId)	Delete an agent pool update Deletes agent pool update
void	deleteAgentPoolsUpdate(String poolId, String updateId, Map<String,String> additionalHeaders)	Delete an agent pool update Deletes agent pool update
AgentPoolUpdate	getAgentPoolsUpdateInstance(String poolId, String updateId)	Retrieve an agent pool update by ID Retrieves an agent pool update by its `updateId`
AgentPoolUpdate	getAgentPoolsUpdateInstance(String poolId, String updateId, Map<String,String> additionalHeaders)	Retrieve an agent pool update by ID Retrieves an agent pool update by its `updateId`
AgentPoolUpdateSetting	getAgentPoolsUpdateSettings(String poolId)	Retrieve an agent pool update's settings Retrieves the current state of the agent pool update instance settings
AgentPoolUpdateSetting	getAgentPoolsUpdateSettings(String poolId, Map<String,String> additionalHeaders)	Retrieve an agent pool update's settings Retrieves the current state of the agent pool update instance settings
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<AgentPool>	listAgentPools(Integer limitPerPoolType, AgentType poolType, String after)	List all agent pools Lists all agent pools with pagination support
List<AgentPool>	listAgentPools(Integer limitPerPoolType, AgentType poolType, String after, Map<String,String> additionalHeaders)	List all agent pools Lists all agent pools with pagination support
Iterable<AgentPool>	listAgentPoolsPaged(Integer limitPerPoolType, AgentType poolType, String after)	List all agent pools (Paginated) Lists all agent pools with pagination support This method returns a lazy, paginated iterable that automatically handles pagination.
Iterable<AgentPool>	listAgentPoolsPaged(Integer limitPerPoolType, AgentType poolType, String after, Map<String,String> additionalHeaders)	List all agent pools (Paginated with additional headers) Lists all agent pools with pagination support This method returns a lazy, paginated iterable that automatically handles pagination.
List<AgentPoolUpdate>	listAgentPoolsUpdates(String poolId, Boolean scheduled)	List all agent pool updates Lists all agent pool updates
List<AgentPoolUpdate>	listAgentPoolsUpdates(String poolId, Boolean scheduled, Map<String,String> additionalHeaders)	List all agent pool updates Lists all agent pool updates
Iterable<AgentPoolUpdate>	listAgentPoolsUpdatesPaged(String poolId, Boolean scheduled)	List all agent pool updates (Paginated) Lists all agent pool updates This method returns a lazy, paginated iterable that automatically handles pagination.
Iterable<AgentPoolUpdate>	listAgentPoolsUpdatesPaged(String poolId, Boolean scheduled, Map<String,String> additionalHeaders)	List all agent pool updates (Paginated with additional headers) Lists all agent pool updates This method returns a lazy, paginated iterable that automatically handles pagination.
AgentPoolUpdate	pauseAgentPoolsUpdate(String poolId, String updateId)	Pause an agent pool update Pauses a running or queued agent pool update
AgentPoolUpdate	pauseAgentPoolsUpdate(String poolId, String updateId, Map<String,String> additionalHeaders)	Pause an agent pool update Pauses a running or queued agent pool update
AgentPoolUpdate	resumeAgentPoolsUpdate(String poolId, String updateId)	Resume an agent pool update Resumes a running or queued agent pool update
AgentPoolUpdate	resumeAgentPoolsUpdate(String poolId, String updateId, Map<String,String> additionalHeaders)	Resume an agent pool update Resumes a running or queued agent pool update
AgentPoolUpdate	retryAgentPoolsUpdate(String poolId, String updateId)	Retry an agent pool update Retries an agent pool update if the update is unsuccessful or communication with Okta was interrupted during an agent auto-update
AgentPoolUpdate	retryAgentPoolsUpdate(String poolId, String updateId, Map<String,String> additionalHeaders)	Retry an agent pool update Retries an agent pool update if the update is unsuccessful or communication with Okta was interrupted during an agent auto-update
void	setApiClient(ApiClient apiClient)
AgentPoolUpdate	stopAgentPoolsUpdate(String poolId, String updateId)	Stop an agent pool update Stops an agent pool update
AgentPoolUpdate	stopAgentPoolsUpdate(String poolId, String updateId, Map<String,String> additionalHeaders)	Stop an agent pool update Stops an agent pool update
AgentPoolUpdate	updateAgentPoolsUpdate(String poolId, String updateId, AgentPoolUpdate agentPoolUpdate)	Update an agent pool update by ID Updates an agent pool update instance and returns the latest agent pool update
AgentPoolUpdate	updateAgentPoolsUpdate(String poolId, String updateId, AgentPoolUpdate agentPoolUpdate, Map<String,String> additionalHeaders)	Update an agent pool update by ID Updates an agent pool update instance and returns the latest agent pool update
AgentPoolUpdateSetting	updateAgentPoolsUpdateSettings(String poolId, AgentPoolUpdateSetting agentPoolUpdateSetting)	Update an agent pool update settings Updates an agent pool update instance settings
AgentPoolUpdateSetting	updateAgentPoolsUpdateSettings(String poolId, AgentPoolUpdateSetting agentPoolUpdateSetting, Map<String,String> additionalHeaders)	Update an agent pool update settings Updates an agent pool update instance settings

Methods inherited from class java.lang.Object

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

Constructor Details

AgentPoolsApi

public AgentPoolsApi()

AgentPoolsApi

public AgentPoolsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateAgentPoolsUpdate

public AgentPoolUpdate activateAgentPoolsUpdate(String poolId,
 String updateId)
                                         throws ApiException

Activate an agent pool update Activates a scheduled agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

activateAgentPoolsUpdate

public AgentPoolUpdate activateAgentPoolsUpdate(String poolId,
 String updateId,
 Map<String,String> additionalHeaders)
                                         throws ApiException

Activate an agent pool update Activates a scheduled agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

additionalHeaders - additionalHeaders for this call

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

createAgentPoolsUpdate

public AgentPoolUpdate createAgentPoolsUpdate(String poolId,
 AgentPoolUpdate agentPoolUpdate)
                                       throws ApiException

Create an agent pool update Creates an agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

agentPoolUpdate - (required)

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

createAgentPoolsUpdate

public AgentPoolUpdate createAgentPoolsUpdate(String poolId,
 AgentPoolUpdate agentPoolUpdate,
 Map<String,String> additionalHeaders)
                                       throws ApiException

Create an agent pool update Creates an agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

agentPoolUpdate - (required)

additionalHeaders - additionalHeaders for this call

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

deactivateAgentPoolsUpdate

public AgentPoolUpdate deactivateAgentPoolsUpdate(String poolId,
 String updateId)
                                           throws ApiException

Deactivate an agent pool update Deactivates scheduled agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

deactivateAgentPoolsUpdate

public AgentPoolUpdate deactivateAgentPoolsUpdate(String poolId,
 String updateId,
 Map<String,String> additionalHeaders)
                                           throws ApiException

Deactivate an agent pool update Deactivates scheduled agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

additionalHeaders - additionalHeaders for this call

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

deleteAgentPoolsUpdate

public void deleteAgentPoolsUpdate(String poolId,
 String updateId)
                            throws ApiException

Delete an agent pool update Deletes agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

Throws:

ApiException - if fails to make API call

deleteAgentPoolsUpdate

public void deleteAgentPoolsUpdate(String poolId,
 String updateId,
 Map<String,String> additionalHeaders)
                            throws ApiException

Delete an agent pool update Deletes agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getAgentPoolsUpdateInstance

public AgentPoolUpdate getAgentPoolsUpdateInstance(String poolId,
 String updateId)
                                            throws ApiException

Retrieve an agent pool update by ID Retrieves an agent pool update by its `updateId`

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

getAgentPoolsUpdateInstance

public AgentPoolUpdate getAgentPoolsUpdateInstance(String poolId,
 String updateId,
 Map<String,String> additionalHeaders)
                                            throws ApiException

Retrieve an agent pool update by ID Retrieves an agent pool update by its `updateId`

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

additionalHeaders - additionalHeaders for this call

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

getAgentPoolsUpdateSettings

public AgentPoolUpdateSetting getAgentPoolsUpdateSettings(String poolId)
                                                   throws ApiException

Retrieve an agent pool update's settings Retrieves the current state of the agent pool update instance settings

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

Returns:

AgentPoolUpdateSetting

Throws:

ApiException - if fails to make API call

getAgentPoolsUpdateSettings

public AgentPoolUpdateSetting getAgentPoolsUpdateSettings(String poolId,
 Map<String,String> additionalHeaders)
                                                   throws ApiException

Retrieve an agent pool update's settings Retrieves the current state of the agent pool update instance settings

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

additionalHeaders - additionalHeaders for this call

Returns:

AgentPoolUpdateSetting

Throws:

ApiException - if fails to make API call

listAgentPools

public List<AgentPool> listAgentPools(Integer limitPerPoolType,
 AgentType poolType,
 String after)
                               throws ApiException

List all agent pools Lists all agent pools with pagination support

Parameters:

limitPerPoolType - Maximum number of agent pools returned (optional, default to 5)

poolType - Agent type to search for (optional)

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)

Returns:

List<AgentPool>

Throws:

ApiException - if fails to make API call

listAgentPools

public List<AgentPool> listAgentPools(Integer limitPerPoolType,
 AgentType poolType,
 String after,
 Map<String,String> additionalHeaders)
                               throws ApiException

List all agent pools Lists all agent pools with pagination support

Parameters:

limitPerPoolType - Maximum number of agent pools returned (optional, default to 5)

poolType - Agent type to search for (optional)

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<AgentPool>

Throws:

ApiException - if fails to make API call

listAgentPoolsPaged

public Iterable<AgentPool> listAgentPoolsPaged(Integer limitPerPoolType,
 AgentType poolType,
 String after)

List all agent pools (Paginated) Lists all agent pools with pagination support This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.

Parameters:

limitPerPoolType - Maximum number of agent pools returned (optional, default to 5)

poolType - Agent type to search for (optional)

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)

Returns:

Iterable<AgentPool> lazy iterable over all pages

listAgentPoolsPaged

public Iterable<AgentPool> listAgentPoolsPaged(Integer limitPerPoolType,
 AgentType poolType,
 String after,
 Map<String,String> additionalHeaders)

List all agent pools (Paginated with additional headers) Lists all agent pools with pagination support This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.

Parameters:

limitPerPoolType - Maximum number of agent pools returned (optional, default to 5)

poolType - Agent type to search for (optional)

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)

additionalHeaders - additional headers for this call

Returns:

Iterable<AgentPool> lazy iterable over all pages

listAgentPoolsUpdates

public List<AgentPoolUpdate> listAgentPoolsUpdates(String poolId,
 Boolean scheduled)
                                            throws ApiException

List all agent pool updates Lists all agent pool updates

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

scheduled - Return only scheduled or ad-hoc updates. If this parameter isn't provided, Okta returns the entire list of updates. (optional)

Returns:

List<AgentPoolUpdate>

Throws:

ApiException - if fails to make API call

listAgentPoolsUpdates

public List<AgentPoolUpdate> listAgentPoolsUpdates(String poolId,
 Boolean scheduled,
 Map<String,String> additionalHeaders)
                                            throws ApiException

List all agent pool updates Lists all agent pool updates

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

scheduled - Return only scheduled or ad-hoc updates. If this parameter isn't provided, Okta returns the entire list of updates. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<AgentPoolUpdate>

Throws:

ApiException - if fails to make API call

listAgentPoolsUpdatesPaged

public Iterable<AgentPoolUpdate> listAgentPoolsUpdatesPaged(String poolId,
 Boolean scheduled)

List all agent pool updates (Paginated) Lists all agent pool updates This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

scheduled - Return only scheduled or ad-hoc updates. If this parameter isn't provided, Okta returns the entire list of updates. (optional)

Returns:

Iterable<AgentPoolUpdate> lazy iterable over all pages

listAgentPoolsUpdatesPaged

public Iterable<AgentPoolUpdate> listAgentPoolsUpdatesPaged(String poolId,
 Boolean scheduled,
 Map<String,String> additionalHeaders)

List all agent pool updates (Paginated with additional headers) Lists all agent pool updates This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

scheduled - Return only scheduled or ad-hoc updates. If this parameter isn't provided, Okta returns the entire list of updates. (optional)

additionalHeaders - additional headers for this call

Returns:

Iterable<AgentPoolUpdate> lazy iterable over all pages

pauseAgentPoolsUpdate

public AgentPoolUpdate pauseAgentPoolsUpdate(String poolId,
 String updateId)
                                      throws ApiException

Pause an agent pool update Pauses a running or queued agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

pauseAgentPoolsUpdate

public AgentPoolUpdate pauseAgentPoolsUpdate(String poolId,
 String updateId,
 Map<String,String> additionalHeaders)
                                      throws ApiException

Pause an agent pool update Pauses a running or queued agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

additionalHeaders - additionalHeaders for this call

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

resumeAgentPoolsUpdate

public AgentPoolUpdate resumeAgentPoolsUpdate(String poolId,
 String updateId)
                                       throws ApiException

Resume an agent pool update Resumes a running or queued agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

resumeAgentPoolsUpdate

public AgentPoolUpdate resumeAgentPoolsUpdate(String poolId,
 String updateId,
 Map<String,String> additionalHeaders)
                                       throws ApiException

Resume an agent pool update Resumes a running or queued agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

additionalHeaders - additionalHeaders for this call

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

retryAgentPoolsUpdate

public AgentPoolUpdate retryAgentPoolsUpdate(String poolId,
 String updateId)
                                      throws ApiException

Retry an agent pool update Retries an agent pool update if the update is unsuccessful or communication with Okta was interrupted during an agent auto-update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

retryAgentPoolsUpdate

public AgentPoolUpdate retryAgentPoolsUpdate(String poolId,
 String updateId,
 Map<String,String> additionalHeaders)
                                      throws ApiException

Retry an agent pool update Retries an agent pool update if the update is unsuccessful or communication with Okta was interrupted during an agent auto-update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

additionalHeaders - additionalHeaders for this call

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

stopAgentPoolsUpdate

public AgentPoolUpdate stopAgentPoolsUpdate(String poolId,
 String updateId)
                                     throws ApiException

Stop an agent pool update Stops an agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

stopAgentPoolsUpdate

public AgentPoolUpdate stopAgentPoolsUpdate(String poolId,
 String updateId,
 Map<String,String> additionalHeaders)
                                     throws ApiException

Stop an agent pool update Stops an agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

additionalHeaders - additionalHeaders for this call

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

updateAgentPoolsUpdate

public AgentPoolUpdate updateAgentPoolsUpdate(String poolId,
 String updateId,
 AgentPoolUpdate agentPoolUpdate)
                                       throws ApiException

Update an agent pool update by ID Updates an agent pool update instance and returns the latest agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

agentPoolUpdate - (required)

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

updateAgentPoolsUpdate

public AgentPoolUpdate updateAgentPoolsUpdate(String poolId,
 String updateId,
 AgentPoolUpdate agentPoolUpdate,
 Map<String,String> additionalHeaders)
                                       throws ApiException

Update an agent pool update by ID Updates an agent pool update instance and returns the latest agent pool update

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

updateId - ID of the update (required)

agentPoolUpdate - (required)

additionalHeaders - additionalHeaders for this call

Returns:

AgentPoolUpdate

Throws:

ApiException - if fails to make API call

updateAgentPoolsUpdateSettings

public AgentPoolUpdateSetting updateAgentPoolsUpdateSettings(String poolId,
 AgentPoolUpdateSetting agentPoolUpdateSetting)
                                                      throws ApiException

Update an agent pool update settings Updates an agent pool update instance settings

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

agentPoolUpdateSetting - (required)

Returns:

AgentPoolUpdateSetting

Throws:

ApiException - if fails to make API call

updateAgentPoolsUpdateSettings

public AgentPoolUpdateSetting updateAgentPoolsUpdateSettings(String poolId,
 AgentPoolUpdateSetting agentPoolUpdateSetting,
 Map<String,String> additionalHeaders)
                                                      throws ApiException

Update an agent pool update settings Updates an agent pool update instance settings

Parameters:

poolId - ID of the agent pool for which the settings apply to (required)

agentPoolUpdateSetting - (required)

additionalHeaders - additionalHeaders for this call

Returns:

AgentPoolUpdateSetting

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()