mn.foreman.api.endpoints.miners

Interface Miners

All Known Implementing Classes:

MinersImpl

public interface Miners

A Miners provides a handler for interacting with the /api/miners Foreman API endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Miners.Miner A miner object.

Method Summary

Modifier and Type	Method and Description
List<Miners.Miner>	all() Returns all of the miners.
Optional<Miners.Miner>	one(int minerId) Returns one Miners.Miner.
Optional<Miners.Miner>	update(int minerId, String name, String apiIp, String platform, String minerType, String serial) Updates the miner with the provided parameters.

Method Detail

all

List<Miners.Miner> all()

Returns all of the miners.

Returns:

The miners.

one

Optional<Miners.Miner> one(int minerId)

Returns one Miners.Miner.

Parameters:

minerId - The ID.

Returns:

The miner.

update

Optional<Miners.Miner> update(int minerId,
                              String name,
                              String apiIp,
                              String platform,
                              String minerType,
                              String serial)

Updates the miner with the provided parameters.

Parameters:

minerId - The miner ID.

name - The name.

apiIp - The API IP (leave null to not update).

platform - The platform.

minerType - The miner type.

serial - The serial (leave null to not update).

Returns:

The new Miners.Miner.