errors

type EDAMErrorCode ¶

type EDAMErrorCode int64

Numeric codes indicating the type of error that occurred on the service. <dl>

<dt>UNKNOWN</dt>
  <dd>No information available about the error</dd>
<dt>BAD_DATA_FORMAT</dt>
  <dd>The format of the request data was incorrect</dd>
<dt>PERMISSION_DENIED</dt>
  <dd>Not permitted to perform action</dd>
<dt>INTERNAL_ERROR</dt>
  <dd>Unexpected problem with the service</dd>
<dt>DATA_REQUIRED</dt>
  <dd>A required parameter/field was absent</dd>
<dt>LIMIT_REACHED</dt>
  <dd>Operation denied due to data model limit</dd>
<dt>QUOTA_REACHED</dt>
  <dd>Operation denied due to user storage limit</dd>
<dt>INVALID_AUTH</dt>
  <dd>Username and/or password incorrect</dd>
<dt>AUTH_EXPIRED</dt>
  <dd>Authentication token expired</dd>
<dt>DATA_CONFLICT</dt>
  <dd>Change denied due to data model conflict</dd>
<dt>ENML_VALIDATION</dt>
  <dd>Content of submitted note was malformed</dd>
<dt>SHARD_UNAVAILABLE</dt>
  <dd>Service shard with account data is temporarily down</dd>
<dt>LEN_TOO_SHORT</dt>
  <dd>Operation denied due to data model limit, where something such
      as a string length was too short</dd>
<dt>LEN_TOO_LONG</dt>
  <dd>Operation denied due to data model limit, where something such
      as a string length was too long</dd>
<dt>TOO_FEW</dt>
  <dd>Operation denied due to data model limit, where there were
      too few of something.</dd>
<dt>TOO_MANY</dt>
  <dd>Operation denied due to data model limit, where there were
      too many of something.</dd>
<dt>UNSUPPORTED_OPERATION</dt>
  <dd>Operation denied because it is currently unsupported.</dd>
<dt>TAKEN_DOWN</dt>
  <dd>Operation denied because access to the corresponding object is
      prohibited in response to a take-down notice.</dd>
<dt>RATE_LIMIT_REACHED</dt>
  <dd>Operation denied because the calling application has reached
      its hourly API call limit for this user.</dd>

</dl>

const (
	EDAMErrorCode_UNKNOWN               EDAMErrorCode = 1
	EDAMErrorCode_BAD_DATA_FORMAT       EDAMErrorCode = 2
	EDAMErrorCode_PERMISSION_DENIED     EDAMErrorCode = 3
	EDAMErrorCode_INTERNAL_ERROR        EDAMErrorCode = 4
	EDAMErrorCode_DATA_REQUIRED         EDAMErrorCode = 5
	EDAMErrorCode_LIMIT_REACHED         EDAMErrorCode = 6
	EDAMErrorCode_QUOTA_REACHED         EDAMErrorCode = 7
	EDAMErrorCode_INVALID_AUTH          EDAMErrorCode = 8
	EDAMErrorCode_AUTH_EXPIRED          EDAMErrorCode = 9
	EDAMErrorCode_DATA_CONFLICT         EDAMErrorCode = 10
	EDAMErrorCode_ENML_VALIDATION       EDAMErrorCode = 11
	EDAMErrorCode_SHARD_UNAVAILABLE     EDAMErrorCode = 12
	EDAMErrorCode_LEN_TOO_SHORT         EDAMErrorCode = 13
	EDAMErrorCode_LEN_TOO_LONG          EDAMErrorCode = 14
	EDAMErrorCode_TOO_FEW               EDAMErrorCode = 15
	EDAMErrorCode_TOO_MANY              EDAMErrorCode = 16
	EDAMErrorCode_UNSUPPORTED_OPERATION EDAMErrorCode = 17
	EDAMErrorCode_TAKEN_DOWN            EDAMErrorCode = 18
	EDAMErrorCode_RATE_LIMIT_REACHED    EDAMErrorCode = 19
)

func EDAMErrorCodeFromString(s string) (EDAMErrorCode, error)

func EDAMErrorCodePtr(v EDAMErrorCode) *EDAMErrorCode

func (p EDAMErrorCode) MarshalText() ([]byte, error)

func (p EDAMErrorCode) String() string

