| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> |
| <link href="style.css" rel="stylesheet" type="text/css"/> |
| <title>Thrift module: airavata_errors</title></head><body> |
| <div class="container-fluid"> |
| <h1>Thrift module: airavata_errors</h1> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> |
| <tr> |
| <td>airavata_errors</td><td></td> |
| <td><a href="#Struct_AiravataClientException">AiravataClientException</a><br/> |
| <a href="#Enum_AiravataErrorType">AiravataErrorType</a><br/> |
| <a href="#Struct_AiravataSystemException">AiravataSystemException</a><br/> |
| <a href="#Struct_AuthenticationException">AuthenticationException</a><br/> |
| <a href="#Struct_AuthorizationException">AuthorizationException</a><br/> |
| <a href="#Struct_ExperimentNotFoundException">ExperimentNotFoundException</a><br/> |
| <a href="#Struct_InvalidRequestException">InvalidRequestException</a><br/> |
| <a href="#Struct_LaunchValidationException">LaunchValidationException</a><br/> |
| <a href="#Struct_ProjectNotFoundException">ProjectNotFoundException</a><br/> |
| <a href="#Struct_TimedOutException">TimedOutException</a><br/> |
| <a href="#Struct_ValidationResults">ValidationResults</a><br/> |
| <a href="#Struct_ValidatorResult">ValidatorResult</a><br/> |
| </td> |
| <td></code></td> |
| </tr></table> |
| <hr/><h2 id="Enumerations">Enumerations</h2> |
| <div class="definition"><h3 id="Enum_AiravataErrorType">Enumeration: AiravataErrorType</h3> |
| 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. |
| <br/><br/><table class="table-bordered table-striped table-condensed"> |
| <tr><td><code>UNKNOWN</code></td><td><code>0</code></td><td> |
| </td></tr> |
| <tr><td><code>PERMISSION_DENIED</code></td><td><code>1</code></td><td> |
| </td></tr> |
| <tr><td><code>INTERNAL_ERROR</code></td><td><code>2</code></td><td> |
| </td></tr> |
| <tr><td><code>AUTHENTICATION_FAILURE</code></td><td><code>3</code></td><td> |
| </td></tr> |
| <tr><td><code>INVALID_AUTHORIZATION</code></td><td><code>4</code></td><td> |
| </td></tr> |
| <tr><td><code>AUTHORIZATION_EXPIRED</code></td><td><code>5</code></td><td> |
| </td></tr> |
| <tr><td><code>UNKNOWN_GATEWAY_ID</code></td><td><code>6</code></td><td> |
| </td></tr> |
| <tr><td><code>UNSUPPORTED_OPERATION</code></td><td><code>7</code></td><td> |
| </td></tr> |
| </table></div> |
| <hr/><h2 id="Structs">Data structures</h2> |
| <div class="definition"><h3 id="Struct_ExperimentNotFoundException">Exception: ExperimentNotFoundException</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> |
| <tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| </table><br/>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. |
| <br/></div><div class="definition"><h3 id="Struct_ProjectNotFoundException">Exception: ProjectNotFoundException</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> |
| <tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| </table><br/>1: optional string identifier, |
| 2: optional string key |
| |
| <br/></div><div class="definition"><h3 id="Struct_InvalidRequestException">Exception: InvalidRequestException</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> |
| <tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| </table><br/>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. |
| <br/></div><div class="definition"><h3 id="Struct_TimedOutException">Exception: TimedOutException</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> |
| </table><br/>This exception is thrown when RPC timeout gets exceeded. |
| <br/></div><div class="definition"><h3 id="Struct_AuthenticationException">Exception: AuthenticationException</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> |
| <tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| </table><br/>This exception is thrown for invalid sshKeyAuthentication requests. |
| |
| message: contains the cause of the authorization failure. |
| <br/></div><div class="definition"><h3 id="Struct_AuthorizationException">Exception: AuthorizationException</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> |
| <tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> |
| </table><br/>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 |
| <br/></div><div class="definition"><h3 id="Struct_AiravataClientException">Exception: AiravataClientException</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> |
| <tr><td>1</td><td>airavataErrorType</td><td><code><a href="#Enum_AiravataErrorType">AiravataErrorType</a></code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>parameter</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| </table><br/>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. |
| <br/></div><div class="definition"><h3 id="Struct_ValidatorResult">Struct: ValidatorResult</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> |
| <tr><td>1</td><td>result</td><td><code>bool</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>errorDetails</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_ValidationResults">Struct: ValidationResults</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> |
| <tr><td>1</td><td>validationState</td><td><code>bool</code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>validationResultList</td><td><code>list<<code><a href="#Struct_ValidatorResult">ValidatorResult</a></code>></code></td><td></td><td>required</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_LaunchValidationException">Exception: LaunchValidationException</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> |
| <tr><td>1</td><td>validationResult</td><td><code><a href="#Struct_ValidationResults">ValidationResults</a></code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>errorMessage</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| </table><br/></div><div class="definition"><h3 id="Struct_AiravataSystemException">Exception: AiravataSystemException</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> |
| <tr><td>1</td><td>airavataErrorType</td><td><code><a href="#Enum_AiravataErrorType">AiravataErrorType</a></code></td><td></td><td>required</td><td></td></tr> |
| <tr><td>2</td><td>message</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| </table><br/>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 |
| |
| <br/></div></div></body></html> |
