mn.foreman.api.endpoints.pickaxe

Interface Pickaxe

All Known Implementing Classes:

PickaxeImpl

public interface Pickaxe

A Pickaxe provides a handler for interacting with the /api/pickaxe Foreman API endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Pickaxe.CancelledCommands All of the cancelled commands.
static class	Pickaxe.InfrastructureConfig An infrastructure configuration.
static class	Pickaxe.InfrastructureStats The stats for a device.
static class	Pickaxe.MinerConfig A miner configuration.
static class	Pickaxe.PickaxeConfiguration The pickaxe configuration.
static class	Pickaxe.PickaxeInstance A pickaxe instance.

Method Summary

Modifier and Type	Method and Description
List<Pickaxe.PickaxeInstance>	all() Returns all of the pickaxes.
Optional<List<String>>	cancelCommands() Cancels all of the pending or in-progress commands on this Pickaxe.
Optional<CommandDone.Response>	commandDone(CommandDone done, String commandId, boolean compress) Sends a command completion to the Foreman API.
Optional<CommandDoneBatch.Response>	commandDoneBatch(CommandDoneBatch done, boolean compress) Sends command completions to the Foreman API.
Optional<CommandStart.Response>	commandStarted(CommandStart start, boolean compress) Sends a command started to the Foreman API.
Optional<CommandStartBatch.Response>	commandStartedBatch(CommandStartBatch start, boolean compress) Sends command starts to the Foreman API.
Optional<CommandUpdate.Response>	commandUpdate(CommandUpdate update, String commandId, boolean compress) Sends a command update to the Foreman API.
Optional<CommandUpdateBatch.Response>	commandUpdateBatch(CommandUpdateBatch update, boolean compress) Sends command updates to the Foreman API.
Optional<Pickaxe.PickaxeConfiguration>	config() Obtains the configuration.
Optional<Commands>	getCommands() Queries for pending commands to be executed.
Optional<List<Pickaxe.InfrastructureConfig>>	infrastructureConfigs() Returns the infrastructure configs.
boolean	infrastructureUpdate(List<Pickaxe.InfrastructureStats> stats, boolean compress) Publishes the provided stats to the Foreman API.
Optional<List<Pickaxe.MinerConfig>>	minerConfigs(String version, String hostname, String hostIp) Returns the miner configurations.
boolean	started() Informs Foreman that the Pickaxe has started.
boolean	updateMacs(Map<Miners.Miner,String> newMacs, boolean compress) Sets the MACs for the provided miners.

Method Detail

all

List<Pickaxe.PickaxeInstance> all()

Returns all of the pickaxes.

Returns:

All of the pickaxes.

cancelCommands

Optional<List<String>> cancelCommands()

Cancels all of the pending or in-progress commands on this Pickaxe.

Returns:

The cancelled command IDs.

commandDone

Optional<CommandDone.Response> commandDone(CommandDone done,
                                           String commandId,
                                           boolean compress)

Sends a command completion to the Foreman API.

Parameters:

done - The completed command.

commandId - The referencing command ID.

compress - If the request should be compressed.

Returns:

The command response.

commandDoneBatch

Optional<CommandDoneBatch.Response> commandDoneBatch(CommandDoneBatch done,
                                                     boolean compress)

Sends command completions to the Foreman API.

Parameters:

done - The completed commands.

compress - If the request should be compressed.

Returns:

The command response.

commandStarted

Optional<CommandStart.Response> commandStarted(CommandStart start,
                                               boolean compress)

Sends a command started to the Foreman API.

Parameters:

start - The started command.

compress - If the request should be compressed.

Returns:

The command response.

commandStartedBatch

Optional<CommandStartBatch.Response> commandStartedBatch(CommandStartBatch start,
                                                         boolean compress)

Sends command starts to the Foreman API.

Parameters:

start - The started commands.

compress - If the request should be compressed.

Returns:

The command response.

commandUpdate

Optional<CommandUpdate.Response> commandUpdate(CommandUpdate update,
                                               String commandId,
                                               boolean compress)

Sends a command update to the Foreman API.

Parameters:

update - The updated command.

commandId - The referencing command ID.

compress - If the request should be compressed.

Returns:

The command response.

commandUpdateBatch

Optional<CommandUpdateBatch.Response> commandUpdateBatch(CommandUpdateBatch update,
                                                         boolean compress)

Sends command updates to the Foreman API.

Parameters:

update - The updates.

compress - If the request should be compressed.

Returns:

The command response.

config

Optional<Pickaxe.PickaxeConfiguration> config()

Obtains the configuration.

Returns:

The configuration.

getCommands

Optional<Commands> getCommands()

Queries for pending commands to be executed.

Returns:

The commands to execute, if any.

infrastructureConfigs

Optional<List<Pickaxe.InfrastructureConfig>> infrastructureConfigs()

Returns the infrastructure configs.

Returns:

The infrastructure configs.

infrastructureUpdate

boolean infrastructureUpdate(List<Pickaxe.InfrastructureStats> stats,
                             boolean compress)

Publishes the provided stats to the Foreman API.

Parameters:

stats - The stats.

compress - If the request should be compressed.

Returns:

Whether successful.

minerConfigs

Optional<List<Pickaxe.MinerConfig>> minerConfigs(String version,
                                                 String hostname,
                                                 String hostIp)

Returns the miner configurations.

Parameters:

version - The version.

hostname - The hostname.

hostIp - The host IP.

Returns:

The miner configurations.

started

boolean started()

Informs Foreman that the Pickaxe has started.

Returns:

Whether successful.

updateMacs

boolean updateMacs(Map<Miners.Miner,String> newMacs,
                   boolean compress)

Sets the MACs for the provided miners.

Parameters:

newMacs - The new MACs.

compress - If the request should be compressed.

Returns:

Whether the command was successful.