IIJGIOServiceException (iijgio-dag-client-all 1.2.4 API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.lang.RuntimeException
    - - com.iijgio.dag.IIJGIOClientException
      - com.iijgio.dag.IIJGIOServiceException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IIJGIOStorageException
```
public class IIJGIOServiceException
extends IIJGIOClientException
```
IIJGIOClientExceptionを拡張し、IIJ GIOストレージ＆アナリシスサービス APIからのエラーレスポンスを定義します。この例外を受け取った場合は、リクエストはAPIに到達したが何らかの原因でサービスがリクエストを処理できず、エラーとなった事を示します。
IIJGIOServiceExceptionは、エラー及びエラーの原因を特定するために必要な情報を提供します。特に、errorTypeプロパティでは、リクエスト自体が間違っているのかサービス側で処理中にエラーが発生したのか判別することが出来ます

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IIJGIOServiceException.ErrorType
リクエストのエラーの原因を示す列挙型です

Nested Classes
Modifier and Type	Class and Description
`static class`	`IIJGIOServiceException.ErrorType` リクエストのエラーの原因を示す列挙型です

Constructor Summary

Constructors
Constructor and Description
`IIJGIOServiceException(String message)` IIJGIOServiceException をメッセージを指定して構築します
`IIJGIOServiceException(String message, Exception cause)` IIJGIOServiceException を、原因の例外とメッセージを指定して構築します

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getErrorCode()` この例外で示されるエラーのErrorCodeを返します
`String`	`getErrorMessage()` この例外の原因となったレスポンスのエラーメッセージを返します
`IIJGIOServiceException.ErrorType`	`getErrorType()` この例外で示されるエラーの原因がリクエストかサービス側にあるのかを示す ErrorTypeを返します
`String`	`getMessage()` この例外の概要の文字列表現を返します。概要には HTTP ステータスコード, requestID, エラーコード, エラーメッセージが含まれます
`String`	`getRequestId()` この例外のrequestIDを返します
`String`	`getServiceName()` このエラーレスポンスのサービス名を返します
`int`	`getStatusCode()` この例外の原因となったレスポンスのHTTP ステータスコードを返します
`void`	`setErrorCode(String errorCode)` この例外で示されるエラーのErrorCodeを設定します
`void`	`setErrorType(IIJGIOServiceException.ErrorType errorType)` この例外で示されるエラーの原因がリクエストかサービス側にあるのかを示す ErrorTypeを設定します
`void`	`setRequestId(String requestId)` この例外のrequestIDを指定します
`void`	`setServiceName(String serviceName)` このエラーレスポンスのサービス名を設定します
`void`	`setStatusCode(int statusCode)` この例外の原因となったレスポンスのHTTP ステータスコードを設定します

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IIJGIOServiceException
```
public IIJGIOServiceException(String message)
```
    IIJGIOServiceException をメッセージを指定して構築します
    
    Parameters:
    
    message - エラーに関する詳細メッセージ
  - IIJGIOServiceException
```
public IIJGIOServiceException(String message,
                              Exception cause)
```
    IIJGIOServiceException を、原因の例外とメッセージを指定して構築します
    
    Parameters:
    
    message - エラーに関する詳細メッセージ
    
    cause - この例外の原因となった例外
- Method Detail
  - getRequestId
```
public String getRequestId()
```
    この例外のrequestIDを返します
    
    Returns:
    
    サービスリクエスト毎にユニークなrequestID
  - setRequestId
```
public void setRequestId(String requestId)
```
    この例外のrequestIDを指定します
    
    Parameters:
    
    requestId - サービスリクエスト毎にユニークなrequestID
  - getServiceName
```
public String getServiceName()
```
    このエラーレスポンスのサービス名を返します
    
    Returns:
    
    このエラーレスポンスのサービス名
  - setServiceName
```
public void setServiceName(String serviceName)
```
    このエラーレスポンスのサービス名を設定します
    
    Parameters:
    
    serviceName - このエラーレスポンスのサービス名
  - getErrorCode
```
public String getErrorCode()
```
    この例外で示されるエラーのErrorCodeを返します
    
    Returns:
    
    この例外で示されるエラーのErrorCode
  - setErrorCode
```
public void setErrorCode(String errorCode)
```
    この例外で示されるエラーのErrorCodeを設定します
    
    Parameters:
    
    errorCode - この例外で示されるエラーのErrorCode
  - getErrorType
```
public IIJGIOServiceException.ErrorType getErrorType()
```
    この例外で示されるエラーの原因がリクエストかサービス側にあるのかを示す ErrorTypeを返します
    
    Returns:
    
    このエラーの原因を示すErrorType
    
    See Also:
    
    IIJGIOServiceException.ErrorType
  - setErrorType
```
public void setErrorType(IIJGIOServiceException.ErrorType errorType)
```
    この例外で示されるエラーの原因がリクエストかサービス側にあるのかを示す ErrorTypeを設定します
    
    Parameters:
    
    errorType - このエラーの原因を示すErrorType
    
    See Also:
    
    IIJGIOServiceException.ErrorType
  - getStatusCode
```
public int getStatusCode()
```
    この例外の原因となったレスポンスのHTTP ステータスコードを返します
    
    Returns:
    
    この例外を返すHTTP ステータスコード
  - setStatusCode
```
public void setStatusCode(int statusCode)
```
    この例外の原因となったレスポンスのHTTP ステータスコードを設定します
    
    Parameters:
    
    statusCode - この例外を返すHTTP ステータスコード
  - getErrorMessage
```
public String getErrorMessage()
```
    この例外の原因となったレスポンスのエラーメッセージを返します
    
    Returns:
    
    この例外を示すエラーメッセージ
  - getMessage
```
public String getMessage()
```
    この例外の概要の文字列表現を返します。概要には HTTP ステータスコード, requestID, エラーコード, エラーメッセージが含まれます
    
    Overrides:
    
    getMessage in class Throwable
    
    See Also:
    
    Throwable.getMessage()

Class IIJGIOServiceException

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Constructor Detail

IIJGIOServiceException

IIJGIOServiceException

Method Detail

getRequestId

setRequestId

getServiceName

setServiceName

getErrorCode

setErrorCode

getErrorType

setErrorType

getStatusCode

setStatusCode

getErrorMessage

getMessage