Package io.openems.edge.core.host.jsonrpc

Class SetNetworkConfigRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.edge.core.host.jsonrpc.SetNetworkConfigRequest

public class SetNetworkConfigRequest
extends JsonrpcRequest

Updates the current network configuration.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "setNetworkConfig",
   "params": {
   "interfaces": {
     [name: string]: {
       "dhcp"?: boolean,
       "linkLocalAddressing"?: boolean,
       "gateway"?: string,
       "dns"?: string,
       "addresses"?: [{
         "label": string,
         "address": string,
         "subnetmask": string
       }]
     }
   }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcRequest

DEFAULT_TIMEOUT_SECONDS, id, NO_TIMEOUT, timeoutOpt

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
SetNetworkConfigRequest(List<NetworkInterface<?>> interfaces)

Method Summary

Modifier and Type	Method	Description
static SetNetworkConfigRequest	from(JsonrpcRequest r)	Parses a generic JsonrpcRequest to a SetNetworkConfigRequest.
List<NetworkInterface<?>>	getNetworkInterface()	Gets the request network interfaces.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcRequest

getId, getTimeout, toJsonObject

Methods inherited from class io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

getFullyQualifiedMethod, getMethod

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

from, from, toString

Methods inherited from class java.lang.Object

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

Field Details

METHOD

public static final String METHOD

See Also:

• Constant Field Values

Constructor Details

SetNetworkConfigRequest

public SetNetworkConfigRequest(List<NetworkInterface<?>> interfaces)

Method Details

from

public static SetNetworkConfigRequest from(JsonrpcRequest r)
                                    throws OpenemsError.OpenemsNamedException

Parses a generic JsonrpcRequest to a SetNetworkConfigRequest.

Parameters:

r - the JsonrpcRequest

Returns:

the SetNetworkConfigRequest

Throws:

OpenemsError.OpenemsNamedException - on error

getParams

public com.google.gson.JsonObject getParams()

Description copied from class: AbstractJsonrpcRequest

Gets the params JsonObject of the JsonrpcRequest.

Specified by:

getParams in class AbstractJsonrpcRequest

Returns:

the params as JsonObject

getNetworkInterface

public List<NetworkInterface<?>> getNetworkInterface()

Gets the request network interfaces.

Returns:

the network interfaces