UploadApiRateLimitValue (Official Dropbox Java SDK 4.0.0 API)

java.lang.Object
- com.dropbox.core.v2.team.UploadApiRateLimitValue

```
public final class UploadApiRateLimitValue
extends java.lang.Object
```
The value for Feature.UPLOAD_API_RATE_LIMIT.
This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isAbc() methods will return true. You can use tag() to determine the tag associated with this instance.

Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHER value will be used.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UploadApiRateLimitValue.Tag
Discriminating tag type for UploadApiRateLimitValue.

Nested Classes
Modifier and Type	Class and Description
`static class`	`UploadApiRateLimitValue.Tag` Discriminating tag type for `UploadApiRateLimitValue`.

Field Summary

Fields
Modifier and Type	Field and Description
`static UploadApiRateLimitValue`	`OTHER` Catch-all used for unknown tag values returned by the Dropbox servers.
`static UploadApiRateLimitValue`	`UNLIMITED` This team has unlimited upload API quota.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`long`	`getLimitValue()` The number of upload API calls allowed per month.
`int`	`hashCode()`
`boolean`	`isLimit()` Returns `true` if this instance has the tag `UploadApiRateLimitValue.Tag.LIMIT`, `false` otherwise.
`boolean`	`isOther()` Returns `true` if this instance has the tag `UploadApiRateLimitValue.Tag.OTHER`, `false` otherwise.
`boolean`	`isUnlimited()` Returns `true` if this instance has the tag `UploadApiRateLimitValue.Tag.UNLIMITED`, `false` otherwise.
`static UploadApiRateLimitValue`	`limit(long value)` Returns an instance of `UploadApiRateLimitValue` that has its tag set to `UploadApiRateLimitValue.Tag.LIMIT`.
`UploadApiRateLimitValue.Tag`	`tag()` Returns the tag for this instance.
`java.lang.String`	`toString()`
`java.lang.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 Detail
  - UNLIMITED
```
public static final UploadApiRateLimitValue UNLIMITED
```
    This team has unlimited upload API quota. So far both server version account and legacy account type have unlimited monthly upload api quota.
  - OTHER
```
public static final UploadApiRateLimitValue OTHER
```
    Catch-all used for unknown tag values returned by the Dropbox servers.
    Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.
- Method Detail
  - tag
```
public UploadApiRateLimitValue.Tag tag()
```
    Returns the tag for this instance.
    This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isXyz() methods will return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this UploadApiRateLimitValue.
    
    If a tag returned by the server is unrecognized by this SDK, the UploadApiRateLimitValue.Tag.OTHER value will be used.
    
    Returns:
    
    the tag for this instance.
  - isUnlimited
```
public boolean isUnlimited()
```
    Returns true if this instance has the tag UploadApiRateLimitValue.Tag.UNLIMITED, false otherwise.
    
    Returns:
    
    true if this instance is tagged as UploadApiRateLimitValue.Tag.UNLIMITED, false otherwise.
  - isLimit
```
public boolean isLimit()
```
    Returns true if this instance has the tag UploadApiRateLimitValue.Tag.LIMIT, false otherwise.
    
    Returns:
    
    true if this instance is tagged as UploadApiRateLimitValue.Tag.LIMIT, false otherwise.
  - limit
```
public static UploadApiRateLimitValue limit(long value)
```
    Returns an instance of UploadApiRateLimitValue that has its tag set to UploadApiRateLimitValue.Tag.LIMIT.
    The number of upload API calls allowed per month.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of UploadApiRateLimitValue with its tag set to UploadApiRateLimitValue.Tag.LIMIT.
  - getLimitValue
```
public long getLimitValue()
```
    The number of upload API calls allowed per month.
    This instance must be tagged as UploadApiRateLimitValue.Tag.LIMIT.
    
    Returns:
    
    The long value associated with this instance if isLimit() is true.
    
    Throws:
    
    java.lang.IllegalStateException - If isLimit() is false.
  - isOther
```
public boolean isOther()
```
    Returns true if this instance has the tag UploadApiRateLimitValue.Tag.OTHER, false otherwise.
    
    Returns:
    
    true if this instance is tagged as UploadApiRateLimitValue.Tag.OTHER, false otherwise.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toStringMultiline
```
public java.lang.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

Class UploadApiRateLimitValue

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNLIMITED

OTHER

Method Detail

tag

isUnlimited

isLimit

limit

getLimitValue

isOther

hashCode

equals

toString

toStringMultiline