Package co.arago.hiro.client.model

Class VersionResponse

java.lang.Object

co.arago.hiro.client.model.HiroJsonMap

co.arago.hiro.client.model.HiroMessage

co.arago.hiro.client.model.VersionResponse

All Implemented Interfaces:

JsonMessage, ToMap, java.io.Serializable

public class VersionResponse
extends HiroMessage

The response to a version GET request against "/api/version".

 {
     "[name of first api]": {
         "endpoint": "...",
         "version": "...",
         ...
     },
     "[name of second api]": {
         ...
     },
     ...
 }

 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VersionResponse.VersionEntry

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,VersionResponse.VersionEntry>	versionEntryMap

Fields inherited from class co.arago.hiro.client.model.HiroMessage

hiroError

Fields inherited from class co.arago.hiro.client.model.HiroJsonMap

fieldsMap

Constructor Summary

Constructors

Constructor	Description
VersionResponse()

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,?>	getMap()	Returns the map of fields that have NOT been assigned to fields of derived children directly.
VersionResponse.VersionEntry	getVersionEntryOf(java.lang.String apiName)
void	setField(java.lang.String key, java.lang.Object value)	Jackson Setter that transforms incoming maps into VersionEntries.

Methods inherited from class co.arago.hiro.client.model.HiroMessage

catchError, getError, isError

Methods inherited from class co.arago.hiro.client.model.HiroJsonMap

addFields, getField, getUnmappedField, setFields, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.arago.hiro.client.model.JsonMessage

toJsonString, toJsonStringNoNull, toPrettyJsonString, toPrettyJsonStringNoNull

Field Detail

versionEntryMap

protected final java.util.Map<java.lang.String,VersionResponse.VersionEntry> versionEntryMap

Constructor Detail

VersionResponse

public VersionResponse()

Method Detail

getMap

public java.util.Map<java.lang.String,?> getMap()

Description copied from class: HiroJsonMap

Returns the map of fields that have NOT been assigned to fields of derived children directly.

Overrides:

getMap in class HiroJsonMap

Returns:

A merged map of versionEntryMap and HiroJsonMap.fieldsMap. This is a shallow copy of both.

setField

public void setField(java.lang.String key,
                     java.lang.Object value)

Jackson Setter that transforms incoming maps into VersionEntries.

Overrides:

setField in class HiroMessage

Parameters:

key - Incoming JSON key

value - Incoming JSON value

getVersionEntryOf

public VersionResponse.VersionEntry getVersionEntryOf(java.lang.String apiName)
                                               throws HiroException

Parameters:

apiName - Name of the API

Returns:

The VersionResponse.VersionEntry of that API.

Throws:

HiroException - If no API with this name can be found.