Package org.openapitools.client.api

Class AgentPoolsApi

java.lang.Object

org.openapitools.client.api.AgentPoolsApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-04-19T09:13:44.263607-05:00[America/Chicago]")
@Component("org.openapitools.client.api.AgentPoolsApi")
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 scheduled Agent pool update
org.springframework.http.ResponseEntity<AgentPoolUpdate>	activateAgentPoolsUpdateWithHttpInfo(String poolId, String updateId)	Activate an Agent Pool update Activates scheduled Agent pool update
PagedList	activateAgentPoolsUpdateWithPaginationInfo(String poolId, String updateId)	Activate an Agent Pool update Activates scheduled Agent pool update
<T> T	createAgentPoolsUpdate(Class<?> T, String poolId, AgentPoolUpdate agentPoolUpdate)	Create an Agent Pool update Creates an Agent pool update \\n For user flow 2 manual update, starts the update immediately.
AgentPoolUpdate	createAgentPoolsUpdate(String poolId, AgentPoolUpdate agentPoolUpdate)	Create an Agent Pool update Creates an Agent pool update \\n For user flow 2 manual update, starts the update immediately.
org.springframework.http.ResponseEntity<AgentPoolUpdate>	createAgentPoolsUpdateWithHttpInfo(String poolId, AgentPoolUpdate agentPoolUpdate)	Create an Agent Pool update Creates an Agent pool update \\n For user flow 2 manual update, starts the update immediately.
PagedList	createAgentPoolsUpdateWithPaginationInfo(String poolId, AgentPoolUpdate agentPoolUpdate)	Create an Agent Pool update Creates an Agent pool update \\n For user flow 2 manual update, starts the update immediately.
AgentPoolUpdate	deactivateAgentPoolsUpdate(String poolId, String updateId)	Deactivate an Agent Pool update Deactivates scheduled Agent pool update
org.springframework.http.ResponseEntity<AgentPoolUpdate>	deactivateAgentPoolsUpdateWithHttpInfo(String poolId, String updateId)	Deactivate an Agent Pool update Deactivates scheduled Agent pool update
PagedList	deactivateAgentPoolsUpdateWithPaginationInfo(String poolId, String updateId)	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
org.springframework.http.ResponseEntity<Void>	deleteAgentPoolsUpdateWithHttpInfo(String poolId, String updateId)	Delete an Agent Pool update Deletes Agent pool update
AgentPoolUpdate	getAgentPoolsUpdateInstance(String poolId, String updateId)	Retrieve an Agent Pool update by id Retrieves Agent pool update from updateId
org.springframework.http.ResponseEntity<AgentPoolUpdate>	getAgentPoolsUpdateInstanceWithHttpInfo(String poolId, String updateId)	Retrieve an Agent Pool update by id Retrieves Agent pool update from updateId
PagedList	getAgentPoolsUpdateInstanceWithPaginationInfo(String poolId, String updateId)	Retrieve an Agent Pool update by id Retrieves Agent pool update from updateId
AgentPoolUpdateSetting	getAgentPoolsUpdateSettings(String poolId)	Retrieve an Agent Pool update's settings Retrieves the current state of the agent pool update instance settings
org.springframework.http.ResponseEntity<AgentPoolUpdateSetting>	getAgentPoolsUpdateSettingsWithHttpInfo(String poolId)	Retrieve an Agent Pool update's settings Retrieves the current state of the agent pool update instance settings
PagedList	getAgentPoolsUpdateSettingsWithPaginationInfo(String poolId)	Retrieve an Agent Pool update's settings Retrieves the current state of the agent pool update instance settings
ApiClient	getApiClient()
List<AgentPool>	listAgentPools(Integer limitPerPoolType, AgentType poolType, String after)	List all Agent Pools Lists all agent pools with pagination support
List<AgentPoolUpdate>	listAgentPoolsUpdates(String poolId, Boolean scheduled)	List all Agent Pool updates Lists all agent pool updates
org.springframework.http.ResponseEntity<List<AgentPoolUpdate>>	listAgentPoolsUpdatesWithHttpInfo(String poolId, Boolean scheduled)	List all Agent Pool updates Lists all agent pool updates
PagedList	listAgentPoolsUpdatesWithPaginationInfo(String poolId, Boolean scheduled)	List all Agent Pool updates Lists all agent pool updates
org.springframework.http.ResponseEntity<List<AgentPool>>	listAgentPoolsWithHttpInfo(Integer limitPerPoolType, AgentType poolType, String after)	List all Agent Pools Lists all agent pools with pagination support
PagedList	listAgentPoolsWithPaginationInfo(Integer limitPerPoolType, AgentType poolType, String after)	List all Agent Pools Lists all agent pools with pagination support
AgentPoolUpdate	pauseAgentPoolsUpdate(String poolId, String updateId)	Pause an Agent Pool update Pauses running or queued Agent pool update
org.springframework.http.ResponseEntity<AgentPoolUpdate>	pauseAgentPoolsUpdateWithHttpInfo(String poolId, String updateId)	Pause an Agent Pool update Pauses running or queued Agent pool update
PagedList	pauseAgentPoolsUpdateWithPaginationInfo(String poolId, String updateId)	Pause an Agent Pool update Pauses running or queued Agent pool update
AgentPoolUpdate	resumeAgentPoolsUpdate(String poolId, String updateId)	Resume an Agent Pool update Resumes running or queued Agent pool update
org.springframework.http.ResponseEntity<AgentPoolUpdate>	resumeAgentPoolsUpdateWithHttpInfo(String poolId, String updateId)	Resume an Agent Pool update Resumes running or queued Agent pool update
PagedList	resumeAgentPoolsUpdateWithPaginationInfo(String poolId, String updateId)	Resume an Agent Pool update Resumes running or queued Agent pool update
AgentPoolUpdate	retryAgentPoolsUpdate(String poolId, String updateId)	Retry an Agent Pool update Retries Agent pool update
org.springframework.http.ResponseEntity<AgentPoolUpdate>	retryAgentPoolsUpdateWithHttpInfo(String poolId, String updateId)	Retry an Agent Pool update Retries Agent pool update
PagedList	retryAgentPoolsUpdateWithPaginationInfo(String poolId, String updateId)	Retry an Agent Pool update Retries Agent pool update
void	setApiClient(ApiClient apiClient)
AgentPoolUpdate	stopAgentPoolsUpdate(String poolId, String updateId)	Stop an Agent Pool update Stops Agent pool update
org.springframework.http.ResponseEntity<AgentPoolUpdate>	stopAgentPoolsUpdateWithHttpInfo(String poolId, String updateId)	Stop an Agent Pool update Stops Agent pool update
PagedList	stopAgentPoolsUpdateWithPaginationInfo(String poolId, String updateId)	Stop an Agent Pool update Stops Agent pool update
<T> T	updateAgentPoolsUpdate(Class<?> T, String poolId, String updateId, AgentPoolUpdate agentPoolUpdate)	Update an Agent Pool update by id Updates Agent pool update and return latest agent pool update
AgentPoolUpdate	updateAgentPoolsUpdate(String poolId, String updateId, AgentPoolUpdate agentPoolUpdate)	Update an Agent Pool update by id Updates Agent pool update and return latest agent pool update
<T> T	updateAgentPoolsUpdateSettings(Class<?> T, String poolId, AgentPoolUpdateSetting agentPoolUpdateSetting)	Update an Agent Pool update settings Updates an agent pool update settings
AgentPoolUpdateSetting	updateAgentPoolsUpdateSettings(String poolId, AgentPoolUpdateSetting agentPoolUpdateSetting)	Update an Agent Pool update settings Updates an agent pool update settings
org.springframework.http.ResponseEntity<AgentPoolUpdateSetting>	updateAgentPoolsUpdateSettingsWithHttpInfo(String poolId, AgentPoolUpdateSetting agentPoolUpdateSetting)	Update an Agent Pool update settings Updates an agent pool update settings
PagedList	updateAgentPoolsUpdateSettingsWithPaginationInfo(String poolId, AgentPoolUpdateSetting agentPoolUpdateSetting)	Update an Agent Pool update settings Updates an agent pool update settings
org.springframework.http.ResponseEntity<AgentPoolUpdate>	updateAgentPoolsUpdateWithHttpInfo(String poolId, String updateId, AgentPoolUpdate agentPoolUpdate)	Update an Agent Pool update by id Updates Agent pool update and return latest agent pool update
PagedList	updateAgentPoolsUpdateWithPaginationInfo(String poolId, String updateId, AgentPoolUpdate agentPoolUpdate)	Update an Agent Pool update by id Updates Agent pool update and return latest agent pool update

