mn.foreman.api.endpoints.actions

Interface Actions

All Known Implementing Classes:

ActionsImpl

public interface Actions

An Actions provides a handler for interacting with the /api/actions Foreman API endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Actions.PowerMode All of the known power modes.
static class	Actions.Response An action response.

Method Summary

Modifier and Type	Method and Description
Optional<Actions.Response>	changeNetwork(int minerId, Network network, boolean compress) Changes the network for the provided miner.
Optional<Actions.Response>	changePools(int minerId, List<Pool> pools, boolean compress) Changes the pools for the provided miner.
Optional<Actions.Response>	changePowerMode(int minerId, Actions.PowerMode mode, boolean compress) Changes the power mode for the provided miner.
Optional<StatusRunning>	status(int command) Gets the status of the provided command.

Method Detail

changeNetwork

Optional<Actions.Response> changeNetwork(int minerId,
                                         Network network,
                                         boolean compress)

Changes the network for the provided miner.

Parameters:

minerId - The miner ID.

network - The new network configuration.

compress - If the request should be compressed.

Returns:

The response, if present.

changePools

Optional<Actions.Response> changePools(int minerId,
                                       List<Pool> pools,
                                       boolean compress)

Changes the pools for the provided miner.

Parameters:

minerId - The miner ID.

pools - The new pools.

compress - If the request should be compressed.

Returns:

The response, if present.

changePowerMode

Optional<Actions.Response> changePowerMode(int minerId,
                                           Actions.PowerMode mode,
                                           boolean compress)

Changes the power mode for the provided miner.

Parameters:

minerId - The miner ID.

mode - The power mode.

compress - If the request should be compressed.

Returns:

The response, if present.

status

Optional<StatusRunning> status(int command)

Gets the status of the provided command.

Parameters:

command - The command.

Returns:

The status, if present.