org.ic4j.agent

Class Status

java.lang.Object

org.ic4j.agent.Status

public class Status
extends java.lang.Object

The structure returned by [`ic_agent::Agent::status`], containing the information returned by the status endpoint of a replica.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	icAPIVersion Identifies the interface version supported, i.e.
java.util.Optional<java.lang.String>	implRevision Optional.
java.util.Optional<java.lang.String>	implSource Optional.
java.util.Optional<java.lang.String>	implVersion Optional.
java.util.Optional<java.lang.String>	replicaHealthStatus Optional.
java.util.Optional<byte[]>	rootKey Optional.
java.util.Map<java.lang.String,?>	values Contains any additional values that the replica gave as status.

Constructor Summary

Constructors

Constructor and Description
Status()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

icAPIVersion

public java.lang.String icAPIVersion

Identifies the interface version supported, i.e. the version of the present document that the internet computer aims to support, e.g. 0.8.1. The implementation may also return unversioned to indicate that it does not comply to a particular version, e.g. in between releases.

implSource

public java.util.Optional<java.lang.String> implSource

Optional. Identifies the implementation of the Internet Computer, by convention with the canonical location of the source code.

implVersion

public java.util.Optional<java.lang.String> implVersion

Optional. If the user is talking to a released version of an Internet Computer implementation, this is the version number. For non-released versions, output of `git describe` like 0.1.13-13-g2414721 would also be very suitable.

implRevision

public java.util.Optional<java.lang.String> implRevision

Optional. The precise git revision of the Internet Computer implementation.

replicaHealthStatus

public java.util.Optional<java.lang.String> replicaHealthStatus

Optional. The health status of the replica. One hopes it's "healthy".

rootKey

public java.util.Optional<byte[]> rootKey

Optional. The root (public) key used to verify certificates.

values

public java.util.Map<java.lang.String,?> values

Contains any additional values that the replica gave as status. /*

Constructor Detail

Status

public Status()