HskResponse (com.authlete:authlete-java-common 4.23 API)

java.lang.Object
- com.authlete.common.dto.ApiResponse
- - com.authlete.common.dto.HskResponse

All Implemented Interfaces:

Serializable
```
public class HskResponse
extends ApiResponse
```
Response from Authlete's /api/hsk/create API, /api/hsk/delete/{handle} API and /api/hsk/get/{handle} API.

Since:

2.97, Authlete 2.2.12

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HskResponse.Action
The result of the API call.

Constructor Summary

Constructors
Constructor Description

HskResponse()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`HskResponse.Action`	`getAction()`	Get the result of the API call.
`Hsk`	`getHsk()`	Get the information about the key on the HSM.
`HskResponse`	`setAction(HskResponse.Action action)`	Set the result of the API call.
`HskResponse`	`setHsk(Hsk hsk)`	Set the information about the key on the HSM.

Methods inherited from class com.authlete.common.dto.ApiResponse
getResponseHeaders, getResultCode, getResultMessage, setResponseHeaders, setResultCode, setResultMessage

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

- Constructor Detail
  - HskResponse
```
public HskResponse()
```
- Method Detail
  - getAction
```
public HskResponse.Action getAction()
```
    Get the result of the API call.
    
    Returns:
    
    The result of the API call.
  - setAction
```
public HskResponse setAction(HskResponse.Action action)
```
    Set the result of the API call.
    
    Parameters:
    
    action - The result of the API call.
    
    Returns:
    
    this object.
  - getHsk
```
public Hsk getHsk()
```
    Get the information about the key on the HSM.
    
    Returns:
    
    Information about the key.
  - setHsk
```
public HskResponse setHsk(Hsk hsk)
```
    Set the information about the key on the HSM.
    
    Parameters:
    
    hsk - Information about the key.
    
    Returns:
    
    this object.