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="2024-09-23T08:35:59.300824-05:00[America/Chicago]", comments="Generator version: 7.8.0") public class AgentPoolsApi extends Object

  • 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 scheduled Agent pool update
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 scheduled Agent pool update
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 \\n For user flow 2 manual update, starts the update immediately. \\n For user flow 3, schedules the update based on the configured update window and delay.
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 \\n For user flow 2 manual update, starts the update immediately. \\n For user flow 3, schedules the update based on the configured update window and delay.
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 will apply (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 will apply (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 will apply (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 will apply (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 Agent pool update from updateId
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 Agent pool update from updateId
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 will apply (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 will apply (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 AgentPools being 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). (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 AgentPools being 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). (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<AgentPool>
      Throws:
      ApiException - if fails to make API call

    • 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 will apply (required)
      scheduled - Scope the list only to scheduled or ad-hoc updates. If the parameter is not provided we will return the whole 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 will apply (required)
      scheduled - Scope the list only to scheduled or ad-hoc updates. If the parameter is not provided we will return the whole list of updates. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<AgentPoolUpdate>
      Throws:
      ApiException - if fails to make API call

    • pauseAgentPoolsUpdate

      public AgentPoolUpdate pauseAgentPoolsUpdate(String poolId, String updateId) throws ApiException
      Pause an Agent Pool update Pauses running or queued Agent pool update
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 running or queued Agent pool update
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 running or queued Agent pool update
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 running or queued Agent pool update
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 Agent pool update
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 Agent pool update
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 Agent pool update
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 Agent pool update
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 Agent pool update and return latest agent pool update
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 Agent pool update and return latest agent pool update
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 settings
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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 settings
      Parameters:
      poolId - Id of the agent pool for which the settings will apply (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()