Methods inherited from class java.lang.Object

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

Constructor Details

AgentPoolsApi

public AgentPoolsApi()

AgentPoolsApi

@Autowired
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 org.springframework.web.client.RestClientException

Activate an Agent Pool update Activates scheduled Agent pool update

201 - Activated

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

AgentPoolUpdate

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

activateAgentPoolsUpdateWithHttpInfo

public org.springframework.http.ResponseEntity<AgentPoolUpdate> activateAgentPoolsUpdateWithHttpInfo(String poolId,
 String updateId)
                                                                                              throws org.springframework.web.client.RestClientException

Activate an Agent Pool update Activates scheduled Agent pool update

201 - Activated

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

activateAgentPoolsUpdateWithPaginationInfo

public PagedList activateAgentPoolsUpdateWithPaginationInfo(String poolId,
 String updateId)
                                                     throws org.springframework.web.client.RestClientException

Activate an Agent Pool update Activates scheduled Agent pool update

201 - Activated

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createAgentPoolsUpdate

public AgentPoolUpdate createAgentPoolsUpdate(String poolId,
 AgentPoolUpdate agentPoolUpdate)
                                       throws org.springframework.web.client.RestClientException

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.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

agentPoolUpdate - (required)

Returns:

AgentPoolUpdate

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createAgentPoolsUpdate