func (p *EDAMErrorCode) UnmarshalText(text []byte) error

type EDAMNotFoundException ¶

type EDAMNotFoundException struct {
	Identifier *string `thrift:"identifier,1" json:"identifier,omitempty"`
	Key        *string `thrift:"key,2" json:"key,omitempty"`
}

This exception is thrown by EDAM procedures when a caller asks to perform an operation on an object that does not exist. This may be thrown based on an invalid primary identifier (e.g. a bad GUID), or when the caller refers to an object by another unique identifier (e.g. a User's email address).

identifier: A description of the object that was not found on the server.

For example, "Note.notebookGuid" when a caller attempts to create a note in a
notebook that does not exist in the user's account.

key: The value passed from the client in the identifier, which was not

found. For example, the GUID that was not found.

Attributes:

• Identifier
• Key

func NewEDAMNotFoundException() *EDAMNotFoundException

func (p *EDAMNotFoundException) Error() string

func (p *EDAMNotFoundException) GetIdentifier() string

func (p *EDAMNotFoundException) GetKey() string

func (p *EDAMNotFoundException) IsSetIdentifier() bool

func (p *EDAMNotFoundException) IsSetKey() bool

func (p *EDAMNotFoundException) Read(iprot thrift.TProtocol) error

func (p *EDAMNotFoundException) String() string

func (p *EDAMNotFoundException) Write(oprot thrift.TProtocol) error

type EDAMSystemException ¶

type EDAMSystemException struct {
	ErrorCode         EDAMErrorCode `thrift:"errorCode,1,required" json:"errorCode"`
	Message           *string       `thrift:"message,2" json:"message,omitempty"`
	RateLimitDuration *int32        `thrift:"rateLimitDuration,3" json:"rateLimitDuration,omitempty"`
}

This exception is thrown by EDAM procedures when a call fails as a result of a problem in the service that could not be changed through caller action.

errorCode: The numeric code indicating the type of error that occurred.

must be one of the values of EDAMErrorCode.

message: This may contain additional information about the error

rateLimitDuration: Indicates the minimum number of seconds that an application should

expect subsequent API calls for this user to fail. The application should not retry
API requests for the user until at least this many seconds have passed. Present only
when errorCode is RATE_LIMIT_REACHED,

Attributes:

• ErrorCode
• Message
• RateLimitDuration

func NewEDAMSystemException() *EDAMSystemException

func (p *EDAMSystemException) Error() string

func (p *EDAMSystemException) GetErrorCode() EDAMErrorCode

func (p *EDAMSystemException) GetMessage() string

func (p *EDAMSystemException) GetRateLimitDuration() int32

func (p *EDAMSystemException) IsSetMessage() bool

func (p *EDAMSystemException) IsSetRateLimitDuration() bool

func (p *EDAMSystemException) Read(iprot thrift.TProtocol) error

func (p *EDAMSystemException) String() string

func (p *EDAMSystemException) Write(oprot thrift.TProtocol) error

type EDAMUserException ¶

type EDAMUserException struct {
	ErrorCode EDAMErrorCode `thrift:"errorCode,1,required" json:"errorCode"`
	Parameter *string       `thrift:"parameter,2" json:"parameter,omitempty"`
}

This exception is thrown by EDAM procedures when a call fails as a result of a problem that a caller may be able to resolve. For example, if the user attempts to add a note to their account which would exceed their storage quota, this type of exception may be thrown to indicate the source of the error so that they can choose an alternate action.

This exception would not be used for internal system errors that do not reflect user actions, but rather reflect a problem within the service that the user cannot resolve.

errorCode: The numeric code indicating the type of error that occurred.

must be one of the values of EDAMErrorCode.

parameter: If the error applied to a particular input parameter, this will

indicate which parameter.

Attributes:

• ErrorCode
• Parameter

func NewEDAMUserException() *EDAMUserException

func (p *EDAMUserException) Error() string

func (p *EDAMUserException) GetErrorCode() EDAMErrorCode

func (p *EDAMUserException) GetParameter() string

func (p *EDAMUserException) IsSetParameter() bool

func (p *EDAMUserException) Read(iprot thrift.TProtocol) error

func (p *EDAMUserException) String() string

func (p *EDAMUserException) Write(oprot thrift.TProtocol) error