mn.foreman.api.endpoints.miners

Class MinersImpl

java.lang.Object

mn.foreman.api.endpoints.miners.MinersImpl

All Implemented Interfaces:

Miners

public class MinersImpl
extends Object
implements Miners

The miners endpoint.

Nested Class Summary

Nested classes/interfaces inherited from interface mn.foreman.api.endpoints.miners.Miners

Miners.Miner

Constructor Summary

Constructors

Constructor and Description
MinersImpl(String clientId, String pickaxeId, com.fasterxml.jackson.databind.ObjectMapper objectMapper, WebUtil webUtil) Constructor.

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, boolean compress) Updates the miner with the provided parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MinersImpl

public MinersImpl(String clientId,
                  String pickaxeId,
                  com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                  WebUtil webUtil)

Constructor.

Parameters:

clientId - The client ID.

pickaxeId - The pickaxe ID.

objectMapper - The mapper.

webUtil - The web util.

Method Detail

all

public List<Miners.Miner> all()

Description copied from interface: Miners

Returns all of the miners.

Specified by:

all in interface Miners

Returns:

The miners.

one

public Optional<Miners.Miner> one(int minerId)

Description copied from interface: Miners

Returns one Miners.Miner.

Specified by:

one in interface Miners

Parameters:

minerId - The ID.

Returns:

The miner.

update

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

Description copied from interface: Miners

Updates the miner with the provided parameters.

Specified by:

update in interface Miners

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).

compress - If the request should be compressed.

Returns:

The new Miners.Miner.