Enum holochain::conductor::api::AdminResponse

pub enum AdminResponse {
    Error(ExternalApiWireError),
    DnaRegistered(HoloHash<Dna>),
    CoordinatorsUpdated,
    AppInstalled(InstalledAppInfo),
    AppBundleInstalled(InstalledAppInfo),
    AppUninstalled,
    CloneCellCreated(CellId),
    AdminInterfacesAdded,
    AgentPubKeyGenerated(HoloHash<Agent>),
    DnasListed(Vec<HoloHash<Dna>, Global>),
    CellIdsListed(Vec<CellId, Global>),
    EnabledAppsListed(Vec<String, Global>),
    ActiveAppsListed(Vec<String, Global>),
    AppsListed(Vec<InstalledAppInfo, Global>),
    AppInterfaceAttached {
        port: u16,
    },
    AppInterfacesListed(Vec<u16, Global>),
    AppEnabled {
        app: InstalledAppInfo,
        errors: Vec<(CellId, String), Global>,
    },
    AppActivated {
        app: InstalledAppInfo,
        errors: Vec<(CellId, String), Global>,
    },
    AppDisabled,
    AppStarted(bool),
    AppDeactivated,
    StateDumped(String),
    FullStateDumped(FullStateDump),
    NetworkMetricsDumped(String),
    AgentInfoAdded,
    AgentInfoRequested(Vec<AgentInfoSigned, Global>),
    RecordsAdded,
}

Represents the possible responses to an AdminRequest and follows a general convention of noun_verb as opposed to the verb_noun of AdminRequest.

Will serialize as an object with any contents of the enum on a key data and the enum variant on a key type, e.g. { type: 'app_interface_attached', data: { port: 4000 } }

Variants

Error(ExternalApiWireError)

Can occur in response to any AdminRequest.

There has been an error during the handling of the request.

DnaRegistered(HoloHash<Dna>)

The successful response to an AdminRequest::RegisterDna

CoordinatorsUpdated

The successful response to an AdminRequest::UpdateCoordinators

AppInstalled(InstalledAppInfo)

The successful response to an AdminRequest::InstallApp.

The resulting InstalledAppInfo contains the app ID, the AppRoleIds and, most usefully, the new CellIds of the newly installed DNAs.

AppBundleInstalled(InstalledAppInfo)

The successful response to an AdminRequest::InstallAppBundle.

The resulting InstalledAppInfo contains the app ID, the AppRoleIds and, most usefully, the new CellIds of the newly installed DNAs.

AppUninstalled

The successful response to an AdminRequest::UninstallApp.

It means the app was uninstalled successfully.

CloneCellCreated(CellId)

The successful response to an AdminRequest::CreateCloneCell.

The response contains the CellId of the newly created clone.

AdminInterfacesAdded

The successful response to an AdminRequest::AddAdminInterfaces.

It means the AdminInterfaces have successfully been added.

AgentPubKeyGenerated(HoloHash<Agent>)

The successful response to an AdminRequest::GenerateAgentPubKey.

Contains a new AgentPubKey generated by the keystore.

DnasListed(Vec<HoloHash<Dna>, Global>)

The successful response to an AdminRequest::ListDnas.

Contains a list of the hashes of all installed DNAs.

CellIdsListed(Vec<CellId, Global>)

The successful response to an AdminRequest::ListCellIds.

Contains a list of all the cell IDs in the conductor.

EnabledAppsListed(Vec<String, Global>)

The successful response to an AdminRequest::ListEnabledApps.

Contains a list of all the active app IDs in the conductor.

ActiveAppsListed(Vec<String, Global>)

👎Deprecated:

alias for EnabledAppsListed

AppsListed(Vec<InstalledAppInfo, Global>)

The successful response to an AdminRequest::ListApps.

Contains a list of the InstalledAppInfo of the installed apps in the conductor.

AppInterfaceAttached

Fields

port: u16

Networking port of the new AppInterfaceApi

The successful response to an AdminRequest::AttachAppInterface.

AppInterfaceApi successfully attached. If no port was specified in the request, contains the port number that was selected by the conductor for running this app interface.

AppInterfacesListed(Vec<u16, Global>)

The list of attached app interfaces.

AppEnabled

Fields

app: InstalledAppInfo

errors: Vec<(CellId, String), Global>

The successful response to an AdminRequest::EnableApp.

It means the app was enabled successfully. If it was possible to put the app in a running state, it will be running, otherwise it will be paused.

AppActivated

Fields

app: InstalledAppInfo

👎Deprecated:

alias for AppEnabled

errors: Vec<(CellId, String), Global>

👎Deprecated:

alias for AppEnabled

👎Deprecated:

alias for AppEnabled

AppDisabled

The successful response to an AdminRequest::DisableApp.

It means the app was disabled successfully.

AppStarted(bool)

The successful response to an AdminRequest::StartApp.

The boolean determines whether or not the app was actually started. If false, it was because the app was in a disabled state, or the app failed to start. TODO: add reason why app couldn’t start

AppDeactivated

👎Deprecated:

alias for AppDisabled

StateDumped(String)

The successful response to an AdminRequest::DumpState.

The result contains a string of serialized JSON data which can be deserialized to access the full state dump and inspect the source chain.

FullStateDumped(FullStateDump)

The successful response to an AdminRequest::DumpFullState.

The result contains a string of serialized JSON data which can be deserialized to access the full state dump and inspect the source chain.

Note that this result can be very big, as it’s requesting the full database of the cell.

NetworkMetricsDumped(String)

The successful result of a call to AdminRequest::DumpNetworkMetrics.

The string is a JSON blob of the metrics results.

AgentInfoAdded

The successful response to an AdminRequest::AddAgentInfo.

This means the agent info was successfully added to the peer store.

AgentInfoRequested(Vec<AgentInfoSigned, Global>)

The successful response to an AdminRequest::RequestAgentInfo.

This is all the agent info that was found for the request.

RecordsAdded

The successful response to an AdminRequest::AddRecords.

Trait Implementations

impl Debug for AdminResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AdminResponse

fn deserialize<__D>(
    __deserializer: __D
) -> Result<AdminResponse, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for AdminResponse

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<&AdminResponse> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: &AdminResponse) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<AdminResponse> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: AdminResponse) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<SerializedBytes> for AdminResponse

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(sb: SerializedBytes) -> Result<AdminResponse, SerializedBytesError>

Performs the conversion.