org.openapitools.client.api

Class RateLimitSettingsApi

java.lang.Object

org.openapitools.client.api.RateLimitSettingsApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T23:40:43.026Z[Etc/UTC]")
public class RateLimitSettingsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RateLimitSettingsApi()
RateLimitSettingsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
RateLimitAdminNotifications	getRateLimitSettingsAdminNotifications() Retrieve the Rate Limit Admin Notification Settings Retrieves the currently configured Rate Limit Admin Notification Settings
RateLimitAdminNotifications	getRateLimitSettingsAdminNotifications(Map<String,String> additionalHeaders) Retrieve the Rate Limit Admin Notification Settings Retrieves the currently configured Rate Limit Admin Notification Settings
PerClientRateLimitSettings	getRateLimitSettingsPerClient() Retrieve the Per-Client Rate Limit Settings Retrieves the currently configured Per-Client Rate Limit Settings
PerClientRateLimitSettings	getRateLimitSettingsPerClient(Map<String,String> additionalHeaders) Retrieve the Per-Client Rate Limit Settings Retrieves the currently configured Per-Client Rate Limit Settings
RateLimitWarningThresholdResponse	getRateLimitSettingsWarningThreshold() Retrieve the Rate Limit Warning Threshold Percentage Retrieves the currently configured threshold for warning notifications when the API's rate limit is exceeded
RateLimitWarningThresholdResponse	getRateLimitSettingsWarningThreshold(Map<String,String> additionalHeaders) Retrieve the Rate Limit Warning Threshold Percentage Retrieves the currently configured threshold for warning notifications when the API's rate limit is exceeded
RateLimitAdminNotifications	replaceRateLimitSettingsAdminNotifications(RateLimitAdminNotifications rateLimitAdminNotifications) Replace the Rate Limit Admin Notification Settings Replaces the Rate Limit Admin Notification Settings and returns the configured properties
RateLimitAdminNotifications	replaceRateLimitSettingsAdminNotifications(RateLimitAdminNotifications rateLimitAdminNotifications, Map<String,String> additionalHeaders) Replace the Rate Limit Admin Notification Settings Replaces the Rate Limit Admin Notification Settings and returns the configured properties
PerClientRateLimitSettings	replaceRateLimitSettingsPerClient(PerClientRateLimitSettings perClientRateLimitSettings) Replace the Per-Client Rate Limit Settings Replaces the Per-Client Rate Limit Settings and returns the configured properties
PerClientRateLimitSettings	replaceRateLimitSettingsPerClient(PerClientRateLimitSettings perClientRateLimitSettings, Map<String,String> additionalHeaders) Replace the Per-Client Rate Limit Settings Replaces the Per-Client Rate Limit Settings and returns the configured properties
RateLimitWarningThresholdResponse	replaceRateLimitSettingsWarningThreshold(RateLimitWarningThresholdRequest rateLimitWarningThreshold) Replace the Rate Limit Warning Threshold Percentage Replaces the Rate Limit Warning Threshold Percentage and returns the configured property
RateLimitWarningThresholdResponse	replaceRateLimitSettingsWarningThreshold(RateLimitWarningThresholdRequest rateLimitWarningThreshold, Map<String,String> additionalHeaders) Replace the Rate Limit Warning Threshold Percentage Replaces the Rate Limit Warning Threshold Percentage and returns the configured property
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimitSettingsApi

public RateLimitSettingsApi()

RateLimitSettingsApi

public RateLimitSettingsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getRateLimitSettingsAdminNotifications

public RateLimitAdminNotifications getRateLimitSettingsAdminNotifications()
                                                                   throws ApiException

Retrieve the Rate Limit Admin Notification Settings Retrieves the currently configured Rate Limit Admin Notification Settings

Returns:

RateLimitAdminNotifications

Throws:

ApiException - if fails to make API call

getRateLimitSettingsAdminNotifications

public RateLimitAdminNotifications getRateLimitSettingsAdminNotifications(Map<String,String> additionalHeaders)
                                                                   throws ApiException

Retrieve the Rate Limit Admin Notification Settings Retrieves the currently configured Rate Limit Admin Notification Settings

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

RateLimitAdminNotifications

Throws:

ApiException - if fails to make API call

getRateLimitSettingsPerClient

public PerClientRateLimitSettings getRateLimitSettingsPerClient()
                                                         throws ApiException

Retrieve the Per-Client Rate Limit Settings Retrieves the currently configured Per-Client Rate Limit Settings

Returns:

PerClientRateLimitSettings

Throws:

ApiException - if fails to make API call

getRateLimitSettingsPerClient

public PerClientRateLimitSettings getRateLimitSettingsPerClient(Map<String,String> additionalHeaders)
                                                         throws ApiException

Retrieve the Per-Client Rate Limit Settings Retrieves the currently configured Per-Client Rate Limit Settings

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

PerClientRateLimitSettings

Throws:

ApiException - if fails to make API call

getRateLimitSettingsWarningThreshold

public RateLimitWarningThresholdResponse getRateLimitSettingsWarningThreshold()
                                                                       throws ApiException

Retrieve the Rate Limit Warning Threshold Percentage Retrieves the currently configured threshold for warning notifications when the API's rate limit is exceeded

Returns:

RateLimitWarningThresholdResponse

Throws:

ApiException - if fails to make API call

getRateLimitSettingsWarningThreshold

public RateLimitWarningThresholdResponse getRateLimitSettingsWarningThreshold(Map<String,String> additionalHeaders)
                                                                       throws ApiException

Retrieve the Rate Limit Warning Threshold Percentage Retrieves the currently configured threshold for warning notifications when the API's rate limit is exceeded

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

RateLimitWarningThresholdResponse

Throws:

ApiException - if fails to make API call

replaceRateLimitSettingsAdminNotifications

public RateLimitAdminNotifications replaceRateLimitSettingsAdminNotifications(RateLimitAdminNotifications rateLimitAdminNotifications)
                                                                       throws ApiException

Replace the Rate Limit Admin Notification Settings Replaces the Rate Limit Admin Notification Settings and returns the configured properties

Parameters:

rateLimitAdminNotifications - (required)

Returns:

RateLimitAdminNotifications

Throws:

ApiException - if fails to make API call

replaceRateLimitSettingsAdminNotifications

public RateLimitAdminNotifications replaceRateLimitSettingsAdminNotifications(RateLimitAdminNotifications rateLimitAdminNotifications,
                                                                              Map<String,String> additionalHeaders)
                                                                       throws ApiException

Replace the Rate Limit Admin Notification Settings Replaces the Rate Limit Admin Notification Settings and returns the configured properties

Parameters:

rateLimitAdminNotifications - (required)

additionalHeaders - additionalHeaders for this call

Returns:

RateLimitAdminNotifications

Throws:

ApiException - if fails to make API call

replaceRateLimitSettingsPerClient

public PerClientRateLimitSettings replaceRateLimitSettingsPerClient(PerClientRateLimitSettings perClientRateLimitSettings)
                                                             throws ApiException

Replace the Per-Client Rate Limit Settings Replaces the Per-Client Rate Limit Settings and returns the configured properties

Parameters:

perClientRateLimitSettings - (required)

Returns:

PerClientRateLimitSettings

Throws:

ApiException - if fails to make API call

replaceRateLimitSettingsPerClient

public PerClientRateLimitSettings replaceRateLimitSettingsPerClient(PerClientRateLimitSettings perClientRateLimitSettings,
                                                                    Map<String,String> additionalHeaders)
                                                             throws ApiException

Replace the Per-Client Rate Limit Settings Replaces the Per-Client Rate Limit Settings and returns the configured properties

Parameters:

perClientRateLimitSettings - (required)

additionalHeaders - additionalHeaders for this call

Returns:

PerClientRateLimitSettings

Throws:

ApiException - if fails to make API call

replaceRateLimitSettingsWarningThreshold

public RateLimitWarningThresholdResponse replaceRateLimitSettingsWarningThreshold(RateLimitWarningThresholdRequest rateLimitWarningThreshold)
                                                                           throws ApiException

Replace the Rate Limit Warning Threshold Percentage Replaces the Rate Limit Warning Threshold Percentage and returns the configured property

Parameters:

rateLimitWarningThreshold - (optional)

Returns:

RateLimitWarningThresholdResponse

Throws:

ApiException - if fails to make API call

replaceRateLimitSettingsWarningThreshold

public RateLimitWarningThresholdResponse replaceRateLimitSettingsWarningThreshold(RateLimitWarningThresholdRequest rateLimitWarningThreshold,
                                                                                  Map<String,String> additionalHeaders)
                                                                           throws ApiException

Replace the Rate Limit Warning Threshold Percentage Replaces the Rate Limit Warning Threshold Percentage and returns the configured property

Parameters:

rateLimitWarningThreshold - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

RateLimitWarningThresholdResponse

Throws:

ApiException - if fails to make API call

getObjectMapper

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