Direct Known Subclasses:
ApiEntityResponse, ApiOptionalResponse, ConfigureK8s.Response, CreateAppRole.Response, CreateCubbyhole.Response, CreateKey.Response, CreateKv1.Response, CreateKv2.Response, CreatePolicy.Response, CreateRole.Response, CreateTokenRole.Response, DbConfigure.Response, DbCreateRole.Response, DbDelete.Response, DbDeleteRole.Response, DeleteAllKv2.Response, DeleteAppRole.Response, DeleteCubbyhole.Response, DeleteKey.Response, DeleteKv1.Response, DeleteKv2.Response, DeletePolicy.Response, DeleteRole.Response, DeleteTokenRole.Response, DestroyKv2.Response, DestroySecretId.Response, DisableAuth.Response, DisableEngine.Response, EnableAuth.Response, EnableEngine.Response, GenerateSelfSignedRoot.Response, PkiRole.Response, RevokeAndOrphanToken.Response, RevokeToken.Response, UndeleteKv2.Response, UpdateCubbyhole.Response, UpdateKeyConfig.Response, UpdateKv1.Response

public abstract class ApiResponse extends ApiJsonParser
A base for responses without an entity. For responses that may have an entity, use ApiOptionalResponse, for responses that must have an entity, use ApiEntityResponse.
  • Constructor Details

    • ApiResponse

      protected ApiResponse(ApiResponse.Builder<?,?> builder)
      Create a new rest response.
      builder - subclass of builder
  • Method Details

    • headers

      public Headers headers()
      HTTP headers returned in the response.
      HTTP headers
    • status

      public Status status()
      HTTP status returned. In most cases for successful invocation, this should be one of statuses in the 200 family. In case the invocation resulted in an error, an exception is thrown instead of returning a response.
      status of the response (only if successful)
    • requestId

      public String requestId()
      Request ID that was used. As this ID may be generated during request, this is the only way to obtain it.
      request ID used when invoking the integrated system