Package com.ibm.cloud.networking.zone_rate_limits.v1.model

Class UpdateRateLimitOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.networking.zone_rate_limits.v1.model.UpdateRateLimitOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class UpdateRateLimitOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The updateRateLimit options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateRateLimitOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
RatelimitInputAction	action()	Gets the action.
List<RatelimitInputBypassItem>	bypass()	Gets the bypass.
RatelimitInputCorrelate	correlate()	Gets the correlate.
String	description()	Gets the description.
Boolean	disabled()	Gets the disabled.
RatelimitInputMatch	match()	Gets the match.
UpdateRateLimitOptions.Builder	newBuilder()	New builder.
Long	period()	Gets the period.
String	rateLimitIdentifier()	Gets the rateLimitIdentifier.
Long	threshold()	Gets the threshold.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public UpdateRateLimitOptions.Builder newBuilder()

New builder.

Returns:

a UpdateRateLimitOptions builder

rateLimitIdentifier

public String rateLimitIdentifier()

Gets the rateLimitIdentifier. Identifier of rate limit.

Returns:

the rateLimitIdentifier

disabled

public Boolean disabled()

Gets the disabled. Whether this ratelimit is currently disabled.

Returns:

the disabled

description

public String description()

Gets the description. A note that you can use to describe the reason for a rate limit.

Returns:

the description

bypass

public List<RatelimitInputBypassItem> bypass()

Gets the bypass. Criteria that would allow the rate limit to be bypassed, for example to express that you shouldn't apply a rate limit to a given set of URLs.

Returns:

the bypass

threshold

public Long threshold()

Gets the threshold. The threshold that triggers the rate limit mitigations, combine with period. i.e. threshold per period.

Returns:

the threshold

period

public Long period()

Gets the period. The time in seconds to count matching traffic. If the count exceeds threshold within this period the action will be performed.

Returns:

the period

action

public RatelimitInputAction action()

Gets the action. action.

Returns:

the action

correlate

public RatelimitInputCorrelate correlate()

Gets the correlate. Enable NAT based rate limits.

Returns:

the correlate

match

public RatelimitInputMatch match()

Gets the match. Determines which traffic the rate limit counts towards the threshold. Needs to be one of "request" or "response" objects.

Returns:

the match