Thrift module: airavata_errors

Module	Services	Data types	Constants
airavata_errors		AiravataClientException AiravataErrorType AiravataSystemException AuthenticationException AuthorizationException DuplicateEntryException ExperimentNotFoundException InvalidRequestException LaunchValidationException ProjectNotFoundException TimedOutException ValidationResults ValidatorResult

Enumerations

Enumeration: AiravataErrorType

A list of Airavata API Error Message Types

 UNKNOWN: No information available about the error
  
 PERMISSION_DENIED: Not permitted to perform action

 INTERNAL_ERROR: Unexpected problem with the service

 AUTHENTICATION_FAILURE: The client failed to authenticate.

 INVALID_AUTHORIZATION: Security Token and/or Username and/or password is incorrect
  
 AUTHORIZATION_EXPIRED: Authentication token expired
 
 UNKNOWN_GATEWAY_ID: The gateway is not registered with Airavata.

 UNSUPPORTED_OPERATION: Operation denied because it is currently unsupported.

`UNKNOWN`	`0`
`PERMISSION_DENIED`	`1`
`INTERNAL_ERROR`	`2`
`AUTHENTICATION_FAILURE`	`3`
`INVALID_AUTHORIZATION`	`4`
`AUTHORIZATION_EXPIRED`	`5`
`UNKNOWN_GATEWAY_ID`	`6`
`UNSUPPORTED_OPERATION`	`7`

Data structures

Exception: ExperimentNotFoundException

Key	Field	Type	Description	Requiredness	Default value
1	message	`string`		required

This exception is thrown when a client asks to perform an operation on an experiment that does not exist.

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

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

Exception: ProjectNotFoundException

Key	Field	Type	Description	Requiredness	Default value
1	message	`string`		required

1:  optional  string identifier,
2:  optional  string key

Exception: InvalidRequestException

Key	Field	Type	Description	Requiredness	Default value
1	message	`string`		required

This exception is thrown for invalid requests that occur from any reasons like required input parameters are missing,
 or a parameter is malformed.

 message: contains the associated error message.

Exception: TimedOutException

Key	Field	Type	Description	Requiredness	Default value

This exception is thrown when RPC timeout gets exceeded.

Exception: AuthenticationException

Key	Field	Type	Description	Requiredness	Default value
1	message	`string`		required

This exception is thrown for invalid sshKeyAuthentication requests.

 message: contains the cause of the authorization failure.

Exception: AuthorizationException

Key	Field	Type	Description	Requiredness	Default value
1	message	`string`		required

This exception is thrown for invalid authorization requests such user does not have acces to an aplication or resource.

 message: contains the authorization failure message

Exception: DuplicateEntryException

Key	Field	Type	Description	Requiredness	Default value
1	message	`string`		required

This exception is thrown when you try to save a duplicate entity that already exists
  in the database.

  message: contains the associated error message

Exception: AiravataClientException

Key	Field	Type	Description	Requiredness	Default value
1	airavataErrorType	`AiravataErrorType`		required
2	parameter	`string`		optional

This exception is thrown by Airavata Services when a call fails as a result of
a problem that a client may be able to resolve.  For example, if the user
attempts to execute an application on a resource gateway does not have access to.

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 client cannot resolve.

airavataErrorType:  The message type indicating the error that occurred.
  must be one of the values of AiravataErrorType.

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

Struct: ValidatorResult

Key	Field	Type	Description	Requiredness	Default value
1	result	`bool`		required
2	errorDetails	`string`		optional

Struct: ValidationResults

Key	Field	Type	Description	Requiredness	Default value
1	validationState	`bool`		required
2	validationResultList	`list<ValidatorResult>`		required

Exception: LaunchValidationException

Key	Field	Type	Description	Requiredness	Default value
1	validationResult	`ValidationResults`		required
2	errorMessage	`string`		optional

Exception: AiravataSystemException

Key	Field	Type	Description	Requiredness	Default value
1	airavataErrorType	`AiravataErrorType`		required
2	message	`string`		optional

This exception is thrown by Airavata Services when a call fails as a result of
a problem in the service that could not be changed through client's action.

