org.openapitools.client.api

Class PrincipalRateLimitApi

java.lang.Object

org.openapitools.client.api.PrincipalRateLimitApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-10-28T09:54:00.189-05:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.PrincipalRateLimitApi")
public class PrincipalRateLimitApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PrincipalRateLimitApi()
PrincipalRateLimitApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
<T> T	createPrincipalRateLimitEntity(java.lang.Class<?> T, PrincipalRateLimitEntity entity) Create a Principal Rate Limit Creates a new Principal Rate Limit entity.
PrincipalRateLimitEntity	createPrincipalRateLimitEntity(PrincipalRateLimitEntity entity) Create a Principal Rate Limit Creates a new Principal Rate Limit entity.
PagedList	createPrincipalRateLimitEntityWithPaginationInfo(PrincipalRateLimitEntity entity) Create a Principal Rate Limit Creates a new Principal Rate Limit entity.
ApiClient	getApiClient()
PrincipalRateLimitEntity	getPrincipalRateLimitEntity(java.lang.String principalRateLimitId) Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`
PagedList	getPrincipalRateLimitEntityWithPaginationInfo(java.lang.String principalRateLimitId) Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`
java.util.List<PrincipalRateLimitEntity>	listPrincipalRateLimitEntities(java.lang.String filter, java.lang.String after, java.lang.Integer limit) List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parameters
PagedList	listPrincipalRateLimitEntitiesWithPaginationInfo(java.lang.String filter, java.lang.String after, java.lang.Integer limit) List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parameters
<T> T	replacePrincipalRateLimitEntity(java.lang.Class<?> T, java.lang.String principalRateLimitId, PrincipalRateLimitEntity entity) Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`
PrincipalRateLimitEntity	replacePrincipalRateLimitEntity(java.lang.String principalRateLimitId, PrincipalRateLimitEntity entity) Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`
PagedList	replacePrincipalRateLimitEntityWithPaginationInfo(java.lang.String principalRateLimitId, PrincipalRateLimitEntity entity) Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PrincipalRateLimitApi

public PrincipalRateLimitApi()

PrincipalRateLimitApi

@Autowired
public PrincipalRateLimitApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createPrincipalRateLimitEntity

public PrincipalRateLimitEntity createPrincipalRateLimitEntity(PrincipalRateLimitEntity entity)
                                                        throws org.springframework.web.client.RestClientException

Create a Principal Rate Limit Creates a new Principal Rate Limit entity. In the current release, we only allow one Principal Rate Limit entity per org and principal.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

entity - (required)

Returns:

PrincipalRateLimitEntity

Throws:

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

createPrincipalRateLimitEntity

public <T> T createPrincipalRateLimitEntity(java.lang.Class<?> T,
                                            PrincipalRateLimitEntity entity)
                                     throws org.springframework.web.client.RestClientException

Create a Principal Rate Limit Creates a new Principal Rate Limit entity. In the current release, we only allow one Principal Rate Limit entity per org and principal.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

entity - (required)

Returns:

T instance

Throws:

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

createPrincipalRateLimitEntityWithPaginationInfo

public PagedList createPrincipalRateLimitEntityWithPaginationInfo(PrincipalRateLimitEntity entity)
                                                           throws org.springframework.web.client.RestClientException

Create a Principal Rate Limit Creates a new Principal Rate Limit entity. In the current release, we only allow one Principal Rate Limit entity per org and principal.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

entity - (required)

Returns:

ResponseEntity<PrincipalRateLimitEntity>

Throws:

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

getPrincipalRateLimitEntity

public PrincipalRateLimitEntity getPrincipalRateLimitEntity(java.lang.String principalRateLimitId)
                                                     throws org.springframework.web.client.RestClientException

Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

Returns:

PrincipalRateLimitEntity

Throws:

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

getPrincipalRateLimitEntityWithPaginationInfo

public PagedList getPrincipalRateLimitEntityWithPaginationInfo(java.lang.String principalRateLimitId)
                                                        throws org.springframework.web.client.RestClientException

Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

Returns:

ResponseEntity<PrincipalRateLimitEntity>

Throws:

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

listPrincipalRateLimitEntities

public java.util.List<PrincipalRateLimitEntity> listPrincipalRateLimitEntities(java.lang.String filter,
                                                                               java.lang.String after,
                                                                               java.lang.Integer limit)
                                                                        throws org.springframework.web.client.RestClientException

List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parameters

200 - OK

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

filter - (optional)

after - (optional)

limit - (optional, default to 20)

Returns:

List<PrincipalRateLimitEntity>

Throws:

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

listPrincipalRateLimitEntitiesWithPaginationInfo

public PagedList listPrincipalRateLimitEntitiesWithPaginationInfo(java.lang.String filter,
                                                                  java.lang.String after,
                                                                  java.lang.Integer limit)
                                                           throws org.springframework.web.client.RestClientException

List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parameters

200 - OK

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

filter - (optional)

after - (optional)

limit - (optional, default to 20)

Returns:

ResponseEntity<List<PrincipalRateLimitEntity>>

Throws:

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

replacePrincipalRateLimitEntity

public PrincipalRateLimitEntity replacePrincipalRateLimitEntity(java.lang.String principalRateLimitId,
                                                                PrincipalRateLimitEntity entity)
                                                         throws org.springframework.web.client.RestClientException

Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

entity - (required)

Returns:

PrincipalRateLimitEntity

Throws:

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

replacePrincipalRateLimitEntity

public <T> T replacePrincipalRateLimitEntity(java.lang.Class<?> T,
                                             java.lang.String principalRateLimitId,
                                             PrincipalRateLimitEntity entity)
                                      throws org.springframework.web.client.RestClientException

Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

principalRateLimitId - id of the Principal Rate Limit (required)

entity - (required)

Returns:

T instance

Throws:

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

replacePrincipalRateLimitEntityWithPaginationInfo

public PagedList replacePrincipalRateLimitEntityWithPaginationInfo(java.lang.String principalRateLimitId,
                                                                   PrincipalRateLimitEntity entity)
                                                            throws org.springframework.web.client.RestClientException

Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

entity - (required)

Returns:

ResponseEntity<PrincipalRateLimitEntity>

Throws:

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