Network
extends Endpoint
in package
Tags
Table of Contents
Constants
- PATH : mixed = '/network'
Properties
Methods
- __construct() : mixed
- addRemote() : Task
- Add a remote to the network.
- addRemotesToShard() : Task
- get() : NetworkResults
- initialize() : Task
- removeRemote() : Task
- Remove a remote from the network.
- removeRemotesFromShard() : Task
- dispatchPatch() : Task
Constants
PATH
protected
mixed
PATH
= '/network'
Properties
$http
protected
Http
$http
Methods
__construct()
public
__construct(Http $http) : mixed
Parameters
- $http : Http
addRemote()
Add a remote to the network.
public
addRemote(non-empty-string $name, RemoteConfig $remote) : Task
Parameters
- $name : non-empty-string
- $remote : RemoteConfig
Return values
TaskaddRemotesToShard()
public
addRemotesToShard(non-empty-string $shardName, array<int, non-empty-string> $remoteNames) : Task
Parameters
- $shardName : non-empty-string
- $remoteNames : array<int, non-empty-string>
Return values
Taskget()
public
get() : NetworkResults
Return values
NetworkResultsinitialize()
public
initialize(ShardConfig>} $options) : Task
Parameters
- $options : ShardConfig>}
Return values
TaskremoveRemote()
Remove a remote from the network.
public
removeRemote(non-empty-string $name) : Task
Parameters
- $name : non-empty-string
Return values
TaskremoveRemotesFromShard()
public
removeRemotesFromShard(non-empty-string $shardName, array<int, non-empty-string> $remoteNames) : Task
Parameters
- $shardName : non-empty-string
- $remoteNames : array<int, non-empty-string>
Return values
TaskdispatchPatch()
private
dispatchPatch(array<string|int, mixed> $body) : Task
Parameters
- $body : array<string|int, mixed>