AdminImpl
Pekko actor client for the Admin service
Value parameters
- actorSystem
-
- an implicit Pekko ActorSystem
- locationService
-
- an instance of locationService
Attributes
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Fetches the current Lifecycle state of the given Assembly or HCD
Fetches the current Lifecycle state of the given Assembly or HCD
Value parameters
- componentId
-
the csw.location.api.models.ComponentId of the component whose lifecycle state needs to be fetched
Attributes
- Returns
-
a SupervisorLifecycleState as a Future value
- Definition Classes
Fetches the current Lifecycle state of the given container
Fetches the current Lifecycle state of the given container
Value parameters
- prefix
-
the csw.prefix.models.Prefix of the container whose lifecycle state needs to be fetched
Attributes
- Returns
-
a ContainerLifecycleState as a Future value
- Definition Classes
Fetches the LogMetadata for given component
Fetches the LogMetadata for given component
Value parameters
- componentId
-
the component whose LogMetadata needs to be fetched
Attributes
- Returns
-
a Future which completes and gives LogMetaData of the component
- Definition Classes
Sets the current Lifecycle state of the given component(HCD, Assembly or Container) to Offline
Sets the current Lifecycle state of the given component(HCD, Assembly or Container) to Offline
Value parameters
- componentId
-
the csw.location.api.models.ComponentId of the component which needs to be offline
Attributes
- Returns
-
a Done as a Future value
- Definition Classes
Sets the current Lifecycle state of the given component(HCD, Assembly or Container) to Online
Sets the current Lifecycle state of the given component(HCD, Assembly or Container) to Online
Value parameters
- componentId
-
the csw.location.api.models.ComponentId of the component which needs to be online
Attributes
- Returns
-
a Done as a Future value
- Definition Classes
Restarts the given component(HCD, Assembly or Container)
Restarts the given component(HCD, Assembly or Container)
Value parameters
- componentId
-
the csw.location.api.models.ComponentId of the component which needs to be restarted
Attributes
- Returns
-
a Done as a Future value
- Definition Classes
Updates the log level of component
Updates the log level of component
Value parameters
- componentId
-
the component whose log level to be changed
- level
-
represents log level to set
Attributes
- Definition Classes
Shuts down the given component(HCD, Assembly or Container)
Shuts down the given component(HCD, Assembly or Container)
Value parameters
- componentId
-
the csw.location.api.models.ComponentId of the component which needs to be shut down
Attributes
- Returns
-
a Done as a Future value
- Definition Classes