Package com.dropbox.core.v2.auth

Class RateLimitError

java.lang.Object

com.dropbox.core.v2.auth.RateLimitError

public class RateLimitError
extends Object

Error occurred because the app is being rate limited.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RateLimitError.Serializer	For internal use only.

Field Summary

Fields

Modifier and Type	Field	Description
protected final RateLimitReason	reason
protected final long	retryAfter

Constructor Summary

Constructors

Constructor	Description
RateLimitError(RateLimitReason reason)	Error occurred because the app is being rate limited.
RateLimitError(RateLimitReason reason, long retryAfter)	Error occurred because the app is being rate limited.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
RateLimitReason	getReason()	The reason why the app is being rate limited.
long	getRetryAfter()	The number of seconds that the app should wait before making another request.
int	hashCode()
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

reason

@Nonnull
protected final RateLimitReason reason

retryAfter

protected final long retryAfter

Constructor Details

RateLimitError

public RateLimitError(@Nonnull
 RateLimitReason reason,
 long retryAfter)

Error occurred because the app is being rate limited.

Parameters:

reason - The reason why the app is being rate limited. Must not be null.

retryAfter - The number of seconds that the app should wait before making another request.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

RateLimitError

public RateLimitError(@Nonnull
 RateLimitReason reason)

Error occurred because the app is being rate limited.

The default values for unset fields will be used.

Parameters:

reason - The reason why the app is being rate limited. Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Details

getReason

@Nonnull
public RateLimitReason getReason()

The reason why the app is being rate limited.

Returns:

value for this field, never null.

getRetryAfter

public long getRetryAfter()

The number of seconds that the app should wait before making another request.

Returns:

value for this field, or null if not present. Defaults to 1L.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Returns:

Formatted, multiline String representation of this object