Enum SdkErrorType

  • All Implemented Interfaces:
    Serializable, Comparable<SdkErrorType>

    public enum SdkErrorType
    extends Enum<SdkErrorType>
    General categories of errors that can be encountered when making an API call attempt.

    This class is NOT intended to fully distinguish the details of every error that is possible to encounter when making an API call attempt; for example, it is not a replacement for detailed logs. Instead, the categories are intentionally broad to make it easy at-a-glance what is causing issues with requests, and to help direct further investigation.

    • Enum Constant Detail

      • THROTTLING

        public static final SdkErrorType THROTTLING
        The service responded with a throttling error.
      • SERVER_ERROR

        public static final SdkErrorType SERVER_ERROR
        The service responded with an error other than THROTTLING.
      • CONFIGURED_TIMEOUT

        public static final SdkErrorType CONFIGURED_TIMEOUT
        A clientside timeout occurred, either an attempt level timeout, or API call level.
      • OTHER

        public static final SdkErrorType OTHER
        Catch-all type for errors that don't fit into the other categories.
    • Method Detail

      • values

        public static SdkErrorType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (SdkErrorType c : SdkErrorType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SdkErrorType valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null