org.openapitools.client.api

Class PrincipalRateLimitApi

java.lang.Object

org.openapitools.client.api.PrincipalRateLimitApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
public class PrincipalRateLimitApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PrincipalRateLimitApi()
PrincipalRateLimitApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
PrincipalRateLimitEntity	createPrincipalRateLimitEntity(PrincipalRateLimitEntity entity) Create a Principal Rate Limit Creates a new Principal Rate Limit entity.
PrincipalRateLimitEntity	createPrincipalRateLimitEntity(PrincipalRateLimitEntity entity, Map<String,String> additionalHeaders) Create a Principal Rate Limit Creates a new Principal Rate Limit entity.
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
PrincipalRateLimitEntity	getPrincipalRateLimitEntity(String principalRateLimitId) Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`
PrincipalRateLimitEntity	getPrincipalRateLimitEntity(String principalRateLimitId, Map<String,String> additionalHeaders) Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`
List<PrincipalRateLimitEntity>	listPrincipalRateLimitEntities(String filter, String after, Integer limit) List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parameters
List<PrincipalRateLimitEntity>	listPrincipalRateLimitEntities(String filter, String after, Integer limit, Map<String,String> additionalHeaders) List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parameters
PrincipalRateLimitEntity	replacePrincipalRateLimitEntity(String principalRateLimitId, PrincipalRateLimitEntity entity) Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`
PrincipalRateLimitEntity	replacePrincipalRateLimitEntity(String principalRateLimitId, PrincipalRateLimitEntity entity, Map<String,String> additionalHeaders) 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

public PrincipalRateLimitApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createPrincipalRateLimitEntity

public PrincipalRateLimitEntity createPrincipalRateLimitEntity(PrincipalRateLimitEntity entity)
                                                        throws ApiException

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.

Parameters:

entity - (required)

Returns:

PrincipalRateLimitEntity

Throws:

ApiException - if fails to make API call

createPrincipalRateLimitEntity

public PrincipalRateLimitEntity createPrincipalRateLimitEntity(PrincipalRateLimitEntity entity,
                                                               Map<String,String> additionalHeaders)
                                                        throws ApiException

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.

Parameters:

entity - (required)

additionalHeaders - additionalHeaders for this call

Returns:

PrincipalRateLimitEntity

Throws:

ApiException - if fails to make API call

getPrincipalRateLimitEntity

public PrincipalRateLimitEntity getPrincipalRateLimitEntity(String principalRateLimitId)
                                                     throws ApiException

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

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

Returns:

PrincipalRateLimitEntity

Throws:

ApiException - if fails to make API call

getPrincipalRateLimitEntity

public PrincipalRateLimitEntity getPrincipalRateLimitEntity(String principalRateLimitId,
                                                            Map<String,String> additionalHeaders)
                                                     throws ApiException

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

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

additionalHeaders - additionalHeaders for this call

Returns:

PrincipalRateLimitEntity

Throws:

ApiException - if fails to make API call

listPrincipalRateLimitEntities

public List<PrincipalRateLimitEntity> listPrincipalRateLimitEntities(String filter,
                                                                     String after,
                                                                     Integer limit)
                                                              throws ApiException

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

Parameters:

filter - (optional)

after - (optional)

limit - (optional, default to 20)

Returns:

List<PrincipalRateLimitEntity>

Throws:

ApiException - if fails to make API call

listPrincipalRateLimitEntities

public List<PrincipalRateLimitEntity> listPrincipalRateLimitEntities(String filter,
                                                                     String after,
                                                                     Integer limit,
                                                                     Map<String,String> additionalHeaders)
                                                              throws ApiException

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

Parameters:

filter - (optional)

after - (optional)

limit - (optional, default to 20)

additionalHeaders - additionalHeaders for this call

Returns:

List<PrincipalRateLimitEntity>

Throws:

ApiException - if fails to make API call

replacePrincipalRateLimitEntity

public PrincipalRateLimitEntity replacePrincipalRateLimitEntity(String principalRateLimitId,
                                                                PrincipalRateLimitEntity entity)
                                                         throws ApiException

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

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

entity - (required)

Returns:

PrincipalRateLimitEntity

Throws:

ApiException - if fails to make API call

replacePrincipalRateLimitEntity

public PrincipalRateLimitEntity replacePrincipalRateLimitEntity(String principalRateLimitId,
                                                                PrincipalRateLimitEntity entity,
                                                                Map<String,String> additionalHeaders)
                                                         throws ApiException

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

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

entity - (required)

additionalHeaders - additionalHeaders for this call

Returns:

PrincipalRateLimitEntity

Throws:

ApiException - if fails to make API call

getObjectMapper

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