public <T> T createAgentPoolsUpdate(Class<?> T,
 String poolId,
 AgentPoolUpdate agentPoolUpdate)
                             throws org.springframework.web.client.RestClientException

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.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

poolId - Id of the agent pool for which the settings will apply (required)

agentPoolUpdate - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createAgentPoolsUpdateWithHttpInfo

public org.springframework.http.ResponseEntity<AgentPoolUpdate> createAgentPoolsUpdateWithHttpInfo(String poolId,
 AgentPoolUpdate agentPoolUpdate)
                                                                                            throws org.springframework.web.client.RestClientException

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.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

agentPoolUpdate - (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createAgentPoolsUpdateWithPaginationInfo

public PagedList createAgentPoolsUpdateWithPaginationInfo(String poolId,
 AgentPoolUpdate agentPoolUpdate)
                                                   throws org.springframework.web.client.RestClientException

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.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

agentPoolUpdate - (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivateAgentPoolsUpdate

public AgentPoolUpdate deactivateAgentPoolsUpdate(String poolId,
 String updateId)
                                           throws org.springframework.web.client.RestClientException

Deactivate an Agent Pool update Deactivates scheduled Agent pool update

201 - Deactivated

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

AgentPoolUpdate

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivateAgentPoolsUpdateWithHttpInfo

public org.springframework.http.ResponseEntity<AgentPoolUpdate> deactivateAgentPoolsUpdateWithHttpInfo(String poolId,
 String updateId)
                                                                                                throws org.springframework.web.client.RestClientException

Deactivate an Agent Pool update Deactivates scheduled Agent pool update

201 - Deactivated

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivateAgentPoolsUpdateWithPaginationInfo

public PagedList deactivateAgentPoolsUpdateWithPaginationInfo(String poolId,
 String updateId)
                                                       throws org.springframework.web.client.RestClientException

Deactivate an Agent Pool update Deactivates scheduled Agent pool update

201 - Deactivated

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteAgentPoolsUpdate

public void deleteAgentPoolsUpdate(String poolId,
 String updateId)
                            throws org.springframework.web.client.RestClientException

Delete an Agent Pool update Deletes Agent pool update

204 - Deleted

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteAgentPoolsUpdateWithHttpInfo

public org.springframework.http.ResponseEntity<Void> deleteAgentPoolsUpdateWithHttpInfo(String poolId,
 String updateId)
                                                                                 throws org.springframework.web.client.RestClientException

Delete an Agent Pool update Deletes Agent pool update

204 - Deleted

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<Void>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getAgentPoolsUpdateInstance

public AgentPoolUpdate getAgentPoolsUpdateInstance(String poolId,
 String updateId)
                                            throws org.springframework.web.client.RestClientException

Retrieve an Agent Pool update by id Retrieves Agent pool update from updateId

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

AgentPoolUpdate

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getAgentPoolsUpdateInstanceWithHttpInfo

public org.springframework.http.ResponseEntity<AgentPoolUpdate> getAgentPoolsUpdateInstanceWithHttpInfo(String poolId,
 String updateId)
                                                                                                 throws org.springframework.web.client.RestClientException

Retrieve an Agent Pool update by id Retrieves Agent pool update from updateId

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getAgentPoolsUpdateInstanceWithPaginationInfo

public PagedList getAgentPoolsUpdateInstanceWithPaginationInfo(String poolId,
 String updateId)
                                                        throws org.springframework.web.client.RestClientException

Retrieve an Agent Pool update by id Retrieves Agent pool update from updateId

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getAgentPoolsUpdateSettings

public AgentPoolUpdateSetting getAgentPoolsUpdateSettings(String poolId)
                                                   throws org.springframework.web.client.RestClientException

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

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

Returns:

AgentPoolUpdateSetting

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getAgentPoolsUpdateSettingsWithHttpInfo

public org.springframework.http.ResponseEntity<AgentPoolUpdateSetting> getAgentPoolsUpdateSettingsWithHttpInfo(String poolId)
                                                                                                        throws org.springframework.web.client.RestClientException

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

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

Returns:

ResponseEntity<AgentPoolUpdateSetting>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getAgentPoolsUpdateSettingsWithPaginationInfo

public PagedList getAgentPoolsUpdateSettingsWithPaginationInfo(String poolId)
                                                        throws org.springframework.web.client.RestClientException

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

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

Returns:

ResponseEntity<AgentPoolUpdateSetting>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAgentPools

public List<AgentPool> listAgentPools(Integer limitPerPoolType,
 AgentType poolType,
 String after)
                               throws org.springframework.web.client.RestClientException

List all Agent Pools Lists all agent pools with pagination support

200 - OK

403 - Forbidden

429 - Too Many Requests

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](/#pagination) for more information. (optional)

Returns:

List<AgentPool>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAgentPoolsWithHttpInfo

public org.springframework.http.ResponseEntity<List<AgentPool>> listAgentPoolsWithHttpInfo(Integer limitPerPoolType,
 AgentType poolType,
 String after)
                                                                                    throws org.springframework.web.client.RestClientException

List all Agent Pools Lists all agent pools with pagination support

200 - OK

403 - Forbidden

429 - Too Many Requests

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](/#pagination) for more information. (optional)

Returns:

ResponseEntity<List<AgentPool>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAgentPoolsWithPaginationInfo

public PagedList listAgentPoolsWithPaginationInfo(Integer limitPerPoolType,
 AgentType poolType,
 String after)
                                           throws org.springframework.web.client.RestClientException

List all Agent Pools Lists all agent pools with pagination support

200 - OK

403 - Forbidden

429 - Too Many Requests

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](/#pagination) for more information. (optional)

Returns:

ResponseEntity<List<AgentPool>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAgentPoolsUpdates

public List<AgentPoolUpdate> listAgentPoolsUpdates(String poolId,
 Boolean scheduled)
                                            throws org.springframework.web.client.RestClientException

List all Agent Pool updates Lists all agent pool updates

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

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:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAgentPoolsUpdatesWithHttpInfo

public org.springframework.http.ResponseEntity<List<AgentPoolUpdate>> listAgentPoolsUpdatesWithHttpInfo(String poolId,
 Boolean scheduled)
                                                                                                 throws org.springframework.web.client.RestClientException

List all Agent Pool updates Lists all agent pool updates

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

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:

ResponseEntity<List<AgentPoolUpdate>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAgentPoolsUpdatesWithPaginationInfo

public PagedList listAgentPoolsUpdatesWithPaginationInfo(String poolId,
 Boolean scheduled)
                                                  throws org.springframework.web.client.RestClientException

List all Agent Pool updates Lists all agent pool updates

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

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:

ResponseEntity<List<AgentPoolUpdate>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

pauseAgentPoolsUpdate

public AgentPoolUpdate pauseAgentPoolsUpdate(String poolId,
 String updateId)
                                      throws org.springframework.web.client.RestClientException

Pause an Agent Pool update Pauses running or queued Agent pool update

201 - Paused

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

AgentPoolUpdate

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

pauseAgentPoolsUpdateWithHttpInfo

public org.springframework.http.ResponseEntity<AgentPoolUpdate> pauseAgentPoolsUpdateWithHttpInfo(String poolId,
 String updateId)
                                                                                           throws org.springframework.web.client.RestClientException

Pause an Agent Pool update Pauses running or queued Agent pool update

201 - Paused

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

pauseAgentPoolsUpdateWithPaginationInfo

public PagedList pauseAgentPoolsUpdateWithPaginationInfo(String poolId,
 String updateId)
                                                  throws org.springframework.web.client.RestClientException

Pause an Agent Pool update Pauses running or queued Agent pool update

201 - Paused

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

resumeAgentPoolsUpdate

public AgentPoolUpdate resumeAgentPoolsUpdate(String poolId,
 String updateId)
                                       throws org.springframework.web.client.RestClientException

Resume an Agent Pool update Resumes running or queued Agent pool update

201 - Resumed

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

AgentPoolUpdate

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

resumeAgentPoolsUpdateWithHttpInfo

public org.springframework.http.ResponseEntity<AgentPoolUpdate> resumeAgentPoolsUpdateWithHttpInfo(String poolId,
 String updateId)
                                                                                            throws org.springframework.web.client.RestClientException

Resume an Agent Pool update Resumes running or queued Agent pool update

201 - Resumed

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

resumeAgentPoolsUpdateWithPaginationInfo

public PagedList resumeAgentPoolsUpdateWithPaginationInfo(String poolId,
 String updateId)
                                                   throws org.springframework.web.client.RestClientException

Resume an Agent Pool update Resumes running or queued Agent pool update

201 - Resumed

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

retryAgentPoolsUpdate

public AgentPoolUpdate retryAgentPoolsUpdate(String poolId,
 String updateId)
                                      throws org.springframework.web.client.RestClientException

Retry an Agent Pool update Retries Agent pool update

201 - Retried

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

AgentPoolUpdate

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

retryAgentPoolsUpdateWithHttpInfo

public org.springframework.http.ResponseEntity<AgentPoolUpdate> retryAgentPoolsUpdateWithHttpInfo(String poolId,
 String updateId)
                                                                                           throws org.springframework.web.client.RestClientException

Retry an Agent Pool update Retries Agent pool update

201 - Retried

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

retryAgentPoolsUpdateWithPaginationInfo

public PagedList retryAgentPoolsUpdateWithPaginationInfo(String poolId,
 String updateId)
                                                  throws org.springframework.web.client.RestClientException

Retry an Agent Pool update Retries Agent pool update

201 - Retried

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

stopAgentPoolsUpdate

public AgentPoolUpdate stopAgentPoolsUpdate(String poolId,
 String updateId)
                                     throws org.springframework.web.client.RestClientException

Stop an Agent Pool update Stops Agent pool update

201 - Stopped

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

AgentPoolUpdate

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

stopAgentPoolsUpdateWithHttpInfo

public org.springframework.http.ResponseEntity<AgentPoolUpdate> stopAgentPoolsUpdateWithHttpInfo(String poolId,
 String updateId)
                                                                                          throws org.springframework.web.client.RestClientException

Stop an Agent Pool update Stops Agent pool update

201 - Stopped

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

stopAgentPoolsUpdateWithPaginationInfo

public PagedList stopAgentPoolsUpdateWithPaginationInfo(String poolId,
 String updateId)
                                                 throws org.springframework.web.client.RestClientException

Stop an Agent Pool update Stops Agent pool update

201 - Stopped

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateAgentPoolsUpdate

public AgentPoolUpdate updateAgentPoolsUpdate(String poolId,
 String updateId,
 AgentPoolUpdate agentPoolUpdate)
                                       throws org.springframework.web.client.RestClientException

Update an Agent Pool update by id Updates Agent pool update and return latest agent pool update

201 - Updated

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

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:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateAgentPoolsUpdate

public <T> T updateAgentPoolsUpdate(Class<?> T,
 String poolId,
 String updateId,
 AgentPoolUpdate agentPoolUpdate)
                             throws org.springframework.web.client.RestClientException

Update an Agent Pool update by id Updates Agent pool update and return latest agent pool update

201 - Updated

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

agentPoolUpdate - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateAgentPoolsUpdateWithHttpInfo

public org.springframework.http.ResponseEntity<AgentPoolUpdate> updateAgentPoolsUpdateWithHttpInfo(String poolId,
 String updateId,
 AgentPoolUpdate agentPoolUpdate)
                                                                                            throws org.springframework.web.client.RestClientException

Update an Agent Pool update by id Updates Agent pool update and return latest agent pool update

201 - Updated

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

agentPoolUpdate - (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateAgentPoolsUpdateWithPaginationInfo

public PagedList updateAgentPoolsUpdateWithPaginationInfo(String poolId,
 String updateId,
 AgentPoolUpdate agentPoolUpdate)
                                                   throws org.springframework.web.client.RestClientException

Update an Agent Pool update by id Updates Agent pool update and return latest agent pool update

201 - Updated

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

updateId - Id of the update (required)

agentPoolUpdate - (required)

Returns:

ResponseEntity<AgentPoolUpdate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateAgentPoolsUpdateSettings

public AgentPoolUpdateSetting updateAgentPoolsUpdateSettings(String poolId,
 AgentPoolUpdateSetting agentPoolUpdateSetting)
                                                      throws org.springframework.web.client.RestClientException

Update an Agent Pool update settings Updates an agent pool update settings

201 - Updated

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

agentPoolUpdateSetting - (required)

Returns:

AgentPoolUpdateSetting

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateAgentPoolsUpdateSettings

public <T> T updateAgentPoolsUpdateSettings(Class<?> T,
 String poolId,
 AgentPoolUpdateSetting agentPoolUpdateSetting)
                                     throws org.springframework.web.client.RestClientException

Update an Agent Pool update settings Updates an agent pool update settings

201 - Updated

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

poolId - Id of the agent pool for which the settings will apply (required)

agentPoolUpdateSetting - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateAgentPoolsUpdateSettingsWithHttpInfo

public org.springframework.http.ResponseEntity<AgentPoolUpdateSetting> updateAgentPoolsUpdateSettingsWithHttpInfo(String poolId,
 AgentPoolUpdateSetting agentPoolUpdateSetting)
                                                                                                           throws org.springframework.web.client.RestClientException

Update an Agent Pool update settings Updates an agent pool update settings

201 - Updated

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

agentPoolUpdateSetting - (required)

Returns:

ResponseEntity<AgentPoolUpdateSetting>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateAgentPoolsUpdateSettingsWithPaginationInfo

public PagedList updateAgentPoolsUpdateSettingsWithPaginationInfo(String poolId,
 AgentPoolUpdateSetting agentPoolUpdateSetting)
                                                           throws org.springframework.web.client.RestClientException

Update an Agent Pool update settings Updates an agent pool update settings

201 - Updated

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

poolId - Id of the agent pool for which the settings will apply (required)

agentPoolUpdateSetting - (required)

Returns:

ResponseEntity<AgentPoolUpdateSetting>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API