Class UploadApiRateLimitValue
- java.lang.Object
-
- com.dropbox.core.v2.team.UploadApiRateLimitValue
-
public final class UploadApiRateLimitValue extends java.lang.Object
The value forFeature.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 returntrue
. You can usetag()
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 Description static class
UploadApiRateLimitValue.Tag
Discriminating tag type forUploadApiRateLimitValue
.
-
Field Summary
Fields Modifier and Type Field 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 Description boolean
equals(java.lang.Object obj)
long
getLimitValue()
The number of upload API calls allowed per month.int
hashCode()
boolean
isLimit()
boolean
isOther()
boolean
isUnlimited()
static UploadApiRateLimitValue
limit(long value)
Returns an instance ofUploadApiRateLimitValue
that has its tag set toUploadApiRateLimitValue.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.
-
-
-
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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisUploadApiRateLimitValue
.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 is tagged asUploadApiRateLimitValue.Tag.UNLIMITED
,false
otherwise.
-
isLimit
public boolean isLimit()
- Returns:
true
if this instance is tagged asUploadApiRateLimitValue.Tag.LIMIT
,false
otherwise.
-
limit
public static UploadApiRateLimitValue limit(long value)
Returns an instance ofUploadApiRateLimitValue
that has its tag set toUploadApiRateLimitValue.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 toUploadApiRateLimitValue.Tag.LIMIT
.
-
getLimitValue
public long getLimitValue()
The number of upload API calls allowed per month.This instance must be tagged as
UploadApiRateLimitValue.Tag.LIMIT
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asUploadApiRateLimitValue.Tag.OTHER
,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.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
-
-