airavataErrorType:  The message type indicating the error that occurred.
  must be one of the values of AiravataErrorType.

message:  This may contain additional information about the error
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



source/api-docs/master/airavata_errors.html [1:149]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -





Thrift module: airavata_errors

Thrift module: airavata_errors
Module Services Data types Constants


airavata_errors 
AiravataClientException

AiravataErrorType

AiravataSystemException

AuthenticationException

AuthorizationException

DuplicateEntryException

ExperimentNotFoundException

InvalidRequestException

LaunchValidationException

ProjectNotFoundException

TimedOutException

ValidationResults

ValidatorResult




Enumerations
Enumeration: AiravataErrorType
A list of Airavata API Error Message Types

 UNKNOWN: No information available about the error
  
 PERMISSION_DENIED: Not permitted to perform action

 INTERNAL_ERROR: Unexpected problem with the service

 AUTHENTICATION_FAILURE: The client failed to authenticate.

 INVALID_AUTHORIZATION: Security Token and/or Username and/or password is incorrect
  
 AUTHORIZATION_EXPIRED: Authentication token expired
 
 UNKNOWN_GATEWAY_ID: The gateway is not registered with Airavata.

 UNSUPPORTED_OPERATION: Operation denied because it is currently unsupported.



UNKNOWN 0 

PERMISSION_DENIED 1 

INTERNAL_ERROR 2 

AUTHENTICATION_FAILURE 3 

INVALID_AUTHORIZATION 4 

AUTHORIZATION_EXPIRED 5 

UNKNOWN_GATEWAY_ID 6 

UNSUPPORTED_OPERATION 7 


Data structures
Exception: ExperimentNotFoundException
Key Field Type Description Requiredness Default value

1 message string required 

This exception is thrown when a client asks to perform an operation on an experiment that does not exist.

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

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

Exception: ProjectNotFoundException
Key Field Type Description Requiredness Default value

1 message string required 

1:  optional  string identifier,
2:  optional  string key


Exception: InvalidRequestException
Key Field Type Description Requiredness Default value

1 message string required 

This exception is thrown for invalid requests that occur from any reasons like required input parameters are missing,
 or a parameter is malformed.

 message: contains the associated error message.

Exception: TimedOutException
Key Field Type Description Requiredness Default value


This exception is thrown when RPC timeout gets exceeded.

Exception: AuthenticationException
Key Field Type Description Requiredness Default value

1 message string required 

This exception is thrown for invalid sshKeyAuthentication requests.

 message: contains the cause of the authorization failure.

Exception: AuthorizationException
Key Field Type Description Requiredness Default value

1 message string required 

This exception is thrown for invalid authorization requests such user does not have acces to an aplication or resource.

 message: contains the authorization failure message

Exception: DuplicateEntryException
Key Field Type Description Requiredness Default value

1 message string required 

This exception is thrown when you try to save a duplicate entity that already exists
  in the database.

  message: contains the associated error message


Exception: AiravataClientException
Key Field Type Description Requiredness Default value

1 airavataErrorType AiravataErrorType required 
2 parameter string optional 

This exception is thrown by Airavata Services when a call fails as a result of
a problem that a client may be able to resolve.  For example, if the user
attempts to execute an application on a resource gateway does not have access to.

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 client cannot resolve.

airavataErrorType:  The message type indicating the error that occurred.
  must be one of the values of AiravataErrorType.

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

Struct: ValidatorResult
Key Field Type Description Requiredness Default value

1 result bool required 
2 errorDetails string optional 

Struct: ValidationResults
Key Field Type Description Requiredness Default value

1 validationState bool required 
2 validationResultList list<ValidatorResult> required 

Exception: LaunchValidationException
Key Field Type Description Requiredness Default value

1 validationResult ValidationResults required 
2 errorMessage string optional 

Exception: AiravataSystemException
Key Field Type Description Requiredness Default value

1 airavataErrorType AiravataErrorType required 
2 message string optional 

This exception is thrown by Airavata Services when a call fails as a result of
a problem in the service that could not be changed through client's action.

airavataErrorType:  The message type indicating the error that occurred.
  must be one of the values of AiravataErrorType.

message:  This may contain additional information about the error
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -