Class 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.

    • 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.
      • 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.
      • 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