A B C D F G H I J K L M N O P Q R S T U V W

A

Actions - Interface in mn.foreman.api.endpoints.actions

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

actions() - Method in interface mn.foreman.api.ForemanApi

Creates a new Actions that can be leveraged to operate on the /api/actions Foreman API endpoint.

actions() - Method in class mn.foreman.api.ForemanApiImpl

Actions.PowerMode - Enum in mn.foreman.api.endpoints.actions

All of the known power modes.

Actions.Response - Class in mn.foreman.api.endpoints.actions

An action response.

ActionsImpl - Class in mn.foreman.api.endpoints.actions

A simple Actions implementation.

ActionsImpl(ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.actions.ActionsImpl

Constructor.

active - Variable in class mn.foreman.api.endpoints.miners.Miners.Miner

Whether or not the miner is active.

all() - Method in interface mn.foreman.api.endpoints.miners.Miners

Returns all of the miners.

all() - Method in class mn.foreman.api.endpoints.miners.MinersImpl

all() - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Returns all of the pickaxes.

all() - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

apiIp - Variable in class mn.foreman.api.endpoints.miners.Miners.Miner

The API ip.

apiIp - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig

The api ip.

apiPort - Variable in class mn.foreman.api.endpoints.miners.Miners.Miner

The API port.

apiPort - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig

The api port.

apiPort - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig.ChiselConfig

The port where chisel is listening.

apiType - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig

The API type.

ApiType - Enum in mn.foreman.api.model

A miner configuration API type.

args - Variable in class mn.foreman.api.model.CommandStart

The arguments for the command.

Autominer - Interface in mn.foreman.api.endpoints.autominer

An Autominer provides a handler for interacting with the autominer API endpoints.

autominer() - Method in interface mn.foreman.api.ForemanApi

Creates an Autominer handler.

autominer() - Method in class mn.foreman.api.ForemanApiImpl

AutominerImpl - Class in mn.foreman.api.endpoints.autominer

A Autominer implementation.

AutominerImpl(ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.autominer.AutominerImpl

Constructor.

B

BatchedDone() - Constructor for class mn.foreman.api.model.CommandDoneBatch.BatchedDone

BatchedStart() - Constructor for class mn.foreman.api.model.CommandStartBatch.BatchedStart

BatchedUpdate() - Constructor for class mn.foreman.api.model.CommandUpdateBatch.BatchedUpdate

C

cacheStats - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig

Whether the miner data should be cached and skipped periodically.

cancelCommands() - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

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

cancelCommands() - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

CancelledCommands() - Constructor for class mn.foreman.api.endpoints.pickaxe.Pickaxe.CancelledCommands

cancelledIds - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.CancelledCommands

The cancelled IDs.

changeNetwork(int, Network) - Method in interface mn.foreman.api.endpoints.actions.Actions

Changes the network for the provided miner.

changeNetwork(int, Network) - Method in class mn.foreman.api.endpoints.actions.ActionsImpl

changePools(int, List<Pool>) - Method in interface mn.foreman.api.endpoints.actions.Actions

Changes the pools for the provided miner.

changePools(int, List<Pool>) - Method in class mn.foreman.api.endpoints.actions.ActionsImpl

changePowerMode(int, Actions.PowerMode) - Method in interface mn.foreman.api.endpoints.actions.Actions

Changes the power mode for the provided miner.

changePowerMode(int, Actions.PowerMode) - Method in class mn.foreman.api.endpoints.actions.ActionsImpl

chisel - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig

The chisel configuration.

ChiselConfig() - Constructor for class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig.ChiselConfig

Claymore - Interface in mn.foreman.api.endpoints.claymore

A Claymore provides a handler for interacting with the claymore API endpoints.

claymore() - Method in interface mn.foreman.api.ForemanApi

Creates a Claymore handlers.

claymore() - Method in class mn.foreman.api.ForemanApiImpl

ClaymoreImpl - Class in mn.foreman.api.endpoints.claymore

A Claymore implementation.

ClaymoreImpl(ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.claymore.ClaymoreImpl

Constructor.

clientName - Variable in class mn.foreman.api.endpoints.groups.Groups.GroupInfo.SubClient

The client name.

collectDelay - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The collect delay.

collectDelayUnits - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The collect delay (units).

command - Variable in class mn.foreman.api.endpoints.actions.Actions.Response

The new command ID.

Command - Interface in mn.foreman.api.model

A marker interface for all commands.

command - Variable in class mn.foreman.api.model.CommandStart

The command.

commandCompletionBatchSize - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The command completion batch size.

commandDone(CommandDone, String) - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Sends a command completion to the Foreman API.

commandDone(CommandDone, String) - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

CommandDone - Class in mn.foreman.api.model

A CommandDone represents all of the information related to a Pickaxe command finishing.

CommandDone() - Constructor for class mn.foreman.api.model.CommandDone

CommandDone.Response - Class in mn.foreman.api.model

The response.

CommandDone.Status - Class in mn.foreman.api.model

The status.

commandDoneBatch(CommandDoneBatch) - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Sends command completions to the Foreman API.

commandDoneBatch(CommandDoneBatch) - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

CommandDoneBatch - Class in mn.foreman.api.model

A CommandDoneBatch represents all of the information related to Pickaxe commands finishing.

CommandDoneBatch() - Constructor for class mn.foreman.api.model.CommandDoneBatch

CommandDoneBatch.BatchedDone - Class in mn.foreman.api.model

The completed command.

CommandDoneBatch.Response - Class in mn.foreman.api.model

The response.

commandQueryDelay - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The command query delay.

commandQueryDelayUnits - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The command query delay (units).

Commands - Class in mn.foreman.api.model

The commands to run.

Commands() - Constructor for class mn.foreman.api.model.Commands

commands - Variable in class mn.foreman.api.model.Commands

The commands to run.

CommandStart - Class in mn.foreman.api.model

A CommandStart represents a command to be performed against miners.

CommandStart() - Constructor for class mn.foreman.api.model.CommandStart

CommandStart.Response - Class in mn.foreman.api.model

The response.

CommandStartBatch - Class in mn.foreman.api.model

A CommandStartBatch represents command to be performed against miners.

CommandStartBatch() - Constructor for class mn.foreman.api.model.CommandStartBatch

CommandStartBatch.BatchedStart - Class in mn.foreman.api.model

The started command.

CommandStartBatch.Response - Class in mn.foreman.api.model

The response.

commandStarted(CommandStart) - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Sends a command started to the Foreman API.

commandStarted(CommandStart) - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

commandStartedBatch(CommandStartBatch) - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Sends command starts to the Foreman API.

commandStartedBatch(CommandStartBatch) - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

commandThreadsOverride - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of threads to use for processing commands.

commandUpdate(CommandUpdate, String) - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Sends a command update to the Foreman API.

commandUpdate(CommandUpdate, String) - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

CommandUpdate - Class in mn.foreman.api.model

A CommandUpdate represents an update to the Foreman dashboard from a command that's being ran.

CommandUpdate() - Constructor for class mn.foreman.api.model.CommandUpdate

CommandUpdate.Response - Class in mn.foreman.api.model

The response.

commandUpdateBatch(CommandUpdateBatch) - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Sends command updates to the Foreman API.

commandUpdateBatch(CommandUpdateBatch) - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

CommandUpdateBatch - Class in mn.foreman.api.model

A CommandUpdateBatch represents updates to the Foreman dashboard from commands being ran.

CommandUpdateBatch() - Constructor for class mn.foreman.api.model.CommandUpdateBatch

CommandUpdateBatch.BatchedUpdate - Class in mn.foreman.api.model

The started command.

CommandUpdateBatch.Response - Class in mn.foreman.api.model

The response.

compressMetrics - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

Whether or not metrics should be compressed.

config() - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Obtains the configuration.

config() - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

CPower - Interface in mn.foreman.api.endpoints.csp.cpower

Endpoints for CPower-related processing.

cpower() - Method in interface mn.foreman.api.endpoints.csp.Csp

Returns a new CPower.

cpower() - Method in class mn.foreman.api.endpoints.csp.CspImpl

CPowerImpl - Class in mn.foreman.api.endpoints.csp.cpower

A simple implementation for communicating with the Foreman CPower API.

CPowerImpl(String, ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.csp.cpower.CPowerImpl

Constructor.

cpowerPlcEnabled - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

Whether the CPower PLC integration is enabled.

cpowerPlcIp - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The CPower PLC IP address.

cpowerPlcPassword - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The CPower PLC password.

cpowerPlcPort - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The CPower PLC port.

cpowerPlcUsername - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The CPower PLC username.

Csp - Interface in mn.foreman.api.endpoints.csp

Endpoints for CSP-related processing.

csp() - Method in interface mn.foreman.api.ForemanApi

Creates a Csp handler.

csp() - Method in class mn.foreman.api.ForemanApiImpl

CspImpl - Class in mn.foreman.api.endpoints.csp

An implementation to handle CSP-related actions against the Foreman API.

CspImpl(String, ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.csp.CspImpl

Constructor.

CurrentLoad() - Constructor for class mn.foreman.api.endpoints.qse.prioritypower.PriorityPower.CurrentLoad

D

delay - Variable in class mn.foreman.api.model.Commands

How long to wait before polling for commands again.

delaySeconds - Variable in class mn.foreman.api.model.Commands

How long to wait before polling for commands again.

delayUnits - Variable in class mn.foreman.api.model.Commands

How long to wait before polling for commands again (units).

details - Variable in class mn.foreman.api.model.CommandDone.Status

A detailed message.

diagnosis - Variable in class mn.foreman.api.endpoints.notifications.Notifications.Notification.FailingMiner

The diagnosis.

discord(int, Instant) - Method in interface mn.foreman.api.endpoints.notifications.Notifications

Obtains the Discord notifications.

discord(int, Instant) - Method in class mn.foreman.api.endpoints.notifications.NotificationsImpl

dns - Variable in class mn.foreman.api.model.Network

The DNS entry.

DoneStatus - Enum in mn.foreman.api.model

The status for the CommandDone.Response.

F

FailingMiner() - Constructor for class mn.foreman.api.endpoints.notifications.Notifications.Notification.FailingMiner

failingMiners - Variable in class mn.foreman.api.endpoints.notifications.Notifications.Notification

The failing miners.

ForemanApi - Interface in mn.foreman.api

A ForemanApi provides a mechanism for interacting with the Foreman API.

ForemanApiImpl - Class in mn.foreman.api

An implementation of a ForemanApi.

ForemanApiImpl(String, String, ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.ForemanApiImpl

Constructor.

forValue(int) - Static method in enum mn.foreman.api.model.ApiType

Returns the type for the provided value.

forValue(String) - Static method in enum mn.foreman.api.model.InfrastructureType

Returns the type for the provided value.

fromJson(String, ObjectMapper, TypeReference<T>) - Static method in class mn.foreman.api.JsonUtils

Converts the provided json to the desired type.

G

gateway - Variable in class mn.foreman.api.model.Network

The gateway.

get(String) - Method in class mn.foreman.api.JdkWebUtil

get(String, boolean) - Method in class mn.foreman.api.JdkWebUtil

get(String, Map<String, String>) - Method in class mn.foreman.api.JdkWebUtil

get(String) - Method in interface mn.foreman.api.WebUtil

Performs a GET operation against the provided URI.

get(String, boolean) - Method in interface mn.foreman.api.WebUtil

Performs a GET operation against the provided URI.

get(String, Map<String, String>) - Method in interface mn.foreman.api.WebUtil

Performs a GET operation against the provided URI.

getCommands() - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Queries for pending commands to be executed.

getCommands() - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

getStatus() - Method in enum mn.foreman.api.model.DoneStatus

Returns the status.

getType() - Method in enum mn.foreman.api.model.ApiType

Returns the type.

getType() - Method in enum mn.foreman.api.model.InfrastructureType

Returns the type.

googleChat(int, Instant) - Method in interface mn.foreman.api.endpoints.notifications.Notifications

Obtains the Google Chat notifications.

googleChat(int, Instant) - Method in class mn.foreman.api.endpoints.notifications.NotificationsImpl

GroupInfo() - Constructor for class mn.foreman.api.endpoints.groups.Groups.GroupInfo

Groups - Interface in mn.foreman.api.endpoints.groups

A Notifications provides a handler for interacting with the /api/groups Foreman API endpoint.

groups() - Method in interface mn.foreman.api.endpoints.groups.Groups

Obtains the Groups.GroupInfo.

groups() - Method in class mn.foreman.api.endpoints.groups.GroupsImpl

groups() - Method in interface mn.foreman.api.ForemanApi

Creates a new Actions that can be leveraged to operate on the /api/groups Foreman API endpoint.

groups() - Method in class mn.foreman.api.ForemanApiImpl

Groups.GroupInfo - Class in mn.foreman.api.endpoints.groups

An object representing group information.

Groups.GroupInfo.SubClient - Class in mn.foreman.api.endpoints.groups

An object representing a sub-client.

GroupsImpl - Class in mn.foreman.api.endpoints.groups

A simple Actions implementation.

GroupsImpl(String, ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.groups.GroupsImpl

Constructor.

H

highLimit - Variable in class mn.foreman.api.endpoints.qse.prioritypower.PriorityPower.CurrentLoad

The high limit.

hostname - Variable in class mn.foreman.api.model.Network

The hostname.

I

id - Variable in class mn.foreman.api.endpoints.groups.Groups.GroupInfo.SubClient

The client ID.

id - Variable in class mn.foreman.api.endpoints.miners.Miners.Miner

The miner ID.

id - Variable in class mn.foreman.api.endpoints.notifications.Notifications.Notification

The notification ID.

id - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.InfrastructureConfig

The ID.

id - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeInstance

The id.

id - Variable in class mn.foreman.api.model.CommandStart

The command ID.

ignoreConsumption - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig

Whether to ignore consumption.

info - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.InfrastructureConfig

The info.

infrastructureCollectDelay - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The infrastructure collect delay.

infrastructureCollectDelayUnits - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The infrastructure collect delay (units).

InfrastructureConfig() - Constructor for class mn.foreman.api.endpoints.pickaxe.Pickaxe.InfrastructureConfig

infrastructureConfigs() - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Returns the infrastructure configs.

infrastructureConfigs() - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

infrastructureMetricsBatchSize - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The size of each infrastructure metrics batch.

infrastructureMetricsPushDelay - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The infrastructure metrics push delay.

infrastructureMetricsPushDelayUnits - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The infrastructure metrics push delay (units).

infrastructureMetricsThreadsOverride - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of threads to use for infrastructure metrics sending.

InfrastructureStats() - Constructor for class mn.foreman.api.endpoints.pickaxe.Pickaxe.InfrastructureStats

infrastructureThreadsOverride - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of threads to use for infrastructure querying.

InfrastructureType - Enum in mn.foreman.api.model

All of the known infrastructure types.

infrastructureUpdate(List<Pickaxe.InfrastructureStats>) - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Publishes the provided stats to the Foreman API.

infrastructureUpdate(List<Pickaxe.InfrastructureStats>) - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

ipAddress - Variable in class mn.foreman.api.model.Network

The IP address.

isDone() - Method in enum mn.foreman.api.endpoints.actions.StatusRunning

Returns whether or not the action is done.

isFast - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.InfrastructureConfig

Use Fast collection interval.

isSuccess() - Method in enum mn.foreman.api.endpoints.actions.StatusRunning

Returns whether or not the action is done.

isSuccess() - Method in enum mn.foreman.api.endpoints.StatusSubmit

Returns whether or not the action was accepted.

J

JdkWebUtil - Class in mn.foreman.api

A WebUtil implementation that uses native JDK libraries.

JdkWebUtil(String, String, int, TimeUnit) - Constructor for class mn.foreman.api.JdkWebUtil

Constructor.

JsonUtils - Class in mn.foreman.api

Utilities for parsing json.

JsonUtils() - Constructor for class mn.foreman.api.JsonUtils

jvmArguments - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The JVM arguments.

K

key - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig.Param

The key.

key - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeInstance

The key.

L

label - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeInstance

The label.

lastUpdated - Variable in class mn.foreman.api.endpoints.miners.Miners.Miner

When the miner was last updated.

lowLimit - Variable in class mn.foreman.api.endpoints.qse.prioritypower.PriorityPower.CurrentLoad

The low limit.

M

mac - Variable in class mn.foreman.api.endpoints.miners.Miners.Miner

The MAC address.

MacUpdate - Class in mn.foreman.api.model

An update request to update a miner's MAC address.

MacUpdate() - Constructor for class mn.foreman.api.model.MacUpdate

mappings() - Method in interface mn.foreman.api.endpoints.autominer.Autominer

Returns all of the autominer mappings.

mappings() - Method in class mn.foreman.api.endpoints.autominer.AutominerImpl

mappings() - Method in interface mn.foreman.api.endpoints.claymore.Claymore

Returns all of the claymore mappings.

mappings() - Method in class mn.foreman.api.endpoints.claymore.ClaymoreImpl

mappings() - Method in interface mn.foreman.api.endpoints.nicehash.Nicehash

Returns all of the nicehash mappings.

mappings() - Method in class mn.foreman.api.endpoints.nicehash.NicehashImpl

message - Variable in class mn.foreman.api.model.CommandDone.Status

The message.

metricsBatchSize - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The size of each metrics batch.

metricsPushDelay - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The metrics push delay.

metricsPushDelayUnits - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The metrics push delay (units).

metricsRateLimit - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of IPs to scan per second.

metricsThreadsOverride - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of threads to use for metrics sending.

Miner() - Constructor for class mn.foreman.api.endpoints.miners.Miners.Miner

miner - Variable in class mn.foreman.api.endpoints.notifications.Notifications.Notification.FailingMiner

The miner's name.

MinerConfig() - Constructor for class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig

minerConfigs(String, String, String) - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Returns the miner configurations.

minerConfigs(String, String, String) - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

minerId - Variable in class mn.foreman.api.endpoints.notifications.Notifications.Notification.FailingMiner

The miner ID.

Miners - Interface in mn.foreman.api.endpoints.miners

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

miners() - Method in interface mn.foreman.api.ForemanApi

Creates a new Miners that can be leveraged to operate on the /api/miners Foreman API endpoint.

miners() - Method in class mn.foreman.api.ForemanApiImpl

Miners.Miner - Class in mn.foreman.api.endpoints.miners

A miner object.

MinersImpl - Class in mn.foreman.api.endpoints.miners

The miners endpoint.

MinersImpl(String, String, ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.miners.MinersImpl

Constructor.

mn.foreman.api - package mn.foreman.api

mn.foreman.api.endpoints - package mn.foreman.api.endpoints

mn.foreman.api.endpoints.actions - package mn.foreman.api.endpoints.actions

mn.foreman.api.endpoints.autominer - package mn.foreman.api.endpoints.autominer

mn.foreman.api.endpoints.claymore - package mn.foreman.api.endpoints.claymore

mn.foreman.api.endpoints.csp - package mn.foreman.api.endpoints.csp

mn.foreman.api.endpoints.csp.cpower - package mn.foreman.api.endpoints.csp.cpower

mn.foreman.api.endpoints.groups - package mn.foreman.api.endpoints.groups

mn.foreman.api.endpoints.miners - package mn.foreman.api.endpoints.miners

mn.foreman.api.endpoints.nicehash - package mn.foreman.api.endpoints.nicehash

mn.foreman.api.endpoints.notifications - package mn.foreman.api.endpoints.notifications

mn.foreman.api.endpoints.pickaxe - package mn.foreman.api.endpoints.pickaxe

mn.foreman.api.endpoints.ping - package mn.foreman.api.endpoints.ping

mn.foreman.api.endpoints.qse - package mn.foreman.api.endpoints.qse

mn.foreman.api.endpoints.qse.prioritypower - package mn.foreman.api.endpoints.qse.prioritypower

mn.foreman.api.endpoints.sitemap - package mn.foreman.api.endpoints.sitemap

mn.foreman.api.endpoints.tags - package mn.foreman.api.endpoints.tags

mn.foreman.api.model - package mn.foreman.api.model

N

name - Variable in class mn.foreman.api.endpoints.groups.Groups.GroupInfo

The group name.

name - Variable in class mn.foreman.api.endpoints.miners.Miners.Miner

The miner name.

netmask - Variable in class mn.foreman.api.model.Network

The netmask.

Network - Class in mn.foreman.api.model

A network configuration.

Network() - Constructor for class mn.foreman.api.model.Network

Nicehash - Interface in mn.foreman.api.endpoints.nicehash

A Nicehash provides a handler for interacting with the nicehash API endpoints.

nicehash() - Method in interface mn.foreman.api.ForemanApi

Creates a Nicehash handler.

nicehash() - Method in class mn.foreman.api.ForemanApiImpl

NicehashImpl - Class in mn.foreman.api.endpoints.nicehash

A Nicehash implementation.

NicehashImpl(ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.nicehash.NicehashImpl

Constructor.

Notification() - Constructor for class mn.foreman.api.endpoints.notifications.Notifications.Notification

Notifications - Interface in mn.foreman.api.endpoints.notifications

A Notifications provides a handler for interacting with the /api/notifications Foreman API endpoint.

notifications() - Method in interface mn.foreman.api.ForemanApi

Creates a new Notifications that can be leveraged to operate on the /api/notifications Foreman API endpoint.

notifications() - Method in class mn.foreman.api.ForemanApiImpl

Notifications.Notification - Class in mn.foreman.api.endpoints.notifications

A notification.

Notifications.Notification.FailingMiner - Class in mn.foreman.api.endpoints.notifications

A miner that is currently failing.

NotificationsImpl - Class in mn.foreman.api.endpoints.notifications

A simple Notifications implementation.

NotificationsImpl(String, ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.notifications.NotificationsImpl

Constructor.

O

one(int) - Method in interface mn.foreman.api.endpoints.miners.Miners

Returns one Miners.Miner.

one(int) - Method in class mn.foreman.api.endpoints.miners.MinersImpl

P

Param() - Constructor for class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig.Param

params - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig

The parameters.

Pickaxe - Interface in mn.foreman.api.endpoints.pickaxe

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

pickaxe() - Method in interface mn.foreman.api.ForemanApi

Creates a new Pickaxe that can be leveraged to operate on the /api/pickaxe Foreman API endpoint.

pickaxe() - Method in class mn.foreman.api.ForemanApiImpl

Pickaxe.CancelledCommands - Class in mn.foreman.api.endpoints.pickaxe

All of the cancelled commands.

Pickaxe.InfrastructureConfig - Class in mn.foreman.api.endpoints.pickaxe

An infrastructure configuration.

Pickaxe.InfrastructureStats - Class in mn.foreman.api.endpoints.pickaxe

The stats for a device.

Pickaxe.MinerConfig - Class in mn.foreman.api.endpoints.pickaxe

A miner configuration.

Pickaxe.MinerConfig.ChiselConfig - Class in mn.foreman.api.endpoints.pickaxe

A chisel configuration.

Pickaxe.MinerConfig.Param - Class in mn.foreman.api.endpoints.pickaxe

A miner configuration parameter.

Pickaxe.PickaxeConfiguration - Class in mn.foreman.api.endpoints.pickaxe

The pickaxe configuration.

Pickaxe.PickaxeInstance - Class in mn.foreman.api.endpoints.pickaxe

A pickaxe instance.

PickaxeConfiguration() - Constructor for class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

PickaxeImpl - Class in mn.foreman.api.endpoints.pickaxe

A simple Pickaxe implementation.

PickaxeImpl(String, String, ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

Constructor.

PickaxeInstance() - Constructor for class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeInstance

Ping - Interface in mn.foreman.api.endpoints.ping

Pings the dashboard to verify the credentials worked.

ping() - Method in interface mn.foreman.api.endpoints.ping.Ping

Pings the dashboard to validate connectivity.

ping() - Method in class mn.foreman.api.endpoints.ping.PingImpl

ping() - Method in interface mn.foreman.api.ForemanApi

Creates a new Ping that can be leveraged to test API credentials.

ping() - Method in class mn.foreman.api.ForemanApiImpl

pingClient() - Method in interface mn.foreman.api.endpoints.ping.Ping

Pings the dashboard to validate auth against the client.

pingClient() - Method in class mn.foreman.api.endpoints.ping.PingImpl

PingImpl - Class in mn.foreman.api.endpoints.ping

Pings the dashboard to test the provided API credentials.

PingImpl(String, WebUtil) - Constructor for class mn.foreman.api.endpoints.ping.PingImpl

Constructor.

platform - Variable in class mn.foreman.api.endpoints.miners.Miners.Miner

The platform.

Pool - Class in mn.foreman.api.model

A mining pool.

Pool() - Constructor for class mn.foreman.api.model.Pool

post(String) - Method in class mn.foreman.api.JdkWebUtil

post(String, String) - Method in class mn.foreman.api.JdkWebUtil

post(String) - Method in interface mn.foreman.api.WebUtil

Performs a POST operation against the provided URI.

post(String, String) - Method in interface mn.foreman.api.WebUtil

Performs a POST operation against the provided URI with content.

priorityEnabled - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

Whether priority power integration is enabled.

PriorityPower - Interface in mn.foreman.api.endpoints.qse.prioritypower

A PriorityPower provides a mechanism for relaying PriorityPower-related RTAC information to/from Foreman.

priorityPower() - Method in interface mn.foreman.api.endpoints.qse.Qse

Returns a handler for publishing PriorityPower-related data to Foreman.

priorityPower() - Method in class mn.foreman.api.endpoints.qse.QseImpl

PriorityPower.CurrentLoad - Class in mn.foreman.api.endpoints.qse.prioritypower

The load to configure into the RTAC.

PriorityPowerImpl - Class in mn.foreman.api.endpoints.qse.prioritypower

An implementation that will communicate with the Foreman API.

PriorityPowerImpl(String, ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.qse.prioritypower.PriorityPowerImpl

Constructor.

priorityRtacClientAddress - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The priority power RTAC client address.

priorityRtacIp - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The priority power RTAC IP address.

priorityRtacPort - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The priority power RTAC port.

priorityRtacServerAddress - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The priority power RTAC server address.

published - Variable in class mn.foreman.api.endpoints.notifications.Notifications.Notification

When the notification was published.

put(String, String) - Method in class mn.foreman.api.JdkWebUtil

put(String, String) - Method in interface mn.foreman.api.WebUtil

Performs a PUT operation against the provided URI.

Q

Qse - Interface in mn.foreman.api.endpoints.qse

Endpoints for QSE-related processing.

qse() - Method in interface mn.foreman.api.ForemanApi

Creates a Qse handler.

qse() - Method in class mn.foreman.api.ForemanApiImpl

QseImpl - Class in mn.foreman.api.endpoints.qse

An implementation to handle QSE-related actions against the Foreman API.

QseImpl(String, ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.qse.QseImpl

Constructor.

R

rangesRateLimit - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of IPs to scan per second.

rangesScannerThreadsOverride - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of threads to use for scanning (ranges).

rangesTargetedRateLimit - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of IPs to scan per second.

readSocketTimeout - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The read socket timeout.

readSocketTimeoutUnits - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The read socket timeout (units).

Response() - Constructor for class mn.foreman.api.endpoints.actions.Actions.Response

Response() - Constructor for class mn.foreman.api.endpoints.sitemap.SiteMap.Response

Response() - Constructor for class mn.foreman.api.model.CommandDone.Response

Response() - Constructor for class mn.foreman.api.model.CommandDoneBatch.Response

Response() - Constructor for class mn.foreman.api.model.CommandStart.Response

Response() - Constructor for class mn.foreman.api.model.CommandStartBatch.Response

Response() - Constructor for class mn.foreman.api.model.CommandUpdate.Response

Response() - Constructor for class mn.foreman.api.model.CommandUpdateBatch.Response

runId - Variable in class mn.foreman.api.endpoints.qse.prioritypower.PriorityPower.CurrentLoad

The curtailment run ID.

S

seen - Variable in class mn.foreman.api.endpoints.miners.Miners.Miner

Whether or not the miner has been seen.

setLocation(int, String, int, int) - Method in interface mn.foreman.api.endpoints.sitemap.SiteMap

Changes the site map location of a miner.

setLocation(int, String, int, int) - Method in class mn.foreman.api.endpoints.sitemap.SiteMapImpl

SiteMap - Interface in mn.foreman.api.endpoints.sitemap

A SiteMap provides a handler for interacting with the /api/site-map/ Foreman API endpoint.

siteMap() - Method in interface mn.foreman.api.ForemanApi

Creates a new SiteMap that can be leveraged to operate on the /api/site-map Foreman API endpoint.

siteMap() - Method in class mn.foreman.api.ForemanApiImpl

SiteMap.Response - Class in mn.foreman.api.endpoints.sitemap

An response.

SiteMapImpl - Class in mn.foreman.api.endpoints.sitemap

All of the handlers for interacting with the SiteMap API.

SiteMapImpl(ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.sitemap.SiteMapImpl

Constructor.

slack(int, Instant) - Method in interface mn.foreman.api.endpoints.notifications.Notifications

Obtains the Slack notifications.

slack(int, Instant) - Method in class mn.foreman.api.endpoints.notifications.NotificationsImpl

started() - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Informs Foreman that the Pickaxe has started.

started() - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

startStopRateLimit - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of IPs to scan per second.

startStopScannerThreadsOverride - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of threads to use for scanning (start/stop).

startStopTargetedRateLimit - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of IPs to scan per second.

statsThreadsOverride - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of threads to use for stats querying.

status - Variable in class mn.foreman.api.endpoints.actions.Actions.Response

The status.

status(int) - Method in interface mn.foreman.api.endpoints.actions.Actions

Gets the status of the provided command.

status(int) - Method in class mn.foreman.api.endpoints.actions.ActionsImpl

status - Variable in class mn.foreman.api.endpoints.miners.Miners.Miner

The miner status.

status - Variable in class mn.foreman.api.endpoints.sitemap.SiteMap.Response

The status.

status - Variable in class mn.foreman.api.model.CommandDone.Response

The command status.

Status() - Constructor for class mn.foreman.api.model.CommandDone.Status

status - Variable in class mn.foreman.api.model.CommandStart.Response

The command status.

status - Variable in class mn.foreman.api.model.CommandUpdate.Response

The command status.

StatusRunning - Enum in mn.foreman.api.endpoints.actions

The action statuses.

StatusSubmit - Enum in mn.foreman.api.endpoints

The action submit statuses.

SubClient() - Constructor for class mn.foreman.api.endpoints.groups.Groups.GroupInfo.SubClient

subClients - Variable in class mn.foreman.api.endpoints.groups.Groups.GroupInfo

The sub-clients.

subject - Variable in class mn.foreman.api.endpoints.notifications.Notifications.Notification

The subject.

success - Variable in class mn.foreman.api.model.CommandDoneBatch.Response

The number of successful completions.

success - Variable in class mn.foreman.api.model.CommandStartBatch.Response

The number of successful starts.

success - Variable in class mn.foreman.api.model.CommandUpdateBatch.Response

The number of successful updates.

T

tag(int, List<String>) - Method in interface mn.foreman.api.endpoints.tags.Tags

Tags the provided miner with the provided tags.

tag(int, List<String>) - Method in class mn.foreman.api.endpoints.tags.TagsImpl

Tags - Interface in mn.foreman.api.endpoints.tags

Provides an API handler for tagging miners.

tags() - Method in interface mn.foreman.api.ForemanApi

Creates a new Tags that can be leveraged to operate on the /api/tags Foreman API endpoint.

tags() - Method in class mn.foreman.api.ForemanApiImpl

TagsImpl - Class in mn.foreman.api.endpoints.tags

A simple Tags implementation.

TagsImpl(ObjectMapper, WebUtil) - Constructor for class mn.foreman.api.endpoints.tags.TagsImpl

Constructor.

targetedRangesScannerThreadsOverride - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of threads to use for scanning (targeted, ranges).

targetedStartStopScannerThreadsOverride - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The number of threads to use for scanning (targeted, start/stop).

telegram(int, Instant) - Method in interface mn.foreman.api.endpoints.notifications.Notifications

Obtains the Telegram notifications.

telegram(int, Instant) - Method in class mn.foreman.api.endpoints.notifications.NotificationsImpl

toString() - Method in class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig.ChiselConfig

toString() - Method in class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig.Param

type - Variable in class mn.foreman.api.endpoints.miners.Miners.Miner

The miner type.

type - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.InfrastructureConfig

The type.

type - Variable in class mn.foreman.api.model.CommandDone.Status

The type.

U

update(int, String, String, String, String, String) - Method in interface mn.foreman.api.endpoints.miners.Miners

Updates the miner with the provided parameters.

update(int, String, String, String, String, String) - Method in class mn.foreman.api.endpoints.miners.MinersImpl

updateMacs(Map<Miners.Miner, String>) - Method in interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Sets the MACs for the provided miners.

updateMacs(Map<Miners.Miner, String>) - Method in class mn.foreman.api.endpoints.pickaxe.PickaxeImpl

updateRtacStats(boolean, double, double, double, double) - Method in interface mn.foreman.api.endpoints.qse.prioritypower.PriorityPower

Updates the RTAC state in Foreman.

updateRtacStats(boolean, double, double, double, double) - Method in class mn.foreman.api.endpoints.qse.prioritypower.PriorityPowerImpl

updateState(double, double, double) - Method in interface mn.foreman.api.endpoints.csp.cpower.CPower

Updates the state in Foreman.

updateState(double, double, double) - Method in class mn.foreman.api.endpoints.csp.cpower.CPowerImpl

V

value - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.MinerConfig.Param

The value.

valueOf(String) - Static method in enum mn.foreman.api.endpoints.actions.Actions.PowerMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum mn.foreman.api.endpoints.actions.StatusRunning

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum mn.foreman.api.endpoints.StatusSubmit

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum mn.foreman.api.model.ApiType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum mn.foreman.api.model.DoneStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum mn.foreman.api.model.InfrastructureType

Returns the enum constant of this type with the specified name.

values() - Static method in enum mn.foreman.api.endpoints.actions.Actions.PowerMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum mn.foreman.api.endpoints.actions.StatusRunning

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum mn.foreman.api.endpoints.StatusSubmit

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum mn.foreman.api.model.ApiType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum mn.foreman.api.model.DoneStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum mn.foreman.api.model.InfrastructureType

Returns an array containing the constants of this enum type, in the order they are declared.

version - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeInstance

The version.

W

WebUtil - Interface in mn.foreman.api

WebUtil provides utility functions for performing HTTP operations against the Foreman API.

writeSocketTimeout - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The write socket timeout.

writeSocketTimeoutUnits - Variable in class mn.foreman.api.endpoints.pickaxe.Pickaxe.PickaxeConfiguration

The write socket timeout (units).

A B C D F G H I J K L M N O P Q R S T U V W