From c5f9f4de55ed1778905084922e7dc5a284bd50d1 Mon Sep 17 00:00:00 2001 From: Avi Zimmerman Date: Mon, 30 Oct 2023 11:29:32 +0200 Subject: [PATCH] update docs --- docs/classes/app_pb.AppQueryRequest.html | 231 +------- docs/classes/app_pb.ConnectRequest.html | 327 +---------- docs/classes/app_pb.ConnectResponse.html | 296 +--------- docs/classes/app_pb.DisconnectRequest.html | 220 +------- docs/classes/app_pb.DisconnectResponse.html | 205 +------ docs/classes/app_pb.MeshConnBootstrap.html | 270 +-------- docs/classes/app_pb.MeshConnNetworking.html | 218 +------- docs/classes/app_pb.MeshConnServices.html | 231 +------- docs/classes/app_pb.MeshConnTLS.html | 283 +--------- docs/classes/app_pb.MetricsRequest.html | 219 +------- docs/classes/app_pb.MetricsResponse.html | 223 +------- docs/classes/app_pb.StatusRequest.html | 219 +------- docs/classes/app_pb.StatusResponse.html | 231 +------- docs/classes/members_pb.JoinRequest.html | 379 ++----------- docs/classes/members_pb.JoinResponse.html | 309 +---------- docs/classes/members_pb.LeaveRequest.html | 218 +------- docs/classes/members_pb.LeaveResponse.html | 205 +------ .../members_pb.PeerConfigurations.html | 244 +-------- .../members_pb.StorageConsensusRequest.html | 205 +------ .../members_pb.StorageConsensusResponse.html | 218 +------- docs/classes/members_pb.StorageServer.html | 257 +-------- .../members_pb.SubscribePeersRequest.html | 218 +------- docs/classes/members_pb.UpdateRequest.html | 322 +---------- docs/classes/members_pb.UpdateResponse.html | 205 +------ docs/classes/members_pb.WireGuardPeer.html | 257 +-------- docs/classes/mesh_pb.GetNodeRequest.html | 218 +------- docs/classes/mesh_pb.MeshEdge.html | 262 +-------- docs/classes/mesh_pb.MeshEdges.html | 218 +------- docs/classes/mesh_pb.MeshGraph.html | 244 +-------- docs/classes/network_acls_pb.NetworkACL.html | 296 +--------- docs/classes/network_acls_pb.NetworkACLs.html | 218 +------- .../network_acls_pb.NetworkAction.html | 257 +-------- docs/classes/network_acls_pb.Route.html | 257 +-------- docs/classes/network_acls_pb.Routes.html | 218 +------- .../node_pb.DataChannelNegotiation.html | 309 +---------- docs/classes/node_pb.FeaturePort.html | 231 +------- docs/classes/node_pb.GetStatusRequest.html | 218 +------- docs/classes/node_pb.InterfaceMetrics.html | 335 +----------- docs/classes/node_pb.MeshNode.html | 335 +----------- docs/classes/node_pb.NodeList.html | 218 +------- docs/classes/node_pb.PeerMetrics.html | 309 +---------- docs/classes/node_pb.Status.html | 348 +----------- docs/classes/node_pb.WebRTCSignal.html | 244 +-------- docs/classes/plugin_pb.AllocateIPRequest.html | 231 +------- docs/classes/plugin_pb.AllocatedIP.html | 218 +------- .../plugin_pb.AuthenticationRequest.html | 236 +------- .../plugin_pb.AuthenticationResponse.html | 218 +------- docs/classes/plugin_pb.Event.html | 252 +-------- docs/classes/plugin_pb.NodeConfiguration.html | 296 +--------- .../plugin_pb.PluginConfiguration.html | 231 +------- docs/classes/plugin_pb.PluginInfo.html | 257 +-------- docs/classes/plugin_pb.ReleaseIPRequest.html | 231 +------- docs/classes/raft_pb.RaftApplyResponse.html | 231 +------- docs/classes/raft_pb.RaftDataItem.html | 244 +-------- docs/classes/raft_pb.RaftLogEntry.html | 257 +-------- docs/classes/raft_pb.RaftSnapshot.html | 215 +------- docs/classes/rbac_pb.Group.html | 231 +------- docs/classes/rbac_pb.Groups.html | 218 +------- docs/classes/rbac_pb.RBACAction.html | 244 +-------- docs/classes/rbac_pb.Role.html | 231 +------- docs/classes/rbac_pb.RoleBinding.html | 244 +-------- docs/classes/rbac_pb.RoleBindings.html | 218 +------- docs/classes/rbac_pb.Roles.html | 218 +------- docs/classes/rbac_pb.Rule.html | 244 +-------- docs/classes/rbac_pb.Subject.html | 231 +------- docs/classes/registrar_pb.LookupRequest.html | 244 +-------- docs/classes/registrar_pb.LookupResponse.html | 244 +-------- .../classes/registrar_pb.RegisterRequest.html | 244 +-------- .../registrar_pb.RegisterResponse.html | 218 +------- ...orage_provider_pb.AddObserverResponse.html | 205 +------ .../storage_provider_pb.AddVoterResponse.html | 205 +------ .../storage_provider_pb.BootstrapRequest.html | 205 +------ ...storage_provider_pb.BootstrapResponse.html | 218 +------- ...torage_provider_pb.DeleteValueRequest.html | 218 +------- ...orage_provider_pb.DeleteValueResponse.html | 205 +------ ...orage_provider_pb.DemoteVoterResponse.html | 205 +------ .../storage_provider_pb.GetLeaderRequest.html | 205 +------ .../storage_provider_pb.GetPeersRequest.html | 205 +------ .../storage_provider_pb.GetValueRequest.html | 218 +------- .../storage_provider_pb.GetValueResponse.html | 218 +------- .../storage_provider_pb.ListKeysRequest.html | 218 +------- .../storage_provider_pb.ListKeysResponse.html | 218 +------- ...storage_provider_pb.ListValuesRequest.html | 218 +------- ...torage_provider_pb.ListValuesResponse.html | 218 +------- .../storage_provider_pb.PrefixEvent.html | 244 +-------- .../storage_provider_pb.PutValueRequest.html | 231 +------- .../storage_provider_pb.PutValueResponse.html | 205 +------ ...rage_provider_pb.RemoveServerResponse.html | 205 +------ .../storage_provider_pb.StoragePeer.html | 257 +-------- .../storage_provider_pb.StoragePeers.html | 218 +------- .../storage_provider_pb.StorageStatus.html | 257 +-------- ...rage_provider_pb.StorageStatusRequest.html | 205 +------ .../storage_provider_pb.StorageValue.html | 231 +------- ...ge_provider_pb.SubscribePrefixRequest.html | 218 +------- .../storage_query_pb.NetworkState.html | 235 +------- .../storage_query_pb.PublishRequest.html | 244 +-------- .../storage_query_pb.PublishResponse.html | 205 +------ .../storage_query_pb.QueryRequest.html | 244 +-------- .../storage_query_pb.QueryResponse.html | 231 +------- .../storage_query_pb.SubscribeRequest.html | 218 +------- .../storage_query_pb.SubscriptionEvent.html | 231 +------- docs/classes/webrtc_pb.DataChannelOffer.html | 244 +-------- .../webrtc_pb.StartDataChannelRequest.html | 283 +--------- .../enums/app_pb.ConnectRequest_AddrType.html | 127 +---- .../app_pb.ConnectRequest_AuthHeader.html | 153 +----- .../app_pb.ConnectRequest_AuthMethod.html | 153 +----- ...b.MeshConnBootstrap_DefaultNetworkACL.html | 105 +--- ...pp_pb.StatusResponse_ConnectionStatus.html | 124 +---- docs/enums/members_pb.ConnectProtocol.html | 127 +---- docs/enums/network_acls_pb.ACLAction.html | 127 +---- docs/enums/node_pb.ClusterStatus.html | 153 +----- docs/enums/node_pb.DataChannel.html | 114 +--- docs/enums/node_pb.EdgeAttribute.html | 140 +---- docs/enums/node_pb.Feature.html | 270 ++------- docs/enums/plugin_pb.Event_WatchEvent.html | 140 +---- ...plugin_pb.PluginInfo_PluginCapability.html | 166 +----- docs/enums/raft_pb.RaftCommandType.html | 127 +---- docs/enums/rbac_pb.RuleResource.html | 244 +-------- docs/enums/rbac_pb.RuleVerb.html | 153 +----- docs/enums/rbac_pb.SubjectType.html | 153 +----- ...age_provider_pb.PrefixEvent_EventType.html | 124 +---- ...ge_query_pb.QueryRequest_QueryCommand.html | 114 +--- ...orage_query_pb.QueryRequest_QueryType.html | 231 +------- docs/index.html | 68 +-- docs/modules/admin_connect.html | 71 +-- docs/modules/app_connect.html | 71 +-- docs/modules/app_pb.html | 76 +-- docs/modules/members_connect.html | 71 +-- docs/modules/members_pb.html | 76 +-- docs/modules/mesh_connect.html | 71 +-- docs/modules/mesh_pb.html | 71 +-- docs/modules/network_acls_pb.html | 76 +-- docs/modules/node_connect.html | 71 +-- docs/modules/node_pb.html | 76 +-- docs/modules/plugin_connect.html | 71 +-- docs/modules/plugin_pb.html | 76 +-- docs/modules/raft_pb.html | 76 +-- docs/modules/rbac_pb.html | 76 +-- docs/modules/registrar_connect.html | 71 +-- docs/modules/registrar_pb.html | 71 +-- docs/modules/storage_provider_connect.html | 71 +-- docs/modules/storage_provider_pb.html | 76 +-- docs/modules/storage_query_connect.html | 71 +-- docs/modules/storage_query_pb.html | 76 +-- docs/modules/webrtc_connect.html | 71 +-- docs/modules/webrtc_pb.html | 71 +-- docs/proto/index.html | 8 +- docs/variables/admin_connect.Admin.html | 512 ++---------------- docs/variables/app_connect.AppDaemon.html | 175 +----- .../variables/members_connect.Membership.html | 188 +------ docs/variables/mesh_connect.Mesh.html | 134 +---- docs/variables/node_connect.Node.html | 134 +---- docs/variables/plugin_connect.AuthPlugin.html | 98 +--- docs/variables/plugin_connect.IPAMPlugin.html | 116 +--- docs/variables/plugin_connect.Plugin.html | 134 +---- .../plugin_connect.StorageQuerierPlugin.html | 98 +--- .../variables/plugin_connect.WatchPlugin.html | 98 +--- .../registrar_connect.Registrar.html | 116 +--- ...rovider_connect.StorageProviderPlugin.html | 332 ++---------- ...age_query_connect.StorageQueryService.html | 134 +---- docs/variables/webrtc_connect.WebRTC.html | 116 +--- go/v1/app.pb.go | 10 +- proto/v1/app.proto | 17 +- ts/v1/app_connect.d.ts | 7 +- ts/v1/app_connect.js | 7 +- ts/v1/app_pb.d.ts | 10 +- ts/v1/app_pb.js | 10 +- 167 files changed, 1697 insertions(+), 30153 deletions(-) diff --git a/docs/classes/app_pb.AppQueryRequest.html b/docs/classes/app_pb.AppQueryRequest.html index 39c4176c..01e3d357 100644 --- a/docs/classes/app_pb.AppQueryRequest.html +++ b/docs/classes/app_pb.AppQueryRequest.html @@ -1,228 +1,17 @@ -AppQueryRequest | Webmesh API
-
- -
-
-
-
- -

Class AppQueryRequest

-
-

AppQueryRequest is sent by the application to a daemon to query a mesh's storage.

-
-
-

Generated

from message v1.AppQueryRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
id +AppQueryRequest | Webmesh API

Class AppQueryRequest

AppQueryRequest is sent by the application to a daemon to query a mesh's storage.

+

Generated

from message v1.AppQueryRequest

+

Hierarchy

Constructors

constructor +

Properties

id query? fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

id

-
id: string
-

ID is the unique identifier of this connection.

-
-
-

Generated

from field: string id = 1;

-
-
-

Optional query

-
query?: QueryRequest
-

Query is the query to execute.

-
-
-

Generated

from field: v1.QueryRequest query = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.AppQueryRequest" = "v1.AppQueryRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

id

id: string

ID is the unique identifier of this connection.

+

Generated

from field: string id = 1;

+

Optional query

query?: QueryRequest

Query is the query to execute.

+

Generated

from field: v1.QueryRequest query = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.AppQueryRequest" = "v1.AppQueryRequest"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/app_pb.ConnectRequest.html b/docs/classes/app_pb.ConnectRequest.html index 720900e2..51775e7c 100644 --- a/docs/classes/app_pb.ConnectRequest.html +++ b/docs/classes/app_pb.ConnectRequest.html @@ -1,47 +1,7 @@ -ConnectRequest | Webmesh API
-
- -
-
-
-
- -

Class ConnectRequest

-
-

ConnectRequest is sent by an application to a daemon to establish a connection to a mesh.

-
-
-

Generated

from message v1.ConnectRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
addrType +ConnectRequest | Webmesh API

Class ConnectRequest

ConnectRequest is sent by an application to a daemon to establish a connection to a mesh.

+

Generated

from message v1.ConnectRequest

+

Hierarchy

Constructors

constructor +

Properties

addrType addrs authCredentials authMethod @@ -53,266 +13,27 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

addrType

-
addrType: ConnectRequest_AddrType
-

AddrType is the type of join addresses in the addrs list.

-
-
-

Generated

from field: v1.ConnectRequest.AddrType addrType = 4;

-
-
-

addrs

-
addrs: string[]
-

Addrs are the join addresses to use to connect to the mesh.

-
-
-

Generated

from field: repeated string addrs = 5;

-
-
-

authCredentials

-
authCredentials: {
    [key: string]: Uint8Array;
}
-

AuthCredentials are additional credentials as required by the authType.

-
-
-

Type declaration

-
    -
  • -
    [key: string]: Uint8Array
-
-

Generated

from field: map<string, bytes> authCredentials = 3;

-
-
-

authMethod

-
authMethod: ConnectRequest_AuthMethod
-

AuthMethod is the type of authentication to use.

-
-
-

Generated

from field: v1.ConnectRequest.AuthMethod authMethod = 2;

-
-
-

Optional bootstrap

-
bootstrap?: MeshConnBootstrap
-

Bootstrap are options for bootstrapping a new mesh.

-
-
-

Generated

from field: v1.MeshConnBootstrap bootstrap = 8;

-
-
-

id

-
id: string
-

ID is the unique identifier of this connection. If not provided +

Constructors

constructor

Properties

addrType

addrType: ConnectRequest_AddrType

AddrType is the type of join addresses in the addrs list.

+

Generated

from field: v1.ConnectRequest.AddrType addrType = 4;

+

addrs

addrs: string[]

Addrs are the join addresses to use to connect to the mesh.

+

Generated

from field: repeated string addrs = 5;

+

authCredentials

authCredentials: {
    [key: string]: Uint8Array;
}

AuthCredentials are additional credentials as required by the authType.

+

Type declaration

  • [key: string]: Uint8Array

Generated

from field: map<string, bytes> authCredentials = 3;

+

authMethod

authMethod: ConnectRequest_AuthMethod

AuthMethod is the type of authentication to use.

+

Generated

from field: v1.ConnectRequest.AuthMethod authMethod = 2;

+

Optional bootstrap

bootstrap?: MeshConnBootstrap

Bootstrap are options for bootstrapping a new mesh.

+

Generated

from field: v1.MeshConnBootstrap bootstrap = 8;

+

id

id: string

ID is the unique identifier of this connection. If not provided one will be generated.

-
-
-

Generated

from field: string id = 1;

-
-
-

Optional networking

-
networking?: MeshConnNetworking
-

Networking is the networking configuration to use.

-
-
-

Generated

from field: v1.MeshConnNetworking networking = 6;

-
-
-

Optional services

-
services?: MeshConnServices
-

Services are the services to expose to other nodes on the mesh.

-
-
-

Generated

from field: v1.MeshConnServices services = 7;

-
-
-

Optional tls

-
tls?: MeshConnTLS
-

TLS are TLS configurations for the mesh connection.

-
-
-

Generated

from field: v1.MeshConnTLS tls = 9;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.ConnectRequest" = "v1.ConnectRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: string id = 1;

+

Optional networking

networking?: MeshConnNetworking

Networking is the networking configuration to use.

+

Generated

from field: v1.MeshConnNetworking networking = 6;

+

Optional services

services?: MeshConnServices

Services are the services to expose to other nodes on the mesh.

+

Generated

from field: v1.MeshConnServices services = 7;

+

Optional tls

tls?: MeshConnTLS

TLS are TLS configurations for the mesh connection.

+

Generated

from field: v1.MeshConnTLS tls = 9;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.ConnectRequest" = "v1.ConnectRequest"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/app_pb.ConnectResponse.html b/docs/classes/app_pb.ConnectResponse.html index 35ce2acb..b90e947d 100644 --- a/docs/classes/app_pb.ConnectResponse.html +++ b/docs/classes/app_pb.ConnectResponse.html @@ -1,47 +1,7 @@ -ConnectResponse | Webmesh API
-
- -
-
-
-
- -

Class ConnectResponse

-
-

ConnectResponse is returned by the Connect RPC.

-
-
-

Generated

from message v1.ConnectResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
id +ConnectResponse | Webmesh API

Class ConnectResponse

ConnectResponse is returned by the Connect RPC.

+

Generated

from message v1.ConnectResponse

+

Hierarchy

Constructors

constructor +

Properties

id ipv4Address ipv4Network ipv6Address @@ -51,238 +11,22 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

id

-
id: string
-

ID is the unique identifier of this connection.

-
-
-

Generated

from field: string id = 1;

-
-
-

ipv4Address

-
ipv4Address: string
-

IPv4Address is the IPv4 address of the node.

-
-
-

Generated

from field: string ipv4Address = 4;

-
-
-

ipv4Network

-
ipv4Network: string
-

IPv4Network is the IPv4 network of the mesh.

-
-
-

Generated

from field: string ipv4Network = 6;

-
-
-

ipv6Address

-
ipv6Address: string
-

IPv6Address is the IPv6 address of the node.

-
-
-

Generated

from field: string ipv6Address = 5;

-
-
-

ipv6Network

-
ipv6Network: string
-

IPv6Network is the IPv6 network of the mesh.

-
-
-

Generated

from field: string ipv6Network = 7;

-
-
-

meshDomain

-
meshDomain: string
-

Mesh domain is the domain of the mesh.

-
-
-

Generated

from field: string meshDomain = 3;

-
-
-

nodeID

-
nodeID: string
-

Node id is the unique identifier of the node.

-
-
-

Generated

from field: string nodeID = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.ConnectResponse" = "v1.ConnectResponse"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

id

id: string

ID is the unique identifier of this connection.

+

Generated

from field: string id = 1;

+

ipv4Address

ipv4Address: string

IPv4Address is the IPv4 address of the node.

+

Generated

from field: string ipv4Address = 4;

+

ipv4Network

ipv4Network: string

IPv4Network is the IPv4 network of the mesh.

+

Generated

from field: string ipv4Network = 6;

+

ipv6Address

ipv6Address: string

IPv6Address is the IPv6 address of the node.

+

Generated

from field: string ipv6Address = 5;

+

ipv6Network

ipv6Network: string

IPv6Network is the IPv6 network of the mesh.

+

Generated

from field: string ipv6Network = 7;

+

meshDomain

meshDomain: string

Mesh domain is the domain of the mesh.

+

Generated

from field: string meshDomain = 3;

+

nodeID

nodeID: string

Node id is the unique identifier of the node.

+

Generated

from field: string nodeID = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.ConnectResponse" = "v1.ConnectResponse"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/app_pb.DisconnectRequest.html b/docs/classes/app_pb.DisconnectRequest.html index 8934aa5d..14383c17 100644 --- a/docs/classes/app_pb.DisconnectRequest.html +++ b/docs/classes/app_pb.DisconnectRequest.html @@ -1,218 +1,14 @@ -DisconnectRequest | Webmesh API
-
- -
-
-
-
- -

Class DisconnectRequest

-
-

DisconnectRequest is sent by an application to a daemon to disconnect -from a mesh. This message will eventually contain unique identifiers -for allowing the application to disconnect from a specific mesh.

-
-
-

Generated

from message v1.DisconnectRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
id +DisconnectRequest | Webmesh API

Class DisconnectRequest

DisconnectRequest is sent by an application to a daemon to disconnect from a mesh.

+

Generated

from message v1.DisconnectRequest

+

Hierarchy

Constructors

constructor +

Properties

id fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

id

-
id: string
-

ID is the unique identifier of this connection.

-
-
-

Generated

from field: string id = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.DisconnectRequest" = "v1.DisconnectRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

id

id: string

ID is the unique identifier of this connection.

+

Generated

from field: string id = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.DisconnectRequest" = "v1.DisconnectRequest"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/app_pb.DisconnectResponse.html b/docs/classes/app_pb.DisconnectResponse.html index ea6d99a6..3078d1ac 100644 --- a/docs/classes/app_pb.DisconnectResponse.html +++ b/docs/classes/app_pb.DisconnectResponse.html @@ -1,204 +1,11 @@ -DisconnectResponse | Webmesh API
-
- -
-
-
-
- -

Class DisconnectResponse

-
-

DisconnectResponse is returned by the Disconnect RPC.

-
-
-

Generated

from message v1.DisconnectResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +DisconnectResponse | Webmesh API

Class DisconnectResponse

DisconnectResponse is returned by the Disconnect RPC.

+

Generated

from message v1.DisconnectResponse

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.DisconnectResponse" = "v1.DisconnectResponse"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.DisconnectResponse" = "v1.DisconnectResponse"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/app_pb.MeshConnBootstrap.html b/docs/classes/app_pb.MeshConnBootstrap.html index 9e656732..4afcd8fd 100644 --- a/docs/classes/app_pb.MeshConnBootstrap.html +++ b/docs/classes/app_pb.MeshConnBootstrap.html @@ -1,47 +1,7 @@ -MeshConnBootstrap | Webmesh API
-
- -
-
-
-
- -

Class MeshConnBootstrap

-
-

MeshConnBootstrap are configurations for bootstrapping a new mesh.

-
-
-

Generated

from message v1.MeshConnBootstrap

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
defaultNetworkACL +MeshConnBootstrap | Webmesh API

Class MeshConnBootstrap

MeshConnBootstrap are configurations for bootstrapping a new mesh.

+

Generated

from message v1.MeshConnBootstrap

+

Hierarchy

Constructors

constructor +

Properties

defaultNetworkACL domain enabled ipv4Network @@ -49,216 +9,18 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

defaultNetworkACL

-
defaultNetworkACL: MeshConnBootstrap_DefaultNetworkACL
-

DefaultNetworkACL is the default network ACL to use for the mesh.

-
-
-

Generated

from field: v1.MeshConnBootstrap.DefaultNetworkACL defaultNetworkACL = 5;

-
-
-

domain

-
domain: string
-

Domain is the domain of the mesh. Defaults to "webmesh.internal".

-
-
-

Generated

from field: string domain = 2;

-
-
-

enabled

-
enabled: boolean
-

Enabled indicates whether or not to bootstrap a new mesh.

-
-
-

Generated

from field: bool enabled = 1;

-
-
-

ipv4Network

-
ipv4Network: string
-

IPv4Network is the IPv4 network of the mesh. Defaults to 172.16.0.0/12.

-
-
-

Generated

from field: string ipv4Network = 3;

-
-
-

rbacEnabled

-
rbacEnabled: boolean
-

RBACEnabled indicates whether or not to enable RBAC on the mesh.

-
-
-

Generated

from field: bool rbacEnabled = 4;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.MeshConnBootstrap" = "v1.MeshConnBootstrap"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

defaultNetworkACL

defaultNetworkACL: MeshConnBootstrap_DefaultNetworkACL

DefaultNetworkACL is the default network ACL to use for the mesh.

+

Generated

from field: v1.MeshConnBootstrap.DefaultNetworkACL defaultNetworkACL = 5;

+

domain

domain: string

Domain is the domain of the mesh. Defaults to "webmesh.internal".

+

Generated

from field: string domain = 2;

+

enabled

enabled: boolean

Enabled indicates whether or not to bootstrap a new mesh.

+

Generated

from field: bool enabled = 1;

+

ipv4Network

ipv4Network: string

IPv4Network is the IPv4 network of the mesh. Defaults to 172.16.0.0/12.

+

Generated

from field: string ipv4Network = 3;

+

rbacEnabled

rbacEnabled: boolean

RBACEnabled indicates whether or not to enable RBAC on the mesh.

+

Generated

from field: bool rbacEnabled = 4;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.MeshConnBootstrap" = "v1.MeshConnBootstrap"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/app_pb.MeshConnNetworking.html b/docs/classes/app_pb.MeshConnNetworking.html index d6793ad0..85f23444 100644 --- a/docs/classes/app_pb.MeshConnNetworking.html +++ b/docs/classes/app_pb.MeshConnNetworking.html @@ -1,216 +1,14 @@ -MeshConnNetworking | Webmesh API
-
- -
-
-
-
- -

Class MeshConnNetworking

-
-

MeshConnNetworking are configurations for networking on a mesh.

-
-
-

Generated

from message v1.MeshConnNetworking

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
useDNS +MeshConnNetworking | Webmesh API

Class MeshConnNetworking

MeshConnNetworking are configurations for networking on a mesh.

+

Generated

from message v1.MeshConnNetworking

+

Hierarchy

Constructors

constructor +

Properties

useDNS fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

useDNS

-
useDNS: boolean
-

UseDNS indicates whether or not to use the DNS servers of the mesh.

-
-
-

Generated

from field: bool useDNS = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.MeshConnNetworking" = "v1.MeshConnNetworking"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

useDNS

useDNS: boolean

UseDNS indicates whether or not to use the DNS servers of the mesh.

+

Generated

from field: bool useDNS = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.MeshConnNetworking" = "v1.MeshConnNetworking"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/app_pb.MeshConnServices.html b/docs/classes/app_pb.MeshConnServices.html index b4da0bbe..b870f70b 100644 --- a/docs/classes/app_pb.MeshConnServices.html +++ b/docs/classes/app_pb.MeshConnServices.html @@ -1,230 +1,19 @@ -MeshConnServices | Webmesh API
-
- -
-
-
-
- -

Class MeshConnServices

-
-

MeshConnServices are configurations for exposing services to other nodes on a mesh.

-
-
-

Generated

from message v1.MeshConnServices

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
enabled +MeshConnServices | Webmesh API

Class MeshConnServices

MeshConnServices are configurations for exposing services to other nodes on a mesh.

+

Generated

from message v1.MeshConnServices

+

Hierarchy

Constructors

constructor +

Properties

enabled public fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

enabled

-
enabled: boolean
-

Enabled indicates whether or not to expose services to other nodes.

-
-
-

Generated

from field: bool enabled = 1;

-
-
-

public

-
public: boolean
-

Public indicates that the services should be exposed publicly. +

Constructors

constructor

Properties

enabled

enabled: boolean

Enabled indicates whether or not to expose services to other nodes.

+

Generated

from field: bool enabled = 1;

+

public

public: boolean

Public indicates that the services should be exposed publicly. This is useful for allowing other nodes to connect to the mesh via this node's public IP address.

-
-
-

Generated

from field: bool public = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.MeshConnServices" = "v1.MeshConnServices"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: bool public = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.MeshConnServices" = "v1.MeshConnServices"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/app_pb.MeshConnTLS.html b/docs/classes/app_pb.MeshConnTLS.html index 90a825bd..09fd0154 100644 --- a/docs/classes/app_pb.MeshConnTLS.html +++ b/docs/classes/app_pb.MeshConnTLS.html @@ -1,47 +1,7 @@ -MeshConnTLS | Webmesh API
-
- -
-
-
-
- -

Class MeshConnTLS

-
-

MeshhConnTLS are TLS configurations for a mesh connection.

-
-
-

Generated

from message v1.MeshConnTLS

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
caCertData +MeshConnTLS | Webmesh API

Class MeshConnTLS

MeshhConnTLS are TLS configurations for a mesh connection.

+

Generated

from message v1.MeshConnTLS

+

Hierarchy

Constructors

constructor +

Properties

caCertData certData enabled keyData @@ -50,229 +10,22 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

caCertData

-
caCertData: Uint8Array
-

CACert is a PEM-encoded CA certificate to use for TLS.

-
-
-

Generated

from field: bytes caCertData = 2;

-
-
-

certData

-
certData: Uint8Array
-

CertData is a PEM-encoded certificate to use for TLS.

-
-
-

Generated

from field: bytes certData = 3;

-
-
-

enabled

-
enabled: boolean
-

Enabled indicates whether or not to use TLS.

-
-
-

Generated

from field: bool enabled = 1;

-
-
-

keyData

-
keyData: Uint8Array
-

KeyData is a PEM-encoded private key to use for TLS.

-
-
-

Generated

from field: bytes keyData = 4;

-
-
-

skipVerify

-
skipVerify: boolean
-

SkipVerify indicates whether or not to skip verification of the +

Constructors

constructor

Properties

caCertData

caCertData: Uint8Array

CACert is a PEM-encoded CA certificate to use for TLS.

+

Generated

from field: bytes caCertData = 2;

+

certData

certData: Uint8Array

CertData is a PEM-encoded certificate to use for TLS.

+

Generated

from field: bytes certData = 3;

+

enabled

enabled: boolean

Enabled indicates whether or not to use TLS.

+

Generated

from field: bool enabled = 1;

+

keyData

keyData: Uint8Array

KeyData is a PEM-encoded private key to use for TLS.

+

Generated

from field: bytes keyData = 4;

+

skipVerify

skipVerify: boolean

SkipVerify indicates whether or not to skip verification of the server certificate.

-
-
-

Generated

from field: bool skipVerify = 6;

-
-
-

verifyChainOnly

-
verifyChainOnly: boolean
-

VerifyChainOnly indicates whether or not to only verify the +

Generated

from field: bool skipVerify = 6;

+

verifyChainOnly

verifyChainOnly: boolean

VerifyChainOnly indicates whether or not to only verify the certificate chain.

-
-
-

Generated

from field: bool verifyChainOnly = 5;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.MeshConnTLS" = "v1.MeshConnTLS"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: bool verifyChainOnly = 5;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.MeshConnTLS" = "v1.MeshConnTLS"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/app_pb.MetricsRequest.html b/docs/classes/app_pb.MetricsRequest.html index 27c28204..11203f30 100644 --- a/docs/classes/app_pb.MetricsRequest.html +++ b/docs/classes/app_pb.MetricsRequest.html @@ -1,218 +1,15 @@ -MetricsRequest | Webmesh API
-
- -
-
-
-
- -

Class MetricsRequest

-
-

MetricsRequest is sent by the application to a daemon to retrieve interface -metrics for a mesh connection.

-
-
-

Generated

from message v1.MetricsRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
ids +MetricsRequest | Webmesh API

Class MetricsRequest

MetricsRequest is sent by the application to a daemon to retrieve interface metrics for a mesh connection.

+

Generated

from message v1.MetricsRequest

+

Hierarchy

Constructors

constructor +

Properties

ids fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

ids

-
ids: string[]
-

IDs are the unique identifiers of the connections to retrieve metrics for. +

Constructors

constructor

Properties

ids

ids: string[]

IDs are the unique identifiers of the connections to retrieve metrics for. If not provided, metrics for all connections will be returned.

-
-
-

Generated

from field: repeated string ids = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.MetricsRequest" = "v1.MetricsRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: repeated string ids = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.MetricsRequest" = "v1.MetricsRequest"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/app_pb.MetricsResponse.html b/docs/classes/app_pb.MetricsResponse.html index 2abcf8b0..dfa73e0d 100644 --- a/docs/classes/app_pb.MetricsResponse.html +++ b/docs/classes/app_pb.MetricsResponse.html @@ -1,221 +1,14 @@ -MetricsResponse | Webmesh API
-
- -
-
-
-
- -

Class MetricsResponse

-
-

MetricsResponse is a message containing interface metrics.

-
-
-

Generated

from message v1.MetricsResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
interfaces +MetricsResponse | Webmesh API

Class MetricsResponse

MetricsResponse is a message containing interface metrics.

+

Generated

from message v1.MetricsResponse

+

Hierarchy

Constructors

constructor +

Properties

interfaces fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

interfaces

-
interfaces: {
    [key: string]: InterfaceMetrics;
}
-

Interfaces is a map of network IDs to their interface metrics.

-
-
-

Type declaration

-
-
-

Generated

from field: map<string, v1.InterfaceMetrics> interfaces = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.MetricsResponse" = "v1.MetricsResponse"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

interfaces

interfaces: {
    [key: string]: InterfaceMetrics;
}

Interfaces is a map of network IDs to their interface metrics.

+

Type declaration

Generated

from field: map<string, v1.InterfaceMetrics> interfaces = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.MetricsResponse" = "v1.MetricsResponse"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/app_pb.StatusRequest.html b/docs/classes/app_pb.StatusRequest.html index 475a8b15..ac2aa64a 100644 --- a/docs/classes/app_pb.StatusRequest.html +++ b/docs/classes/app_pb.StatusRequest.html @@ -1,217 +1,14 @@ -StatusRequest | Webmesh API
-
- -
-
-
-
- -

Class StatusRequest

-
-

StatusRequest is sent by the application to a daemon to retrieve the status -of a mesh connection.

-
-
-

Generated

from message v1.StatusRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
id +StatusRequest | Webmesh API

Class StatusRequest

StatusRequest is sent by the application to a daemon to retrieve the status of a mesh connection.

+

Generated

from message v1.StatusRequest

+

Hierarchy

Constructors

constructor +

Properties

id fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

id

-
id: string
-

ID is the unique identifier of this connection.

-
-
-

Generated

from field: string id = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.StatusRequest" = "v1.StatusRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

id

id: string

ID is the unique identifier of this connection.

+

Generated

from field: string id = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.StatusRequest" = "v1.StatusRequest"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/app_pb.StatusResponse.html b/docs/classes/app_pb.StatusResponse.html index 5f1e9e5c..9fa6eddf 100644 --- a/docs/classes/app_pb.StatusResponse.html +++ b/docs/classes/app_pb.StatusResponse.html @@ -1,228 +1,17 @@ -StatusResponse | Webmesh API
-
- -
-
-
-
- -

Class StatusResponse

-
-

StatusResponse is a message containing the status of the node.

-
-
-

Generated

from message v1.StatusResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
connectionStatus +StatusResponse | Webmesh API

Class StatusResponse

StatusResponse is a message containing the status of the node.

+

Generated

from message v1.StatusResponse

+

Hierarchy

Constructors

constructor +

Properties

connectionStatus node? fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

connectionStatus

-
connectionStatus: StatusResponse_ConnectionStatus
-

ConnectionStatus is the status of the connection.

-
-
-

Generated

from field: v1.StatusResponse.ConnectionStatus connectionStatus = 1;

-
-
-

Optional node

-
node?: MeshNode
-

Node is the node status. This is only populated if the node is connected.

-
-
-

Generated

from field: v1.MeshNode node = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.StatusResponse" = "v1.StatusResponse"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

connectionStatus

connectionStatus: StatusResponse_ConnectionStatus

ConnectionStatus is the status of the connection.

+

Generated

from field: v1.StatusResponse.ConnectionStatus connectionStatus = 1;

+

Optional node

node?: MeshNode

Node is the node status. This is only populated if the node is connected.

+

Generated

from field: v1.MeshNode node = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.StatusResponse" = "v1.StatusResponse"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/members_pb.JoinRequest.html b/docs/classes/members_pb.JoinRequest.html index 496963be..02a885d2 100644 --- a/docs/classes/members_pb.JoinRequest.html +++ b/docs/classes/members_pb.JoinRequest.html @@ -1,47 +1,7 @@ -JoinRequest | Webmesh API
-
- -
-
-
-
- -

Class JoinRequest

-
-

JoinRequest is a request to join the cluster.

-
-
-

Generated

from message v1.JoinRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
asObserver +JoinRequest | Webmesh API

Class JoinRequest

JoinRequest is a request to join the cluster.

+

Generated

from message v1.JoinRequest

+

Hierarchy

Constructors

constructor +

Properties

asObserver asVoter assignIPv4 directPeers @@ -57,68 +17,19 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

asObserver

-
asObserver: boolean
-

as_observer is whether the node should be added as an observer. They will receive +

Constructors

constructor

Properties

asObserver

asObserver: boolean

as_observer is whether the node should be added as an observer. They will receive updates to the storage, but not be able to vote in elections.

-
-
-

Generated

from field: bool asObserver = 10;

-
-
-

asVoter

-
asVoter: boolean
-

as_voter is whether the node should receive a vote in elections. The request +

Generated

from field: bool asObserver = 10;

+

asVoter

asVoter: boolean

as_voter is whether the node should receive a vote in elections. The request will be denied if the node is not allowed to vote.

-
-
-

Generated

from field: bool asVoter = 9;

-
-
-

assignIPv4

-
assignIPv4: boolean
-

assign_ipv4 is whether an IPv4 address should be assigned to the node.

-
-
-

Generated

from field: bool assignIPv4 = 7;

-
-
-

directPeers

-
directPeers: {
    [key: string]: ConnectProtocol;
}
-

direct_peers is a map of extra peers that should be connected to directly over relays. +

Generated

from field: bool asVoter = 9;

+

assignIPv4

assignIPv4: boolean

assign_ipv4 is whether an IPv4 address should be assigned to the node.

+

Generated

from field: bool assignIPv4 = 7;

+

directPeers

directPeers: {
    [key: string]: ConnectProtocol;
}

direct_peers is a map of extra peers that should be connected to directly over relays. The provided edge attribute is the callers preference of how the relay should be created. The request will be denied if the node is not allowed to put data channels or edges. The default joining behavior creates direct links between the caller and the joiner. @@ -126,253 +37,27 @@

directPeers -

-
-

Type declaration

-
-
-

Generated

from field: map<string, v1.ConnectProtocol> directPeers = 12;

-
-
-

features

-
features: FeaturePort[]
-

features is a list of features supported by the node that should be advertised to peers +

Type declaration

Generated

from field: map<string, v1.ConnectProtocol> directPeers = 12;

+

features

features: FeaturePort[]

features is a list of features supported by the node that should be advertised to peers and the port they are available on.

-
-
-

Generated

from field: repeated v1.FeaturePort features = 13;

-
-
-

id

-
id: string
-

id is the ID of the node.

-
-
-

Generated

from field: string id = 1;

-
-
-

multiaddrs

-
multiaddrs: string[]
-

multiaddrs are libp2p multiaddresses this node is listening on.

-
-
-

Generated

from field: repeated string multiaddrs = 14;

-
-
-

preferStorageIPv6

-
preferStorageIPv6: boolean
-

prefer_storage_ipv6 is whether IPv6 should be preferred over IPv4 for storage communication. +

Generated

from field: repeated v1.FeaturePort features = 13;

+

id

id: string

id is the ID of the node.

+

Generated

from field: string id = 1;

+

multiaddrs

multiaddrs: string[]

multiaddrs are libp2p multiaddresses this node is listening on.

+

Generated

from field: repeated string multiaddrs = 14;

+

preferStorageIPv6

preferStorageIPv6: boolean

prefer_storage_ipv6 is whether IPv6 should be preferred over IPv4 for storage communication. This is only used if assign_ipv4 is true.

-
-
-

Generated

from field: bool preferStorageIPv6 = 8;

-
-
-

primaryEndpoint

-
primaryEndpoint: string
-

primary_endpoint is a routable address for the node. If left unset, +

Generated

from field: bool preferStorageIPv6 = 8;

+

primaryEndpoint

primaryEndpoint: string

primary_endpoint is a routable address for the node. If left unset, the node is assumed to be behind a NAT and not directly accessible.

-
-
-

Generated

from field: string primaryEndpoint = 4;

-
-
-

publicKey

-
publicKey: string
-

public_key is the public key of the node to broadcast to peers.

-
-
-

Generated

from field: string publicKey = 2;

-
-
-

routes

-
routes: string[]
-

routes is a list of routes to advertise to peers. The request will be denied +

Generated

from field: string primaryEndpoint = 4;

+

publicKey

publicKey: string

public_key is the public key of the node to broadcast to peers.

+

Generated

from field: string publicKey = 2;

+

routes

routes: string[]

routes is a list of routes to advertise to peers. The request will be denied if the node is not allowed to put routes.

-
-
-

Generated

from field: repeated string routes = 11;

-
-
-

wireguardEndpoints

-
wireguardEndpoints: string[]
-

wireguard_endpoints is a list of WireGuard endpoints for the node.

-
-
-

Generated

from field: repeated string wireguardEndpoints = 5;

-
-
-

zoneAwarenessID

-
zoneAwarenessID: string
-

zone_awareness_id is the zone awareness ID of the node.

-
-
-

Generated

from field: string zoneAwarenessID = 6;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.JoinRequest" = "v1.JoinRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: repeated string routes = 11;

+

wireguardEndpoints

wireguardEndpoints: string[]

wireguard_endpoints is a list of WireGuard endpoints for the node.

+

Generated

from field: repeated string wireguardEndpoints = 5;

+

zoneAwarenessID

zoneAwarenessID: string

zone_awareness_id is the zone awareness ID of the node.

+

Generated

from field: string zoneAwarenessID = 6;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.JoinRequest" = "v1.JoinRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/members_pb.JoinResponse.html b/docs/classes/members_pb.JoinResponse.html index 6b7dcf23..23343e76 100644 --- a/docs/classes/members_pb.JoinResponse.html +++ b/docs/classes/members_pb.JoinResponse.html @@ -1,47 +1,7 @@ -JoinResponse | Webmesh API
-
- -
-
-
-
- -

Class JoinResponse

-
-

JoinResponse is a response to a join request.

-
-
-

Generated

from message v1.JoinResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
addressIPv4 +JoinResponse | Webmesh API

Class JoinResponse

JoinResponse is a response to a join request.

+

Generated

from message v1.JoinResponse

+

Hierarchy

Constructors

constructor +

Properties

addressIPv4 addressIPv6 dnsServers iceServers @@ -52,254 +12,29 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

addressIPv4

-
addressIPv4: string
-

address_ipv4 is the private IPv4 wireguard address of the node +

Constructors

constructor

Properties

addressIPv4

addressIPv4: string

address_ipv4 is the private IPv4 wireguard address of the node in CIDR format representing the network. This is only set if assign_ipv4 was set in the request or no network_ipv6 was provided.

-
-
-

Generated

from field: string addressIPv4 = 1;

-
-
-

addressIPv6

-
addressIPv6: string
-

address_ipv6 is the IPv6 network assigned to the node.

-
-
-

Generated

from field: string addressIPv6 = 2;

-
-
-

dnsServers

-
dnsServers: string[]
-

dns_servers is a list of peers offering DNS services.

-
-
-

Generated

from field: repeated string dnsServers = 7;

-
-
-

iceServers

-
iceServers: string[]
-

ice_servers is a list of public nodes that can be used to negotiate +

Generated

from field: string addressIPv4 = 1;

+

addressIPv6

addressIPv6: string

address_ipv6 is the IPv6 network assigned to the node.

+

Generated

from field: string addressIPv6 = 2;

+

dnsServers

dnsServers: string[]

dns_servers is a list of peers offering DNS services.

+

Generated

from field: repeated string dnsServers = 7;

+

iceServers

iceServers: string[]

ice_servers is a list of public nodes that can be used to negotiate ICE connections if required. This may only be populated when one of the peers has the ICE flag set. This must be set if the requestor specifies direct_peers.

-
-
-

Generated

from field: repeated string iceServers = 6;

-
-
-

meshDomain

-
meshDomain: string
-

mesh_domain is the domain of the mesh.

-
-
-

Generated

from field: string meshDomain = 8;

-
-
-

networkIPv4

-
networkIPv4: string
-

network_ipv4 is the IPv4 network of the Mesh.

-
-
-

Generated

from field: string networkIPv4 = 3;

-
-
-

networkIPv6

-
networkIPv6: string
-

network_ipv6 is the IPv6 network of the Mesh.

-
-
-

Generated

from field: string networkIPv6 = 4;

-
-
-

peers

-
peers: WireGuardPeer[]
-

peers is a list of wireguard peers to connect to.

-
-
-

Generated

from field: repeated v1.WireGuardPeer peers = 5;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.JoinResponse" = "v1.JoinResponse"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: repeated string iceServers = 6;

+

meshDomain

meshDomain: string

mesh_domain is the domain of the mesh.

+

Generated

from field: string meshDomain = 8;

+

networkIPv4

networkIPv4: string

network_ipv4 is the IPv4 network of the Mesh.

+

Generated

from field: string networkIPv4 = 3;

+

networkIPv6

networkIPv6: string

network_ipv6 is the IPv6 network of the Mesh.

+

Generated

from field: string networkIPv6 = 4;

+

peers

peers: WireGuardPeer[]

peers is a list of wireguard peers to connect to.

+

Generated

from field: repeated v1.WireGuardPeer peers = 5;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.JoinResponse" = "v1.JoinResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/members_pb.LeaveRequest.html b/docs/classes/members_pb.LeaveRequest.html index 8e5f3648..2c949710 100644 --- a/docs/classes/members_pb.LeaveRequest.html +++ b/docs/classes/members_pb.LeaveRequest.html @@ -1,216 +1,14 @@ -LeaveRequest | Webmesh API
-
- -
-
-
-
- -

Class LeaveRequest

-
-

LeaveRequest is a request to leave the cluster.

-
-
-

Generated

from message v1.LeaveRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
id +LeaveRequest | Webmesh API

Class LeaveRequest

LeaveRequest is a request to leave the cluster.

+

Generated

from message v1.LeaveRequest

+

Hierarchy

Constructors

constructor +

Properties

id fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

id

-
id: string
-

id is the ID of the node.

-
-
-

Generated

from field: string id = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.LeaveRequest" = "v1.LeaveRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

id

id: string

id is the ID of the node.

+

Generated

from field: string id = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.LeaveRequest" = "v1.LeaveRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/members_pb.LeaveResponse.html b/docs/classes/members_pb.LeaveResponse.html index fa08694b..179aac0c 100644 --- a/docs/classes/members_pb.LeaveResponse.html +++ b/docs/classes/members_pb.LeaveResponse.html @@ -1,204 +1,11 @@ -LeaveResponse | Webmesh API
-
- -
-
-
-
- -

Class LeaveResponse

-
-

LeaveResponse is a response to a leave request. It is currently empty.

-
-
-

Generated

from message v1.LeaveResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +LeaveResponse | Webmesh API

Class LeaveResponse

LeaveResponse is a response to a leave request. It is currently empty.

+

Generated

from message v1.LeaveResponse

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.LeaveResponse" = "v1.LeaveResponse"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.LeaveResponse" = "v1.LeaveResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/members_pb.PeerConfigurations.html b/docs/classes/members_pb.PeerConfigurations.html index cd0bd122..e72f0297 100644 --- a/docs/classes/members_pb.PeerConfigurations.html +++ b/docs/classes/members_pb.PeerConfigurations.html @@ -1,242 +1,22 @@ -PeerConfigurations | Webmesh API
-
- -
-
-
-
- -

Class PeerConfigurations

-
-

PeerConfigurations is a stream of peer configurations.

-
-
-

Generated

from message v1.PeerConfigurations

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
dnsServers +PeerConfigurations | Webmesh API

Class PeerConfigurations

PeerConfigurations is a stream of peer configurations.

+

Generated

from message v1.PeerConfigurations

+

Hierarchy

Constructors

constructor +

Properties

dnsServers iceServers peers fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

dnsServers

-
dnsServers: string[]
-

dns_servers is a list of peers offering DNS services.

-
-
-

Generated

from field: repeated string dnsServers = 7;

-
-
-

iceServers

-
iceServers: string[]
-

ice_servers is a list of public nodes that can be used to negotiate +

Constructors

constructor

Properties

dnsServers

dnsServers: string[]

dns_servers is a list of peers offering DNS services.

+

Generated

from field: repeated string dnsServers = 7;

+

iceServers

iceServers: string[]

ice_servers is a list of public nodes that can be used to negotiate ICE connections if required. This may only be populated when one of the peers has the ICE flag set.

-
-
-

Generated

from field: repeated string iceServers = 6;

-
-
-

peers

-
peers: WireGuardPeer[]
-

peers is a list of wireguard peers to connect to.

-
-
-

Generated

from field: repeated v1.WireGuardPeer peers = 5;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.PeerConfigurations" = "v1.PeerConfigurations"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: repeated string iceServers = 6;

+

peers

peers: WireGuardPeer[]

peers is a list of wireguard peers to connect to.

+

Generated

from field: repeated v1.WireGuardPeer peers = 5;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.PeerConfigurations" = "v1.PeerConfigurations"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/members_pb.StorageConsensusRequest.html b/docs/classes/members_pb.StorageConsensusRequest.html index 65087121..9c97d763 100644 --- a/docs/classes/members_pb.StorageConsensusRequest.html +++ b/docs/classes/members_pb.StorageConsensusRequest.html @@ -1,204 +1,11 @@ -StorageConsensusRequest | Webmesh API
-
- -
-
-
-
- -

Class StorageConsensusRequest

-
-

StorageConsensusRequest is a request to get the current Storage configuration.

-
-
-

Generated

from message v1.StorageConsensusRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +StorageConsensusRequest | Webmesh API

Class StorageConsensusRequest

StorageConsensusRequest is a request to get the current Storage configuration.

+

Generated

from message v1.StorageConsensusRequest

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.StorageConsensusRequest" = "v1.StorageConsensusRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.StorageConsensusRequest" = "v1.StorageConsensusRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/members_pb.StorageConsensusResponse.html b/docs/classes/members_pb.StorageConsensusResponse.html index 60fc7b65..024675b2 100644 --- a/docs/classes/members_pb.StorageConsensusResponse.html +++ b/docs/classes/members_pb.StorageConsensusResponse.html @@ -1,216 +1,14 @@ -StorageConsensusResponse | Webmesh API
-
- -
-
-
-
- -

Class StorageConsensusResponse

-
-

StorageConsensusResponse is a response to a Storage consensus request.

-
-
-

Generated

from message v1.StorageConsensusResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
servers +StorageConsensusResponse | Webmesh API

Class StorageConsensusResponse

StorageConsensusResponse is a response to a Storage consensus request.

+

Generated

from message v1.StorageConsensusResponse

+

Hierarchy

Constructors

constructor +

Properties

servers fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

servers

-
servers: StorageServer[]
-

servers is the list of servers in the storage configuration.

-
-
-

Generated

from field: repeated v1.StorageServer servers = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.StorageConsensusResponse" = "v1.StorageConsensusResponse"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

servers

servers: StorageServer[]

servers is the list of servers in the storage configuration.

+

Generated

from field: repeated v1.StorageServer servers = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.StorageConsensusResponse" = "v1.StorageConsensusResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/members_pb.StorageServer.html b/docs/classes/members_pb.StorageServer.html index 1260ffc9..488e360f 100644 --- a/docs/classes/members_pb.StorageServer.html +++ b/docs/classes/members_pb.StorageServer.html @@ -1,252 +1,23 @@ -StorageServer | Webmesh API
-
- -
-
-
-
- -

Class StorageServer

-
-

StorageServer is a server in the Storage configuration.

-
-
-

Generated

from message v1.StorageServer

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
address +StorageServer | Webmesh API

Class StorageServer

StorageServer is a server in the Storage configuration.

+

Generated

from message v1.StorageServer

+

Hierarchy

Constructors

constructor +

Properties

address id publicKey suffrage fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

address

-
address: string
-

Address is the mesh address of the server.

-
-
-

Generated

from field: string address = 4;

-
-
-

id

-
id: string
-

ID is the ID of the server.

-
-
-

Generated

from field: string id = 1;

-
-
-

publicKey

-
publicKey: string
-

PublicKey is the public key of this server. Not all storage providers track this field.

-
-
-

Generated

from field: string publicKey = 3;

-
-
-

suffrage

-
suffrage: ClusterStatus
-

Suffrage is the suffrage of the server.

-
-
-

Generated

from field: v1.ClusterStatus suffrage = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.StorageServer" = "v1.StorageServer"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

address

address: string

Address is the mesh address of the server.

+

Generated

from field: string address = 4;

+

id

id: string

ID is the ID of the server.

+

Generated

from field: string id = 1;

+

publicKey

publicKey: string

PublicKey is the public key of this server. Not all storage providers track this field.

+

Generated

from field: string publicKey = 3;

+

suffrage

suffrage: ClusterStatus

Suffrage is the suffrage of the server.

+

Generated

from field: v1.ClusterStatus suffrage = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.StorageServer" = "v1.StorageServer"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/members_pb.SubscribePeersRequest.html b/docs/classes/members_pb.SubscribePeersRequest.html index 7022354d..72f9706b 100644 --- a/docs/classes/members_pb.SubscribePeersRequest.html +++ b/docs/classes/members_pb.SubscribePeersRequest.html @@ -1,216 +1,14 @@ -SubscribePeersRequest | Webmesh API
-
- -
-
-
-
- -

Class SubscribePeersRequest

-
-

SubscribePeersRequest is a request to subscribe to peer updates.

-
-
-

Generated

from message v1.SubscribePeersRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
id +SubscribePeersRequest | Webmesh API

Class SubscribePeersRequest

SubscribePeersRequest is a request to subscribe to peer updates.

+

Generated

from message v1.SubscribePeersRequest

+

Hierarchy

Constructors

constructor +

Properties

id fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

id

-
id: string
-

id is the ID of the node.

-
-
-

Generated

from field: string id = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.SubscribePeersRequest" = "v1.SubscribePeersRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

id

id: string

id is the ID of the node.

+

Generated

from field: string id = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.SubscribePeersRequest" = "v1.SubscribePeersRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/members_pb.UpdateRequest.html b/docs/classes/members_pb.UpdateRequest.html index 92ca2fe8..047d42a3 100644 --- a/docs/classes/members_pb.UpdateRequest.html +++ b/docs/classes/members_pb.UpdateRequest.html @@ -1,48 +1,8 @@ -UpdateRequest | Webmesh API
-
- -
-
-
-
- -

Class UpdateRequest

-
-

UpdateRequest contains most of the same fields as JoinRequest, but is +UpdateRequest | Webmesh API

Class UpdateRequest

UpdateRequest contains most of the same fields as JoinRequest, but is used to update the state of a node in the cluster.

-
-
-

Generated

from message v1.UpdateRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
asVoter +

Generated

from message v1.UpdateRequest

+

Hierarchy

Constructors

constructor +

Properties

asVoter features id multiaddrs @@ -54,264 +14,30 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

asVoter

-
asVoter: boolean
-

as_voter is whether the node should receive a vote in elections. The request +

Constructors

constructor

Properties

asVoter

asVoter: boolean

as_voter is whether the node should receive a vote in elections. The request will be denied if the node is not allowed to vote.

-
-
-

Generated

from field: bool asVoter = 6;

-
-
-

features

-
features: FeaturePort[]
-

features is a list of features supported by the node that should be advertised to peers +

Generated

from field: bool asVoter = 6;

+

features

features: FeaturePort[]

features is a list of features supported by the node that should be advertised to peers and the port they are available on.

-
-
-

Generated

from field: repeated v1.FeaturePort features = 8;

-
-
-

id

-
id: string
-

id is the ID of the node.

-
-
-

Generated

from field: string id = 1;

-
-
-

multiaddrs

-
multiaddrs: string[]
-

multiaddrs are libp2p multiaddresses this node is listening on.

-
-
-

Generated

from field: repeated string multiaddrs = 9;

-
-
-

primaryEndpoint

-
primaryEndpoint: string
-

primary_endpoint is a routable address for the node. If left unset, +

Generated

from field: repeated v1.FeaturePort features = 8;

+

id

id: string

id is the ID of the node.

+

Generated

from field: string id = 1;

+

multiaddrs

multiaddrs: string[]

multiaddrs are libp2p multiaddresses this node is listening on.

+

Generated

from field: repeated string multiaddrs = 9;

+

primaryEndpoint

primaryEndpoint: string

primary_endpoint is a routable address for the node. If left unset, the node is assumed to be behind a NAT and not directly accessible.

-
-
-

Generated

from field: string primaryEndpoint = 3;

-
-
-

publicKey

-
publicKey: string
-

public_key is the public key of the node to broadcast to peers.

-
-
-

Generated

from field: string publicKey = 2;

-
-
-

routes

-
routes: string[]
-

routes is a list of routes to advertise to peers. The request will be denied +

Generated

from field: string primaryEndpoint = 3;

+

publicKey

publicKey: string

public_key is the public key of the node to broadcast to peers.

+

Generated

from field: string publicKey = 2;

+

routes

routes: string[]

routes is a list of routes to advertise to peers. The request will be denied if the node is not allowed to put routes.

-
-
-

Generated

from field: repeated string routes = 7;

-
-
-

wireguardEndpoints

-
wireguardEndpoints: string[]
-

wireguard_endpoints is a list of WireGuard endpoints for the node.

-
-
-

Generated

from field: repeated string wireguardEndpoints = 4;

-
-
-

zoneAwarenessID

-
zoneAwarenessID: string
-

zone_awareness_id is the zone awareness ID of the node.

-
-
-

Generated

from field: string zoneAwarenessID = 5;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.UpdateRequest" = "v1.UpdateRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: repeated string routes = 7;

+

wireguardEndpoints

wireguardEndpoints: string[]

wireguard_endpoints is a list of WireGuard endpoints for the node.

+

Generated

from field: repeated string wireguardEndpoints = 4;

+

zoneAwarenessID

zoneAwarenessID: string

zone_awareness_id is the zone awareness ID of the node.

+

Generated

from field: string zoneAwarenessID = 5;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.UpdateRequest" = "v1.UpdateRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/members_pb.UpdateResponse.html b/docs/classes/members_pb.UpdateResponse.html index 9033a88f..6a6e6d98 100644 --- a/docs/classes/members_pb.UpdateResponse.html +++ b/docs/classes/members_pb.UpdateResponse.html @@ -1,204 +1,11 @@ -UpdateResponse | Webmesh API
-
- -
-
-
-
- -

Class UpdateResponse

-
-

UpdateResponse is a response to an update request. It is currently empty.

-
-
-

Generated

from message v1.UpdateResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +UpdateResponse | Webmesh API

Class UpdateResponse

UpdateResponse is a response to an update request. It is currently empty.

+

Generated

from message v1.UpdateResponse

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.UpdateResponse" = "v1.UpdateResponse"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.UpdateResponse" = "v1.UpdateResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/members_pb.WireGuardPeer.html b/docs/classes/members_pb.WireGuardPeer.html index 1b304436..7317761c 100644 --- a/docs/classes/members_pb.WireGuardPeer.html +++ b/docs/classes/members_pb.WireGuardPeer.html @@ -1,252 +1,23 @@ -WireGuardPeer | Webmesh API
-
- -
-
-
-
- -

Class WireGuardPeer

-
-

WireGuardPeer is a peer in the Wireguard network.

-
-
-

Generated

from message v1.WireGuardPeer

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
allowedIPs +WireGuardPeer | Webmesh API

Class WireGuardPeer

WireGuardPeer is a peer in the Wireguard network.

+

Generated

from message v1.WireGuardPeer

+

Hierarchy

Constructors

constructor +

Properties

allowedIPs allowedRoutes node? proto fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

allowedIPs

-
allowedIPs: string[]
-

allowed_ips is the list of allowed IPs for the peer.

-
-
-

Generated

from field: repeated string allowedIPs = 2;

-
-
-

allowedRoutes

-
allowedRoutes: string[]
-

allowed_routes is the list of allowed routes for the peer.

-
-
-

Generated

from field: repeated string allowedRoutes = 3;

-
-
-

Optional node

-
node?: MeshNode
-

Node is information about this node.

-
-
-

Generated

from field: v1.MeshNode node = 1;

-
-
-

proto

-
proto: ConnectProtocol
-

proto indicates the protocol to use to connect to the peer.

-
-
-

Generated

from field: v1.ConnectProtocol proto = 4;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.WireGuardPeer" = "v1.WireGuardPeer"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

allowedIPs

allowedIPs: string[]

allowed_ips is the list of allowed IPs for the peer.

+

Generated

from field: repeated string allowedIPs = 2;

+

allowedRoutes

allowedRoutes: string[]

allowed_routes is the list of allowed routes for the peer.

+

Generated

from field: repeated string allowedRoutes = 3;

+

Optional node

node?: MeshNode

Node is information about this node.

+

Generated

from field: v1.MeshNode node = 1;

+

proto

proto: ConnectProtocol

proto indicates the protocol to use to connect to the peer.

+

Generated

from field: v1.ConnectProtocol proto = 4;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.WireGuardPeer" = "v1.WireGuardPeer"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/mesh_pb.GetNodeRequest.html b/docs/classes/mesh_pb.GetNodeRequest.html index 801a9b68..2b928274 100644 --- a/docs/classes/mesh_pb.GetNodeRequest.html +++ b/docs/classes/mesh_pb.GetNodeRequest.html @@ -1,216 +1,14 @@ -GetNodeRequest | Webmesh API
-
- -
-
-
-
- -

Class GetNodeRequest

-
-

GetNodeRequest is a request to get a node.

-
-
-

Generated

from message v1.GetNodeRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
id +GetNodeRequest | Webmesh API

Class GetNodeRequest

GetNodeRequest is a request to get a node.

+

Generated

from message v1.GetNodeRequest

+

Hierarchy

Constructors

constructor +

Properties

id fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

id

-
id: string
-

id is the ID of the node.

-
-
-

Generated

from field: string id = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.GetNodeRequest" = "v1.GetNodeRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

id

id: string

id is the ID of the node.

+

Generated

from field: string id = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.GetNodeRequest" = "v1.GetNodeRequest"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/mesh_pb.MeshEdge.html b/docs/classes/mesh_pb.MeshEdge.html index 949ba43c..f092be98 100644 --- a/docs/classes/mesh_pb.MeshEdge.html +++ b/docs/classes/mesh_pb.MeshEdge.html @@ -1,257 +1,23 @@ -MeshEdge | Webmesh API
-
- -
-
-
-
- -

Class MeshEdge

-
-

MeshEdge is an edge between two nodes.

-
-
-

Generated

from message v1.MeshEdge

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
attributes +MeshEdge | Webmesh API

Class MeshEdge

MeshEdge is an edge between two nodes.

+

Generated

from message v1.MeshEdge

+

Hierarchy

Constructors

constructor +

Properties

attributes source target weight fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional data: any
    -

    Returns MeshEdge

-
-

Properties

-
-

attributes

-
attributes: {
    [key: string]: string;
}
-

attributes is a list of attributes for the edge.

-
-
-

Type declaration

-
    -
  • -
    [key: string]: string
-
-

Generated

from field: map<string, string> attributes = 4;

-
-
-

source

-
source: string
-

source is the source node.

-
-
-

Generated

from field: string source = 1;

-
-
-

target

-
target: string
-

target is the target node.

-
-
-

Generated

from field: string target = 2;

-
-
-

weight

-
weight: number
-

weight is the weight of the edge.

-
-
-

Generated

from field: int32 weight = 3;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.MeshEdge" = "v1.MeshEdge"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonValue: JsonValue
      • -
    • -
      Optional options: any
    -

    Returns MeshEdge

-
-

Static fromJsonString

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonString: string
      • -
    • -
      Optional options: any
    -

    Returns MeshEdge

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

attributes

attributes: {
    [key: string]: string;
}

attributes is a list of attributes for the edge.

+

Type declaration

  • [key: string]: string

Generated

from field: map<string, string> attributes = 4;

+

source

source: string

source is the source node.

+

Generated

from field: string source = 1;

+

target

target: string

target is the target node.

+

Generated

from field: string target = 2;

+

weight

weight: number

weight is the weight of the edge.

+

Generated

from field: int32 weight = 3;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.MeshEdge" = "v1.MeshEdge"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/mesh_pb.MeshEdges.html b/docs/classes/mesh_pb.MeshEdges.html index 98788b96..43b409b9 100644 --- a/docs/classes/mesh_pb.MeshEdges.html +++ b/docs/classes/mesh_pb.MeshEdges.html @@ -1,216 +1,14 @@ -MeshEdges | Webmesh API
-
- -
-
-
-
- -

Class MeshEdges

-
-

MeshEdges is a list of edges.

-
-
-

Generated

from message v1.MeshEdges

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
items +MeshEdges | Webmesh API

Class MeshEdges

MeshEdges is a list of edges.

+

Generated

from message v1.MeshEdges

+

Hierarchy

Constructors

constructor +

Properties

items fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

items

-
items: MeshEdge[]
-

items is the list of edges.

-
-
-

Generated

from field: repeated v1.MeshEdge items = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.MeshEdges" = "v1.MeshEdges"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

items

items: MeshEdge[]

items is the list of edges.

+

Generated

from field: repeated v1.MeshEdge items = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.MeshEdges" = "v1.MeshEdges"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/mesh_pb.MeshGraph.html b/docs/classes/mesh_pb.MeshGraph.html index bc27f88d..3f114b85 100644 --- a/docs/classes/mesh_pb.MeshGraph.html +++ b/docs/classes/mesh_pb.MeshGraph.html @@ -1,240 +1,20 @@ -MeshGraph | Webmesh API
-
- -
-
-
-
- -

Class MeshGraph

-
-

MeshGraph is a graph of nodes.

-
-
-

Generated

from message v1.MeshGraph

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
dot +MeshGraph | Webmesh API

Class MeshGraph

MeshGraph is a graph of nodes.

+

Generated

from message v1.MeshGraph

+

Hierarchy

Constructors

constructor +

Properties

dot edges nodes fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

dot

-
dot: string
-

dot is the DOT representation of the graph.

-
-
-

Generated

from field: string dot = 3;

-
-
-

edges

-
edges: MeshEdge[]
-

edges is the list of edges.

-
-
-

Generated

from field: repeated v1.MeshEdge edges = 2;

-
-
-

nodes

-
nodes: string[]
-

nodes is the list of nodes.

-
-
-

Generated

from field: repeated string nodes = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.MeshGraph" = "v1.MeshGraph"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

dot

dot: string

dot is the DOT representation of the graph.

+

Generated

from field: string dot = 3;

+

edges

edges: MeshEdge[]

edges is the list of edges.

+

Generated

from field: repeated v1.MeshEdge edges = 2;

+

nodes

nodes: string[]

nodes is the list of nodes.

+

Generated

from field: repeated string nodes = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.MeshGraph" = "v1.MeshGraph"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/network_acls_pb.NetworkACL.html b/docs/classes/network_acls_pb.NetworkACL.html index ef84bc5e..0aeea038 100644 --- a/docs/classes/network_acls_pb.NetworkACL.html +++ b/docs/classes/network_acls_pb.NetworkACL.html @@ -1,47 +1,7 @@ -NetworkACL | Webmesh API
-
- -
-
-
-
- -

Class NetworkACL

-
-

NetworkACL is a network ACL.

-
-
-

Generated

from message v1.NetworkACL

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
action +NetworkACL | Webmesh API

Class NetworkACL

NetworkACL is a network ACL.

+

Generated

from message v1.NetworkACL

+

Hierarchy

Constructors

constructor +

Properties

action destinationCIDRs destinationNodes name @@ -51,247 +11,31 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

action

-
action: ACLAction
-

action is the action to take when a request matches the ACL.

-
-
-

Generated

from field: v1.ACLAction action = 3;

-
-
-

destinationCIDRs

-
destinationCIDRs: string[]
-

destination_cidrs is a list of destination CIDRs to match against. If empty, all CIDRs are matched. +

Constructors

constructor

Properties

action

action: ACLAction

action is the action to take when a request matches the ACL.

+

Generated

from field: v1.ACLAction action = 3;

+

destinationCIDRs

destinationCIDRs: string[]

destination_cidrs is a list of destination CIDRs to match against. If empty, all CIDRs are matched. If one or more of the CIDRs is '*', all CIDRs are matched.

// protocols is a list of protocols to match against. If empty, all protocols are matched. // Protocols can be specified by name or number. repeated string protocols = 8; // ports is a list of ports to match against. If empty, all ports are matched. repeated uint32 ports = 9;

-
-
-

Generated

from field: repeated string destinationCIDRs = 7;

-
-
-

destinationNodes

-
destinationNodes: string[]
-

destination_nodes is a list of destination nodes to match against. If empty, all nodes are matched. +

Generated

from field: repeated string destinationCIDRs = 7;

+

destinationNodes

destinationNodes: string[]

destination_nodes is a list of destination nodes to match against. If empty, all nodes are matched. Groups can be specified with the prefix "group:". If one or more of the nodes is '*', all nodes are matched.

-
-
-

Generated

from field: repeated string destinationNodes = 5;

-
-
-

name

-
name: string
-

name is the name of the ACL.

-
-
-

Generated

from field: string name = 1;

-
-
-

priority

-
priority: number
-

priority is the priority of the ACL. ACLs with higher priority are evaluated first.

-
-
-

Generated

from field: int32 priority = 2;

-
-
-

sourceCIDRs

-
sourceCIDRs: string[]
-

source_cidrs is a list of source CIDRs to match against. If empty, all CIDRs are matched. +

Generated

from field: repeated string destinationNodes = 5;

+

name

name: string

name is the name of the ACL.

+

Generated

from field: string name = 1;

+

priority

priority: number

priority is the priority of the ACL. ACLs with higher priority are evaluated first.

+

Generated

from field: int32 priority = 2;

+

sourceCIDRs

sourceCIDRs: string[]

source_cidrs is a list of source CIDRs to match against. If empty, all CIDRs are matched. If one or more of the CIDRs is '*', all CIDRs are matched.

-
-
-

Generated

from field: repeated string sourceCIDRs = 6;

-
-
-

sourceNodes

-
sourceNodes: string[]
-

source_nodes is a list of source nodes to match against. If empty, all nodes are matched. Groups +

Generated

from field: repeated string sourceCIDRs = 6;

+

sourceNodes

sourceNodes: string[]

source_nodes is a list of source nodes to match against. If empty, all nodes are matched. Groups can be specified with the prefix "group:". If one or more of the nodes is '*', all nodes are matched.

-
-
-

Generated

from field: repeated string sourceNodes = 4;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.NetworkACL" = "v1.NetworkACL"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: repeated string sourceNodes = 4;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.NetworkACL" = "v1.NetworkACL"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/network_acls_pb.NetworkACLs.html b/docs/classes/network_acls_pb.NetworkACLs.html index 26614397..27fde5ce 100644 --- a/docs/classes/network_acls_pb.NetworkACLs.html +++ b/docs/classes/network_acls_pb.NetworkACLs.html @@ -1,216 +1,14 @@ -NetworkACLs | Webmesh API
-
- -
-
-
-
- -

Class NetworkACLs

-
-

NetworkACLs is a list of network ACLs.

-
-
-

Generated

from message v1.NetworkACLs

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
items +NetworkACLs | Webmesh API

Class NetworkACLs

NetworkACLs is a list of network ACLs.

+

Generated

from message v1.NetworkACLs

+

Hierarchy

Constructors

constructor +

Properties

items fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

items

-
items: NetworkACL[]
-

items is the list of network ACLs.

-
-
-

Generated

from field: repeated v1.NetworkACL items = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.NetworkACLs" = "v1.NetworkACLs"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

items

items: NetworkACL[]

items is the list of network ACLs.

+

Generated

from field: repeated v1.NetworkACL items = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.NetworkACLs" = "v1.NetworkACLs"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/network_acls_pb.NetworkAction.html b/docs/classes/network_acls_pb.NetworkAction.html index a17d3871..4b7a1b96 100644 --- a/docs/classes/network_acls_pb.NetworkAction.html +++ b/docs/classes/network_acls_pb.NetworkAction.html @@ -1,253 +1,24 @@ -NetworkAction | Webmesh API
-
- -
-
-
-
- -

Class NetworkAction

-
-

NetworkAction is an action that can be performed on a network resource. It is used +NetworkAction | Webmesh API

Class NetworkAction

NetworkAction is an action that can be performed on a network resource. It is used by implementations to evaluate network ACLs.

-
-
-

Generated

from message v1.NetworkAction

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
dstCIDR +

Generated

from message v1.NetworkAction

+

Hierarchy

Constructors

constructor +

Properties

dstCIDR dstNode srcCIDR srcNode fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

dstCIDR

-
dstCIDR: string
-

dst_cidr is the destination CIDR of the action.

-
-
-

Generated

from field: string dstCIDR = 4;

-
-
-

dstNode

-
dstNode: string
-

dst_node is the destination node of the action.

-
-
-

Generated

from field: string dstNode = 3;

-
-
-

srcCIDR

-
srcCIDR: string
-

src_cidr is the source CIDR of the action.

-
-
-

Generated

from field: string srcCIDR = 2;

-
-
-

srcNode

-
srcNode: string
-

src_node is the source node of the action.

-
-
-

Generated

from field: string srcNode = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.NetworkAction" = "v1.NetworkAction"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

dstCIDR

dstCIDR: string

dst_cidr is the destination CIDR of the action.

+

Generated

from field: string dstCIDR = 4;

+

dstNode

dstNode: string

dst_node is the destination node of the action.

+

Generated

from field: string dstNode = 3;

+

srcCIDR

srcCIDR: string

src_cidr is the source CIDR of the action.

+

Generated

from field: string srcCIDR = 2;

+

srcNode

srcNode: string

src_node is the source node of the action.

+

Generated

from field: string srcNode = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.NetworkAction" = "v1.NetworkAction"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/network_acls_pb.Route.html b/docs/classes/network_acls_pb.Route.html index 6e3be050..403dced5 100644 --- a/docs/classes/network_acls_pb.Route.html +++ b/docs/classes/network_acls_pb.Route.html @@ -1,252 +1,23 @@ -Route | Webmesh API
-
- -
-
-
-
- -

Class Route

-
-

Route is a route that is broadcasted by one or more nodes.

-
-
-

Generated

from message v1.Route

-
-
-

Hierarchy

-
    -
  • unknown<Route> -
      -
    • Route
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
destinationCIDRs +Route | Webmesh API

Class Route

Route is a route that is broadcasted by one or more nodes.

+

Generated

from message v1.Route

+

Hierarchy

Constructors

constructor +

Properties

destinationCIDRs name nextHopNode node fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

destinationCIDRs

-
destinationCIDRs: string[]
-

destination_cidrs are the destination CIDRs of the route.

-
-
-

Generated

from field: repeated string destinationCIDRs = 3;

-
-
-

name

-
name: string
-

name is the name of the route.

-
-
-

Generated

from field: string name = 1;

-
-
-

nextHopNode

-
nextHopNode: string
-

nextHopNode is an optional node that is used as the next hop for the route.

-
-
-

Generated

from field: string nextHopNode = 4;

-
-
-

node

-
node: string
-

node is the node that broadcasts the route. A group can be specified with the prefix "group:".

-
-
-

Generated

from field: string node = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.Route" = "v1.Route"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

destinationCIDRs

destinationCIDRs: string[]

destination_cidrs are the destination CIDRs of the route.

+

Generated

from field: repeated string destinationCIDRs = 3;

+

name

name: string

name is the name of the route.

+

Generated

from field: string name = 1;

+

nextHopNode

nextHopNode: string

nextHopNode is an optional node that is used as the next hop for the route.

+

Generated

from field: string nextHopNode = 4;

+

node

node: string

node is the node that broadcasts the route. A group can be specified with the prefix "group:".

+

Generated

from field: string node = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.Route" = "v1.Route"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/network_acls_pb.Routes.html b/docs/classes/network_acls_pb.Routes.html index a85ad724..e4164230 100644 --- a/docs/classes/network_acls_pb.Routes.html +++ b/docs/classes/network_acls_pb.Routes.html @@ -1,216 +1,14 @@ -Routes | Webmesh API
-
- -
-
-
-
- -

Class Routes

-
-

Routes is a list of routes.

-
-
-

Generated

from message v1.Routes

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
items +Routes | Webmesh API

Class Routes

Routes is a list of routes.

+

Generated

from message v1.Routes

+

Hierarchy

Constructors

constructor +

Properties

items fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

items

-
items: Route[]
-

items is the list of routes.

-
-
-

Generated

from field: repeated v1.Route items = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.Routes" = "v1.Routes"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

items

items: Route[]

items is the list of routes.

+

Generated

from field: repeated v1.Route items = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.Routes" = "v1.Routes"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/node_pb.DataChannelNegotiation.html b/docs/classes/node_pb.DataChannelNegotiation.html index d71a561f..dbe41feb 100644 --- a/docs/classes/node_pb.DataChannelNegotiation.html +++ b/docs/classes/node_pb.DataChannelNegotiation.html @@ -1,47 +1,7 @@ -DataChannelNegotiation | Webmesh API
-
- -
-
-
-
- -

Class DataChannelNegotiation

-
-

DataChannelNegotiation is the message for communicating data channels to nodes.

-
-
-

Generated

from message v1.DataChannelNegotiation

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
answer +DataChannelNegotiation | Webmesh API

Class DataChannelNegotiation

DataChannelNegotiation is the message for communicating data channels to nodes.

+

Generated

from message v1.DataChannelNegotiation

+

Hierarchy

Constructors

constructor +

Properties

answer candidate dst offer @@ -52,249 +12,24 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

answer

-
answer: string
-

answer is the answer for the node to use as its remote description.

-
-
-

Generated

from field: string answer = 6;

-
-
-

candidate

-
candidate: string
-

candidate is an ICE candidate.

-
-
-

Generated

from field: string candidate = 7;

-
-
-

dst

-
dst: string
-

dst is the destination address of the traffic.

-
-
-

Generated

from field: string dst = 3;

-
-
-

offer

-
offer: string
-

offer is the offer for the node to use as its local description.

-
-
-

Generated

from field: string offer = 5;

-
-
-

port

-
port: number
-

port is the destination port of the traffic.

-
-
-

Generated

from field: uint32 port = 4;

-
-
-

proto

-
proto: string
-

proto is the protocol of the traffic.

-
-
-

Generated

from field: string proto = 1;

-
-
-

src

-
src: string
-

src is the address of the client that initiated the request.

-
-
-

Generated

from field: string src = 2;

-
-
-

stunServers

-
stunServers: string[]
-

stun_servers is the list of STUN servers to use.

-
-
-

Generated

from field: repeated string stunServers = 8;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.DataChannelNegotiation" = "v1.DataChannelNegotiation"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

answer

answer: string

answer is the answer for the node to use as its remote description.

+

Generated

from field: string answer = 6;

+

candidate

candidate: string

candidate is an ICE candidate.

+

Generated

from field: string candidate = 7;

+

dst

dst: string

dst is the destination address of the traffic.

+

Generated

from field: string dst = 3;

+

offer

offer: string

offer is the offer for the node to use as its local description.

+

Generated

from field: string offer = 5;

+

port

port: number

port is the destination port of the traffic.

+

Generated

from field: uint32 port = 4;

+

proto

proto: string

proto is the protocol of the traffic.

+

Generated

from field: string proto = 1;

+

src

src: string

src is the address of the client that initiated the request.

+

Generated

from field: string src = 2;

+

stunServers

stunServers: string[]

stun_servers is the list of STUN servers to use.

+

Generated

from field: repeated string stunServers = 8;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.DataChannelNegotiation" = "v1.DataChannelNegotiation"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/node_pb.FeaturePort.html b/docs/classes/node_pb.FeaturePort.html index e83af5a3..5bc2fbf3 100644 --- a/docs/classes/node_pb.FeaturePort.html +++ b/docs/classes/node_pb.FeaturePort.html @@ -1,228 +1,17 @@ -FeaturePort | Webmesh API
-
- -
-
-
-
- -

Class FeaturePort

-
-

FeaturePort describes a feature and the port it is advertised on.

-
-
-

Generated

from message v1.FeaturePort

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
feature +FeaturePort | Webmesh API

Class FeaturePort

FeaturePort describes a feature and the port it is advertised on.

+

Generated

from message v1.FeaturePort

+

Hierarchy

Constructors

constructor +

Properties

feature port fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

feature

-
feature: Feature
-

feature is the feature.

-
-
-

Generated

from field: v1.Feature feature = 1;

-
-
-

port

-
port: number
-

port is the port the feature is advertised on.

-
-
-

Generated

from field: int32 port = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.FeaturePort" = "v1.FeaturePort"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

feature

feature: Feature

feature is the feature.

+

Generated

from field: v1.Feature feature = 1;

+

port

port: number

port is the port the feature is advertised on.

+

Generated

from field: int32 port = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.FeaturePort" = "v1.FeaturePort"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/node_pb.GetStatusRequest.html b/docs/classes/node_pb.GetStatusRequest.html index b201d4a0..f6ca13ca 100644 --- a/docs/classes/node_pb.GetStatusRequest.html +++ b/docs/classes/node_pb.GetStatusRequest.html @@ -1,217 +1,15 @@ -GetStatusRequest | Webmesh API
-
- -
-
-
-
- -

Class GetStatusRequest

-
-

GetStatusRequest is a request to get the status of a node.

-
-
-

Generated

from message v1.GetStatusRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
id +GetStatusRequest | Webmesh API

Class GetStatusRequest

GetStatusRequest is a request to get the status of a node.

+

Generated

from message v1.GetStatusRequest

+

Hierarchy

Constructors

constructor +

Properties

id fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

id

-
id: string
-

id is the ID of the node. If unset, the status of the +

Constructors

constructor

Properties

id

id: string

id is the ID of the node. If unset, the status of the local node is returned.

-
-
-

Generated

from field: string id = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.GetStatusRequest" = "v1.GetStatusRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: string id = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.GetStatusRequest" = "v1.GetStatusRequest"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/node_pb.InterfaceMetrics.html b/docs/classes/node_pb.InterfaceMetrics.html index 55c37537..737c30b7 100644 --- a/docs/classes/node_pb.InterfaceMetrics.html +++ b/docs/classes/node_pb.InterfaceMetrics.html @@ -1,47 +1,7 @@ -InterfaceMetrics | Webmesh API
-
- -
-
-
-
- -

Class InterfaceMetrics

-
-

InterfaceMetrics is the metrics for the WireGuard interface on a node.

-
-
-

Generated

from message v1.InterfaceMetrics

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
addressV4 +InterfaceMetrics | Webmesh API

Class InterfaceMetrics

InterfaceMetrics is the metrics for the WireGuard interface on a node.

+

Generated

from message v1.InterfaceMetrics

+

Hierarchy

Constructors

constructor +

Properties

addressV4 addressV6 deviceName listenPort @@ -54,271 +14,28 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

addressV4

-
addressV4: string
-

address_v4 is the IPv4 address of the node.

-
-
-

Generated

from field: string addressV4 = 3;

-
-
-

addressV6

-
addressV6: string
-

address_v6 is the IPv6 address of the node.

-
-
-

Generated

from field: string addressV6 = 4;

-
-
-

deviceName

-
deviceName: string
-

device_name is the name of the device.

-
-
-

Generated

from field: string deviceName = 1;

-
-
-

listenPort

-
listenPort: number
-

listen_port is the port wireguard is listening on.

-
-
-

Generated

from field: int32 listenPort = 6;

-
-
-

numPeers

-
numPeers: number
-

num_peers is the number of peers connected to the node.

-
-
-

Generated

from field: int32 numPeers = 9;

-
-
-

peers

-
peers: PeerMetrics[]
-

peers are the per-peer statistics.

-
-
-

Generated

from field: repeated v1.PeerMetrics peers = 10;

-
-
-

publicKey

-
publicKey: string
-

public_key is the public key of the node.

-
-
-

Generated

from field: string publicKey = 2;

-
-
-

totalReceiveBytes

-
totalReceiveBytes: bigint
-

total_receive_bytes is the total number of bytes received.

-
-
-

Generated

from field: uint64 totalReceiveBytes = 7;

-
-
-

totalTransmitBytes

-
totalTransmitBytes: bigint
-

total_transmit_bytes is the total number of bytes transmitted.

-
-
-

Generated

from field: uint64 totalTransmitBytes = 8;

-
-
-

type

-
type: string
-

type is the type of interface being used for wireguard.

-
-
-

Generated

from field: string type = 5;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.InterfaceMetrics" = "v1.InterfaceMetrics"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

addressV4

addressV4: string

address_v4 is the IPv4 address of the node.

+

Generated

from field: string addressV4 = 3;

+

addressV6

addressV6: string

address_v6 is the IPv6 address of the node.

+

Generated

from field: string addressV6 = 4;

+

deviceName

deviceName: string

device_name is the name of the device.

+

Generated

from field: string deviceName = 1;

+

listenPort

listenPort: number

listen_port is the port wireguard is listening on.

+

Generated

from field: int32 listenPort = 6;

+

numPeers

numPeers: number

num_peers is the number of peers connected to the node.

+

Generated

from field: int32 numPeers = 9;

+

peers

peers: PeerMetrics[]

peers are the per-peer statistics.

+

Generated

from field: repeated v1.PeerMetrics peers = 10;

+

publicKey

publicKey: string

public_key is the public key of the node.

+

Generated

from field: string publicKey = 2;

+

totalReceiveBytes

totalReceiveBytes: bigint

total_receive_bytes is the total number of bytes received.

+

Generated

from field: uint64 totalReceiveBytes = 7;

+

totalTransmitBytes

totalTransmitBytes: bigint

total_transmit_bytes is the total number of bytes transmitted.

+

Generated

from field: uint64 totalTransmitBytes = 8;

+

type

type: string

type is the type of interface being used for wireguard.

+

Generated

from field: string type = 5;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.InterfaceMetrics" = "v1.InterfaceMetrics"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/node_pb.MeshNode.html b/docs/classes/node_pb.MeshNode.html index dc937de6..f5f2f872 100644 --- a/docs/classes/node_pb.MeshNode.html +++ b/docs/classes/node_pb.MeshNode.html @@ -1,47 +1,7 @@ -MeshNode | Webmesh API
-
- -
-
-
-
- -

Class MeshNode

-
-

MeshNode is a node that has been registered with the mesh.

-
-
-

Generated

from message v1.MeshNode

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
features +MeshNode | Webmesh API

Class MeshNode

MeshNode is a node that has been registered with the mesh.

+

Generated

from message v1.MeshNode

+

Hierarchy

Constructors

constructor +

Properties

features id joinedAt? multiaddrs @@ -54,271 +14,28 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional data: any
    -

    Returns MeshNode

-
-

Properties

-
-

features

-
features: FeaturePort[]
-

features are a list of features and the ports they are advertised on.

-
-
-

Generated

from field: repeated v1.FeaturePort features = 9;

-
-
-

id

-
id: string
-

id is the ID of the node.

-
-
-

Generated

from field: string id = 1;

-
-
-

Optional joinedAt

-
joinedAt?: any
-

joined_at is the time the node joined the cluster.

-
-
-

Generated

from field: google.protobuf.Timestamp joinedAt = 11;

-
-
-

multiaddrs

-
multiaddrs: string[]
-

multiaddrs are the multiaddrs of the node.

-
-
-

Generated

from field: repeated string multiaddrs = 10;

-
-
-

primaryEndpoint

-
primaryEndpoint: string
-

primary_endpoint is the primary endpoint of the node.

-
-
-

Generated

from field: string primaryEndpoint = 4;

-
-
-

privateIPv4

-
privateIPv4: string
-

private_ipv4 is the private IPv4 address of the node.

-
-
-

Generated

from field: string privateIPv4 = 7;

-
-
-

privateIPv6

-
privateIPv6: string
-

private_ipv6 is the private IPv6 address of the node.

-
-
-

Generated

from field: string privateIPv6 = 8;

-
-
-

publicKey

-
publicKey: string
-

public_key is the public key of the node.

-
-
-

Generated

from field: string publicKey = 2;

-
-
-

wireguardEndpoints

-
wireguardEndpoints: string[]
-

wireguard_endpoints is a list of WireGuard endpoints for the node.

-
-
-

Generated

from field: repeated string wireguardEndpoints = 5;

-
-
-

zoneAwarenessID

-
zoneAwarenessID: string
-

zone_awareness_id is the zone awareness ID of the node.

-
-
-

Generated

from field: string zoneAwarenessID = 6;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.MeshNode" = "v1.MeshNode"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonString: string
      • -
    • -
      Optional options: any
    -

    Returns MeshNode

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

features

features: FeaturePort[]

features are a list of features and the ports they are advertised on.

+

Generated

from field: repeated v1.FeaturePort features = 9;

+

id

id: string

id is the ID of the node.

+

Generated

from field: string id = 1;

+

Optional joinedAt

joinedAt?: any

joined_at is the time the node joined the cluster.

+

Generated

from field: google.protobuf.Timestamp joinedAt = 11;

+

multiaddrs

multiaddrs: string[]

multiaddrs are the multiaddrs of the node.

+

Generated

from field: repeated string multiaddrs = 10;

+

primaryEndpoint

primaryEndpoint: string

primary_endpoint is the primary endpoint of the node.

+

Generated

from field: string primaryEndpoint = 4;

+

privateIPv4

privateIPv4: string

private_ipv4 is the private IPv4 address of the node.

+

Generated

from field: string privateIPv4 = 7;

+

privateIPv6

privateIPv6: string

private_ipv6 is the private IPv6 address of the node.

+

Generated

from field: string privateIPv6 = 8;

+

publicKey

publicKey: string

public_key is the public key of the node.

+

Generated

from field: string publicKey = 2;

+

wireguardEndpoints

wireguardEndpoints: string[]

wireguard_endpoints is a list of WireGuard endpoints for the node.

+

Generated

from field: repeated string wireguardEndpoints = 5;

+

zoneAwarenessID

zoneAwarenessID: string

zone_awareness_id is the zone awareness ID of the node.

+

Generated

from field: string zoneAwarenessID = 6;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.MeshNode" = "v1.MeshNode"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/node_pb.NodeList.html b/docs/classes/node_pb.NodeList.html index 788fc07a..2980cce9 100644 --- a/docs/classes/node_pb.NodeList.html +++ b/docs/classes/node_pb.NodeList.html @@ -1,216 +1,14 @@ -NodeList | Webmesh API
-
- -
-
-
-
- -

Class NodeList

-
-

NodeList is a list of nodes.

-
-
-

Generated

from message v1.NodeList

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
nodes +NodeList | Webmesh API

Class NodeList

NodeList is a list of nodes.

+

Generated

from message v1.NodeList

+

Hierarchy

Constructors

constructor +

Properties

nodes fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional data: any
    -

    Returns NodeList

-
-

Properties

-
-

nodes

-
nodes: MeshNode[]
-

nodes is the list of nodes.

-
-
-

Generated

from field: repeated v1.MeshNode nodes = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.NodeList" = "v1.NodeList"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonString: string
      • -
    • -
      Optional options: any
    -

    Returns NodeList

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

nodes

nodes: MeshNode[]

nodes is the list of nodes.

+

Generated

from field: repeated v1.MeshNode nodes = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.NodeList" = "v1.NodeList"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/node_pb.PeerMetrics.html b/docs/classes/node_pb.PeerMetrics.html index 69d82d07..513f8d8b 100644 --- a/docs/classes/node_pb.PeerMetrics.html +++ b/docs/classes/node_pb.PeerMetrics.html @@ -1,47 +1,7 @@ -PeerMetrics | Webmesh API
-
- -
-
-
-
- -

Class PeerMetrics

-
-

PeerMetrics are the metrics for a node's peer.

-
-
-

Generated

from message v1.PeerMetrics

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
allowedIPs +PeerMetrics | Webmesh API

Class PeerMetrics

PeerMetrics are the metrics for a node's peer.

+

Generated

from message v1.PeerMetrics

+

Hierarchy

Constructors

constructor +

Properties

allowedIPs endpoint lastHandshakeTime persistentKeepAlive @@ -52,249 +12,24 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

allowedIPs

-
allowedIPs: string[]
-

allowed_ips is the list of allowed IPs for the peer.

-
-
-

Generated

from field: repeated string allowedIPs = 5;

-
-
-

endpoint

-
endpoint: string
-

endpoint is the connected endpoint of the peer.

-
-
-

Generated

from field: string endpoint = 2;

-
-
-

lastHandshakeTime

-
lastHandshakeTime: string
-

last_handshake_time is the last handshake time for the peer.

-
-
-

Generated

from field: string lastHandshakeTime = 4;

-
-
-

persistentKeepAlive

-
persistentKeepAlive: string
-

persistent_keep_alive is the persistent keep alive interval for the peer.

-
-
-

Generated

from field: string persistentKeepAlive = 3;

-
-
-

protocolVersion

-
protocolVersion: bigint
-

protocol_version is the version of the wireguard protocol negotiated with the peer.

-
-
-

Generated

from field: int64 protocolVersion = 6;

-
-
-

publicKey

-
publicKey: string
-

public_key is the public key of the peer.

-
-
-

Generated

from field: string publicKey = 1;

-
-
-

receiveBytes

-
receiveBytes: bigint
-

receive_bytes is the bytes received from the peer.

-
-
-

Generated

from field: uint64 receiveBytes = 7;

-
-
-

transmitBytes

-
transmitBytes: bigint
-

transmit_bytes is the bytes transmitted to the peer.

-
-
-

Generated

from field: uint64 transmitBytes = 8;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.PeerMetrics" = "v1.PeerMetrics"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

allowedIPs

allowedIPs: string[]

allowed_ips is the list of allowed IPs for the peer.

+

Generated

from field: repeated string allowedIPs = 5;

+

endpoint

endpoint: string

endpoint is the connected endpoint of the peer.

+

Generated

from field: string endpoint = 2;

+

lastHandshakeTime

lastHandshakeTime: string

last_handshake_time is the last handshake time for the peer.

+

Generated

from field: string lastHandshakeTime = 4;

+

persistentKeepAlive

persistentKeepAlive: string

persistent_keep_alive is the persistent keep alive interval for the peer.

+

Generated

from field: string persistentKeepAlive = 3;

+

protocolVersion

protocolVersion: bigint

protocol_version is the version of the wireguard protocol negotiated with the peer.

+

Generated

from field: int64 protocolVersion = 6;

+

publicKey

publicKey: string

public_key is the public key of the peer.

+

Generated

from field: string publicKey = 1;

+

receiveBytes

receiveBytes: bigint

receive_bytes is the bytes received from the peer.

+

Generated

from field: uint64 receiveBytes = 7;

+

transmitBytes

transmitBytes: bigint

transmit_bytes is the bytes transmitted to the peer.

+

Generated

from field: uint64 transmitBytes = 8;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.PeerMetrics" = "v1.PeerMetrics"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/node_pb.Status.html b/docs/classes/node_pb.Status.html index 1141acc1..42476720 100644 --- a/docs/classes/node_pb.Status.html +++ b/docs/classes/node_pb.Status.html @@ -1,47 +1,7 @@ -Status | Webmesh API
-
- -
-
-
-
- -

Class Status

-
-

Status represents the status of a node.

-
-
-

Generated

from message v1.Status

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
buildDate +Status | Webmesh API

Class Status

Status represents the status of a node.

+

Generated

from message v1.Status

+

Hierarchy

Constructors

constructor +

Properties

buildDate clusterStatus commit currentLeader @@ -55,283 +15,31 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional data: any
    -

    Returns Status

-
-

Properties

-
-

buildDate

-
buildDate: string
-

build_date is the build date of the node.

-
-
-

Generated

from field: string build_date = 5;

-
-
-

clusterStatus

-
clusterStatus: ClusterStatus
-

cluster_status is the status of the node in the cluster.

-
-
-

Generated

from field: v1.ClusterStatus clusterStatus = 9;

-
-
-

commit

-
commit: string
-

commit is the commit of the node.

-
-
-

Generated

from field: string commit = 4;

-
-
-

currentLeader

-
currentLeader: string
-

current_leader is the current leader of the cluster.

-
-
-

Generated

from field: string currentLeader = 10;

-
-
-

description

-
description: string
-

description is an optional description provided +

Constructors

constructor

Properties

buildDate

buildDate: string

build_date is the build date of the node.

+

Generated

from field: string build_date = 5;

+

clusterStatus

clusterStatus: ClusterStatus

cluster_status is the status of the node in the cluster.

+

Generated

from field: v1.ClusterStatus clusterStatus = 9;

+

commit

commit: string

commit is the commit of the node.

+

Generated

from field: string commit = 4;

+

currentLeader

currentLeader: string

current_leader is the current leader of the cluster.

+

Generated

from field: string currentLeader = 10;

+

description

description: string

description is an optional description provided by the node.

-
-
-

Generated

from field: string description = 2;

-
-
-

features

-
features: FeaturePort[]
-

features is the list of features currently enabled.

-
-
-

Generated

from field: repeated v1.FeaturePort features = 8;

-
-
-

id

-
id: string
-

id is the ID of the node.

-
-
-

Generated

from field: string id = 1;

-
-
-

Optional interfaceMetrics

-
interfaceMetrics?: InterfaceMetrics
-

interface_metrics are the metrics for the node's interfaces.

-
-
-

Generated

from field: v1.InterfaceMetrics interfaceMetrics = 11;

-
-
-

Optional startedAt

-
startedAt?: any
-

started_at is the time the node started.

-
-
-

Generated

from field: google.protobuf.Timestamp startedAt = 7;

-
-
-

uptime

-
uptime: string
-

uptime is the uptime of the node.

-
-
-

Generated

from field: string uptime = 6;

-
-
-

version

-
version: string
-

version is the version of the node.

-
-
-

Generated

from field: string version = 3;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.Status" = "v1.Status"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      bytes: Uint8Array
      • -
    • -
      Optional options: any
    -

    Returns Status

-
-

Static fromJson

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonValue: JsonValue
      • -
    • -
      Optional options: any
    -

    Returns Status

-
-

Static fromJsonString

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonString: string
      • -
    • -
      Optional options: any
    -

    Returns Status

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: string description = 2;

+

features

features: FeaturePort[]

features is the list of features currently enabled.

+

Generated

from field: repeated v1.FeaturePort features = 8;

+

id

id: string

id is the ID of the node.

+

Generated

from field: string id = 1;

+

Optional interfaceMetrics

interfaceMetrics?: InterfaceMetrics

interface_metrics are the metrics for the node's interfaces.

+

Generated

from field: v1.InterfaceMetrics interfaceMetrics = 11;

+

Optional startedAt

startedAt?: any

started_at is the time the node started.

+

Generated

from field: google.protobuf.Timestamp startedAt = 7;

+

uptime

uptime: string

uptime is the uptime of the node.

+

Generated

from field: string uptime = 6;

+

version

version: string

version is the version of the node.

+

Generated

from field: string version = 3;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.Status" = "v1.Status"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/node_pb.WebRTCSignal.html b/docs/classes/node_pb.WebRTCSignal.html index f07a1daf..d43d6008 100644 --- a/docs/classes/node_pb.WebRTCSignal.html +++ b/docs/classes/node_pb.WebRTCSignal.html @@ -1,243 +1,23 @@ -WebRTCSignal | Webmesh API
-
- -
-
-
-
- -

Class WebRTCSignal

-
-

WebRTCSignal is a signal sent to a remote peer over the WebRTC API.

-
-
-

Generated

from message v1.WebRTCSignal

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
candidate +WebRTCSignal | Webmesh API

Class WebRTCSignal

WebRTCSignal is a signal sent to a remote peer over the WebRTC API.

+

Generated

from message v1.WebRTCSignal

+

Hierarchy

Constructors

constructor +

Properties

candidate description nodeID fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

candidate

-
candidate: string
-

candidate is an ICE candidate.

-
-
-

Generated

from field: string candidate = 2;

-
-
-

description

-
description: string
-

description is a session description.

-
-
-

Generated

from field: string description = 3;

-
-
-

nodeID

-
nodeID: string
-

node_id is the ID of the node to send the signal to. +

Constructors

constructor

Properties

candidate

candidate: string

candidate is an ICE candidate.

+

Generated

from field: string candidate = 2;

+

description

description: string

description is a session description.

+

Generated

from field: string description = 3;

+

nodeID

nodeID: string

node_id is the ID of the node to send the signal to. This is set by the original sender. On the node that receives the ReceiveSignalChannel request, this will be set to the ID of the node that sent the request.

-
-
-

Generated

from field: string nodeID = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.WebRTCSignal" = "v1.WebRTCSignal"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: string nodeID = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.WebRTCSignal" = "v1.WebRTCSignal"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/plugin_pb.AllocateIPRequest.html b/docs/classes/plugin_pb.AllocateIPRequest.html index 96448ede..b0ad4fb9 100644 --- a/docs/classes/plugin_pb.AllocateIPRequest.html +++ b/docs/classes/plugin_pb.AllocateIPRequest.html @@ -1,228 +1,17 @@ -AllocateIPRequest | Webmesh API
-
- -
-
-
-
- -

Class AllocateIPRequest

-
-

AllocateIPRequest is the message containing an IP allocation request.

-
-
-

Generated

from message v1.AllocateIPRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
nodeID +AllocateIPRequest | Webmesh API

Class AllocateIPRequest

AllocateIPRequest is the message containing an IP allocation request.

+

Generated

from message v1.AllocateIPRequest

+

Hierarchy

Constructors

constructor +

Properties

nodeID subnet fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

nodeID

-
nodeID: string
-

node_id is the node that the IP should be allocated for.

-
-
-

Generated

from field: string nodeID = 1;

-
-
-

subnet

-
subnet: string
-

subnet is the subnet that the IP should be allocated from.

-
-
-

Generated

from field: string subnet = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.AllocateIPRequest" = "v1.AllocateIPRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

nodeID

nodeID: string

node_id is the node that the IP should be allocated for.

+

Generated

from field: string nodeID = 1;

+

subnet

subnet: string

subnet is the subnet that the IP should be allocated from.

+

Generated

from field: string subnet = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.AllocateIPRequest" = "v1.AllocateIPRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/plugin_pb.AllocatedIP.html b/docs/classes/plugin_pb.AllocatedIP.html index e0e62582..97d5620e 100644 --- a/docs/classes/plugin_pb.AllocatedIP.html +++ b/docs/classes/plugin_pb.AllocatedIP.html @@ -1,216 +1,14 @@ -AllocatedIP | Webmesh API
-
- -
-
-
-
- -

Class AllocatedIP

-
-

AllocatedIP is the message containing an allocated IP.

-
-
-

Generated

from message v1.AllocatedIP

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
ip +AllocatedIP | Webmesh API

Class AllocatedIP

AllocatedIP is the message containing an allocated IP.

+

Generated

from message v1.AllocatedIP

+

Hierarchy

Constructors

constructor +

Properties

ip fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

ip

-
ip: string
-

ip is the allocated IP. It should be returned in CIDR notation.

-
-
-

Generated

from field: string ip = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.AllocatedIP" = "v1.AllocatedIP"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

ip

ip: string

ip is the allocated IP. It should be returned in CIDR notation.

+

Generated

from field: string ip = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.AllocatedIP" = "v1.AllocatedIP"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/plugin_pb.AuthenticationRequest.html b/docs/classes/plugin_pb.AuthenticationRequest.html index e599cec0..d7839298 100644 --- a/docs/classes/plugin_pb.AuthenticationRequest.html +++ b/docs/classes/plugin_pb.AuthenticationRequest.html @@ -1,233 +1,17 @@ -AuthenticationRequest | Webmesh API
-
- -
-
-
-
- -

Class AuthenticationRequest

-
-

AuthenticationRequest is the message containing an authentication request.

-
-
-

Generated

from message v1.AuthenticationRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
certificates +AuthenticationRequest | Webmesh API

Class AuthenticationRequest

AuthenticationRequest is the message containing an authentication request.

+

Generated

from message v1.AuthenticationRequest

+

Hierarchy

Constructors

constructor +

Properties

certificates headers fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

certificates

-
certificates: Uint8Array[]
-

certificates are the DER encoded certificates of the request.

-
-
-

Generated

from field: repeated bytes certificates = 2;

-
-
-

headers

-
headers: {
    [key: string]: string;
}
-

headers are the headers of the request.

-
-
-

Type declaration

-
    -
  • -
    [key: string]: string
-
-

Generated

from field: map<string, string> headers = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.AuthenticationRequest" = "v1.AuthenticationRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

certificates

certificates: Uint8Array[]

certificates are the DER encoded certificates of the request.

+

Generated

from field: repeated bytes certificates = 2;

+

headers

headers: {
    [key: string]: string;
}

headers are the headers of the request.

+

Type declaration

  • [key: string]: string

Generated

from field: map<string, string> headers = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.AuthenticationRequest" = "v1.AuthenticationRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/plugin_pb.AuthenticationResponse.html b/docs/classes/plugin_pb.AuthenticationResponse.html index dd7ea53f..fbfa7620 100644 --- a/docs/classes/plugin_pb.AuthenticationResponse.html +++ b/docs/classes/plugin_pb.AuthenticationResponse.html @@ -1,216 +1,14 @@ -AuthenticationResponse | Webmesh API
-
- -
-
-
-
- -

Class AuthenticationResponse

-
-

AuthenticationResponse is the message containing an authentication response.

-
-
-

Generated

from message v1.AuthenticationResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
id +AuthenticationResponse | Webmesh API

Class AuthenticationResponse

AuthenticationResponse is the message containing an authentication response.

+

Generated

from message v1.AuthenticationResponse

+

Hierarchy

Constructors

constructor +

Properties

id fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

id

-
id: string
-

id is the id of the authenticated user.

-
-
-

Generated

from field: string id = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.AuthenticationResponse" = "v1.AuthenticationResponse"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

id

id: string

id is the id of the authenticated user.

+

Generated

from field: string id = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.AuthenticationResponse" = "v1.AuthenticationResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/plugin_pb.Event.html b/docs/classes/plugin_pb.Event.html index ad8668ed..c57b9d60 100644 --- a/docs/classes/plugin_pb.Event.html +++ b/docs/classes/plugin_pb.Event.html @@ -1,247 +1,19 @@ -Event | Webmesh API
-
- -
-
-
-
- -

Class Event

-
-

Event is the message containing a watch event.

-
-
-

Generated

from message v1.Event

-
-
-

Hierarchy

-
    -
  • unknown<Event> -
      -
    • Event
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
event +Event | Webmesh API

Class Event

Event is the message containing a watch event.

+

Generated

from message v1.Event

+

Hierarchy

Constructors

constructor +

Properties

event type fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional data: any
    -

    Returns Event

-
-

Properties

-
-

event

-
event: {
    case: "node";
    value: MeshNode;
} | {
    case: undefined;
    value?: undefined;
}
-

event is the data of the watch event.

-
-
-

Type declaration

-
    -
  • -
    case: "node"
    • -
  • -
    value: MeshNode
    -

    node is the node that the event is about.

    -
    -
    -

    Generated

    from field: v1.MeshNode node = 2;

    -
-
-

Type declaration

-
    -
  • -
    case: undefined
    • -
  • -
    Optional value?: undefined
-
-

Generated

from oneof v1.Event.event

-
-
-

type

-
type: Event_WatchEvent
-

type is the type of the watch event.

-
-
-

Generated

from field: v1.Event.WatchEvent type = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.Event" = "v1.Event"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      bytes: Uint8Array
      • -
    • -
      Optional options: any
    -

    Returns Event

-
-

Static fromJson

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonValue: JsonValue
      • -
    • -
      Optional options: any
    -

    Returns Event

-
-

Static fromJsonString

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonString: string
      • -
    • -
      Optional options: any
    -

    Returns Event

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

event

event: {
    case: "node";
    value: MeshNode;
} | {
    case: undefined;
    value?: undefined;
}

event is the data of the watch event.

+

Type declaration

  • case: "node"
  • value: MeshNode

    node is the node that the event is about.

    +

    Generated

    from field: v1.MeshNode node = 2;

    +

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof v1.Event.event

+

type

type: Event_WatchEvent

type is the type of the watch event.

+

Generated

from field: v1.Event.WatchEvent type = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.Event" = "v1.Event"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/plugin_pb.NodeConfiguration.html b/docs/classes/plugin_pb.NodeConfiguration.html index 1267a74c..e38267e0 100644 --- a/docs/classes/plugin_pb.NodeConfiguration.html +++ b/docs/classes/plugin_pb.NodeConfiguration.html @@ -1,48 +1,8 @@ -NodeConfiguration | Webmesh API
-
- -
-
-
-
- -

Class NodeConfiguration

-
-

NodeConfiguration is the message containing the configuration of the +NodeConfiguration | Webmesh API

Class NodeConfiguration

NodeConfiguration is the message containing the configuration of the node and the network that it is a part of.

-
-
-

Generated

from message v1.NodeConfiguration

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
addressIPv4 +

Generated

from message v1.NodeConfiguration

+

Hierarchy

Constructors

constructor +

Properties

addressIPv4 addressIPv6 domain id @@ -52,238 +12,22 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

addressIPv4

-
addressIPv4: string
-

AddressIPv4 is the IPv4 address of the node.

-
-
-

Generated

from field: string addressIPv4 = 4;

-
-
-

addressIPv6

-
addressIPv6: string
-

AddressIPv6 is the IPv6 address of the node.

-
-
-

Generated

from field: string addressIPv6 = 5;

-
-
-

domain

-
domain: string
-

Domain is the domain of the network.

-
-
-

Generated

from field: string domain = 6;

-
-
-

id

-
id: string
-

ID is the ID of the node.

-
-
-

Generated

from field: string id = 1;

-
-
-

networkIPv4

-
networkIPv4: string
-

NetworkIPv4 is the IPv4 network that the node is a part of.

-
-
-

Generated

from field: string networkIPv4 = 2;

-
-
-

networkIPv6

-
networkIPv6: string
-

NetworkIPv6 is the IPv6 network that the node is a part of.

-
-
-

Generated

from field: string networkIPv6 = 3;

-
-
-

privateKey

-
privateKey: Uint8Array
-

PrivateKey is the private key of the node.

-
-
-

Generated

from field: bytes privateKey = 7;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.NodeConfiguration" = "v1.NodeConfiguration"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

addressIPv4

addressIPv4: string

AddressIPv4 is the IPv4 address of the node.

+

Generated

from field: string addressIPv4 = 4;

+

addressIPv6

addressIPv6: string

AddressIPv6 is the IPv6 address of the node.

+

Generated

from field: string addressIPv6 = 5;

+

domain

domain: string

Domain is the domain of the network.

+

Generated

from field: string domain = 6;

+

id

id: string

ID is the ID of the node.

+

Generated

from field: string id = 1;

+

networkIPv4

networkIPv4: string

NetworkIPv4 is the IPv4 network that the node is a part of.

+

Generated

from field: string networkIPv4 = 2;

+

networkIPv6

networkIPv6: string

NetworkIPv6 is the IPv6 network that the node is a part of.

+

Generated

from field: string networkIPv6 = 3;

+

privateKey

privateKey: Uint8Array

PrivateKey is the private key of the node.

+

Generated

from field: bytes privateKey = 7;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.NodeConfiguration" = "v1.NodeConfiguration"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/plugin_pb.PluginConfiguration.html b/docs/classes/plugin_pb.PluginConfiguration.html index c2085a84..adba0c8d 100644 --- a/docs/classes/plugin_pb.PluginConfiguration.html +++ b/docs/classes/plugin_pb.PluginConfiguration.html @@ -1,229 +1,18 @@ -PluginConfiguration | Webmesh API
-
- -
-
-
-
- -

Class PluginConfiguration

-
-

PluginConfiguration is the message containing the configuration of a plugin.

-
-
-

Generated

from message v1.PluginConfiguration

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
config? +PluginConfiguration | Webmesh API

Class PluginConfiguration

PluginConfiguration is the message containing the configuration of a plugin.

+

Generated

from message v1.PluginConfiguration

+

Hierarchy

Constructors

constructor +

Properties

config? nodeConfig? fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Optional config

-
config?: any
-

Config is the configuration for the plugin. This will be specific +

Constructors

constructor

Properties

Optional config

config?: any

Config is the configuration for the plugin. This will be specific for each plugin.

-
-
-

Generated

from field: google.protobuf.Struct config = 1;

-
-
-

Optional nodeConfig

-
nodeConfig?: NodeConfiguration
-

NodeConfig is the configuration of the node and the network that it is a part of.

-
-
-

Generated

from field: v1.NodeConfiguration nodeConfig = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.PluginConfiguration" = "v1.PluginConfiguration"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: google.protobuf.Struct config = 1;

+

Optional nodeConfig

nodeConfig?: NodeConfiguration

NodeConfig is the configuration of the node and the network that it is a part of.

+

Generated

from field: v1.NodeConfiguration nodeConfig = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.PluginConfiguration" = "v1.PluginConfiguration"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/plugin_pb.PluginInfo.html b/docs/classes/plugin_pb.PluginInfo.html index 6f17b1f7..1593474f 100644 --- a/docs/classes/plugin_pb.PluginInfo.html +++ b/docs/classes/plugin_pb.PluginInfo.html @@ -1,252 +1,23 @@ -PluginInfo | Webmesh API
-
- -
-
-
-
- -

Class PluginInfo

-
-

PluginInfo is the information of a plugin.

-
-
-

Generated

from message v1.PluginInfo

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
capabilities +PluginInfo | Webmesh API

Class PluginInfo

PluginInfo is the information of a plugin.

+

Generated

from message v1.PluginInfo

+

Hierarchy

Constructors

constructor +

Properties

capabilities description name version fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

capabilities

-
capabilities: PluginInfo_PluginCapability[]
-

Capabilities is the capabilities of the plugin.

-
-
-

Generated

from field: repeated v1.PluginInfo.PluginCapability capabilities = 5;

-
-
-

description

-
description: string
-

Description is the description of the plugin.

-
-
-

Generated

from field: string description = 3;

-
-
-

name

-
name: string
-

Name is the name of the plugin.

-
-
-

Generated

from field: string name = 1;

-
-
-

version

-
version: string
-

Version is the version of the plugin.

-
-
-

Generated

from field: string version = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.PluginInfo" = "v1.PluginInfo"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

capabilities

capabilities: PluginInfo_PluginCapability[]

Capabilities is the capabilities of the plugin.

+

Generated

from field: repeated v1.PluginInfo.PluginCapability capabilities = 5;

+

description

description: string

Description is the description of the plugin.

+

Generated

from field: string description = 3;

+

name

name: string

Name is the name of the plugin.

+

Generated

from field: string name = 1;

+

version

version: string

Version is the version of the plugin.

+

Generated

from field: string version = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.PluginInfo" = "v1.PluginInfo"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/plugin_pb.ReleaseIPRequest.html b/docs/classes/plugin_pb.ReleaseIPRequest.html index f4b0cffc..ed674b13 100644 --- a/docs/classes/plugin_pb.ReleaseIPRequest.html +++ b/docs/classes/plugin_pb.ReleaseIPRequest.html @@ -1,228 +1,17 @@ -ReleaseIPRequest | Webmesh API
-
- -
-
-
-
- -

Class ReleaseIPRequest

-
-

ReleaseIPRequest is the message containing an IP release request.

-
-
-

Generated

from message v1.ReleaseIPRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
ip +ReleaseIPRequest | Webmesh API

Class ReleaseIPRequest

ReleaseIPRequest is the message containing an IP release request.

+

Generated

from message v1.ReleaseIPRequest

+

Hierarchy

Constructors

constructor +

Properties

ip nodeID fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

ip

-
ip: string
-

ip is the IP that should be released.

-
-
-

Generated

from field: string ip = 2;

-
-
-

nodeID

-
nodeID: string
-

node_id is the node that the IP should be released for.

-
-
-

Generated

from field: string nodeID = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.ReleaseIPRequest" = "v1.ReleaseIPRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

ip

ip: string

ip is the IP that should be released.

+

Generated

from field: string ip = 2;

+

nodeID

nodeID: string

node_id is the node that the IP should be released for.

+

Generated

from field: string nodeID = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.ReleaseIPRequest" = "v1.ReleaseIPRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/raft_pb.RaftApplyResponse.html b/docs/classes/raft_pb.RaftApplyResponse.html index 8bdfd034..b3db6c27 100644 --- a/docs/classes/raft_pb.RaftApplyResponse.html +++ b/docs/classes/raft_pb.RaftApplyResponse.html @@ -1,229 +1,18 @@ -RaftApplyResponse | Webmesh API
-
- -
-
-
-
- -

Class RaftApplyResponse

-
-

RaftApplyResponse is the response to an apply request. It +RaftApplyResponse | Webmesh API

Class RaftApplyResponse

RaftApplyResponse is the response to an apply request. It contains the result of applying the log entry.

-
-
-

Generated

from message v1.RaftApplyResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
error +

Generated

from message v1.RaftApplyResponse

+

Hierarchy

Constructors

constructor +

Properties

error time fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

error

-
error: string
-

error is an error that occurred during the apply.

-
-
-

Generated

from field: string error = 2;

-
-
-

time

-
time: string
-

time is the total time it took to apply the log entry.

-
-
-

Generated

from field: string time = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.RaftApplyResponse" = "v1.RaftApplyResponse"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

error

error: string

error is an error that occurred during the apply.

+

Generated

from field: string error = 2;

+

time

time: string

time is the total time it took to apply the log entry.

+

Generated

from field: string time = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.RaftApplyResponse" = "v1.RaftApplyResponse"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/raft_pb.RaftDataItem.html b/docs/classes/raft_pb.RaftDataItem.html index 79447af1..8fe78e5a 100644 --- a/docs/classes/raft_pb.RaftDataItem.html +++ b/docs/classes/raft_pb.RaftDataItem.html @@ -1,240 +1,20 @@ -RaftDataItem | Webmesh API
-
- -
-
-
-
- -

Class RaftDataItem

-
-

RaftDataItem represents a value in the Raft data store.

-
-
-

Generated

from message v1.RaftDataItem

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
key +RaftDataItem | Webmesh API

Class RaftDataItem

RaftDataItem represents a value in the Raft data store.

+

Generated

from message v1.RaftDataItem

+

Hierarchy

Constructors

constructor +

Properties

key ttl? value fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

key

-
key: Uint8Array
-

key is the key of the data item.

-
-
-

Generated

from field: bytes key = 1;

-
-
-

Optional ttl

-
ttl?: any
-

ttl is the time to live of the data item.

-
-
-

Generated

from field: google.protobuf.Duration ttl = 3;

-
-
-

value

-
value: Uint8Array
-

value is the value of the data item.

-
-
-

Generated

from field: bytes value = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.RaftDataItem" = "v1.RaftDataItem"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

key

key: Uint8Array

key is the key of the data item.

+

Generated

from field: bytes key = 1;

+

Optional ttl

ttl?: any

ttl is the time to live of the data item.

+

Generated

from field: google.protobuf.Duration ttl = 3;

+

value

value: Uint8Array

value is the value of the data item.

+

Generated

from field: bytes value = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.RaftDataItem" = "v1.RaftDataItem"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/raft_pb.RaftLogEntry.html b/docs/classes/raft_pb.RaftLogEntry.html index 20c794fa..05ad615d 100644 --- a/docs/classes/raft_pb.RaftLogEntry.html +++ b/docs/classes/raft_pb.RaftLogEntry.html @@ -1,252 +1,23 @@ -RaftLogEntry | Webmesh API
-
- -
-
-
-
- -

Class RaftLogEntry

-
-

RaftLogEntry is the data of an entry in the Raft log.

-
-
-

Generated

from message v1.RaftLogEntry

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
key +RaftLogEntry | Webmesh API

Class RaftLogEntry

RaftLogEntry is the data of an entry in the Raft log.

+

Generated

from message v1.RaftLogEntry

+

Hierarchy

Constructors

constructor +

Properties

key ttl? type value fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

key

-
key: Uint8Array
-

key is the key of the log entry.

-
-
-

Generated

from field: bytes key = 2;

-
-
-

Optional ttl

-
ttl?: any
-

ttl is the time to live of the log entry.

-
-
-

Generated

from field: google.protobuf.Duration ttl = 4;

-
-
-

type

-
type: RaftCommandType
-

type is the type of the log entry.

-
-
-

Generated

from field: v1.RaftCommandType type = 1;

-
-
-

value

-
value: Uint8Array
-

value is the value of the log entry.

-
-
-

Generated

from field: bytes value = 3;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.RaftLogEntry" = "v1.RaftLogEntry"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

key

key: Uint8Array

key is the key of the log entry.

+

Generated

from field: bytes key = 2;

+

Optional ttl

ttl?: any

ttl is the time to live of the log entry.

+

Generated

from field: google.protobuf.Duration ttl = 4;

+

type

type: RaftCommandType

type is the type of the log entry.

+

Generated

from field: v1.RaftCommandType type = 1;

+

value

value: Uint8Array

value is the value of the log entry.

+

Generated

from field: bytes value = 3;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.RaftLogEntry" = "v1.RaftLogEntry"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/raft_pb.RaftSnapshot.html b/docs/classes/raft_pb.RaftSnapshot.html index 78215e52..ce8854e6 100644 --- a/docs/classes/raft_pb.RaftSnapshot.html +++ b/docs/classes/raft_pb.RaftSnapshot.html @@ -1,214 +1,13 @@ -RaftSnapshot | Webmesh API
-
- -
-
-
-
- -

Class RaftSnapshot

-
-

RaftSnapshot is the data of a snapshot.

-
-
-

Generated

from message v1.RaftSnapshot

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
kv +RaftSnapshot | Webmesh API

Class RaftSnapshot

RaftSnapshot is the data of a snapshot.

+

Generated

from message v1.RaftSnapshot

+

Hierarchy

Constructors

constructor +

Properties

kv fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

kv

-
kv: RaftDataItem[]
-
-

Generated

from field: repeated v1.RaftDataItem kv = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.RaftSnapshot" = "v1.RaftSnapshot"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

kv

kv: RaftDataItem[]

Generated

from field: repeated v1.RaftDataItem kv = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.RaftSnapshot" = "v1.RaftSnapshot"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/rbac_pb.Group.html b/docs/classes/rbac_pb.Group.html index 4998aa33..e9a251aa 100644 --- a/docs/classes/rbac_pb.Group.html +++ b/docs/classes/rbac_pb.Group.html @@ -1,228 +1,17 @@ -Group | Webmesh API
-
- -
-
-
-
- -

Class Group

-
-

Group is a group of subjects.

-
-
-

Generated

from message v1.Group

-
-
-

Hierarchy

-
    -
  • unknown<Group> -
      -
    • Group
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
name +Group | Webmesh API

Class Group

Group is a group of subjects.

+

Generated

from message v1.Group

+

Hierarchy

Constructors

constructor +

Properties

name subjects fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional data: any
    -

    Returns Group

-
-

Properties

-
-

name

-
name: string
-

name is the name of the group.

-
-
-

Generated

from field: string name = 1;

-
-
-

subjects

-
subjects: Subject[]
-

subjects is the list of subjects in the group.

-
-
-

Generated

from field: repeated v1.Subject subjects = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.Group" = "v1.Group"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      bytes: Uint8Array
      • -
    • -
      Optional options: any
    -

    Returns Group

-
-

Static fromJson

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonValue: JsonValue
      • -
    • -
      Optional options: any
    -

    Returns Group

-
-

Static fromJsonString

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonString: string
      • -
    • -
      Optional options: any
    -

    Returns Group

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

name

name: string

name is the name of the group.

+

Generated

from field: string name = 1;

+

subjects

subjects: Subject[]

subjects is the list of subjects in the group.

+

Generated

from field: repeated v1.Subject subjects = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.Group" = "v1.Group"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

  • Parameters

    • jsonString: string
    • Optional options: any

    Returns Group

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/rbac_pb.Groups.html b/docs/classes/rbac_pb.Groups.html index d9f658da..6f3aaa01 100644 --- a/docs/classes/rbac_pb.Groups.html +++ b/docs/classes/rbac_pb.Groups.html @@ -1,216 +1,14 @@ -Groups | Webmesh API
-
- -
-
-
-
- -

Class Groups

-
-

Groups is a list of groups.

-
-
-

Generated

from message v1.Groups

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
items +Groups | Webmesh API

Class Groups

Groups is a list of groups.

+

Generated

from message v1.Groups

+

Hierarchy

Constructors

constructor +

Properties

items fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional data: any
    -

    Returns Groups

-
-

Properties

-
-

items

-
items: Group[]
-

items is the list of groups.

-
-
-

Generated

from field: repeated v1.Group items = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.Groups" = "v1.Groups"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      bytes: Uint8Array
      • -
    • -
      Optional options: any
    -

    Returns Groups

-
-

Static fromJson

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonValue: JsonValue
      • -
    • -
      Optional options: any
    -

    Returns Groups

-
-

Static fromJsonString

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonString: string
      • -
    • -
      Optional options: any
    -

    Returns Groups

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

items

items: Group[]

items is the list of groups.

+

Generated

from field: repeated v1.Group items = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.Groups" = "v1.Groups"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/rbac_pb.RBACAction.html b/docs/classes/rbac_pb.RBACAction.html index 8488ba6f..6d73b968 100644 --- a/docs/classes/rbac_pb.RBACAction.html +++ b/docs/classes/rbac_pb.RBACAction.html @@ -1,242 +1,22 @@ -RBACAction | Webmesh API
-
- -
-
-
-
- -

Class RBACAction

-
-

RBACAction is an action that can be performed on a resource. It is used by implementations +RBACAction | Webmesh API

Class RBACAction

RBACAction is an action that can be performed on a resource. It is used by implementations to evaluate rules.

-
-
-

Generated

from message v1.RBACAction

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
resource +

Generated

from message v1.RBACAction

+

Hierarchy

Constructors

constructor +

Properties

resource resourceName verb fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

resource

-
resource: RuleResource
-

resource is the resource on which the action is performed.

-
-
-

Generated

from field: v1.RuleResource resource = 1;

-
-
-

resourceName

-
resourceName: string
-

resource_name is the name of the resource on which the action is +

Constructors

constructor

Properties

resource

resource: RuleResource

resource is the resource on which the action is performed.

+

Generated

from field: v1.RuleResource resource = 1;

+

resourceName

resourceName: string

resource_name is the name of the resource on which the action is performed.

-
-
-

Generated

from field: string resourceName = 2;

-
-
-

verb

-
verb: RuleVerb
-

verb is the verb that is performed on the resource.

-
-
-

Generated

from field: v1.RuleVerb verb = 3;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.RBACAction" = "v1.RBACAction"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: string resourceName = 2;

+

verb

verb: RuleVerb

verb is the verb that is performed on the resource.

+

Generated

from field: v1.RuleVerb verb = 3;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.RBACAction" = "v1.RBACAction"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/rbac_pb.Role.html b/docs/classes/rbac_pb.Role.html index 65170008..eaa0744f 100644 --- a/docs/classes/rbac_pb.Role.html +++ b/docs/classes/rbac_pb.Role.html @@ -1,228 +1,17 @@ -Role | Webmesh API
-
- -
-
-
-
- -

Class Role

-
-

Role is a role that can be assigned to a subject.

-
-
-

Generated

from message v1.Role

-
-
-

Hierarchy

-
    -
  • unknown<Role> -
      -
    • Role
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
name +Role | Webmesh API

Class Role

Role is a role that can be assigned to a subject.

+

Generated

from message v1.Role

+

Hierarchy

Constructors

constructor +

Properties

name rules fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional data: any
    -

    Returns Role

-
-

Properties

-
-

name

-
name: string
-

name is the name of the role.

-
-
-

Generated

from field: string name = 1;

-
-
-

rules

-
rules: Rule[]
-

rules is the list of rules that apply to the role.

-
-
-

Generated

from field: repeated v1.Rule rules = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.Role" = "v1.Role"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      bytes: Uint8Array
      • -
    • -
      Optional options: any
    -

    Returns Role

-
-

Static fromJson

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonValue: JsonValue
      • -
    • -
      Optional options: any
    -

    Returns Role

-
-

Static fromJsonString

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonString: string
      • -
    • -
      Optional options: any
    -

    Returns Role

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

  • Parameters

    • Optional data: any

    Returns Role

Properties

name

name: string

name is the name of the role.

+

Generated

from field: string name = 1;

+

rules

rules: Rule[]

rules is the list of rules that apply to the role.

+

Generated

from field: repeated v1.Rule rules = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.Role" = "v1.Role"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

  • Parameters

    • bytes: Uint8Array
    • Optional options: any

    Returns Role

Static fromJson

  • Parameters

    • jsonValue: JsonValue
    • Optional options: any

    Returns Role

Static fromJsonString

  • Parameters

    • jsonString: string
    • Optional options: any

    Returns Role

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/rbac_pb.RoleBinding.html b/docs/classes/rbac_pb.RoleBinding.html index 78a2e327..ce6e48cd 100644 --- a/docs/classes/rbac_pb.RoleBinding.html +++ b/docs/classes/rbac_pb.RoleBinding.html @@ -1,240 +1,20 @@ -RoleBinding | Webmesh API
-
- -
-
-
-
- -

Class RoleBinding

-
-

RoleBinding is a binding of a role to one or more subjects.

-
-
-

Generated

from message v1.RoleBinding

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
name +RoleBinding | Webmesh API

Class RoleBinding

RoleBinding is a binding of a role to one or more subjects.

+

Generated

from message v1.RoleBinding

+

Hierarchy

Constructors

constructor +

Properties

name role subjects fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

name

-
name: string
-

name is the name of the role binding.

-
-
-

Generated

from field: string name = 1;

-
-
-

role

-
role: string
-

role is the name of the role to which the binding applies.

-
-
-

Generated

from field: string role = 2;

-
-
-

subjects

-
subjects: Subject[]
-

subjects is the list of subjects to which the binding applies.

-
-
-

Generated

from field: repeated v1.Subject subjects = 3;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.RoleBinding" = "v1.RoleBinding"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

name

name: string

name is the name of the role binding.

+

Generated

from field: string name = 1;

+

role

role: string

role is the name of the role to which the binding applies.

+

Generated

from field: string role = 2;

+

subjects

subjects: Subject[]

subjects is the list of subjects to which the binding applies.

+

Generated

from field: repeated v1.Subject subjects = 3;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.RoleBinding" = "v1.RoleBinding"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/rbac_pb.RoleBindings.html b/docs/classes/rbac_pb.RoleBindings.html index 05772bee..e202f482 100644 --- a/docs/classes/rbac_pb.RoleBindings.html +++ b/docs/classes/rbac_pb.RoleBindings.html @@ -1,216 +1,14 @@ -RoleBindings | Webmesh API
-
- -
-
-
-
- -

Class RoleBindings

-
-

RoleBindings is a list of role bindings.

-
-
-

Generated

from message v1.RoleBindings

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
items +RoleBindings | Webmesh API

Class RoleBindings

RoleBindings is a list of role bindings.

+

Generated

from message v1.RoleBindings

+

Hierarchy

Constructors

constructor +

Properties

items fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

items

-
items: RoleBinding[]
-

items is the list of role bindings.

-
-
-

Generated

from field: repeated v1.RoleBinding items = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.RoleBindings" = "v1.RoleBindings"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

items

items: RoleBinding[]

items is the list of role bindings.

+

Generated

from field: repeated v1.RoleBinding items = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.RoleBindings" = "v1.RoleBindings"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/rbac_pb.Roles.html b/docs/classes/rbac_pb.Roles.html index b431e368..1b6665ca 100644 --- a/docs/classes/rbac_pb.Roles.html +++ b/docs/classes/rbac_pb.Roles.html @@ -1,216 +1,14 @@ -Roles | Webmesh API
-
- -
-
-
-
- -

Class Roles

-
-

Roles is a list of roles.

-
-
-

Generated

from message v1.Roles

-
-
-

Hierarchy

-
    -
  • unknown<Roles> -
      -
    • Roles
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
items +Roles | Webmesh API

Class Roles

Roles is a list of roles.

+

Generated

from message v1.Roles

+

Hierarchy

Constructors

constructor +

Properties

items fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional data: any
    -

    Returns Roles

-
-

Properties

-
-

items

-
items: Role[]
-

items is the list of roles.

-
-
-

Generated

from field: repeated v1.Role items = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.Roles" = "v1.Roles"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      bytes: Uint8Array
      • -
    • -
      Optional options: any
    -

    Returns Roles

-
-

Static fromJson

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonValue: JsonValue
      • -
    • -
      Optional options: any
    -

    Returns Roles

-
-

Static fromJsonString

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonString: string
      • -
    • -
      Optional options: any
    -

    Returns Roles

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

items

items: Role[]

items is the list of roles.

+

Generated

from field: repeated v1.Role items = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.Roles" = "v1.Roles"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

  • Parameters

    • jsonString: string
    • Optional options: any

    Returns Roles

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/rbac_pb.Rule.html b/docs/classes/rbac_pb.Rule.html index 814a32d0..4e4683e1 100644 --- a/docs/classes/rbac_pb.Rule.html +++ b/docs/classes/rbac_pb.Rule.html @@ -1,240 +1,20 @@ -Rule | Webmesh API
-
- -
-
-
-
- -

Class Rule

-
-

Rule is a rule that applies to a resource.

-
-
-

Generated

from message v1.Rule

-
-
-

Hierarchy

-
    -
  • unknown<Rule> -
      -
    • Rule
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
resourceNames +Rule | Webmesh API

Class Rule

Rule is a rule that applies to a resource.

+

Generated

from message v1.Rule

+

Hierarchy

Constructors

constructor +

Properties

resourceNames resources verbs fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional data: any
    -

    Returns Rule

-
-

Properties

-
-

resourceNames

-
resourceNames: string[]
-

resource_names is the list of resource names to which the rule applies.

-
-
-

Generated

from field: repeated string resourceNames = 2;

-
-
-

resources

-
resources: RuleResource[]
-

resources is the resources to which the rule applies.

-
-
-

Generated

from field: repeated v1.RuleResource resources = 1;

-
-
-

verbs

-
verbs: RuleVerb[]
-

verbs is the list of verbs that apply to the resource.

-
-
-

Generated

from field: repeated v1.RuleVerb verbs = 3;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.Rule" = "v1.Rule"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      bytes: Uint8Array
      • -
    • -
      Optional options: any
    -

    Returns Rule

-
-

Static fromJson

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonValue: JsonValue
      • -
    • -
      Optional options: any
    -

    Returns Rule

-
-

Static fromJsonString

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonString: string
      • -
    • -
      Optional options: any
    -

    Returns Rule

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

  • Parameters

    • Optional data: any

    Returns Rule

Properties

resourceNames

resourceNames: string[]

resource_names is the list of resource names to which the rule applies.

+

Generated

from field: repeated string resourceNames = 2;

+

resources

resources: RuleResource[]

resources is the resources to which the rule applies.

+

Generated

from field: repeated v1.RuleResource resources = 1;

+

verbs

verbs: RuleVerb[]

verbs is the list of verbs that apply to the resource.

+

Generated

from field: repeated v1.RuleVerb verbs = 3;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.Rule" = "v1.Rule"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

  • Parameters

    • bytes: Uint8Array
    • Optional options: any

    Returns Rule

Static fromJson

  • Parameters

    • jsonValue: JsonValue
    • Optional options: any

    Returns Rule

Static fromJsonString

  • Parameters

    • jsonString: string
    • Optional options: any

    Returns Rule

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/rbac_pb.Subject.html b/docs/classes/rbac_pb.Subject.html index 02af8ca5..fba6f7cb 100644 --- a/docs/classes/rbac_pb.Subject.html +++ b/docs/classes/rbac_pb.Subject.html @@ -1,228 +1,17 @@ -Subject | Webmesh API
-
- -
-
-
-
- -

Class Subject

-
-

Subject is a subject to which a role can be bound.

-
-
-

Generated

from message v1.Subject

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
name +Subject | Webmesh API

Class Subject

Subject is a subject to which a role can be bound.

+

Generated

from message v1.Subject

+

Hierarchy

Constructors

constructor +

Properties

name type fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional data: any
    -

    Returns Subject

-
-

Properties

-
-

name

-
name: string
-

name is the name of the subject.

-
-
-

Generated

from field: string name = 1;

-
-
-

type

-
type: SubjectType
-

type is the type of the subject.

-
-
-

Generated

from field: v1.SubjectType type = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.Subject" = "v1.Subject"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      bytes: Uint8Array
      • -
    • -
      Optional options: any
    -

    Returns Subject

-
-

Static fromJson

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonValue: JsonValue
      • -
    • -
      Optional options: any
    -

    Returns Subject

-
-

Static fromJsonString

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      jsonString: string
      • -
    • -
      Optional options: any
    -

    Returns Subject

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

name

name: string

name is the name of the subject.

+

Generated

from field: string name = 1;

+

type

type: SubjectType

type is the type of the subject.

+

Generated

from field: v1.SubjectType type = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.Subject" = "v1.Subject"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/registrar_pb.LookupRequest.html b/docs/classes/registrar_pb.LookupRequest.html index b332102e..a0c8415a 100644 --- a/docs/classes/registrar_pb.LookupRequest.html +++ b/docs/classes/registrar_pb.LookupRequest.html @@ -1,241 +1,21 @@ -LookupRequest | Webmesh API
-
- -
-
-
-
- -

Class LookupRequest

-
-

LookupRequest is the request object for the Lookup RPC. One of the fields +LookupRequest | Webmesh API

Class LookupRequest

LookupRequest is the request object for the Lookup RPC. One of the fields must be provided.

-
-
-

Generated

from message v1.LookupRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
alias +

Generated

from message v1.LookupRequest

+

Hierarchy

Constructors

constructor +

Properties

alias id publicKey fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

alias

-
alias: string
-

The alias of the public key to lookup.

-
-
-

Generated

from field: string alias = 3;

-
-
-

id

-
id: string
-

The ID derived from the public key to lookup.

-
-
-

Generated

from field: string id = 1;

-
-
-

publicKey

-
publicKey: string
-

The public key to lookup.

-
-
-

Generated

from field: string publicKey = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.LookupRequest" = "v1.LookupRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

alias

alias: string

The alias of the public key to lookup.

+

Generated

from field: string alias = 3;

+

id

id: string

The ID derived from the public key to lookup.

+

Generated

from field: string id = 1;

+

publicKey

publicKey: string

The public key to lookup.

+

Generated

from field: string publicKey = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.LookupRequest" = "v1.LookupRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/registrar_pb.LookupResponse.html b/docs/classes/registrar_pb.LookupResponse.html index 923c33f8..03a259b3 100644 --- a/docs/classes/registrar_pb.LookupResponse.html +++ b/docs/classes/registrar_pb.LookupResponse.html @@ -1,240 +1,20 @@ -LookupResponse | Webmesh API
-
- -
-
-
-
- -

Class LookupResponse

-
-

LookupResponse is the response object for the Lookup RPC.

-
-
-

Generated

from message v1.LookupResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
alias +LookupResponse | Webmesh API

Class LookupResponse

LookupResponse is the response object for the Lookup RPC.

+

Generated

from message v1.LookupResponse

+

Hierarchy

Constructors

constructor +

Properties

alias id publicKey fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

alias

-
alias: string
-

Any alias associated with the public key.

-
-
-

Generated

from field: string alias = 3;

-
-
-

id

-
id: string
-

The ID of the public key that was looked up.

-
-
-

Generated

from field: string id = 1;

-
-
-

publicKey

-
publicKey: string
-

The encoded public key that was looked up.

-
-
-

Generated

from field: string publicKey = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.LookupResponse" = "v1.LookupResponse"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

alias

alias: string

Any alias associated with the public key.

+

Generated

from field: string alias = 3;

+

id

id: string

The ID of the public key that was looked up.

+

Generated

from field: string id = 1;

+

publicKey

publicKey: string

The encoded public key that was looked up.

+

Generated

from field: string publicKey = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.LookupResponse" = "v1.LookupResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/registrar_pb.RegisterRequest.html b/docs/classes/registrar_pb.RegisterRequest.html index 8c8d7770..5e74b3e8 100644 --- a/docs/classes/registrar_pb.RegisterRequest.html +++ b/docs/classes/registrar_pb.RegisterRequest.html @@ -1,243 +1,23 @@ -RegisterRequest | Webmesh API
-
- -
-
-
-
- -

Class RegisterRequest

-
-

RegisterRequest is the request object for the Register RPC.

-
-
-

Generated

from message v1.RegisterRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
alias +RegisterRequest | Webmesh API

Class RegisterRequest

RegisterRequest is the request object for the Register RPC.

+

Generated

from message v1.RegisterRequest

+

Hierarchy

Constructors

constructor +

Properties

alias expiry? publicKey fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

alias

-
alias: string
-

An alias to associate with the public key. This can be used to lookup +

Constructors

constructor

Properties

alias

alias: string

An alias to associate with the public key. This can be used to lookup the public key later.

-
-
-

Generated

from field: string alias = 2;

-
-
-

Optional expiry

-
expiry?: any
-

Expiry is the time at which the public key and its associated aliases +

Generated

from field: string alias = 2;

+

Optional expiry

expiry?: any

Expiry is the time at which the public key and its associated aliases should be removed from the registrar. If not provided, a default value of 1 day from the time of registration will be used.

-
-
-

Generated

from field: google.protobuf.Timestamp expiry = 3;

-
-
-

publicKey

-
publicKey: string
-

The encoded public key to register.

-
-
-

Generated

from field: string publicKey = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.RegisterRequest" = "v1.RegisterRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: google.protobuf.Timestamp expiry = 3;

+

publicKey

publicKey: string

The encoded public key to register.

+

Generated

from field: string publicKey = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.RegisterRequest" = "v1.RegisterRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/registrar_pb.RegisterResponse.html b/docs/classes/registrar_pb.RegisterResponse.html index df9e7ebb..be5d6187 100644 --- a/docs/classes/registrar_pb.RegisterResponse.html +++ b/docs/classes/registrar_pb.RegisterResponse.html @@ -1,216 +1,14 @@ -RegisterResponse | Webmesh API
-
- -
-
-
-
- -

Class RegisterResponse

-
-

RegisterResponse is the response object for the Register RPC.

-
-
-

Generated

from message v1.RegisterResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
id +RegisterResponse | Webmesh API

Class RegisterResponse

RegisterResponse is the response object for the Register RPC.

+

Generated

from message v1.RegisterResponse

+

Hierarchy

Constructors

constructor +

Properties

id fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

id

-
id: string
-

ID of the public key that was registered.

-
-
-

Generated

from field: string id = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.RegisterResponse" = "v1.RegisterResponse"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

id

id: string

ID of the public key that was registered.

+

Generated

from field: string id = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.RegisterResponse" = "v1.RegisterResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.AddObserverResponse.html b/docs/classes/storage_provider_pb.AddObserverResponse.html index e0f030bb..80e55ddd 100644 --- a/docs/classes/storage_provider_pb.AddObserverResponse.html +++ b/docs/classes/storage_provider_pb.AddObserverResponse.html @@ -1,204 +1,11 @@ -AddObserverResponse | Webmesh API
-
- -
-
-
-
- -

Class AddObserverResponse

-
-

AddObserverResponse is the response object for the AddObserver RPC.

-
-
-

Generated

from message v1.AddObserverResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +AddObserverResponse | Webmesh API

Class AddObserverResponse

AddObserverResponse is the response object for the AddObserver RPC.

+

Generated

from message v1.AddObserverResponse

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.AddObserverResponse" = "v1.AddObserverResponse"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.AddObserverResponse" = "v1.AddObserverResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.AddVoterResponse.html b/docs/classes/storage_provider_pb.AddVoterResponse.html index 155973b8..95cdee68 100644 --- a/docs/classes/storage_provider_pb.AddVoterResponse.html +++ b/docs/classes/storage_provider_pb.AddVoterResponse.html @@ -1,204 +1,11 @@ -AddVoterResponse | Webmesh API
-
- -
-
-
-
- -

Class AddVoterResponse

-
-

AddVoterResponse is the response object for the AddVoter RPC.

-
-
-

Generated

from message v1.AddVoterResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +AddVoterResponse | Webmesh API

Class AddVoterResponse

AddVoterResponse is the response object for the AddVoter RPC.

+

Generated

from message v1.AddVoterResponse

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.AddVoterResponse" = "v1.AddVoterResponse"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.AddVoterResponse" = "v1.AddVoterResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.BootstrapRequest.html b/docs/classes/storage_provider_pb.BootstrapRequest.html index b825a96b..f5f6a5a9 100644 --- a/docs/classes/storage_provider_pb.BootstrapRequest.html +++ b/docs/classes/storage_provider_pb.BootstrapRequest.html @@ -1,204 +1,11 @@ -BootstrapRequest | Webmesh API
-
- -
-
-
-
- -

Class BootstrapRequest

-
-

BootstrapRequest is the request object for the Bootstrap RPC.

-
-
-

Generated

from message v1.BootstrapRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +BootstrapRequest | Webmesh API

Class BootstrapRequest

BootstrapRequest is the request object for the Bootstrap RPC.

+

Generated

from message v1.BootstrapRequest

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.BootstrapRequest" = "v1.BootstrapRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.BootstrapRequest" = "v1.BootstrapRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.BootstrapResponse.html b/docs/classes/storage_provider_pb.BootstrapResponse.html index 06635533..fc935fb1 100644 --- a/docs/classes/storage_provider_pb.BootstrapResponse.html +++ b/docs/classes/storage_provider_pb.BootstrapResponse.html @@ -1,216 +1,14 @@ -BootstrapResponse | Webmesh API
-
- -
-
-
-
- -

Class BootstrapResponse

-
-

BootstrapResponse is the response object for the Bootstrap RPC.

-
-
-

Generated

from message v1.BootstrapResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
status? +BootstrapResponse | Webmesh API

Class BootstrapResponse

BootstrapResponse is the response object for the Bootstrap RPC.

+

Generated

from message v1.BootstrapResponse

+

Hierarchy

Constructors

constructor +

Properties

status? fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Optional status

-
status?: StorageStatus
-

Status is the status of the storage after the bootstrap.

-
-
-

Generated

from field: v1.StorageStatus status = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.BootstrapResponse" = "v1.BootstrapResponse"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Optional status

status?: StorageStatus

Status is the status of the storage after the bootstrap.

+

Generated

from field: v1.StorageStatus status = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.BootstrapResponse" = "v1.BootstrapResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.DeleteValueRequest.html b/docs/classes/storage_provider_pb.DeleteValueRequest.html index b59a06e8..b11b49f4 100644 --- a/docs/classes/storage_provider_pb.DeleteValueRequest.html +++ b/docs/classes/storage_provider_pb.DeleteValueRequest.html @@ -1,216 +1,14 @@ -DeleteValueRequest | Webmesh API
-
- -
-
-
-
- -

Class DeleteValueRequest

-
-

DeleteValueRequest is the request object for the DeleteValue RPC.

-
-
-

Generated

from message v1.DeleteValueRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
key +DeleteValueRequest | Webmesh API

Class DeleteValueRequest

DeleteValueRequest is the request object for the DeleteValue RPC.

+

Generated

from message v1.DeleteValueRequest

+

Hierarchy

Constructors

constructor +

Properties

key fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

key

-
key: Uint8Array
-

Key is the key to delete.

-
-
-

Generated

from field: bytes key = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.DeleteValueRequest" = "v1.DeleteValueRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key to delete.

+

Generated

from field: bytes key = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.DeleteValueRequest" = "v1.DeleteValueRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.DeleteValueResponse.html b/docs/classes/storage_provider_pb.DeleteValueResponse.html index 843d01d3..b511e2f3 100644 --- a/docs/classes/storage_provider_pb.DeleteValueResponse.html +++ b/docs/classes/storage_provider_pb.DeleteValueResponse.html @@ -1,204 +1,11 @@ -DeleteValueResponse | Webmesh API
-
- -
-
-
-
- -

Class DeleteValueResponse

-
-

DeleteValueResponse is the response object for the DeleteValue RPC.

-
-
-

Generated

from message v1.DeleteValueResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +DeleteValueResponse | Webmesh API

Class DeleteValueResponse

DeleteValueResponse is the response object for the DeleteValue RPC.

+

Generated

from message v1.DeleteValueResponse

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.DeleteValueResponse" = "v1.DeleteValueResponse"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.DeleteValueResponse" = "v1.DeleteValueResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.DemoteVoterResponse.html b/docs/classes/storage_provider_pb.DemoteVoterResponse.html index efbab599..bc17c9b7 100644 --- a/docs/classes/storage_provider_pb.DemoteVoterResponse.html +++ b/docs/classes/storage_provider_pb.DemoteVoterResponse.html @@ -1,204 +1,11 @@ -DemoteVoterResponse | Webmesh API
-
- -
-
-
-
- -

Class DemoteVoterResponse

-
-

DemoteVoterResponse is the response object for the DemoteVoter RPC.

-
-
-

Generated

from message v1.DemoteVoterResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +DemoteVoterResponse | Webmesh API

Class DemoteVoterResponse

DemoteVoterResponse is the response object for the DemoteVoter RPC.

+

Generated

from message v1.DemoteVoterResponse

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.DemoteVoterResponse" = "v1.DemoteVoterResponse"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.DemoteVoterResponse" = "v1.DemoteVoterResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.GetLeaderRequest.html b/docs/classes/storage_provider_pb.GetLeaderRequest.html index ff0b328a..88e430d8 100644 --- a/docs/classes/storage_provider_pb.GetLeaderRequest.html +++ b/docs/classes/storage_provider_pb.GetLeaderRequest.html @@ -1,204 +1,11 @@ -GetLeaderRequest | Webmesh API
-
- -
-
-
-
- -

Class GetLeaderRequest

-
-

GetLeaderRequest is the request object for the GetLeader RPC.

-
-
-

Generated

from message v1.GetLeaderRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +GetLeaderRequest | Webmesh API

Class GetLeaderRequest

GetLeaderRequest is the request object for the GetLeader RPC.

+

Generated

from message v1.GetLeaderRequest

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.GetLeaderRequest" = "v1.GetLeaderRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.GetLeaderRequest" = "v1.GetLeaderRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.GetPeersRequest.html b/docs/classes/storage_provider_pb.GetPeersRequest.html index ca10bbb7..d12ffe10 100644 --- a/docs/classes/storage_provider_pb.GetPeersRequest.html +++ b/docs/classes/storage_provider_pb.GetPeersRequest.html @@ -1,204 +1,11 @@ -GetPeersRequest | Webmesh API
-
- -
-
-
-
- -

Class GetPeersRequest

-
-

GetPeersRequest is the request object for the GetPeers RPC.

-
-
-

Generated

from message v1.GetPeersRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +GetPeersRequest | Webmesh API

Class GetPeersRequest

GetPeersRequest is the request object for the GetPeers RPC.

+

Generated

from message v1.GetPeersRequest

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.GetPeersRequest" = "v1.GetPeersRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.GetPeersRequest" = "v1.GetPeersRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.GetValueRequest.html b/docs/classes/storage_provider_pb.GetValueRequest.html index 9dbd6a79..68609e15 100644 --- a/docs/classes/storage_provider_pb.GetValueRequest.html +++ b/docs/classes/storage_provider_pb.GetValueRequest.html @@ -1,216 +1,14 @@ -GetValueRequest | Webmesh API
-
- -
-
-
-
- -

Class GetValueRequest

-
-

GetValueRequest is the request object for the GetValue RPC.

-
-
-

Generated

from message v1.GetValueRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
key +GetValueRequest | Webmesh API

Class GetValueRequest

GetValueRequest is the request object for the GetValue RPC.

+

Generated

from message v1.GetValueRequest

+

Hierarchy

Constructors

constructor +

Properties

key fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

key

-
key: Uint8Array
-

Key is the key to get the value for.

-
-
-

Generated

from field: bytes key = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.GetValueRequest" = "v1.GetValueRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key to get the value for.

+

Generated

from field: bytes key = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.GetValueRequest" = "v1.GetValueRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.GetValueResponse.html b/docs/classes/storage_provider_pb.GetValueResponse.html index 8dbbab3e..a00b807f 100644 --- a/docs/classes/storage_provider_pb.GetValueResponse.html +++ b/docs/classes/storage_provider_pb.GetValueResponse.html @@ -1,216 +1,14 @@ -GetValueResponse | Webmesh API
-
- -
-
-
-
- -

Class GetValueResponse

-
-

GetValueResponse is the response object for the GetValue RPC.

-
-
-

Generated

from message v1.GetValueResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
value? +GetValueResponse | Webmesh API

Class GetValueResponse

GetValueResponse is the response object for the GetValue RPC.

+

Generated

from message v1.GetValueResponse

+

Hierarchy

Constructors

constructor +

Properties

value? fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Optional value

-
value?: StorageValue
-

Value is the value of the key.

-
-
-

Generated

from field: v1.StorageValue value = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.GetValueResponse" = "v1.GetValueResponse"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Optional value

value?: StorageValue

Value is the value of the key.

+

Generated

from field: v1.StorageValue value = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.GetValueResponse" = "v1.GetValueResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.ListKeysRequest.html b/docs/classes/storage_provider_pb.ListKeysRequest.html index fee3e870..26fb6ac7 100644 --- a/docs/classes/storage_provider_pb.ListKeysRequest.html +++ b/docs/classes/storage_provider_pb.ListKeysRequest.html @@ -1,216 +1,14 @@ -ListKeysRequest | Webmesh API
-
- -
-
-
-
- -

Class ListKeysRequest

-
-

ListKeysRequest is the request object for the ListValues RPC.

-
-
-

Generated

from message v1.ListKeysRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
prefix +ListKeysRequest | Webmesh API

Class ListKeysRequest

ListKeysRequest is the request object for the ListValues RPC.

+

Generated

from message v1.ListKeysRequest

+

Hierarchy

Constructors

constructor +

Properties

prefix fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

prefix

-
prefix: Uint8Array
-

Prefix is the prefix to list values for.

-
-
-

Generated

from field: bytes prefix = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.ListKeysRequest" = "v1.ListKeysRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

prefix

prefix: Uint8Array

Prefix is the prefix to list values for.

+

Generated

from field: bytes prefix = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.ListKeysRequest" = "v1.ListKeysRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.ListKeysResponse.html b/docs/classes/storage_provider_pb.ListKeysResponse.html index ca2ab0bb..eaf62611 100644 --- a/docs/classes/storage_provider_pb.ListKeysResponse.html +++ b/docs/classes/storage_provider_pb.ListKeysResponse.html @@ -1,216 +1,14 @@ -ListKeysResponse | Webmesh API
-
- -
-
-
-
- -

Class ListKeysResponse

-
-

ListKeysResponse is the response object for the ListValues RPC.

-
-
-

Generated

from message v1.ListKeysResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
keys +ListKeysResponse | Webmesh API

Class ListKeysResponse

ListKeysResponse is the response object for the ListValues RPC.

+

Generated

from message v1.ListKeysResponse

+

Hierarchy

Constructors

constructor +

Properties

keys fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

keys

-
keys: Uint8Array[]
-

Keys is the list of value keys for the prefix.

-
-
-

Generated

from field: repeated bytes keys = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.ListKeysResponse" = "v1.ListKeysResponse"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

keys

keys: Uint8Array[]

Keys is the list of value keys for the prefix.

+

Generated

from field: repeated bytes keys = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.ListKeysResponse" = "v1.ListKeysResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.ListValuesRequest.html b/docs/classes/storage_provider_pb.ListValuesRequest.html index b7cae738..0ddce61a 100644 --- a/docs/classes/storage_provider_pb.ListValuesRequest.html +++ b/docs/classes/storage_provider_pb.ListValuesRequest.html @@ -1,216 +1,14 @@ -ListValuesRequest | Webmesh API
-
- -
-
-
-
- -

Class ListValuesRequest

-
-

ListValuesRequest is the request object for the ListValues RPC.

-
-
-

Generated

from message v1.ListValuesRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
prefix +ListValuesRequest | Webmesh API

Class ListValuesRequest

ListValuesRequest is the request object for the ListValues RPC.

+

Generated

from message v1.ListValuesRequest

+

Hierarchy

Constructors

constructor +

Properties

prefix fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

prefix

-
prefix: Uint8Array
-

Prefix is the prefix to list values for.

-
-
-

Generated

from field: bytes prefix = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.ListValuesRequest" = "v1.ListValuesRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

prefix

prefix: Uint8Array

Prefix is the prefix to list values for.

+

Generated

from field: bytes prefix = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.ListValuesRequest" = "v1.ListValuesRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.ListValuesResponse.html b/docs/classes/storage_provider_pb.ListValuesResponse.html index 130da6e8..b8d92202 100644 --- a/docs/classes/storage_provider_pb.ListValuesResponse.html +++ b/docs/classes/storage_provider_pb.ListValuesResponse.html @@ -1,216 +1,14 @@ -ListValuesResponse | Webmesh API
-
- -
-
-
-
- -

Class ListValuesResponse

-
-

ListValuesResponse is the response object for the ListValues RPC.

-
-
-

Generated

from message v1.ListValuesResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
values +ListValuesResponse | Webmesh API

Class ListValuesResponse

ListValuesResponse is the response object for the ListValues RPC.

+

Generated

from message v1.ListValuesResponse

+

Hierarchy

Constructors

constructor +

Properties

values fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

values

-
values: StorageValue[]
-

Values is the list of values for the prefix.

-
-
-

Generated

from field: repeated v1.StorageValue values = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.ListValuesResponse" = "v1.ListValuesResponse"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

values

values: StorageValue[]

Values is the list of values for the prefix.

+

Generated

from field: repeated v1.StorageValue values = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.ListValuesResponse" = "v1.ListValuesResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.PrefixEvent.html b/docs/classes/storage_provider_pb.PrefixEvent.html index 1b153e3f..81219f34 100644 --- a/docs/classes/storage_provider_pb.PrefixEvent.html +++ b/docs/classes/storage_provider_pb.PrefixEvent.html @@ -1,241 +1,21 @@ -PrefixEvent | Webmesh API
-
- -
-
-
-
- -

Class PrefixEvent

-
-

PrefixEvent is an event that is emitted when a value is added or removed +PrefixEvent | Webmesh API

Class PrefixEvent

PrefixEvent is an event that is emitted when a value is added or removed from the storage for a prefix.

-
-
-

Generated

from message v1.PrefixEvent

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
eventType +

Generated

from message v1.PrefixEvent

+

Hierarchy

Constructors

constructor +

Properties

eventType prefix value? fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

eventType

-
eventType: PrefixEvent_EventType
-

EventType is the type of event.

-
-
-

Generated

from field: v1.PrefixEvent.EventType eventType = 3;

-
-
-

prefix

-
prefix: Uint8Array
-

Prefix is the prefix that the event is for.

-
-
-

Generated

from field: bytes prefix = 1;

-
-
-

Optional value

-
value?: StorageValue
-

Value is the value that was added or removed.

-
-
-

Generated

from field: v1.StorageValue value = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.PrefixEvent" = "v1.PrefixEvent"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

eventType

eventType: PrefixEvent_EventType

EventType is the type of event.

+

Generated

from field: v1.PrefixEvent.EventType eventType = 3;

+

prefix

prefix: Uint8Array

Prefix is the prefix that the event is for.

+

Generated

from field: bytes prefix = 1;

+

Optional value

value?: StorageValue

Value is the value that was added or removed.

+

Generated

from field: v1.StorageValue value = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.PrefixEvent" = "v1.PrefixEvent"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.PutValueRequest.html b/docs/classes/storage_provider_pb.PutValueRequest.html index d5580620..4dbd91e2 100644 --- a/docs/classes/storage_provider_pb.PutValueRequest.html +++ b/docs/classes/storage_provider_pb.PutValueRequest.html @@ -1,228 +1,17 @@ -PutValueRequest | Webmesh API
-
- -
-
-
-
- -

Class PutValueRequest

-
-

PutValueRequest is the request object for the PutValue RPC.

-
-
-

Generated

from message v1.PutValueRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
ttl? +PutValueRequest | Webmesh API

Class PutValueRequest

PutValueRequest is the request object for the PutValue RPC.

+

Generated

from message v1.PutValueRequest

+

Hierarchy

Constructors

constructor +

Properties

ttl? value? fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Optional ttl

-
ttl?: any
-

TTL is the time to live for the value.

-
-
-

Generated

from field: google.protobuf.Duration ttl = 2;

-
-
-

Optional value

-
value?: StorageValue
-

Value is the value to put.

-
-
-

Generated

from field: v1.StorageValue value = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.PutValueRequest" = "v1.PutValueRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Optional ttl

ttl?: any

TTL is the time to live for the value.

+

Generated

from field: google.protobuf.Duration ttl = 2;

+

Optional value

value?: StorageValue

Value is the value to put.

+

Generated

from field: v1.StorageValue value = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.PutValueRequest" = "v1.PutValueRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.PutValueResponse.html b/docs/classes/storage_provider_pb.PutValueResponse.html index 20d8179b..91ae2b8d 100644 --- a/docs/classes/storage_provider_pb.PutValueResponse.html +++ b/docs/classes/storage_provider_pb.PutValueResponse.html @@ -1,204 +1,11 @@ -PutValueResponse | Webmesh API
-
- -
-
-
-
- -

Class PutValueResponse

-
-

PutValueResponse is the response object for the PutValue RPC.

-
-
-

Generated

from message v1.PutValueResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +PutValueResponse | Webmesh API

Class PutValueResponse

PutValueResponse is the response object for the PutValue RPC.

+

Generated

from message v1.PutValueResponse

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.PutValueResponse" = "v1.PutValueResponse"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.PutValueResponse" = "v1.PutValueResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.RemoveServerResponse.html b/docs/classes/storage_provider_pb.RemoveServerResponse.html index f6c40803..d95949f1 100644 --- a/docs/classes/storage_provider_pb.RemoveServerResponse.html +++ b/docs/classes/storage_provider_pb.RemoveServerResponse.html @@ -1,204 +1,11 @@ -RemoveServerResponse | Webmesh API
-
- -
-
-
-
- -

Class RemoveServerResponse

-
-

RemoveServerResponse is the response object for the RemoveServer RPC.

-
-
-

Generated

from message v1.RemoveServerResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +RemoveServerResponse | Webmesh API

Class RemoveServerResponse

RemoveServerResponse is the response object for the RemoveServer RPC.

+

Generated

from message v1.RemoveServerResponse

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.RemoveServerResponse" = "v1.RemoveServerResponse"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.RemoveServerResponse" = "v1.RemoveServerResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.StoragePeer.html b/docs/classes/storage_provider_pb.StoragePeer.html index b7ab0f6e..b6f186ff 100644 --- a/docs/classes/storage_provider_pb.StoragePeer.html +++ b/docs/classes/storage_provider_pb.StoragePeer.html @@ -1,255 +1,26 @@ -StoragePeer | Webmesh API
-
- -
-
-
-
- -

Class StoragePeer

-
-

StoragePeer is a server that is currently recognized by the storage plugin.

-
-
-

Generated

from message v1.StoragePeer

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
address +StoragePeer | Webmesh API

Class StoragePeer

StoragePeer is a server that is currently recognized by the storage plugin.

+

Generated

from message v1.StoragePeer

+

Hierarchy

Constructors

constructor +

Properties

address clusterStatus id publicKey fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

address

-
address: string
-

Address is the address of the server. This is not required +

Constructors

constructor

Properties

address

address: string

Address is the address of the server. This is not required for demotion or removal RPCs.

-
-
-

Generated

from field: string address = 3;

-
-
-

clusterStatus

-
clusterStatus: ClusterStatus
-

ClusterStatus is the status of the server. This is only +

Generated

from field: string address = 3;

+

clusterStatus

clusterStatus: ClusterStatus

ClusterStatus is the status of the server. This is only applicable during a GetStatus RPC.

-
-
-

Generated

from field: v1.ClusterStatus clusterStatus = 4;

-
-
-

id

-
id: string
-

ID is the id of the server.

-
-
-

Generated

from field: string id = 1;

-
-
-

publicKey

-
publicKey: string
-

public_key is the encoded public key of the server. This is not required +

Generated

from field: v1.ClusterStatus clusterStatus = 4;

+

id

id: string

ID is the id of the server.

+

Generated

from field: string id = 1;

+

publicKey

publicKey: string

public_key is the encoded public key of the server. This is not required for demotion or removal RPCs. Not all implementations need to support this.

-
-
-

Generated

from field: string publicKey = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.StoragePeer" = "v1.StoragePeer"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: string publicKey = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.StoragePeer" = "v1.StoragePeer"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.StoragePeers.html b/docs/classes/storage_provider_pb.StoragePeers.html index fa24d048..f6c9e397 100644 --- a/docs/classes/storage_provider_pb.StoragePeers.html +++ b/docs/classes/storage_provider_pb.StoragePeers.html @@ -1,217 +1,15 @@ -StoragePeers | Webmesh API
-
- -
-
-
-
- -

Class StoragePeers

-
-

StoragePeers is a list of servers that are currently recognized by the storage plugin.

-
-
-

Generated

from message v1.StoragePeers

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
peers +StoragePeers | Webmesh API

Class StoragePeers

StoragePeers is a list of servers that are currently recognized by the storage plugin.

+

Generated

from message v1.StoragePeers

+

Hierarchy

Constructors

constructor +

Properties

peers fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

peers

-
peers: StoragePeer[]
-

Peers is the list of servers that are currently recognized as peers +

Constructors

constructor

Properties

peers

peers: StoragePeer[]

Peers is the list of servers that are currently recognized as peers by the storage plugin.

-
-
-

Generated

from field: repeated v1.StoragePeer peers = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.StoragePeers" = "v1.StoragePeers"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: repeated v1.StoragePeer peers = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.StoragePeers" = "v1.StoragePeers"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.StorageStatus.html b/docs/classes/storage_provider_pb.StorageStatus.html index 74fa5b9f..28a1bea8 100644 --- a/docs/classes/storage_provider_pb.StorageStatus.html +++ b/docs/classes/storage_provider_pb.StorageStatus.html @@ -1,255 +1,26 @@ -StorageStatus | Webmesh API
-
- -
-
-
-
- -

Class StorageStatus

-
-

StorageStatus is the response object for the StorageStatus RPC.

-
-
-

Generated

from message v1.StorageStatus

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
clusterStatus +StorageStatus | Webmesh API

Class StorageStatus

StorageStatus is the response object for the StorageStatus RPC.

+

Generated

from message v1.StorageStatus

+

Hierarchy

Constructors

constructor +

Properties

clusterStatus isWritable message peers fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

clusterStatus

-
clusterStatus: ClusterStatus
-

ClusterStatus is the status of the storage. The definitions applied +

Constructors

constructor

Properties

clusterStatus

clusterStatus: ClusterStatus

ClusterStatus is the status of the storage. The definitions applied to each status are implementation specific.

-
-
-

Generated

from field: v1.ClusterStatus clusterStatus = 2;

-
-
-

isWritable

-
isWritable: boolean
-

IsWritable is true if the storage can currently be written to.

-
-
-

Generated

from field: bool isWritable = 1;

-
-
-

message

-
message: string
-

message is an implementation specific message that can be used to provide +

Generated

from field: v1.ClusterStatus clusterStatus = 2;

+

isWritable

isWritable: boolean

IsWritable is true if the storage can currently be written to.

+

Generated

from field: bool isWritable = 1;

+

message

message: string

message is an implementation specific message that can be used to provide additional information about the storage status.

-
-
-

Generated

from field: string message = 4;

-
-
-

peers

-
peers: StoragePeer[]
-

Peers is the list of servers that are currently recognized as peers +

Generated

from field: string message = 4;

+

peers

peers: StoragePeer[]

Peers is the list of servers that are currently recognized as peers by the storage plugin. This should include the current server.

-
-
-

Generated

from field: repeated v1.StoragePeer peers = 3;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.StorageStatus" = "v1.StorageStatus"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: repeated v1.StoragePeer peers = 3;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.StorageStatus" = "v1.StorageStatus"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.StorageStatusRequest.html b/docs/classes/storage_provider_pb.StorageStatusRequest.html index 611d38be..85b43795 100644 --- a/docs/classes/storage_provider_pb.StorageStatusRequest.html +++ b/docs/classes/storage_provider_pb.StorageStatusRequest.html @@ -1,204 +1,11 @@ -StorageStatusRequest | Webmesh API
-
- -
-
-
-
- -

Class StorageStatusRequest

-
-

StorageStatusRequest is the request object for the StorageStatus RPC.

-
-
-

Generated

from message v1.StorageStatusRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +StorageStatusRequest | Webmesh API

Class StorageStatusRequest

StorageStatusRequest is the request object for the StorageStatus RPC.

+

Generated

from message v1.StorageStatusRequest

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.StorageStatusRequest" = "v1.StorageStatusRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.StorageStatusRequest" = "v1.StorageStatusRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.StorageValue.html b/docs/classes/storage_provider_pb.StorageValue.html index 876956b4..8494bad6 100644 --- a/docs/classes/storage_provider_pb.StorageValue.html +++ b/docs/classes/storage_provider_pb.StorageValue.html @@ -1,228 +1,17 @@ -StorageValue | Webmesh API
-
- -
-
-
-
- -

Class StorageValue

-
-

StorageValue is a value stored in the storage.

-
-
-

Generated

from message v1.StorageValue

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
key +StorageValue | Webmesh API

Class StorageValue

StorageValue is a value stored in the storage.

+

Generated

from message v1.StorageValue

+

Hierarchy

Constructors

constructor +

Properties

key value fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

key

-
key: Uint8Array
-

Key is the key of the value.

-
-
-

Generated

from field: bytes key = 1;

-
-
-

value

-
value: Uint8Array
-

Value is the value of the key.

-
-
-

Generated

from field: bytes value = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.StorageValue" = "v1.StorageValue"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

key

key: Uint8Array

Key is the key of the value.

+

Generated

from field: bytes key = 1;

+

value

value: Uint8Array

Value is the value of the key.

+

Generated

from field: bytes value = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.StorageValue" = "v1.StorageValue"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_provider_pb.SubscribePrefixRequest.html b/docs/classes/storage_provider_pb.SubscribePrefixRequest.html index e255f5f5..cb34a45e 100644 --- a/docs/classes/storage_provider_pb.SubscribePrefixRequest.html +++ b/docs/classes/storage_provider_pb.SubscribePrefixRequest.html @@ -1,216 +1,14 @@ -SubscribePrefixRequest | Webmesh API
-
- -
-
-
-
- -

Class SubscribePrefixRequest

-
-

SubscribePrefixRequest is the request object for the SubscribePrefix RPC.

-
-
-

Generated

from message v1.SubscribePrefixRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
prefix +SubscribePrefixRequest | Webmesh API

Class SubscribePrefixRequest

SubscribePrefixRequest is the request object for the SubscribePrefix RPC.

+

Generated

from message v1.SubscribePrefixRequest

+

Hierarchy

Constructors

constructor +

Properties

prefix fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

prefix

-
prefix: Uint8Array
-

Prefix is the prefix to subscribe to.

-
-
-

Generated

from field: bytes prefix = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.SubscribePrefixRequest" = "v1.SubscribePrefixRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

prefix

prefix: Uint8Array

Prefix is the prefix to subscribe to.

+

Generated

from field: bytes prefix = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.SubscribePrefixRequest" = "v1.SubscribePrefixRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_query_pb.NetworkState.html b/docs/classes/storage_query_pb.NetworkState.html index 74f72fd5..f9f81711 100644 --- a/docs/classes/storage_query_pb.NetworkState.html +++ b/docs/classes/storage_query_pb.NetworkState.html @@ -1,235 +1,18 @@ -NetworkState | Webmesh API
-
- -
-
-
-
- -

Class NetworkState

-
-

NetworkState represents the full network state as returned by +NetworkState | Webmesh API

Class NetworkState

NetworkState represents the full network state as returned by a network state query.

-
-
-

Generated

from message v1.NetworkState

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
domain +

Generated

from message v1.NetworkState

+

Hierarchy

Constructors

constructor +

Properties

domain networkV4 networkV6 fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

domain

-
domain: string
-
-

Generated

from field: string domain = 3;

-
-
-

networkV4

-
networkV4: string
-
-

Generated

from field: string networkV4 = 1;

-
-
-

networkV6

-
networkV6: string
-
-

Generated

from field: string networkV6 = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.NetworkState" = "v1.NetworkState"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

domain

domain: string

Generated

from field: string domain = 3;

+

networkV4

networkV4: string

Generated

from field: string networkV4 = 1;

+

networkV6

networkV6: string

Generated

from field: string networkV6 = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.NetworkState" = "v1.NetworkState"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_query_pb.PublishRequest.html b/docs/classes/storage_query_pb.PublishRequest.html index fdb0eb9a..fb8f7a3e 100644 --- a/docs/classes/storage_query_pb.PublishRequest.html +++ b/docs/classes/storage_query_pb.PublishRequest.html @@ -1,241 +1,21 @@ -PublishRequest | Webmesh API
-
- -
-
-
-
- -

Class PublishRequest

-
-

PublishRequest is sent by the application to the node to publish events. +PublishRequest | Webmesh API

Class PublishRequest

PublishRequest is sent by the application to the node to publish events. This currently only supports database events.

-
-
-

Generated

from message v1.PublishRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
key +

Generated

from message v1.PublishRequest

+

Hierarchy

Constructors

constructor +

Properties

key ttl? value fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

key

-
key: Uint8Array
-

key is the key of the event.

-
-
-

Generated

from field: bytes key = 1;

-
-
-

Optional ttl

-
ttl?: any
-

ttl is the time for the event to live in the database.

-
-
-

Generated

from field: google.protobuf.Duration ttl = 3;

-
-
-

value

-
value: Uint8Array
-

value is the value of the event. This will be the raw value of the key.

-
-
-

Generated

from field: bytes value = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.PublishRequest" = "v1.PublishRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

key

key: Uint8Array

key is the key of the event.

+

Generated

from field: bytes key = 1;

+

Optional ttl

ttl?: any

ttl is the time for the event to live in the database.

+

Generated

from field: google.protobuf.Duration ttl = 3;

+

value

value: Uint8Array

value is the value of the event. This will be the raw value of the key.

+

Generated

from field: bytes value = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.PublishRequest" = "v1.PublishRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_query_pb.PublishResponse.html b/docs/classes/storage_query_pb.PublishResponse.html index e0f8de69..3947acdb 100644 --- a/docs/classes/storage_query_pb.PublishResponse.html +++ b/docs/classes/storage_query_pb.PublishResponse.html @@ -1,205 +1,12 @@ -PublishResponse | Webmesh API
-
- -
-
-
-
- -

Class PublishResponse

-
-

PublishResponse is the response to a publish request. This is currently +PublishResponse | Webmesh API

Class PublishResponse

PublishResponse is the response to a publish request. This is currently empty.

-
-
-

Generated

from message v1.PublishResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
fields +

Generated

from message v1.PublishResponse

+

Hierarchy

Constructors

constructor +

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.PublishResponse" = "v1.PublishResponse"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.PublishResponse" = "v1.PublishResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_query_pb.QueryRequest.html b/docs/classes/storage_query_pb.QueryRequest.html index 59e5c1d4..89b7d976 100644 --- a/docs/classes/storage_query_pb.QueryRequest.html +++ b/docs/classes/storage_query_pb.QueryRequest.html @@ -1,244 +1,24 @@ -QueryRequest | Webmesh API
-
- -
-
-
-
- -

Class QueryRequest

-
-

QueryRequest is sent by the application to the node to query the mesh for +QueryRequest | Webmesh API

Class QueryRequest

QueryRequest is sent by the application to the node to query the mesh for information.

-
-
-

Generated

from message v1.QueryRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
command +

Generated

from message v1.QueryRequest

+

Hierarchy

Constructors

constructor +

Properties

command query type fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

command

-
command: QueryRequest_QueryCommand
-

command is the command of the query.

-
-
-

Generated

from field: v1.QueryRequest.QueryCommand command = 1;

-
-
-

query

-
query: string
-

query is the string of the query. This follows the format of a label +

Constructors

constructor

Properties

command

command: QueryRequest_QueryCommand

command is the command of the query.

+

Generated

from field: v1.QueryRequest.QueryCommand command = 1;

+

query

query: string

query is the string of the query. This follows the format of a label selector and is only applicable for certain queries. For get queries this will usually be an ID. For list queries this will usually be one or more filters.

-
-
-

Generated

from field: string query = 3;

-
-
-

type

-
type: QueryRequest_QueryType
-

type is the type of the query.

-
-
-

Generated

from field: v1.QueryRequest.QueryType type = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.QueryRequest" = "v1.QueryRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: string query = 3;

+

type

type: QueryRequest_QueryType

type is the type of the query.

+

Generated

from field: v1.QueryRequest.QueryType type = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.QueryRequest" = "v1.QueryRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_query_pb.QueryResponse.html b/docs/classes/storage_query_pb.QueryResponse.html index 7deca4ef..c4873856 100644 --- a/docs/classes/storage_query_pb.QueryResponse.html +++ b/docs/classes/storage_query_pb.QueryResponse.html @@ -1,231 +1,20 @@ -QueryResponse | Webmesh API
-
- -
-
-
-
- -

Class QueryResponse

-
-

QueryResponse is the message containing a mesh query result.

-
-
-

Generated

from message v1.QueryResponse

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
error +QueryResponse | Webmesh API

Class QueryResponse

QueryResponse is the message containing a mesh query result.

+

Generated

from message v1.QueryResponse

+

Hierarchy

Constructors

constructor +

Properties

error items fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

error

-
error: string
-

error is an error that happened during the query. This will always +

Constructors

constructor

Properties

error

error: string

error is an error that happened during the query. This will always be populated on errors, but single-flight queries will return a coded error instead.

-
-
-

Generated

from field: string error = 4;

-
-
-

items

-
items: Uint8Array[]
-

items contain the results of the query. These will be protobuf +

Generated

from field: string error = 4;

+

items

items: Uint8Array[]

items contain the results of the query. These will be protobuf json-encoded objects of the given query type.

-
-
-

Generated

from field: repeated bytes items = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.QueryResponse" = "v1.QueryResponse"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: repeated bytes items = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.QueryResponse" = "v1.QueryResponse"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_query_pb.SubscribeRequest.html b/docs/classes/storage_query_pb.SubscribeRequest.html index 7df3c9c2..dcbeedcf 100644 --- a/docs/classes/storage_query_pb.SubscribeRequest.html +++ b/docs/classes/storage_query_pb.SubscribeRequest.html @@ -1,217 +1,15 @@ -SubscribeRequest | Webmesh API
-
- -
-
-
-
- -

Class SubscribeRequest

-
-

SubscribeRequest is sent by the application to the node to subscribe to +SubscribeRequest | Webmesh API

Class SubscribeRequest

SubscribeRequest is sent by the application to the node to subscribe to events. This currently only supports database events.

-
-
-

Generated

from message v1.SubscribeRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
prefix +

Generated

from message v1.SubscribeRequest

+

Hierarchy

Constructors

constructor +

Properties

prefix fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

prefix

-
prefix: Uint8Array
-

prefix is the prefix of the events to subscribe to.

-
-
-

Generated

from field: bytes prefix = 1;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.SubscribeRequest" = "v1.SubscribeRequest"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

prefix

prefix: Uint8Array

prefix is the prefix of the events to subscribe to.

+

Generated

from field: bytes prefix = 1;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.SubscribeRequest" = "v1.SubscribeRequest"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/storage_query_pb.SubscriptionEvent.html b/docs/classes/storage_query_pb.SubscriptionEvent.html index e0c55c0b..e4daeccb 100644 --- a/docs/classes/storage_query_pb.SubscriptionEvent.html +++ b/docs/classes/storage_query_pb.SubscriptionEvent.html @@ -1,228 +1,17 @@ -SubscriptionEvent | Webmesh API
-
- -
-
-
-
- -

Class SubscriptionEvent

-
-

SubscriptionEvent is a message containing a subscription event.

-
-
-

Generated

from message v1.SubscriptionEvent

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
key +SubscriptionEvent | Webmesh API

Class SubscriptionEvent

SubscriptionEvent is a message containing a subscription event.

+

Generated

from message v1.SubscriptionEvent

+

Hierarchy

Constructors

constructor +

Properties

key value fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

key

-
key: Uint8Array
-

key is the key of the event.

-
-
-

Generated

from field: bytes key = 1;

-
-
-

value

-
value: Uint8Array
-

value is the value of the event. This will be the raw value of the key.

-
-
-

Generated

from field: bytes value = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.SubscriptionEvent" = "v1.SubscriptionEvent"
-
-

Methods

-
-

Static equals

-
-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

key

key: Uint8Array

key is the key of the event.

+

Generated

from field: bytes key = 1;

+

value

value: Uint8Array

value is the value of the event. This will be the raw value of the key.

+

Generated

from field: bytes value = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.SubscriptionEvent" = "v1.SubscriptionEvent"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/webrtc_pb.DataChannelOffer.html b/docs/classes/webrtc_pb.DataChannelOffer.html index 4e3d3b7e..9b317005 100644 --- a/docs/classes/webrtc_pb.DataChannelOffer.html +++ b/docs/classes/webrtc_pb.DataChannelOffer.html @@ -1,241 +1,21 @@ -DataChannelOffer | Webmesh API
-
- -
-
-
-
- -

Class DataChannelOffer

-
-

DataChannelOffer is an offer for a data channel. Candidates +DataChannelOffer | Webmesh API

Class DataChannelOffer

DataChannelOffer is an offer for a data channel. Candidates are sent after the offer is sent.

-
-
-

Generated

from message v1.DataChannelOffer

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
candidate +

Generated

from message v1.DataChannelOffer

+

Hierarchy

Constructors

constructor +

Properties

candidate offer stunServers fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

candidate

-
candidate: string
-

candidate is an ICE candidate.

-
-
-

Generated

from field: string candidate = 3;

-
-
-

offer

-
offer: string
-

offer is the offer.

-
-
-

Generated

from field: string offer = 1;

-
-
-

stunServers

-
stunServers: string[]
-

stun_servers is the list of STUN servers to use.

-
-
-

Generated

from field: repeated string stunServers = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.DataChannelOffer" = "v1.DataChannelOffer"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

constructor

Properties

candidate

candidate: string

candidate is an ICE candidate.

+

Generated

from field: string candidate = 3;

+

offer

offer: string

offer is the offer.

+

Generated

from field: string offer = 1;

+

stunServers

stunServers: string[]

stun_servers is the list of STUN servers to use.

+

Generated

from field: repeated string stunServers = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.DataChannelOffer" = "v1.DataChannelOffer"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/webrtc_pb.StartDataChannelRequest.html b/docs/classes/webrtc_pb.StartDataChannelRequest.html index db7eff4c..44de7215 100644 --- a/docs/classes/webrtc_pb.StartDataChannelRequest.html +++ b/docs/classes/webrtc_pb.StartDataChannelRequest.html @@ -1,49 +1,9 @@ -StartDataChannelRequest | Webmesh API
-
- -
-
-
-
- -

Class StartDataChannelRequest

-
-

StartDataChannelRequest is a request to start a data channel. +StartDataChannelRequest | Webmesh API

Class StartDataChannelRequest

StartDataChannelRequest is a request to start a data channel. The answer and candidate fields are populated after the offer is received.

-
-
-

Generated

from message v1.StartDataChannelRequest

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
answer +

Generated

from message v1.StartDataChannelRequest

+

Hierarchy

Constructors

constructor +

Properties

answer candidate dst nodeId @@ -52,228 +12,21 @@

Properties

fields runtime typeName -
-
-

Methods

-
equals +

Methods

equals fromBinary fromJson fromJsonString -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

answer

-
answer: string
-

answer is the answer to the offer.

-
-
-

Generated

from field: string answer = 5;

-
-
-

candidate

-
candidate: string
-

candidate is an ICE candidate.

-
-
-

Generated

from field: string candidate = 6;

-
-
-

dst

-
dst: string
-

dst is the destination address of the traffic.

-
-
-

Generated

from field: string dst = 3;

-
-
-

nodeId

-
nodeId: string
-

node_id is the ID of the node to send the data to.

-
-
-

Generated

from field: string node_id = 1;

-
-
-

port

-
port: number
-

port is the destination port of the traffic. A port of 0 coupled +

Constructors

constructor

Properties

answer

answer: string

answer is the answer to the offer.

+

Generated

from field: string answer = 5;

+

candidate

candidate: string

candidate is an ICE candidate.

+

Generated

from field: string candidate = 6;

+

dst

dst: string

dst is the destination address of the traffic.

+

Generated

from field: string dst = 3;

+

nodeId

nodeId: string

node_id is the ID of the node to send the data to.

+

Generated

from field: string node_id = 1;

+

port

port: number

port is the destination port of the traffic. A port of 0 coupled with the udp protocol indicates forwarding to the WireGuard interface.

-
-
-

Generated

from field: uint32 port = 4;

-
-
-

proto

-
proto: string
-

proto is the protocol of the traffic.

-
-
-

Generated

from field: string proto = 2;

-
-
-

Static Readonly fields

-
fields: FieldList
-
-

Static Readonly runtime

-
runtime: any
-
-

Static Readonly typeName

-
typeName: "v1.StartDataChannelRequest" = "v1.StartDataChannelRequest"
-
-

Methods

-
-

Static equals

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      a: any
      • -
    • -
      b: any
    -

    Returns boolean

-
-

Static fromBinary

-
-
-

Static fromJson

-
-
-

Static fromJsonString

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from field: uint32 port = 4;

+

proto

proto: string

proto is the protocol of the traffic.

+

Generated

from field: string proto = 2;

+

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: any

Static Readonly typeName

typeName: "v1.StartDataChannelRequest" = "v1.StartDataChannelRequest"

Methods

Static equals

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/app_pb.ConnectRequest_AddrType.html b/docs/enums/app_pb.ConnectRequest_AddrType.html index 66788ffd..0fb0bb2f 100644 --- a/docs/enums/app_pb.ConnectRequest_AddrType.html +++ b/docs/enums/app_pb.ConnectRequest_AddrType.html @@ -1,119 +1,12 @@ -ConnectRequest_AddrType | Webmesh API
-
- -
-
-
-
- -

Enumeration ConnectRequest_AddrType

-
-

AddrType is the type of join addresses included in the request.

-
-
-

Generated

from enum v1.ConnectRequest.AddrType

-
-
-
-
- -
-
-

Enumeration Members

-
ADDR +ConnectRequest_AddrType | Webmesh API

Enumeration ConnectRequest_AddrType

AddrType is the type of join addresses included in the request.

+

Generated

from enum v1.ConnectRequest.AddrType

+

Enumeration Members

ADDR MULTIADDR RENDEZVOUS -
-
-

Enumeration Members

-
-

ADDR

-
ADDR: 0
-

ADDR is used to join a mesh using an IP or DNS address.

-
-
-

Generated

from enum value: ADDR = 0;

-
-
-

MULTIADDR

-
MULTIADDR: 1
-

MULTIADDR is used to join a mesh using a multiaddr.

-
-
-

Generated

from enum value: MULTIADDR = 1;

-
-
-

RENDEZVOUS

-
RENDEZVOUS: 2
-

RENDEZVOUS is used to join a mesh using a rendezvous string.

-
-
-

Generated

from enum value: RENDEZVOUS = 2;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Enumeration Members

ADDR

ADDR: 0

ADDR is used to join a mesh using an IP or DNS address.

+

Generated

from enum value: ADDR = 0;

+

MULTIADDR

MULTIADDR: 1

MULTIADDR is used to join a mesh using a multiaddr.

+

Generated

from enum value: MULTIADDR = 1;

+

RENDEZVOUS

RENDEZVOUS: 2

RENDEZVOUS is used to join a mesh using a rendezvous string.

+

Generated

from enum value: RENDEZVOUS = 2;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/app_pb.ConnectRequest_AuthHeader.html b/docs/enums/app_pb.ConnectRequest_AuthHeader.html index cbbd4bb2..52e60c0c 100644 --- a/docs/enums/app_pb.ConnectRequest_AuthHeader.html +++ b/docs/enums/app_pb.ConnectRequest_AuthHeader.html @@ -1,146 +1,21 @@ -ConnectRequest_AuthHeader | Webmesh API
-
- -
-
-
-
- -

Enumeration ConnectRequest_AuthHeader

-
-

AuthHeader is an enumeration of headers that coorespond to the AuthMethod. +ConnectRequest_AuthHeader | Webmesh API

Enumeration ConnectRequest_AuthHeader

AuthHeader is an enumeration of headers that coorespond to the AuthMethod. They are used to pass authentication credentials to the daemon. Enums cannot be used as map keys, so their string values are used instead.

-
-
-

Generated

from enum v1.ConnectRequest.AuthHeader

-
-
-
-
- -
-
-

Enumeration Members

-
ADDRS_ENVELOPE +

Generated

from enum v1.ConnectRequest.AuthHeader

+

Enumeration Members

ADDRS_ENVELOPE BASIC_PASSWORD BASIC_USERNAME LDAP_PASSWORD LDAP_USERNAME -
-
-

Enumeration Members

-
-

ADDRS_ENVELOPE

-
ADDRS_ENVELOPE: 4
-

ADDRS_ENVELOPE is the header for a signed envelope containing +

Enumeration Members

ADDRS_ENVELOPE

ADDRS_ENVELOPE: 4

ADDRS_ENVELOPE is the header for a signed envelope containing the join addresses to use to connect to the mesh.

-
-
-

Generated

from enum value: ADDRS_ENVELOPE = 4;

-
-
-

BASIC_PASSWORD

-
BASIC_PASSWORD: 1
-

BASIC_PASSWORD is the password for basic authentication.

-
-
-

Generated

from enum value: BASIC_PASSWORD = 1;

-
-
-

BASIC_USERNAME

-
BASIC_USERNAME: 0
-

BASIC_USERNAME is the username for basic authentication.

-
-
-

Generated

from enum value: BASIC_USERNAME = 0;

-
-
-

LDAP_PASSWORD

-
LDAP_PASSWORD: 3
-

LDAP_PASSWORD is the password for LDAP authentication.

-
-
-

Generated

from enum value: LDAP_PASSWORD = 3;

-
-
-

LDAP_USERNAME

-
LDAP_USERNAME: 2
-

LDAP_USERNAME is the username for LDAP authentication.

-
-
-

Generated

from enum value: LDAP_USERNAME = 2;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from enum value: ADDRS_ENVELOPE = 4;

+

BASIC_PASSWORD

BASIC_PASSWORD: 1

BASIC_PASSWORD is the password for basic authentication.

+

Generated

from enum value: BASIC_PASSWORD = 1;

+

BASIC_USERNAME

BASIC_USERNAME: 0

BASIC_USERNAME is the username for basic authentication.

+

Generated

from enum value: BASIC_USERNAME = 0;

+

LDAP_PASSWORD

LDAP_PASSWORD: 3

LDAP_PASSWORD is the password for LDAP authentication.

+

Generated

from enum value: LDAP_PASSWORD = 3;

+

LDAP_USERNAME

LDAP_USERNAME: 2

LDAP_USERNAME is the username for LDAP authentication.

+

Generated

from enum value: LDAP_USERNAME = 2;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/app_pb.ConnectRequest_AuthMethod.html b/docs/enums/app_pb.ConnectRequest_AuthMethod.html index b0f9a9ff..3f9cd438 100644 --- a/docs/enums/app_pb.ConnectRequest_AuthMethod.html +++ b/docs/enums/app_pb.ConnectRequest_AuthMethod.html @@ -1,144 +1,19 @@ -ConnectRequest_AuthMethod | Webmesh API
-
- -
-
-
-
- -

Enumeration ConnectRequest_AuthMethod

-
-

AuthMethod are types of RPC credentials to supply to the connection.

-
-
-

Generated

from enum v1.ConnectRequest.AuthMethod

-
-
-
-
- -
-
-

Enumeration Members

-
BASIC +ConnectRequest_AuthMethod | Webmesh API

Enumeration ConnectRequest_AuthMethod

AuthMethod are types of RPC credentials to supply to the connection.

+

Generated

from enum v1.ConnectRequest.AuthMethod

+

Enumeration Members

BASIC ID LDAP MTLS NO_AUTH -
-
-

Enumeration Members

-
-

BASIC

-
BASIC: 1
-

BASIC is used to indicate that basic authentication is required.

-
-
-

Generated

from enum value: BASIC = 1;

-
-
-

ID

-
ID: 3
-

ID is used to indicate that an identity is required.

-
-
-

Generated

from enum value: ID = 3;

-
-
-

LDAP

-
LDAP: 2
-

LDAP is used to indicate that LDAP authentication is required.

-
-
-

Generated

from enum value: LDAP = 2;

-
-
-

MTLS

-
MTLS: 4
-

MTLS is used to indicate that mutual TLS authentication is required. +

Enumeration Members

BASIC

BASIC: 1

BASIC is used to indicate that basic authentication is required.

+

Generated

from enum value: BASIC = 1;

+

ID

ID: 3

ID is used to indicate that an identity is required.

+

Generated

from enum value: ID = 3;

+

LDAP

LDAP: 2

LDAP is used to indicate that LDAP authentication is required.

+

Generated

from enum value: LDAP = 2;

+

MTLS

MTLS: 4

MTLS is used to indicate that mutual TLS authentication is required. The TLS object should be used to configure the TLS connection.

-
-
-

Generated

from enum value: MTLS = 4;

-
-
-

NO_AUTH

-
NO_AUTH: 0
-

NO_AUTH is used to indicate that no authentication is required.

-
-
-

Generated

from enum value: NO_AUTH = 0;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from enum value: MTLS = 4;

+

NO_AUTH

NO_AUTH: 0

NO_AUTH is used to indicate that no authentication is required.

+

Generated

from enum value: NO_AUTH = 0;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/app_pb.MeshConnBootstrap_DefaultNetworkACL.html b/docs/enums/app_pb.MeshConnBootstrap_DefaultNetworkACL.html index 78531074..4c5a067a 100644 --- a/docs/enums/app_pb.MeshConnBootstrap_DefaultNetworkACL.html +++ b/docs/enums/app_pb.MeshConnBootstrap_DefaultNetworkACL.html @@ -1,101 +1,6 @@ -MeshConnBootstrap_DefaultNetworkACL | Webmesh API
-
- -
-
-
-
- -

Enumeration MeshConnBootstrap_DefaultNetworkACL

-
-
-

Generated

from enum v1.MeshConnBootstrap.DefaultNetworkACL

-
-
-
-
- -
-
-

Enumeration Members

-
ACCEPT +MeshConnBootstrap_DefaultNetworkACL | Webmesh API

Enumeration MeshConnBootstrap_DefaultNetworkACL

Generated

from enum v1.MeshConnBootstrap.DefaultNetworkACL

+

Enumeration Members

ACCEPT DROP -
-
-

Enumeration Members

-
-

ACCEPT

-
ACCEPT: 0
-
-

Generated

from enum value: ACCEPT = 0;

-
-
-

DROP

-
DROP: 1
-
-

Generated

from enum value: DROP = 1;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Enumeration Members

ACCEPT

ACCEPT: 0

Generated

from enum value: ACCEPT = 0;

+

DROP

DROP: 1

Generated

from enum value: DROP = 1;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/app_pb.StatusResponse_ConnectionStatus.html b/docs/enums/app_pb.StatusResponse_ConnectionStatus.html index 66a0df2e..358a4b95 100644 --- a/docs/enums/app_pb.StatusResponse_ConnectionStatus.html +++ b/docs/enums/app_pb.StatusResponse_ConnectionStatus.html @@ -1,117 +1,11 @@ -StatusResponse_ConnectionStatus | Webmesh API
-
- -
-
-
-
- -

Enumeration StatusResponse_ConnectionStatus

-
-
-

Generated

from enum v1.StatusResponse.ConnectionStatus

-
-
-
-
- -
-
-

Enumeration Members

-
CONNECTED +StatusResponse_ConnectionStatus | Webmesh API

Enumeration StatusResponse_ConnectionStatus

Generated

from enum v1.StatusResponse.ConnectionStatus

+

Enumeration Members

CONNECTED CONNECTING DISCONNECTED -
-
-

Enumeration Members

-
-

CONNECTED

-
CONNECTED: 2
-

CONNECTED indicates that the node is connected to a mesh.

-
-
-

Generated

from enum value: CONNECTED = 2;

-
-
-

CONNECTING

-
CONNECTING: 1
-

CONNECTING indicates that the node is in the process of connecting to a mesh.

-
-
-

Generated

from enum value: CONNECTING = 1;

-
-
-

DISCONNECTED

-
DISCONNECTED: 0
-

DISCONNECTED indicates that the node is not connected to a mesh.

-
-
-

Generated

from enum value: DISCONNECTED = 0;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Enumeration Members

CONNECTED

CONNECTED: 2

CONNECTED indicates that the node is connected to a mesh.

+

Generated

from enum value: CONNECTED = 2;

+

CONNECTING

CONNECTING: 1

CONNECTING indicates that the node is in the process of connecting to a mesh.

+

Generated

from enum value: CONNECTING = 1;

+

DISCONNECTED

DISCONNECTED: 0

DISCONNECTED indicates that the node is not connected to a mesh.

+

Generated

from enum value: DISCONNECTED = 0;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/members_pb.ConnectProtocol.html b/docs/enums/members_pb.ConnectProtocol.html index 55f2bd78..7d2b6a32 100644 --- a/docs/enums/members_pb.ConnectProtocol.html +++ b/docs/enums/members_pb.ConnectProtocol.html @@ -1,120 +1,13 @@ -ConnectProtocol | Webmesh API
-
- -
-
-
-
- -

Enumeration ConnectProtocol

-
-

ConnectProtocol is a type of protocol for establishing a connection into a mesh.

-
-
-

Generated

from enum v1.ConnectProtocol

-
-
-
-
- -
-
-

Enumeration Members

-
CONNECT_ICE +ConnectProtocol | Webmesh API

Enumeration ConnectProtocol

ConnectProtocol is a type of protocol for establishing a connection into a mesh.

+

Generated

from enum v1.ConnectProtocol

+

Enumeration Members

CONNECT_ICE CONNECT_LIBP2P CONNECT_NATIVE -
-
-

Enumeration Members

-
-

CONNECT_ICE

-
CONNECT_ICE: 1
-

CONNECT_ICE indicates that the node should connect to other nodes via ICE.

-
-
-

Generated

from enum value: CONNECT_ICE = 1;

-
-
-

CONNECT_LIBP2P

-
CONNECT_LIBP2P: 2
-

CONNECT_LIBP2P indicates that the node should connect to other nodes via libp2p.

-
-
-

Generated

from enum value: CONNECT_LIBP2P = 2;

-
-
-

CONNECT_NATIVE

-
CONNECT_NATIVE: 0
-

CONNECT_NATIVE indicates that the node should connect to other nodes via the native +

Enumeration Members

CONNECT_ICE

CONNECT_ICE: 1

CONNECT_ICE indicates that the node should connect to other nodes via ICE.

+

Generated

from enum value: CONNECT_ICE = 1;

+

CONNECT_LIBP2P

CONNECT_LIBP2P: 2

CONNECT_LIBP2P indicates that the node should connect to other nodes via libp2p.

+

Generated

from enum value: CONNECT_LIBP2P = 2;

+

CONNECT_NATIVE

CONNECT_NATIVE: 0

CONNECT_NATIVE indicates that the node should connect to other nodes via the native webmesh mechanisms.

-
-
-

Generated

from enum value: CONNECT_NATIVE = 0;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from enum value: CONNECT_NATIVE = 0;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/network_acls_pb.ACLAction.html b/docs/enums/network_acls_pb.ACLAction.html index 1b83953c..996eec81 100644 --- a/docs/enums/network_acls_pb.ACLAction.html +++ b/docs/enums/network_acls_pb.ACLAction.html @@ -1,119 +1,12 @@ -ACLAction | Webmesh API
-
- -
-
-
-
- -

Enumeration ACLAction

-
-

ACLAction is the action to take when a request matches an ACL.

-
-
-

Generated

from enum v1.ACLAction

-
-
-
-
- -
-
-

Enumeration Members

-
ACTION_ACCEPT +ACLAction | Webmesh API

Enumeration ACLAction

ACLAction is the action to take when a request matches an ACL.

+

Generated

from enum v1.ACLAction

+

Enumeration Members

ACTION_ACCEPT ACTION_DENY ACTION_UNKNOWN -
-
-

Enumeration Members

-
-

ACTION_ACCEPT

-
ACTION_ACCEPT: 1
-

ACTION_ACCEPT allows the request to proceed.

-
-
-

Generated

from enum value: ACTION_ACCEPT = 1;

-
-
-

ACTION_DENY

-
ACTION_DENY: 2
-

ACTION_DENY denies the request.

-
-
-

Generated

from enum value: ACTION_DENY = 2;

-
-
-

ACTION_UNKNOWN

-
ACTION_UNKNOWN: 0
-

ACTION_UNKNOWN is the default action for ACLs. It is synonymous with ACTION_DENY.

-
-
-

Generated

from enum value: ACTION_UNKNOWN = 0;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Enumeration Members

ACTION_ACCEPT

ACTION_ACCEPT: 1

ACTION_ACCEPT allows the request to proceed.

+

Generated

from enum value: ACTION_ACCEPT = 1;

+

ACTION_DENY

ACTION_DENY: 2

ACTION_DENY denies the request.

+

Generated

from enum value: ACTION_DENY = 2;

+

ACTION_UNKNOWN

ACTION_UNKNOWN: 0

ACTION_UNKNOWN is the default action for ACLs. It is synonymous with ACTION_DENY.

+

Generated

from enum value: ACTION_UNKNOWN = 0;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/node_pb.ClusterStatus.html b/docs/enums/node_pb.ClusterStatus.html index b31c558b..8120e4bf 100644 --- a/docs/enums/node_pb.ClusterStatus.html +++ b/docs/enums/node_pb.ClusterStatus.html @@ -1,143 +1,18 @@ -ClusterStatus | Webmesh API
-
- -
-
-
-
- -

Enumeration ClusterStatus

-
-

ClusterStatus is the status of the node in the cluster.

-
-
-

Generated

from enum v1.ClusterStatus

-
-
-
-
- -
-
-

Enumeration Members

-
CLUSTER_LEADER +ClusterStatus | Webmesh API

Enumeration ClusterStatus

ClusterStatus is the status of the node in the cluster.

+

Generated

from enum v1.ClusterStatus

+

Enumeration Members

CLUSTER_LEADER CLUSTER_NODE CLUSTER_OBSERVER CLUSTER_STATUS_UNKNOWN CLUSTER_VOTER -
-
-

Enumeration Members

-
-

CLUSTER_LEADER

-
CLUSTER_LEADER: 1
-

CLUSTER_LEADER is the status for the leader node.

-
-
-

Generated

from enum value: CLUSTER_LEADER = 1;

-
-
-

CLUSTER_NODE

-
CLUSTER_NODE: 4
-

CLUSTER_NODE is the status of a node that is not a part of the storage consensus.

-
-
-

Generated

from enum value: CLUSTER_NODE = 4;

-
-
-

CLUSTER_OBSERVER

-
CLUSTER_OBSERVER: 3
-

CLUSTER_OBSERVER is the status for a non-voter node.

-
-
-

Generated

from enum value: CLUSTER_OBSERVER = 3;

-
-
-

CLUSTER_STATUS_UNKNOWN

-
CLUSTER_STATUS_UNKNOWN: 0
-

CLUSTER_STATUS_UNKNOWN is the default status.

-
-
-

Generated

from enum value: CLUSTER_STATUS_UNKNOWN = 0;

-
-
-

CLUSTER_VOTER

-
CLUSTER_VOTER: 2
-

CLUSTER_VOTER is the status for a voter node.

-
-
-

Generated

from enum value: CLUSTER_VOTER = 2;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Enumeration Members

CLUSTER_LEADER

CLUSTER_LEADER: 1

CLUSTER_LEADER is the status for the leader node.

+

Generated

from enum value: CLUSTER_LEADER = 1;

+

CLUSTER_NODE

CLUSTER_NODE: 4

CLUSTER_NODE is the status of a node that is not a part of the storage consensus.

+

Generated

from enum value: CLUSTER_NODE = 4;

+

CLUSTER_OBSERVER

CLUSTER_OBSERVER: 3

CLUSTER_OBSERVER is the status for a non-voter node.

+

Generated

from enum value: CLUSTER_OBSERVER = 3;

+

CLUSTER_STATUS_UNKNOWN

CLUSTER_STATUS_UNKNOWN: 0

CLUSTER_STATUS_UNKNOWN is the default status.

+

Generated

from enum value: CLUSTER_STATUS_UNKNOWN = 0;

+

CLUSTER_VOTER

CLUSTER_VOTER: 2

CLUSTER_VOTER is the status for a voter node.

+

Generated

from enum value: CLUSTER_VOTER = 2;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/node_pb.DataChannel.html b/docs/enums/node_pb.DataChannel.html index e60ea588..7bd0b171 100644 --- a/docs/enums/node_pb.DataChannel.html +++ b/docs/enums/node_pb.DataChannel.html @@ -1,112 +1,14 @@ -DataChannel | Webmesh API
-
- -
-
-
-
- -

Enumeration DataChannel

-
-

DataChannel are the data channels used when communicating over ICE +DataChannel | Webmesh API

Enumeration DataChannel

DataChannel are the data channels used when communicating over ICE with a node.

-
-
-

Generated

from enum v1.DataChannel

-
-
-
-
- -
-
-

Enumeration Members

-
CHANNELS +

Generated

from enum v1.DataChannel

+

Enumeration Members

CHANNELS CONNECTIONS -
-
-

Enumeration Members

-
-

CHANNELS

-
CHANNELS: 0
-

CHANNELS is the data channel used for negotiating new channels. +

Enumeration Members

CHANNELS

CHANNELS: 0

CHANNELS is the data channel used for negotiating new channels. This is the first channel that is opened. The ID of the channel should be 0.

-
-
-

Generated

from enum value: CHANNELS = 0;

-
-
-

CONNECTIONS

-
CONNECTIONS: 1
-

CONNECTIONS is the data channel used for negotiating new connections. +

Generated

from enum value: CHANNELS = 0;

+

CONNECTIONS

CONNECTIONS: 1

CONNECTIONS is the data channel used for negotiating new connections. This is a channel that is opened for each incoming connection from a client. The ID should start at 0 and be incremented for each new connection.

-
-
-

Generated

from enum value: CONNECTIONS = 1;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from enum value: CONNECTIONS = 1;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/node_pb.EdgeAttribute.html b/docs/enums/node_pb.EdgeAttribute.html index 7a6971ab..d81b8a2b 100644 --- a/docs/enums/node_pb.EdgeAttribute.html +++ b/docs/enums/node_pb.EdgeAttribute.html @@ -1,132 +1,16 @@ -EdgeAttribute | Webmesh API
-
- -
-
-
-
- -

Enumeration EdgeAttribute

-
-

EdgeAttribute are pre-defined edge attributes. They should +EdgeAttribute | Webmesh API

Enumeration EdgeAttribute

EdgeAttribute are pre-defined edge attributes. They should be used as their string values.

-
-
-

Generated

from enum v1.EdgeAttribute

-
-
-
-
- -
-
-

Enumeration Members

-
ICE +

Generated

from enum v1.EdgeAttribute

+

Enumeration Members

ICE LIBP2P NATIVE UNKNOWN -
-
-

Enumeration Members

-
-

ICE

-
ICE: 2
-

EDGE_ATTRIBUTE_ICE is an ICE edge attribute.

-
-
-

Generated

from enum value: EDGE_ATTRIBUTE_ICE = 2;

-
-
-

LIBP2P

-
LIBP2P: 3
-

EDGE_ATTRIBUTE_LIBP2P is a libp2p edge attribute.

-
-
-

Generated

from enum value: EDGE_ATTRIBUTE_LIBP2P = 3;

-
-
-

NATIVE

-
NATIVE: 1
-

EDGE_ATTRIBUTE_NATIVE is a native edge attribute.

-
-
-

Generated

from enum value: EDGE_ATTRIBUTE_NATIVE = 1;

-
-
-

UNKNOWN

-
UNKNOWN: 0
-

EDGE_ATTRIBUTE_UNKNOWN is an unknown edge attribute.

-
-
-

Generated

from enum value: EDGE_ATTRIBUTE_UNKNOWN = 0;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Enumeration Members

ICE

ICE: 2

EDGE_ATTRIBUTE_ICE is an ICE edge attribute.

+

Generated

from enum value: EDGE_ATTRIBUTE_ICE = 2;

+

LIBP2P

LIBP2P: 3

EDGE_ATTRIBUTE_LIBP2P is a libp2p edge attribute.

+

Generated

from enum value: EDGE_ATTRIBUTE_LIBP2P = 3;

+

NATIVE

NATIVE: 1

EDGE_ATTRIBUTE_NATIVE is a native edge attribute.

+

Generated

from enum value: EDGE_ATTRIBUTE_NATIVE = 1;

+

UNKNOWN

UNKNOWN: 0

EDGE_ATTRIBUTE_UNKNOWN is an unknown edge attribute.

+

Generated

from enum value: EDGE_ATTRIBUTE_UNKNOWN = 0;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/node_pb.Feature.html b/docs/enums/node_pb.Feature.html index fbc79534..e86bea79 100644 --- a/docs/enums/node_pb.Feature.html +++ b/docs/enums/node_pb.Feature.html @@ -1,37 +1,6 @@ -Feature | Webmesh API
-
- -
-
-
-
- -

Enumeration Feature

-
-

Feature is a list of features supported by a node.

-
-
-

Generated

from enum v1.Feature

-
-
-
-
- -
-
-

Enumeration Members

-
ADMIN_API +Feature | Webmesh API

Enumeration Feature

Feature is a list of features supported by a node.

+

Generated

from enum v1.Feature

+

Enumeration Members

ADMIN_API FEATURE_NONE FORWARD_MESH_DNS ICE_NEGOTIATION @@ -45,208 +14,33 @@

Enumeration Members

STORAGE_PROVIDER STORAGE_QUERIER TURN_SERVER -
-
-

Enumeration Members

-
-

ADMIN_API

-
ADMIN_API: 4
-

ADMIN_API is the feature for the admin API.

-
-
-

Generated

from enum value: ADMIN_API = 4;

-
-
-

FEATURE_NONE

-
FEATURE_NONE: 0
-

FEATURE_NONE is the default feature set.

-
-
-

Generated

from enum value: FEATURE_NONE = 0;

-
-
-

FORWARD_MESH_DNS

-
FORWARD_MESH_DNS: 10
-

FORWARD_MESH_DNS is the feature for forwarding mesh DNS lookups to other meshes.

-
-
-

Generated

from enum value: FORWARD_MESH_DNS = 10;

-
-
-

ICE_NEGOTIATION

-
ICE_NEGOTIATION: 7
-

ICE_NEGOTIATION is the feature for ICE negotiation.

-
-
-

Generated

from enum value: ICE_NEGOTIATION = 7;

-
-
-

LEADER_PROXY

-
LEADER_PROXY: 2
-

LEADER_PROXY is the feature for leader proxying.

-
-
-

Generated

from enum value: LEADER_PROXY = 2;

-
-
-

MEMBERSHIP

-
MEMBERSHIP: 5
-

MEMBERSHIP is the feature for membership. This is always supported on storage-providing members.

-
-
-

Generated

from enum value: MEMBERSHIP = 5;

-
-
-

MESH_API

-
MESH_API: 3
-

MESH_API is the feature for the mesh API. +

Enumeration Members

ADMIN_API

ADMIN_API: 4

ADMIN_API is the feature for the admin API.

+

Generated

from enum value: ADMIN_API = 4;

+

FEATURE_NONE

FEATURE_NONE: 0

FEATURE_NONE is the default feature set.

+

Generated

from enum value: FEATURE_NONE = 0;

+

FORWARD_MESH_DNS

FORWARD_MESH_DNS: 10

FORWARD_MESH_DNS is the feature for forwarding mesh DNS lookups to other meshes.

+

Generated

from enum value: FORWARD_MESH_DNS = 10;

+

ICE_NEGOTIATION

ICE_NEGOTIATION: 7

ICE_NEGOTIATION is the feature for ICE negotiation.

+

Generated

from enum value: ICE_NEGOTIATION = 7;

+

LEADER_PROXY

LEADER_PROXY: 2

LEADER_PROXY is the feature for leader proxying.

+

Generated

from enum value: LEADER_PROXY = 2;

+

MEMBERSHIP

MEMBERSHIP: 5

MEMBERSHIP is the feature for membership. This is always supported on storage-providing members.

+

Generated

from enum value: MEMBERSHIP = 5;

+

MESH_API

MESH_API: 3

MESH_API is the feature for the mesh API. This will be deprecated in favor of the MEMBERSHIP feature.

-
-
-

Generated

from enum value: MESH_API = 3;

-
-
-

MESH_DNS

-
MESH_DNS: 9
-

MESH_DNS is the feature for mesh DNS.

-
-
-

Generated

from enum value: MESH_DNS = 9;

-
-
-

METRICS

-
METRICS: 6
-

METRICS is the feature for exposing metrics.

-
-
-

Generated

from enum value: METRICS = 6;

-
-
-

NODES

-
NODES: 1
-

NODES is the feature for nodes. This is always supported.

-
-
-

Generated

from enum value: NODES = 1;

-
-
-

REGISTRAR

-
REGISTRAR: 13
-

REGISTRAR is the feature for being able to register aliases to node IDs and/or public keys.

-
-
-

Generated

from enum value: REGISTRAR = 13;

-
-
-

STORAGE_PROVIDER

-
STORAGE_PROVIDER: 12
-

STORAGE_PROVIDER is the feature for being able to provide distributed storage.

-
-
-

Generated

from enum value: STORAGE_PROVIDER = 12;

-
-
-

STORAGE_QUERIER

-
STORAGE_QUERIER: 11
-

STORAGE_QUERIER is the feature for querying, publishing, and subscribing to mesh state.

-
-
-

Generated

from enum value: STORAGE_QUERIER = 11;

-
-
-

TURN_SERVER

-
TURN_SERVER: 8
-

TURN_SERVER is the feature for TURN server.

-
-
-

Generated

from enum value: TURN_SERVER = 8;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from enum value: MESH_API = 3;

+

MESH_DNS

MESH_DNS: 9

MESH_DNS is the feature for mesh DNS.

+

Generated

from enum value: MESH_DNS = 9;

+

METRICS

METRICS: 6

METRICS is the feature for exposing metrics.

+

Generated

from enum value: METRICS = 6;

+

NODES

NODES: 1

NODES is the feature for nodes. This is always supported.

+

Generated

from enum value: NODES = 1;

+

REGISTRAR

REGISTRAR: 13

REGISTRAR is the feature for being able to register aliases to node IDs and/or public keys.

+

Generated

from enum value: REGISTRAR = 13;

+

STORAGE_PROVIDER

STORAGE_PROVIDER: 12

STORAGE_PROVIDER is the feature for being able to provide distributed storage.

+

Generated

from enum value: STORAGE_PROVIDER = 12;

+

STORAGE_QUERIER

STORAGE_QUERIER: 11

STORAGE_QUERIER is the feature for querying, publishing, and subscribing to mesh state.

+

Generated

from enum value: STORAGE_QUERIER = 11;

+

TURN_SERVER

TURN_SERVER: 8

TURN_SERVER is the feature for TURN server.

+

Generated

from enum value: TURN_SERVER = 8;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/plugin_pb.Event_WatchEvent.html b/docs/enums/plugin_pb.Event_WatchEvent.html index 96deb9b6..2a74014c 100644 --- a/docs/enums/plugin_pb.Event_WatchEvent.html +++ b/docs/enums/plugin_pb.Event_WatchEvent.html @@ -1,131 +1,15 @@ -Event_WatchEvent | Webmesh API
-
- -
-
-
-
- -

Enumeration Event_WatchEvent

-
-

WatchEvent is the type of a watch event.

-
-
-

Generated

from enum v1.Event.WatchEvent

-
-
-
-
- -
-
-

Enumeration Members

-
LEADER_CHANGE +Event_WatchEvent | Webmesh API

Enumeration Event_WatchEvent

WatchEvent is the type of a watch event.

+

Generated

from enum v1.Event.WatchEvent

+

Enumeration Members

LEADER_CHANGE NODE_JOIN NODE_LEAVE UNKNOWN -
-
-

Enumeration Members

-
-

LEADER_CHANGE

-
LEADER_CHANGE: 3
-

LEADER_CHANGE indicates that the leader of the cluster has changed.

-
-
-

Generated

from enum value: LEADER_CHANGE = 3;

-
-
-

NODE_JOIN

-
NODE_JOIN: 1
-

NODE_JOIN indicates that a node has joined the cluster.

-
-
-

Generated

from enum value: NODE_JOIN = 1;

-
-
-

NODE_LEAVE

-
NODE_LEAVE: 2
-

NODE_LEAVE indicates that a node has left the cluster.

-
-
-

Generated

from enum value: NODE_LEAVE = 2;

-
-
-

UNKNOWN

-
UNKNOWN: 0
-

UNKNOWN is the default value of WatchEvent.

-
-
-

Generated

from enum value: UNKNOWN = 0;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Enumeration Members

LEADER_CHANGE

LEADER_CHANGE: 3

LEADER_CHANGE indicates that the leader of the cluster has changed.

+

Generated

from enum value: LEADER_CHANGE = 3;

+

NODE_JOIN

NODE_JOIN: 1

NODE_JOIN indicates that a node has joined the cluster.

+

Generated

from enum value: NODE_JOIN = 1;

+

NODE_LEAVE

NODE_LEAVE: 2

NODE_LEAVE indicates that a node has left the cluster.

+

Generated

from enum value: NODE_LEAVE = 2;

+

UNKNOWN

UNKNOWN: 0

UNKNOWN is the default value of WatchEvent.

+

Generated

from enum value: UNKNOWN = 0;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/plugin_pb.PluginInfo_PluginCapability.html b/docs/enums/plugin_pb.PluginInfo_PluginCapability.html index 86028aaf..bf395cc5 100644 --- a/docs/enums/plugin_pb.PluginInfo_PluginCapability.html +++ b/docs/enums/plugin_pb.PluginInfo_PluginCapability.html @@ -1,155 +1,21 @@ -PluginInfo_PluginCapability | Webmesh API
-
- -
-
-
-
- -

Enumeration PluginInfo_PluginCapability

-
-

PluginCapability is the capabilities of a plugin.

-
-
-

Generated

from enum v1.PluginInfo.PluginCapability

-
-
-
-
- -
-
-

Enumeration Members

-
AUTH +PluginInfo_PluginCapability | Webmesh API

Enumeration PluginInfo_PluginCapability

PluginCapability is the capabilities of a plugin.

+

Generated

from enum v1.PluginInfo.PluginCapability

+

Enumeration Members

AUTH IPAMV4 STORAGE_PROVIDER STORAGE_QUERIER UNKNOWN WATCH -
-
-

Enumeration Members

-
-

AUTH

-
AUTH: 2
-

AUTH indicates that the plugin is an auth plugin.

-
-
-

Generated

from enum value: AUTH = 2;

-
-
-

IPAMV4

-
IPAMV4: 4
-

IPAMV4 indicates that the plugin is an IPv4 IPAM plugin.

-
-
-

Generated

from enum value: IPAMV4 = 4;

-
-
-

STORAGE_PROVIDER

-
STORAGE_PROVIDER: 1
-

STORAGE_PROVIDER indicates that the plugin can provide storage and underlying consistency.

-
-
-

Generated

from enum value: STORAGE_PROVIDER = 1;

-
-
-

STORAGE_QUERIER

-
STORAGE_QUERIER: 5
-

STORAGE_QUERIER indicates a plugin that wants to interact with storage.

-
-
-

Generated

from enum value: STORAGE_QUERIER = 5;

-
-
-

UNKNOWN

-
UNKNOWN: 0
-

UNKNOWN is the default value of PluginCapability.

-
-
-

Generated

from enum value: UNKNOWN = 0;

-
-
-

WATCH

-
WATCH: 3
-

WATCH indicates that the plugin wants to receive watch events.

-
-
-

Generated

from enum value: WATCH = 3;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Enumeration Members

AUTH

AUTH: 2

AUTH indicates that the plugin is an auth plugin.

+

Generated

from enum value: AUTH = 2;

+

IPAMV4

IPAMV4: 4

IPAMV4 indicates that the plugin is an IPv4 IPAM plugin.

+

Generated

from enum value: IPAMV4 = 4;

+

STORAGE_PROVIDER

STORAGE_PROVIDER: 1

STORAGE_PROVIDER indicates that the plugin can provide storage and underlying consistency.

+

Generated

from enum value: STORAGE_PROVIDER = 1;

+

STORAGE_QUERIER

STORAGE_QUERIER: 5

STORAGE_QUERIER indicates a plugin that wants to interact with storage.

+

Generated

from enum value: STORAGE_QUERIER = 5;

+

UNKNOWN

UNKNOWN: 0

UNKNOWN is the default value of PluginCapability.

+

Generated

from enum value: UNKNOWN = 0;

+

WATCH

WATCH: 3

WATCH indicates that the plugin wants to receive watch events.

+

Generated

from enum value: WATCH = 3;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/raft_pb.RaftCommandType.html b/docs/enums/raft_pb.RaftCommandType.html index 726da19b..3cd2058b 100644 --- a/docs/enums/raft_pb.RaftCommandType.html +++ b/docs/enums/raft_pb.RaftCommandType.html @@ -1,120 +1,13 @@ -RaftCommandType | Webmesh API
-
- -
-
-
-
- -

Enumeration RaftCommandType

-
-

RaftCommandType is the type of command being sent to the +RaftCommandType | Webmesh API

Enumeration RaftCommandType

RaftCommandType is the type of command being sent to the Raft log.

-
-
-

Generated

from enum v1.RaftCommandType

-
-
-
-
- -
-
-

Enumeration Members

-
DELETE +

Generated

from enum v1.RaftCommandType

+

Enumeration Members

DELETE PUT UNKNOWN -
-
-

Enumeration Members

-
-

DELETE

-
DELETE: 2
-

DELETE is the command for deleting a key/value pair.

-
-
-

Generated

from enum value: DELETE = 2;

-
-
-

PUT

-
PUT: 1
-

PUT is the command for putting a key/value pair.

-
-
-

Generated

from enum value: PUT = 1;

-
-
-

UNKNOWN

-
UNKNOWN: 0
-

UNKNOWN is the unknown command type.

-
-
-

Generated

from enum value: UNKNOWN = 0;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Enumeration Members

DELETE

DELETE: 2

DELETE is the command for deleting a key/value pair.

+

Generated

from enum value: DELETE = 2;

+

PUT

PUT: 1

PUT is the command for putting a key/value pair.

+

Generated

from enum value: PUT = 1;

+

UNKNOWN

UNKNOWN: 0

UNKNOWN is the unknown command type.

+

Generated

from enum value: UNKNOWN = 0;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/rbac_pb.RuleResource.html b/docs/enums/rbac_pb.RuleResource.html index 7c11d596..db348172 100644 --- a/docs/enums/rbac_pb.RuleResource.html +++ b/docs/enums/rbac_pb.RuleResource.html @@ -1,37 +1,6 @@ -RuleResource | Webmesh API
-
- -
-
-
-
- -

Enumeration RuleResource

-
-

RuleResource is the resource type for a rule.

-
-
-

Generated

from enum v1.RuleResource

-
-
-
-
- -
-
-

Enumeration Members

-
RESOURCE_ALL +RuleResource | Webmesh API

Enumeration RuleResource

RuleResource is the resource type for a rule.

+

Generated

from enum v1.RuleResource

+

Enumeration Members

RESOURCE_ALL RESOURCE_DATA_CHANNELS RESOURCE_EDGES RESOURCE_GROUPS @@ -43,187 +12,30 @@

Enumeration Members

RESOURCE_ROUTES RESOURCE_UNKNOWN RESOURCE_VOTES -
-
-

Enumeration Members

-
-

RESOURCE_ALL

-
RESOURCE_ALL: 999
-

RESOURCE_ALL is a wildcard resource that matches all resources.

-
-
-

Generated

from enum value: RESOURCE_ALL = 999;

-
-
-

RESOURCE_DATA_CHANNELS

-
RESOURCE_DATA_CHANNELS: 7
-

RESOURCE_DATA_CHANNELS is the resource for creating data channels.

-
-
-

Generated

from enum value: RESOURCE_DATA_CHANNELS = 7;

-
-
-

RESOURCE_EDGES

-
RESOURCE_EDGES: 8
-

RESOURCE_EDGES is the resource for managing edges between nodes.

-
-
-

Generated

from enum value: RESOURCE_EDGES = 8;

-
-
-

RESOURCE_GROUPS

-
RESOURCE_GROUPS: 4
-

RESOURCE_GROUPS is the resource for managing groups.

-
-
-

Generated

from enum value: RESOURCE_GROUPS = 4;

-
-
-

RESOURCE_NETWORK_ACLS

-
RESOURCE_NETWORK_ACLS: 5
-

RESOURCE_NETWORK_ACLS is the resource for managing network ACLs.

-
-
-

Generated

from enum value: RESOURCE_NETWORK_ACLS = 5;

-
-
-

RESOURCE_OBSERVERS

-
RESOURCE_OBSERVERS: 9
-

RESOURCE_OBSERVERS is the resource for managing observers. The only +

Enumeration Members

RESOURCE_ALL

RESOURCE_ALL: 999

RESOURCE_ALL is a wildcard resource that matches all resources.

+

Generated

from enum value: RESOURCE_ALL = 999;

+

RESOURCE_DATA_CHANNELS

RESOURCE_DATA_CHANNELS: 7

RESOURCE_DATA_CHANNELS is the resource for creating data channels.

+

Generated

from enum value: RESOURCE_DATA_CHANNELS = 7;

+

RESOURCE_EDGES

RESOURCE_EDGES: 8

RESOURCE_EDGES is the resource for managing edges between nodes.

+

Generated

from enum value: RESOURCE_EDGES = 8;

+

RESOURCE_GROUPS

RESOURCE_GROUPS: 4

RESOURCE_GROUPS is the resource for managing groups.

+

Generated

from enum value: RESOURCE_GROUPS = 4;

+

RESOURCE_NETWORK_ACLS

RESOURCE_NETWORK_ACLS: 5

RESOURCE_NETWORK_ACLS is the resource for managing network ACLs.

+

Generated

from enum value: RESOURCE_NETWORK_ACLS = 5;

+

RESOURCE_OBSERVERS

RESOURCE_OBSERVERS: 9

RESOURCE_OBSERVERS is the resource for managing observers. The only verb evaluated for this resource is PUT.

-
-
-

Generated

from enum value: RESOURCE_OBSERVERS = 9;

-
-
-

RESOURCE_PUBSUB

-
RESOURCE_PUBSUB: 10
-

RESOURCE_PUBSUB is the resource for managing pubsub topics.

-
-
-

Generated

from enum value: RESOURCE_PUBSUB = 10;

-
-
-

RESOURCE_ROLES

-
RESOURCE_ROLES: 2
-

RESOURCE_ROLES is the resource for managing roles.

-
-
-

Generated

from enum value: RESOURCE_ROLES = 2;

-
-
-

RESOURCE_ROLE_BINDINGS

-
RESOURCE_ROLE_BINDINGS: 3
-

RESOURCE_ROLE_BINDINGS is the resource for managing role bindings.

-
-
-

Generated

from enum value: RESOURCE_ROLE_BINDINGS = 3;

-
-
-

RESOURCE_ROUTES

-
RESOURCE_ROUTES: 6
-

RESOURCE_ROUTES is the resource for managing routes.

-
-
-

Generated

from enum value: RESOURCE_ROUTES = 6;

-
-
-

RESOURCE_UNKNOWN

-
RESOURCE_UNKNOWN: 0
-

RESOURCE_UNKNOWN is an unknown resource.

-
-
-

Generated

from enum value: RESOURCE_UNKNOWN = 0;

-
-
-

RESOURCE_VOTES

-
RESOURCE_VOTES: 1
-

RESOURCE_VOTES is the resource for voting in storage elections. The only +

Generated

from enum value: RESOURCE_OBSERVERS = 9;

+

RESOURCE_PUBSUB

RESOURCE_PUBSUB: 10

RESOURCE_PUBSUB is the resource for managing pubsub topics.

+

Generated

from enum value: RESOURCE_PUBSUB = 10;

+

RESOURCE_ROLES

RESOURCE_ROLES: 2

RESOURCE_ROLES is the resource for managing roles.

+

Generated

from enum value: RESOURCE_ROLES = 2;

+

RESOURCE_ROLE_BINDINGS

RESOURCE_ROLE_BINDINGS: 3

RESOURCE_ROLE_BINDINGS is the resource for managing role bindings.

+

Generated

from enum value: RESOURCE_ROLE_BINDINGS = 3;

+

RESOURCE_ROUTES

RESOURCE_ROUTES: 6

RESOURCE_ROUTES is the resource for managing routes.

+

Generated

from enum value: RESOURCE_ROUTES = 6;

+

RESOURCE_UNKNOWN

RESOURCE_UNKNOWN: 0

RESOURCE_UNKNOWN is an unknown resource.

+

Generated

from enum value: RESOURCE_UNKNOWN = 0;

+

RESOURCE_VOTES

RESOURCE_VOTES: 1

RESOURCE_VOTES is the resource for voting in storage elections. The only verb evaluated for this resource is PUT.

-
-
-

Generated

from enum value: RESOURCE_VOTES = 1;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from enum value: RESOURCE_VOTES = 1;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/rbac_pb.RuleVerb.html b/docs/enums/rbac_pb.RuleVerb.html index ab7e6fd1..81b37973 100644 --- a/docs/enums/rbac_pb.RuleVerb.html +++ b/docs/enums/rbac_pb.RuleVerb.html @@ -1,143 +1,18 @@ -RuleVerb | Webmesh API
-
- -
-
-
-
- -

Enumeration RuleVerb

-
-

RuleVerb is the verb type for a rule.

-
-
-

Generated

from enum v1.RuleVerb

-
-
-
-
- -
-
-

Enumeration Members

-
VERB_ALL +RuleVerb | Webmesh API

Enumeration RuleVerb

RuleVerb is the verb type for a rule.

+

Generated

from enum v1.RuleVerb

+

Enumeration Members

VERB_ALL VERB_DELETE VERB_GET VERB_PUT VERB_UNKNOWN -
-
-

Enumeration Members

-
-

VERB_ALL

-
VERB_ALL: 999
-

VERB_ALL is a wildcard verb that matches all verbs.

-
-
-

Generated

from enum value: VERB_ALL = 999;

-
-
-

VERB_DELETE

-
VERB_DELETE: 3
-

VERB_DELETE is the verb for deleting a resource.

-
-
-

Generated

from enum value: VERB_DELETE = 3;

-
-
-

VERB_GET

-
VERB_GET: 2
-

VERB_GET is the verb for getting a resource.

-
-
-

Generated

from enum value: VERB_GET = 2;

-
-
-

VERB_PUT

-
VERB_PUT: 1
-

VERB_PUT is the verb for creating or updating a resource.

-
-
-

Generated

from enum value: VERB_PUT = 1;

-
-
-

VERB_UNKNOWN

-
VERB_UNKNOWN: 0
-

VERB_UNKNOWN is an unknown verb.

-
-
-

Generated

from enum value: VERB_UNKNOWN = 0;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Enumeration Members

VERB_ALL

VERB_ALL: 999

VERB_ALL is a wildcard verb that matches all verbs.

+

Generated

from enum value: VERB_ALL = 999;

+

VERB_DELETE

VERB_DELETE: 3

VERB_DELETE is the verb for deleting a resource.

+

Generated

from enum value: VERB_DELETE = 3;

+

VERB_GET

VERB_GET: 2

VERB_GET is the verb for getting a resource.

+

Generated

from enum value: VERB_GET = 2;

+

VERB_PUT

VERB_PUT: 1

VERB_PUT is the verb for creating or updating a resource.

+

Generated

from enum value: VERB_PUT = 1;

+

VERB_UNKNOWN

VERB_UNKNOWN: 0

VERB_UNKNOWN is an unknown verb.

+

Generated

from enum value: VERB_UNKNOWN = 0;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/rbac_pb.SubjectType.html b/docs/enums/rbac_pb.SubjectType.html index a7c857fd..dea7389b 100644 --- a/docs/enums/rbac_pb.SubjectType.html +++ b/docs/enums/rbac_pb.SubjectType.html @@ -1,144 +1,19 @@ -SubjectType | Webmesh API
-
- -
-
-
-
- -

Enumeration SubjectType

-
-

SubjectType is the type of a subject.

-
-
-

Generated

from enum v1.SubjectType

-
-
-
-
- -
-
-

Enumeration Members

-
SUBJECT_ALL +SubjectType | Webmesh API

Enumeration SubjectType

SubjectType is the type of a subject.

+

Generated

from enum v1.SubjectType

+

Enumeration Members

SUBJECT_ALL SUBJECT_GROUP SUBJECT_NODE SUBJECT_UNKNOWN SUBJECT_USER -
-
-

Enumeration Members

-
-

SUBJECT_ALL

-
SUBJECT_ALL: 999
-

SUBJECT_ALL is a wildcard subject type that matches all subject types. +

Enumeration Members

SUBJECT_ALL

SUBJECT_ALL: 999

SUBJECT_ALL is a wildcard subject type that matches all subject types. It can be used with a subject named '*' to match all subjects.

-
-
-

Generated

from enum value: SUBJECT_ALL = 999;

-
-
-

SUBJECT_GROUP

-
SUBJECT_GROUP: 3
-

SUBJECT_GROUP is a subject type for a group.

-
-
-

Generated

from enum value: SUBJECT_GROUP = 3;

-
-
-

SUBJECT_NODE

-
SUBJECT_NODE: 1
-

SUBJECT_NODE is a subject type for a node.

-
-
-

Generated

from enum value: SUBJECT_NODE = 1;

-
-
-

SUBJECT_UNKNOWN

-
SUBJECT_UNKNOWN: 0
-

SUBJECT_UNKNOWN is an unknown subject type.

-
-
-

Generated

from enum value: SUBJECT_UNKNOWN = 0;

-
-
-

SUBJECT_USER

-
SUBJECT_USER: 2
-

SUBJECT_USER is a subject type for a user.

-
-
-

Generated

from enum value: SUBJECT_USER = 2;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from enum value: SUBJECT_ALL = 999;

+

SUBJECT_GROUP

SUBJECT_GROUP: 3

SUBJECT_GROUP is a subject type for a group.

+

Generated

from enum value: SUBJECT_GROUP = 3;

+

SUBJECT_NODE

SUBJECT_NODE: 1

SUBJECT_NODE is a subject type for a node.

+

Generated

from enum value: SUBJECT_NODE = 1;

+

SUBJECT_UNKNOWN

SUBJECT_UNKNOWN: 0

SUBJECT_UNKNOWN is an unknown subject type.

+

Generated

from enum value: SUBJECT_UNKNOWN = 0;

+

SUBJECT_USER

SUBJECT_USER: 2

SUBJECT_USER is a subject type for a user.

+

Generated

from enum value: SUBJECT_USER = 2;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/storage_provider_pb.PrefixEvent_EventType.html b/docs/enums/storage_provider_pb.PrefixEvent_EventType.html index 3d0c7585..5de04414 100644 --- a/docs/enums/storage_provider_pb.PrefixEvent_EventType.html +++ b/docs/enums/storage_provider_pb.PrefixEvent_EventType.html @@ -1,117 +1,11 @@ -PrefixEvent_EventType | Webmesh API
-
- -
-
-
-
- -

Enumeration PrefixEvent_EventType

-
-
-

Generated

from enum v1.PrefixEvent.EventType

-
-
-
-
- -
-
-

Enumeration Members

-
EventTypeRemoved +PrefixEvent_EventType | Webmesh API

Enumeration PrefixEvent_EventType

Generated

from enum v1.PrefixEvent.EventType

+

Enumeration Members

EventTypeRemoved EventTypeUnknown EventTypeUpdated -
-
-

Enumeration Members

-
-

EventTypeRemoved

-
EventTypeRemoved: 2
-

EventTypeRemoved is an event for when a value is removed.

-
-
-

Generated

from enum value: EventTypeRemoved = 2;

-
-
-

EventTypeUnknown

-
EventTypeUnknown: 0
-

EventTypeUnknown is an unknown event type.

-
-
-

Generated

from enum value: EventTypeUnknown = 0;

-
-
-

EventTypeUpdated

-
EventTypeUpdated: 1
-

EventTypeUpdated is an event for when a value is added or updated.

-
-
-

Generated

from enum value: EventTypeUpdated = 1;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Enumeration Members

EventTypeRemoved

EventTypeRemoved: 2

EventTypeRemoved is an event for when a value is removed.

+

Generated

from enum value: EventTypeRemoved = 2;

+

EventTypeUnknown

EventTypeUnknown: 0

EventTypeUnknown is an unknown event type.

+

Generated

from enum value: EventTypeUnknown = 0;

+

EventTypeUpdated

EventTypeUpdated: 1

EventTypeUpdated is an event for when a value is added or updated.

+

Generated

from enum value: EventTypeUpdated = 1;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/storage_query_pb.QueryRequest_QueryCommand.html b/docs/enums/storage_query_pb.QueryRequest_QueryCommand.html index 3f2c7aaf..e6551995 100644 --- a/docs/enums/storage_query_pb.QueryRequest_QueryCommand.html +++ b/docs/enums/storage_query_pb.QueryRequest_QueryCommand.html @@ -1,107 +1,9 @@ -QueryRequest_QueryCommand | Webmesh API
-
- -
-
-
-
- -

Enumeration QueryRequest_QueryCommand

-
-

QueryCommand is the type of the query.

-
-
-

Generated

from enum v1.QueryRequest.QueryCommand

-
-
-
-
- -
-
-

Enumeration Members

-
GET +QueryRequest_QueryCommand | Webmesh API

Enumeration QueryRequest_QueryCommand

QueryCommand is the type of the query.

+

Generated

from enum v1.QueryRequest.QueryCommand

+

Enumeration Members

GET LIST -
-
-

Enumeration Members

-
-

GET

-
GET: 0
-

GET is the command to get a value.

-
-
-

Generated

from enum value: GET = 0;

-
-
-

LIST

-
LIST: 1
-

LIST is the command to list keys with an optional prefix.

-
-
-

Generated

from enum value: LIST = 1;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Enumeration Members

GET

GET: 0

GET is the command to get a value.

+

Generated

from enum value: GET = 0;

+

LIST

LIST: 1

LIST is the command to list keys with an optional prefix.

+

Generated

from enum value: LIST = 1;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/storage_query_pb.QueryRequest_QueryType.html b/docs/enums/storage_query_pb.QueryRequest_QueryType.html index b2398a3d..567fa787 100644 --- a/docs/enums/storage_query_pb.QueryRequest_QueryType.html +++ b/docs/enums/storage_query_pb.QueryRequest_QueryType.html @@ -1,37 +1,6 @@ -QueryRequest_QueryType | Webmesh API
-
- -
-
-
-
- -

Enumeration QueryRequest_QueryType

-
-

QueryType is the type of object being queried.

-
-
-

Generated

from enum v1.QueryRequest.QueryType

-
-
-
-
- -
-
-

Enumeration Members

-
ACLS +QueryRequest_QueryType | Webmesh API

Enumeration QueryRequest_QueryType

QueryType is the type of object being queried.

+

Generated

from enum v1.QueryRequest.QueryType

+

Enumeration Members

ACLS EDGES GROUPS KEYS @@ -42,175 +11,27 @@

Enumeration Members

ROLES ROUTES VALUE -
-
-

Enumeration Members

-
-

ACLS

-
ACLS: 5
-

ACLS is the type for querying ACLs.

-
-
-

Generated

from enum value: ACLS = 5;

-
-
-

EDGES

-
EDGES: 3
-

EDGES is the type for querying edges.

-
-
-

Generated

from enum value: EDGES = 3;

-
-
-

GROUPS

-
GROUPS: 8
-

GROUPS is the type for querying groups.

-
-
-

Generated

from enum value: GROUPS = 8;

-
-
-

KEYS

-
KEYS: 1
-

KEYS is the type for querying keys.

-
-
-

Generated

from enum value: KEYS = 1;

-
-
-

NETWORK_STATE

-
NETWORK_STATE: 9
-

NETWORK_STATE is the type for querying network configuration.

-
-
-

Generated

from enum value: NETWORK_STATE = 9;

-
-
-

PEERS

-
PEERS: 2
-

PEERS is the type for querying peers.

-
-
-

Generated

from enum value: PEERS = 2;

-
-
-

RBAC_STATE

-
RBAC_STATE: 10
-

RBAC_STATE is the type for querying RBAC configuration. +

Enumeration Members

ACLS

ACLS: 5

ACLS is the type for querying ACLs.

+

Generated

from enum value: ACLS = 5;

+

EDGES

EDGES: 3

EDGES is the type for querying edges.

+

Generated

from enum value: EDGES = 3;

+

GROUPS

GROUPS: 8

GROUPS is the type for querying groups.

+

Generated

from enum value: GROUPS = 8;

+

KEYS

KEYS: 1

KEYS is the type for querying keys.

+

Generated

from enum value: KEYS = 1;

+

NETWORK_STATE

NETWORK_STATE: 9

NETWORK_STATE is the type for querying network configuration.

+

Generated

from enum value: NETWORK_STATE = 9;

+

PEERS

PEERS: 2

PEERS is the type for querying peers.

+

Generated

from enum value: PEERS = 2;

+

RBAC_STATE

RBAC_STATE: 10

RBAC_STATE is the type for querying RBAC configuration. This will return a single item of true or false.

-
-
-

Generated

from enum value: RBAC_STATE = 10;

-
-
-

ROLEBINDINGS

-
ROLEBINDINGS: 7
-

ROLEBINDINGS is the type for querying role bindings.

-
-
-

Generated

from enum value: ROLEBINDINGS = 7;

-
-
-

ROLES

-
ROLES: 6
-

ROLES is the type for querying roles.

-
-
-

Generated

from enum value: ROLES = 6;

-
-
-

ROUTES

-
ROUTES: 4
-

ROUTES is the type for querying routes.

-
-
-

Generated

from enum value: ROUTES = 4;

-
-
-

VALUE

-
VALUE: 0
-

VALUE represents a raw value query at a supplied key.

-
-
-

Generated

from enum value: VALUE = 0;

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from enum value: RBAC_STATE = 10;

+

ROLEBINDINGS

ROLEBINDINGS: 7

ROLEBINDINGS is the type for querying role bindings.

+

Generated

from enum value: ROLEBINDINGS = 7;

+

ROLES

ROLES: 6

ROLES is the type for querying roles.

+

Generated

from enum value: ROLES = 6;

+

ROUTES

ROUTES: 4

ROUTES is the type for querying routes.

+

Generated

from enum value: ROUTES = 4;

+

VALUE

VALUE: 0

VALUE represents a raw value query at a supplied key.

+

Generated

from enum value: VALUE = 0;

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 49fe7fe9..72349279 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,69 +1,5 @@ -Webmesh API
-
- -
-
-
-
-

Webmesh API

-

Webmesh API Protocol Buffers

Protocol buffers for the Webmesh API. +Webmesh API

Webmesh API

Webmesh API Protocol Buffers

Protocol buffers for the Webmesh API. Documentation is available at webmeshproj.github.io/api/proto/.

Go Reference TypeScript

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/admin_connect.html b/docs/modules/admin_connect.html index 8362e3b2..d1722b3e 100644 --- a/docs/modules/admin_connect.html +++ b/docs/modules/admin_connect.html @@ -1,69 +1,2 @@ -admin_connect | Webmesh API
-
- -
-
-
-
- -

Module admin_connect

-
-
-

Index

-
-

Variables

-
Admin -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +admin_connect | Webmesh API

Module admin_connect

Index

Variables

Admin +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/app_connect.html b/docs/modules/app_connect.html index 0838fca9..d07f4706 100644 --- a/docs/modules/app_connect.html +++ b/docs/modules/app_connect.html @@ -1,69 +1,2 @@ -app_connect | Webmesh API
-
- -
-
-
-
- -

Module app_connect

-
-
-

Index

-
-

Variables

-
AppDaemon -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +app_connect | Webmesh API

Module app_connect

Index

Variables

AppDaemon +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/app_pb.html b/docs/modules/app_pb.html index 8f1af7cf..e6ebf94b 100644 --- a/docs/modules/app_pb.html +++ b/docs/modules/app_pb.html @@ -1,36 +1,9 @@ -app_pb | Webmesh API
-
- -
-
-
-
- -

Module app_pb

-
-
-

Index

-
-

Enumerations

-
ConnectRequest_AddrType +app_pb | Webmesh API

Module app_pb

Index

Enumerations

ConnectRequest_AddrType ConnectRequest_AuthHeader ConnectRequest_AuthMethod MeshConnBootstrap_DefaultNetworkACL StatusResponse_ConnectionStatus -
-
-

Classes

-
AppQueryRequest +

Classes

AppQueryRequest ConnectRequest ConnectResponse DisconnectRequest @@ -43,47 +16,4 @@

Classes

MetricsResponse StatusRequest StatusResponse -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/members_connect.html b/docs/modules/members_connect.html index ca73c28b..8e1808b8 100644 --- a/docs/modules/members_connect.html +++ b/docs/modules/members_connect.html @@ -1,69 +1,2 @@ -members_connect | Webmesh API
-
- -
-
-
-
- -

Module members_connect

-
-
-

Index

-
-

Variables

-
Membership -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +members_connect | Webmesh API

Module members_connect

Index

Variables

Membership +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/members_pb.html b/docs/modules/members_pb.html index c9bf1953..a4c1e1ba 100644 --- a/docs/modules/members_pb.html +++ b/docs/modules/members_pb.html @@ -1,32 +1,5 @@ -members_pb | Webmesh API
-
- -
-
-
-
- -

Module members_pb

-
-
-

Index

-
-

Enumerations

-
ConnectProtocol -
-
-

Classes

-
JoinRequest +members_pb | Webmesh API

Module members_pb

Index

Enumerations

ConnectProtocol +

Classes

JoinRequest JoinResponse LeaveRequest LeaveResponse @@ -38,47 +11,4 @@

Classes

UpdateRequest UpdateResponse WireGuardPeer -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/mesh_connect.html b/docs/modules/mesh_connect.html index 6b0e3df1..1b1d705a 100644 --- a/docs/modules/mesh_connect.html +++ b/docs/modules/mesh_connect.html @@ -1,69 +1,2 @@ -mesh_connect | Webmesh API
-
- -
-
-
-
- -

Module mesh_connect

-
-
-

Index

-
-

Variables

-
Mesh -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +mesh_connect | Webmesh API

Module mesh_connect

Index

Variables

Mesh +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/mesh_pb.html b/docs/modules/mesh_pb.html index 1f43b186..13f9c6ba 100644 --- a/docs/modules/mesh_pb.html +++ b/docs/modules/mesh_pb.html @@ -1,72 +1,5 @@ -mesh_pb | Webmesh API
-
- -
-
-
-
- -

Module mesh_pb

-
-
-

Index

-
-

Classes

-
GetNodeRequest +mesh_pb | Webmesh API

Module mesh_pb

Index

Classes

GetNodeRequest MeshEdge MeshEdges MeshGraph -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/network_acls_pb.html b/docs/modules/network_acls_pb.html index 5b4414d3..9573486b 100644 --- a/docs/modules/network_acls_pb.html +++ b/docs/modules/network_acls_pb.html @@ -1,77 +1,7 @@ -network_acls_pb | Webmesh API
-
- -
-
-
-
- -

Module network_acls_pb

-
-
-

Index

-
-

Enumerations

-
ACLAction -
-
-

Classes

-
NetworkACL +network_acls_pb | Webmesh API

Module network_acls_pb

Index

Enumerations

ACLAction +

Classes

NetworkACL NetworkACLs NetworkAction Route Routes -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/node_connect.html b/docs/modules/node_connect.html index da4e34c9..a324ad19 100644 --- a/docs/modules/node_connect.html +++ b/docs/modules/node_connect.html @@ -1,69 +1,2 @@ -node_connect | Webmesh API
-
- -
-
-
-
- -

Module node_connect

-
-
-

Index

-
-

Variables

-
Node -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +node_connect | Webmesh API

Module node_connect

Index

Variables

Node +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/node_pb.html b/docs/modules/node_pb.html index b87ec628..35f430fd 100644 --- a/docs/modules/node_pb.html +++ b/docs/modules/node_pb.html @@ -1,35 +1,8 @@ -node_pb | Webmesh API
-
- -
-
-
-
- -

Module node_pb

-
-
-

Index

-
-

Enumerations

-
ClusterStatus +node_pb | Webmesh API

Module node_pb

Index

Enumerations

ClusterStatus DataChannel EdgeAttribute Feature -
-
-

Classes

-
DataChannelNegotiation +

Classes

DataChannelNegotiation FeaturePort GetStatusRequest InterfaceMetrics @@ -38,47 +11,4 @@

Classes

PeerMetrics Status WebRTCSignal -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/plugin_connect.html b/docs/modules/plugin_connect.html index eb6c55f6..f0794d94 100644 --- a/docs/modules/plugin_connect.html +++ b/docs/modules/plugin_connect.html @@ -1,73 +1,6 @@ -plugin_connect | Webmesh API
-
- -
-
-
-
- -

Module plugin_connect

-
-
-

Index

-
-

Variables

-
AuthPlugin +plugin_connect | Webmesh API

Module plugin_connect

Index

Variables

AuthPlugin IPAMPlugin Plugin StorageQuerierPlugin WatchPlugin -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/plugin_pb.html b/docs/modules/plugin_pb.html index c5f60305..80dbdc0e 100644 --- a/docs/modules/plugin_pb.html +++ b/docs/modules/plugin_pb.html @@ -1,33 +1,6 @@ -plugin_pb | Webmesh API
-
- -
-
-
-
- -

Module plugin_pb

-
-
-

Index

-
-

Enumerations

-
Event_WatchEvent +plugin_pb | Webmesh API

Module plugin_pb

Index

Enumerations

Event_WatchEvent PluginInfo_PluginCapability -
-
-

Classes

-
AllocateIPRequest +

Classes

AllocateIPRequest AllocatedIP AuthenticationRequest AuthenticationResponse @@ -36,47 +9,4 @@

Classes

PluginConfiguration PluginInfo ReleaseIPRequest -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/raft_pb.html b/docs/modules/raft_pb.html index 445bf7b3..b6151298 100644 --- a/docs/modules/raft_pb.html +++ b/docs/modules/raft_pb.html @@ -1,76 +1,6 @@ -raft_pb | Webmesh API
-
- -
-
-
-
- -

Module raft_pb

-
-
-

Index

-
-

Enumerations

-
RaftCommandType -
-
-

Classes

-
RaftApplyResponse +raft_pb | Webmesh API

Module raft_pb

Index

Enumerations

RaftCommandType +

Classes

RaftApplyResponse RaftDataItem RaftLogEntry RaftSnapshot -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/rbac_pb.html b/docs/modules/rbac_pb.html index c2689a3e..3f5fd47c 100644 --- a/docs/modules/rbac_pb.html +++ b/docs/modules/rbac_pb.html @@ -1,34 +1,7 @@ -rbac_pb | Webmesh API
-
- -
-
-
-
- -

Module rbac_pb

-
-
-

Index

-
-

Enumerations

-
RuleResource +rbac_pb | Webmesh API

Module rbac_pb

Index

Enumerations

RuleResource RuleVerb SubjectType -
-
-

Classes

-
Group +

Classes

Group Groups RBACAction Role @@ -37,47 +10,4 @@

Classes

Roles Rule Subject -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/registrar_connect.html b/docs/modules/registrar_connect.html index 975ba130..2ec5039e 100644 --- a/docs/modules/registrar_connect.html +++ b/docs/modules/registrar_connect.html @@ -1,69 +1,2 @@ -registrar_connect | Webmesh API
-
- -
-
-
-
- -

Module registrar_connect

-
-
-

Index

-
-

Variables

-
Registrar -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +registrar_connect | Webmesh API

Module registrar_connect

Index

Variables

Registrar +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/registrar_pb.html b/docs/modules/registrar_pb.html index d5b22475..8b3c9c29 100644 --- a/docs/modules/registrar_pb.html +++ b/docs/modules/registrar_pb.html @@ -1,72 +1,5 @@ -registrar_pb | Webmesh API
-
- -
-
-
-
- -

Module registrar_pb

-
-
-

Index

-
-

Classes

-
LookupRequest +registrar_pb | Webmesh API

Module registrar_pb

Index

Classes

LookupRequest LookupResponse RegisterRequest RegisterResponse -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/storage_provider_connect.html b/docs/modules/storage_provider_connect.html index 02fa2a16..b75bbd74 100644 --- a/docs/modules/storage_provider_connect.html +++ b/docs/modules/storage_provider_connect.html @@ -1,69 +1,2 @@ -storage_provider_connect | Webmesh API
-
- -
-
-
-
- -

Module storage_provider_connect

-
-
-

Index

-
-

Variables

-
StorageProviderPlugin -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +storage_provider_connect | Webmesh API

Module storage_provider_connect

Index

Variables

StorageProviderPlugin +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/storage_provider_pb.html b/docs/modules/storage_provider_pb.html index f7d260c8..200b44ae 100644 --- a/docs/modules/storage_provider_pb.html +++ b/docs/modules/storage_provider_pb.html @@ -1,32 +1,5 @@ -storage_provider_pb | Webmesh API
-
- -
-
-
-
- -

Module storage_provider_pb

-
-
-

Index

-
-

Enumerations

-
PrefixEvent_EventType -
-
-

Classes

-
AddObserverResponse +storage_provider_pb | Webmesh API

Module storage_provider_pb

Index

Enumerations

PrefixEvent_EventType +

Classes

AddObserverResponse AddVoterResponse BootstrapRequest BootstrapResponse @@ -51,47 +24,4 @@

Classes

StorageStatusRequest StorageValue SubscribePrefixRequest -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/storage_query_connect.html b/docs/modules/storage_query_connect.html index bedbf7f2..4c873e54 100644 --- a/docs/modules/storage_query_connect.html +++ b/docs/modules/storage_query_connect.html @@ -1,69 +1,2 @@ -storage_query_connect | Webmesh API
-
- -
-
-
-
- -

Module storage_query_connect

-
-
-

Index

-
-

Variables

-
StorageQueryService -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +storage_query_connect | Webmesh API

Module storage_query_connect

Index

Variables

StorageQueryService +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/storage_query_pb.html b/docs/modules/storage_query_pb.html index 9a2741dc..1d2ff254 100644 --- a/docs/modules/storage_query_pb.html +++ b/docs/modules/storage_query_pb.html @@ -1,80 +1,10 @@ -storage_query_pb | Webmesh API
-
- -
-
-
-
- -

Module storage_query_pb

-
-
-

Index

-
-

Enumerations

-
QueryRequest_QueryCommand +storage_query_pb | Webmesh API

Module storage_query_pb

Index

Enumerations

QueryRequest_QueryCommand QueryRequest_QueryType -
-
-

Classes

-
NetworkState +

Classes

NetworkState PublishRequest PublishResponse QueryRequest QueryResponse SubscribeRequest SubscriptionEvent -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/webrtc_connect.html b/docs/modules/webrtc_connect.html index b534b5c1..954da3db 100644 --- a/docs/modules/webrtc_connect.html +++ b/docs/modules/webrtc_connect.html @@ -1,69 +1,2 @@ -webrtc_connect | Webmesh API
-
- -
-
-
-
- -

Module webrtc_connect

-
-
-

Index

-
-

Variables

-
WebRTC -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +webrtc_connect | Webmesh API

Module webrtc_connect

Index

Variables

WebRTC +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/webrtc_pb.html b/docs/modules/webrtc_pb.html index a340c82a..9897c78e 100644 --- a/docs/modules/webrtc_pb.html +++ b/docs/modules/webrtc_pb.html @@ -1,70 +1,3 @@ -webrtc_pb | Webmesh API
-
- -
-
-
-
- -

Module webrtc_pb

-
-
-

Index

-
-

Classes

-
DataChannelOffer +webrtc_pb | Webmesh API

Module webrtc_pb

Index

Classes

DataChannelOffer StartDataChannelRequest -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/proto/index.html b/docs/proto/index.html index 180beed1..a34601d3 100644 --- a/docs/proto/index.html +++ b/docs/proto/index.html @@ -3384,7 +3384,7 @@

ConnectResponse

DisconnectRequest

-

DisconnectRequest is sent by an application to a daemon to disconnect

from a mesh. This message will eventually contain unique identifiers

for allowing the application to disconnect from a specific mesh.

+

DisconnectRequest is sent by an application to a daemon to disconnect from a mesh.

@@ -3585,7 +3585,7 @@

MeshConnTLS

MetricsRequest

-

MetricsRequest is sent by the application to a daemon to retrieve interface

metrics for a mesh connection.

+

MetricsRequest is sent by the application to a daemon to retrieve interface metrics for a mesh connection.

@@ -3665,7 +3665,7 @@

MetricsResponse.InterfacesEntry

StatusRequest

-

StatusRequest is sent by the application to a daemon to retrieve the status

of a mesh connection.

+

StatusRequest is sent by the application to a daemon to retrieve the status of a mesh connection.

@@ -3891,7 +3891,7 @@

StatusResponse.ConnectionStatus

AppDaemon

-

AppDaemon is exposed by nodes running in the app-daemon mode. This mode

allows the node to run in an idle state and be controlled by an application.

The application can send commands to the node to execute tasks and receive

responses.

+

AppDaemon is exposed by nodes running in the daemon mode. This mode allows the

node to run in an idle state and be controlled by an application. The application

can send commands to the node to execute tasks and receive responses.

diff --git a/docs/variables/admin_connect.Admin.html b/docs/variables/admin_connect.Admin.html index 23da25e1..b05754e4 100644 --- a/docs/variables/admin_connect.Admin.html +++ b/docs/variables/admin_connect.Admin.html @@ -1,462 +1,52 @@ -Admin | Webmesh API
-
- -
-
-
-
- -

Variable AdminConst

-
Admin: {
    methods: {
        deleteEdge: {
            I: typeof MeshEdge;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteEdge";
        };
        deleteGroup: {
            I: typeof Group;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteGroup";
        };
        deleteNetworkACL: {
            I: typeof NetworkACL;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteNetworkACL";
        };
        deleteRole: {
            I: typeof Role;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteRole";
        };
        deleteRoleBinding: {
            I: typeof RoleBinding;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteRoleBinding";
        };
        deleteRoute: {
            I: typeof Route;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteRoute";
        };
        getEdge: {
            I: typeof MeshEdge;
            O: typeof MeshEdge;
            kind: MethodKind.Unary;
            name: "GetEdge";
        };
        getGroup: {
            I: typeof Group;
            O: typeof Group;
            kind: MethodKind.Unary;
            name: "GetGroup";
        };
        getNetworkACL: {
            I: typeof NetworkACL;
            O: typeof NetworkACL;
            kind: MethodKind.Unary;
            name: "GetNetworkACL";
        };
        getRole: {
            I: typeof Role;
            O: typeof Role;
            kind: MethodKind.Unary;
            name: "GetRole";
        };
        getRoleBinding: {
            I: typeof RoleBinding;
            O: typeof RoleBinding;
            kind: MethodKind.Unary;
            name: "GetRoleBinding";
        };
        getRoute: {
            I: typeof Route;
            O: typeof Route;
            kind: MethodKind.Unary;
            name: "GetRoute";
        };
        listEdges: {
            I: typeof Empty;
            O: typeof MeshEdges;
            kind: MethodKind.Unary;
            name: "ListEdges";
        };
        listGroups: {
            I: typeof Empty;
            O: typeof Groups;
            kind: MethodKind.Unary;
            name: "ListGroups";
        };
        listNetworkACLs: {
            I: typeof Empty;
            O: typeof NetworkACLs;
            kind: MethodKind.Unary;
            name: "ListNetworkACLs";
        };
        listRoleBindings: {
            I: typeof Empty;
            O: typeof RoleBindings;
            kind: MethodKind.Unary;
            name: "ListRoleBindings";
        };
        listRoles: {
            I: typeof Empty;
            O: typeof Roles;
            kind: MethodKind.Unary;
            name: "ListRoles";
        };
        listRoutes: {
            I: typeof Empty;
            O: typeof Routes;
            kind: MethodKind.Unary;
            name: "ListRoutes";
        };
        putEdge: {
            I: typeof MeshEdge;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutEdge";
        };
        putGroup: {
            I: typeof Group;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutGroup";
        };
        putNetworkACL: {
            I: typeof NetworkACL;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutNetworkACL";
        };
        putRole: {
            I: typeof Role;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutRole";
        };
        putRoleBinding: {
            I: typeof RoleBinding;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutRoleBinding";
        };
        putRoute: {
            I: typeof Route;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutRoute";
        };
    };
    typeName: "v1.Admin";
}
-

Admin is the service that provides cluster admin operations. Most methods +Admin | Webmesh API

Variable AdminConst

Admin: {
    methods: {
        deleteEdge: {
            I: typeof MeshEdge;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteEdge";
        };
        deleteGroup: {
            I: typeof Group;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteGroup";
        };
        deleteNetworkACL: {
            I: typeof NetworkACL;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteNetworkACL";
        };
        deleteRole: {
            I: typeof Role;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteRole";
        };
        deleteRoleBinding: {
            I: typeof RoleBinding;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteRoleBinding";
        };
        deleteRoute: {
            I: typeof Route;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteRoute";
        };
        getEdge: {
            I: typeof MeshEdge;
            O: typeof MeshEdge;
            kind: MethodKind.Unary;
            name: "GetEdge";
        };
        getGroup: {
            I: typeof Group;
            O: typeof Group;
            kind: MethodKind.Unary;
            name: "GetGroup";
        };
        getNetworkACL: {
            I: typeof NetworkACL;
            O: typeof NetworkACL;
            kind: MethodKind.Unary;
            name: "GetNetworkACL";
        };
        getRole: {
            I: typeof Role;
            O: typeof Role;
            kind: MethodKind.Unary;
            name: "GetRole";
        };
        getRoleBinding: {
            I: typeof RoleBinding;
            O: typeof RoleBinding;
            kind: MethodKind.Unary;
            name: "GetRoleBinding";
        };
        getRoute: {
            I: typeof Route;
            O: typeof Route;
            kind: MethodKind.Unary;
            name: "GetRoute";
        };
        listEdges: {
            I: typeof Empty;
            O: typeof MeshEdges;
            kind: MethodKind.Unary;
            name: "ListEdges";
        };
        listGroups: {
            I: typeof Empty;
            O: typeof Groups;
            kind: MethodKind.Unary;
            name: "ListGroups";
        };
        listNetworkACLs: {
            I: typeof Empty;
            O: typeof NetworkACLs;
            kind: MethodKind.Unary;
            name: "ListNetworkACLs";
        };
        listRoleBindings: {
            I: typeof Empty;
            O: typeof RoleBindings;
            kind: MethodKind.Unary;
            name: "ListRoleBindings";
        };
        listRoles: {
            I: typeof Empty;
            O: typeof Roles;
            kind: MethodKind.Unary;
            name: "ListRoles";
        };
        listRoutes: {
            I: typeof Empty;
            O: typeof Routes;
            kind: MethodKind.Unary;
            name: "ListRoutes";
        };
        putEdge: {
            I: typeof MeshEdge;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutEdge";
        };
        putGroup: {
            I: typeof Group;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutGroup";
        };
        putNetworkACL: {
            I: typeof NetworkACL;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutNetworkACL";
        };
        putRole: {
            I: typeof Role;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutRole";
        };
        putRoleBinding: {
            I: typeof RoleBinding;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutRoleBinding";
        };
        putRoute: {
            I: typeof Route;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutRoute";
        };
    };
    typeName: "v1.Admin";
}

Admin is the service that provides cluster admin operations. Most methods require the leader to be contacted.

-
-
-

Type declaration

-
    -
  • -
    Readonly methods: {
        deleteEdge: {
            I: typeof MeshEdge;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteEdge";
        };
        deleteGroup: {
            I: typeof Group;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteGroup";
        };
        deleteNetworkACL: {
            I: typeof NetworkACL;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteNetworkACL";
        };
        deleteRole: {
            I: typeof Role;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteRole";
        };
        deleteRoleBinding: {
            I: typeof RoleBinding;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteRoleBinding";
        };
        deleteRoute: {
            I: typeof Route;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteRoute";
        };
        getEdge: {
            I: typeof MeshEdge;
            O: typeof MeshEdge;
            kind: MethodKind.Unary;
            name: "GetEdge";
        };
        getGroup: {
            I: typeof Group;
            O: typeof Group;
            kind: MethodKind.Unary;
            name: "GetGroup";
        };
        getNetworkACL: {
            I: typeof NetworkACL;
            O: typeof NetworkACL;
            kind: MethodKind.Unary;
            name: "GetNetworkACL";
        };
        getRole: {
            I: typeof Role;
            O: typeof Role;
            kind: MethodKind.Unary;
            name: "GetRole";
        };
        getRoleBinding: {
            I: typeof RoleBinding;
            O: typeof RoleBinding;
            kind: MethodKind.Unary;
            name: "GetRoleBinding";
        };
        getRoute: {
            I: typeof Route;
            O: typeof Route;
            kind: MethodKind.Unary;
            name: "GetRoute";
        };
        listEdges: {
            I: typeof Empty;
            O: typeof MeshEdges;
            kind: MethodKind.Unary;
            name: "ListEdges";
        };
        listGroups: {
            I: typeof Empty;
            O: typeof Groups;
            kind: MethodKind.Unary;
            name: "ListGroups";
        };
        listNetworkACLs: {
            I: typeof Empty;
            O: typeof NetworkACLs;
            kind: MethodKind.Unary;
            name: "ListNetworkACLs";
        };
        listRoleBindings: {
            I: typeof Empty;
            O: typeof RoleBindings;
            kind: MethodKind.Unary;
            name: "ListRoleBindings";
        };
        listRoles: {
            I: typeof Empty;
            O: typeof Roles;
            kind: MethodKind.Unary;
            name: "ListRoles";
        };
        listRoutes: {
            I: typeof Empty;
            O: typeof Routes;
            kind: MethodKind.Unary;
            name: "ListRoutes";
        };
        putEdge: {
            I: typeof MeshEdge;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutEdge";
        };
        putGroup: {
            I: typeof Group;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutGroup";
        };
        putNetworkACL: {
            I: typeof NetworkACL;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutNetworkACL";
        };
        putRole: {
            I: typeof Role;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutRole";
        };
        putRoleBinding: {
            I: typeof RoleBinding;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutRoleBinding";
        };
        putRoute: {
            I: typeof Route;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutRoute";
        };
    }
    -
      -
    • -
      Readonly deleteEdge: {
          I: typeof MeshEdge;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "DeleteEdge";
      }
      -

      DeleteEdge deletes an edge between two nodes.

      -
      -
      -

      Generated

      from rpc v1.Admin.DeleteEdge

      -
      -
        -
      • -
        Readonly I: typeof MeshEdge
        • -
      • -
        Readonly O: typeof Empty
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "DeleteEdge"
      • -
    • -
      Readonly deleteGroup: {
          I: typeof Group;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "DeleteGroup";
      }
      -

      DeleteGroup deletes a group.

      -
      -
      -

      Generated

      from rpc v1.Admin.DeleteGroup

      -
      -
        -
      • -
        Readonly I: typeof Group
        • -
      • -
        Readonly O: typeof Empty
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "DeleteGroup"
      • -
    • -
      Readonly deleteNetworkACL: {
          I: typeof NetworkACL;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "DeleteNetworkACL";
      }
      -

      DeleteNetworkACL deletes a network ACL.

      -
      -
      -

      Generated

      from rpc v1.Admin.DeleteNetworkACL

      -
      -
        -
      • -
        Readonly I: typeof NetworkACL
        • -
      • -
        Readonly O: typeof Empty
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "DeleteNetworkACL"
      • -
    • -
      Readonly deleteRole: {
          I: typeof Role;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "DeleteRole";
      }
      -

      DeleteRole deletes a role.

      -
      -
      -

      Generated

      from rpc v1.Admin.DeleteRole

      -
      -
        -
      • -
        Readonly I: typeof Role
        • -
      • -
        Readonly O: typeof Empty
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "DeleteRole"
      • -
    • -
      Readonly deleteRoleBinding: {
          I: typeof RoleBinding;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "DeleteRoleBinding";
      }
      -

      DeleteRoleBinding deletes a role binding.

      -
      -
      -

      Generated

      from rpc v1.Admin.DeleteRoleBinding

      -
      -
        -
      • -
        Readonly I: typeof RoleBinding
        • -
      • -
        Readonly O: typeof Empty
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "DeleteRoleBinding"
      • -
    • -
      Readonly deleteRoute: {
          I: typeof Route;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "DeleteRoute";
      }
      -

      DeleteRoute deletes a route.

      -
      -
      -

      Generated

      from rpc v1.Admin.DeleteRoute

      -
      -
        -
      • -
        Readonly I: typeof Route
        • -
      • -
        Readonly O: typeof Empty
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "DeleteRoute"
      • -
    • -
      Readonly getEdge: {
          I: typeof MeshEdge;
          O: typeof MeshEdge;
          kind: MethodKind.Unary;
          name: "GetEdge";
      }
      -

      GetEdge gets an edge between two nodes.

      -
      -
      -

      Generated

      from rpc v1.Admin.GetEdge

      -
      -
        -
      • -
        Readonly I: typeof MeshEdge
        • -
      • -
        Readonly O: typeof MeshEdge
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "GetEdge"
      • -
    • -
      Readonly getGroup: {
          I: typeof Group;
          O: typeof Group;
          kind: MethodKind.Unary;
          name: "GetGroup";
      }
      -

      GetGroup gets a group.

      -
      -
      -

      Generated

      from rpc v1.Admin.GetGroup

      -
      -
        -
      • -
        Readonly I: typeof Group
        • -
      • -
        Readonly O: typeof Group
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "GetGroup"
      • -
    • -
      Readonly getNetworkACL: {
          I: typeof NetworkACL;
          O: typeof NetworkACL;
          kind: MethodKind.Unary;
          name: "GetNetworkACL";
      }
      -

      GetNetworkACL gets a network ACL.

      -
      -
      -

      Generated

      from rpc v1.Admin.GetNetworkACL

      -
      -
        -
      • -
        Readonly I: typeof NetworkACL
        • -
      • -
        Readonly O: typeof NetworkACL
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "GetNetworkACL"
      • -
    • -
      Readonly getRole: {
          I: typeof Role;
          O: typeof Role;
          kind: MethodKind.Unary;
          name: "GetRole";
      }
      -

      GetRole gets a role.

      -
      -
      -

      Generated

      from rpc v1.Admin.GetRole

      -
      -
        -
      • -
        Readonly I: typeof Role
        • -
      • -
        Readonly O: typeof Role
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "GetRole"
      • -
    • -
      Readonly getRoleBinding: {
          I: typeof RoleBinding;
          O: typeof RoleBinding;
          kind: MethodKind.Unary;
          name: "GetRoleBinding";
      }
      -

      GetRoleBinding gets a role binding.

      -
      -
      -

      Generated

      from rpc v1.Admin.GetRoleBinding

      -
      -
        -
      • -
        Readonly I: typeof RoleBinding
        • -
      • -
        Readonly O: typeof RoleBinding
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "GetRoleBinding"
      • -
    • -
      Readonly getRoute: {
          I: typeof Route;
          O: typeof Route;
          kind: MethodKind.Unary;
          name: "GetRoute";
      }
      -

      GetRoute gets a route.

      -
      -
      -

      Generated

      from rpc v1.Admin.GetRoute

      -
      -
        -
      • -
        Readonly I: typeof Route
        • -
      • -
        Readonly O: typeof Route
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "GetRoute"
      • -
    • -
      Readonly listEdges: {
          I: typeof Empty;
          O: typeof MeshEdges;
          kind: MethodKind.Unary;
          name: "ListEdges";
      }
      -

      ListEdges gets all current edges.

      -
      -
      -

      Generated

      from rpc v1.Admin.ListEdges

      -
      -
        -
      • -
        Readonly I: typeof Empty
        • -
      • -
        Readonly O: typeof MeshEdges
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "ListEdges"
      • -
    • -
      Readonly listGroups: {
          I: typeof Empty;
          O: typeof Groups;
          kind: MethodKind.Unary;
          name: "ListGroups";
      }
      -

      ListGroups gets all groups.

      -
      -
      -

      Generated

      from rpc v1.Admin.ListGroups

      -
      -
        -
      • -
        Readonly I: typeof Empty
        • -
      • -
        Readonly O: typeof Groups
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "ListGroups"
      • -
    • -
      Readonly listNetworkACLs: {
          I: typeof Empty;
          O: typeof NetworkACLs;
          kind: MethodKind.Unary;
          name: "ListNetworkACLs";
      }
      -

      ListNetworkACLs gets all network ACLs.

      -
      -
      -

      Generated

      from rpc v1.Admin.ListNetworkACLs

      -
      -
        -
      • -
        Readonly I: typeof Empty
        • -
      • -
        Readonly O: typeof NetworkACLs
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "ListNetworkACLs"
      • -
    • -
      Readonly listRoleBindings: {
          I: typeof Empty;
          O: typeof RoleBindings;
          kind: MethodKind.Unary;
          name: "ListRoleBindings";
      }
      -

      ListRoleBindings gets all role bindings.

      -
      -
      -

      Generated

      from rpc v1.Admin.ListRoleBindings

      -
      -
        -
      • -
        Readonly I: typeof Empty
        • -
      • -
        Readonly O: typeof RoleBindings
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "ListRoleBindings"
      • -
    • -
      Readonly listRoles: {
          I: typeof Empty;
          O: typeof Roles;
          kind: MethodKind.Unary;
          name: "ListRoles";
      }
      -

      ListRoles gets all roles.

      -
      -
      -

      Generated

      from rpc v1.Admin.ListRoles

      -
      -
        -
      • -
        Readonly I: typeof Empty
        • -
      • -
        Readonly O: typeof Roles
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "ListRoles"
      • -
    • -
      Readonly listRoutes: {
          I: typeof Empty;
          O: typeof Routes;
          kind: MethodKind.Unary;
          name: "ListRoutes";
      }
      -

      ListRoutes gets all routes.

      -
      -
      -

      Generated

      from rpc v1.Admin.ListRoutes

      -
      -
        -
      • -
        Readonly I: typeof Empty
        • -
      • -
        Readonly O: typeof Routes
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "ListRoutes"
      • -
    • -
      Readonly putEdge: {
          I: typeof MeshEdge;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "PutEdge";
      }
      -

      PutEdge creates or updates an edge between two nodes.

      -
      -
      -

      Generated

      from rpc v1.Admin.PutEdge

      -
      -
        -
      • -
        Readonly I: typeof MeshEdge
        • -
      • -
        Readonly O: typeof Empty
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "PutEdge"
      • -
    • -
      Readonly putGroup: {
          I: typeof Group;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "PutGroup";
      }
      -

      PutGroup creates or updates a group.

      -
      -
      -

      Generated

      from rpc v1.Admin.PutGroup

      -
      -
        -
      • -
        Readonly I: typeof Group
        • -
      • -
        Readonly O: typeof Empty
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "PutGroup"
      • -
    • -
      Readonly putNetworkACL: {
          I: typeof NetworkACL;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "PutNetworkACL";
      }
      -

      PutNetworkACL creates or updates a network ACL.

      -
      -
      -

      Generated

      from rpc v1.Admin.PutNetworkACL

      -
      -
        -
      • -
        Readonly I: typeof NetworkACL
        • -
      • -
        Readonly O: typeof Empty
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "PutNetworkACL"
      • -
    • -
      Readonly putRole: {
          I: typeof Role;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "PutRole";
      }
      -

      PutRole creates or updates a role.

      -
      -
      -

      Generated

      from rpc v1.Admin.PutRole

      -
      -
        -
      • -
        Readonly I: typeof Role
        • -
      • -
        Readonly O: typeof Empty
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "PutRole"
      • -
    • -
      Readonly putRoleBinding: {
          I: typeof RoleBinding;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "PutRoleBinding";
      }
      -

      PutRoleBinding creates or updates a role binding.

      -
      -
      -

      Generated

      from rpc v1.Admin.PutRoleBinding

      -
      -
        -
      • -
        Readonly I: typeof RoleBinding
        • -
      • -
        Readonly O: typeof Empty
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "PutRoleBinding"
      • -
    • -
      Readonly putRoute: {
          I: typeof Route;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "PutRoute";
      }
      -

      PutRoute creates or updates a route.

      -
      -
      -

      Generated

      from rpc v1.Admin.PutRoute

      -
      -
        -
      • -
        Readonly I: typeof Route
        • -
      • -
        Readonly O: typeof Empty
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "PutRoute"
    • -
  • -
    Readonly typeName: "v1.Admin"
-
-

Generated

from service v1.Admin

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Type declaration

  • Readonly methods: {
        deleteEdge: {
            I: typeof MeshEdge;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteEdge";
        };
        deleteGroup: {
            I: typeof Group;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteGroup";
        };
        deleteNetworkACL: {
            I: typeof NetworkACL;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteNetworkACL";
        };
        deleteRole: {
            I: typeof Role;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteRole";
        };
        deleteRoleBinding: {
            I: typeof RoleBinding;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteRoleBinding";
        };
        deleteRoute: {
            I: typeof Route;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "DeleteRoute";
        };
        getEdge: {
            I: typeof MeshEdge;
            O: typeof MeshEdge;
            kind: MethodKind.Unary;
            name: "GetEdge";
        };
        getGroup: {
            I: typeof Group;
            O: typeof Group;
            kind: MethodKind.Unary;
            name: "GetGroup";
        };
        getNetworkACL: {
            I: typeof NetworkACL;
            O: typeof NetworkACL;
            kind: MethodKind.Unary;
            name: "GetNetworkACL";
        };
        getRole: {
            I: typeof Role;
            O: typeof Role;
            kind: MethodKind.Unary;
            name: "GetRole";
        };
        getRoleBinding: {
            I: typeof RoleBinding;
            O: typeof RoleBinding;
            kind: MethodKind.Unary;
            name: "GetRoleBinding";
        };
        getRoute: {
            I: typeof Route;
            O: typeof Route;
            kind: MethodKind.Unary;
            name: "GetRoute";
        };
        listEdges: {
            I: typeof Empty;
            O: typeof MeshEdges;
            kind: MethodKind.Unary;
            name: "ListEdges";
        };
        listGroups: {
            I: typeof Empty;
            O: typeof Groups;
            kind: MethodKind.Unary;
            name: "ListGroups";
        };
        listNetworkACLs: {
            I: typeof Empty;
            O: typeof NetworkACLs;
            kind: MethodKind.Unary;
            name: "ListNetworkACLs";
        };
        listRoleBindings: {
            I: typeof Empty;
            O: typeof RoleBindings;
            kind: MethodKind.Unary;
            name: "ListRoleBindings";
        };
        listRoles: {
            I: typeof Empty;
            O: typeof Roles;
            kind: MethodKind.Unary;
            name: "ListRoles";
        };
        listRoutes: {
            I: typeof Empty;
            O: typeof Routes;
            kind: MethodKind.Unary;
            name: "ListRoutes";
        };
        putEdge: {
            I: typeof MeshEdge;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutEdge";
        };
        putGroup: {
            I: typeof Group;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutGroup";
        };
        putNetworkACL: {
            I: typeof NetworkACL;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutNetworkACL";
        };
        putRole: {
            I: typeof Role;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutRole";
        };
        putRoleBinding: {
            I: typeof RoleBinding;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutRoleBinding";
        };
        putRoute: {
            I: typeof Route;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "PutRoute";
        };
    }
    • Readonly deleteEdge: {
          I: typeof MeshEdge;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "DeleteEdge";
      }

      DeleteEdge deletes an edge between two nodes.

      +

      Generated

      from rpc v1.Admin.DeleteEdge

      +
      • Readonly I: typeof MeshEdge
      • Readonly O: typeof Empty
      • Readonly kind: MethodKind.Unary
      • Readonly name: "DeleteEdge"
    • Readonly deleteGroup: {
          I: typeof Group;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "DeleteGroup";
      }

      DeleteGroup deletes a group.

      +

      Generated

      from rpc v1.Admin.DeleteGroup

      +
      • Readonly I: typeof Group
      • Readonly O: typeof Empty
      • Readonly kind: MethodKind.Unary
      • Readonly name: "DeleteGroup"
    • Readonly deleteNetworkACL: {
          I: typeof NetworkACL;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "DeleteNetworkACL";
      }

      DeleteNetworkACL deletes a network ACL.

      +

      Generated

      from rpc v1.Admin.DeleteNetworkACL

      +
      • Readonly I: typeof NetworkACL
      • Readonly O: typeof Empty
      • Readonly kind: MethodKind.Unary
      • Readonly name: "DeleteNetworkACL"
    • Readonly deleteRole: {
          I: typeof Role;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "DeleteRole";
      }

      DeleteRole deletes a role.

      +

      Generated

      from rpc v1.Admin.DeleteRole

      +
      • Readonly I: typeof Role
      • Readonly O: typeof Empty
      • Readonly kind: MethodKind.Unary
      • Readonly name: "DeleteRole"
    • Readonly deleteRoleBinding: {
          I: typeof RoleBinding;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "DeleteRoleBinding";
      }

      DeleteRoleBinding deletes a role binding.

      +

      Generated

      from rpc v1.Admin.DeleteRoleBinding

      +
      • Readonly I: typeof RoleBinding
      • Readonly O: typeof Empty
      • Readonly kind: MethodKind.Unary
      • Readonly name: "DeleteRoleBinding"
    • Readonly deleteRoute: {
          I: typeof Route;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "DeleteRoute";
      }

      DeleteRoute deletes a route.

      +

      Generated

      from rpc v1.Admin.DeleteRoute

      +
      • Readonly I: typeof Route
      • Readonly O: typeof Empty
      • Readonly kind: MethodKind.Unary
      • Readonly name: "DeleteRoute"
    • Readonly getEdge: {
          I: typeof MeshEdge;
          O: typeof MeshEdge;
          kind: MethodKind.Unary;
          name: "GetEdge";
      }

      GetEdge gets an edge between two nodes.

      +

      Generated

      from rpc v1.Admin.GetEdge

      +
      • Readonly I: typeof MeshEdge
      • Readonly O: typeof MeshEdge
      • Readonly kind: MethodKind.Unary
      • Readonly name: "GetEdge"
    • Readonly getGroup: {
          I: typeof Group;
          O: typeof Group;
          kind: MethodKind.Unary;
          name: "GetGroup";
      }

      GetGroup gets a group.

      +

      Generated

      from rpc v1.Admin.GetGroup

      +
      • Readonly I: typeof Group
      • Readonly O: typeof Group
      • Readonly kind: MethodKind.Unary
      • Readonly name: "GetGroup"
    • Readonly getNetworkACL: {
          I: typeof NetworkACL;
          O: typeof NetworkACL;
          kind: MethodKind.Unary;
          name: "GetNetworkACL";
      }

      GetNetworkACL gets a network ACL.

      +

      Generated

      from rpc v1.Admin.GetNetworkACL

      +
      • Readonly I: typeof NetworkACL
      • Readonly O: typeof NetworkACL
      • Readonly kind: MethodKind.Unary
      • Readonly name: "GetNetworkACL"
    • Readonly getRole: {
          I: typeof Role;
          O: typeof Role;
          kind: MethodKind.Unary;
          name: "GetRole";
      }

      GetRole gets a role.

      +

      Generated

      from rpc v1.Admin.GetRole

      +
      • Readonly I: typeof Role
      • Readonly O: typeof Role
      • Readonly kind: MethodKind.Unary
      • Readonly name: "GetRole"
    • Readonly getRoleBinding: {
          I: typeof RoleBinding;
          O: typeof RoleBinding;
          kind: MethodKind.Unary;
          name: "GetRoleBinding";
      }

      GetRoleBinding gets a role binding.

      +

      Generated

      from rpc v1.Admin.GetRoleBinding

      +
      • Readonly I: typeof RoleBinding
      • Readonly O: typeof RoleBinding
      • Readonly kind: MethodKind.Unary
      • Readonly name: "GetRoleBinding"
    • Readonly getRoute: {
          I: typeof Route;
          O: typeof Route;
          kind: MethodKind.Unary;
          name: "GetRoute";
      }

      GetRoute gets a route.

      +

      Generated

      from rpc v1.Admin.GetRoute

      +
      • Readonly I: typeof Route
      • Readonly O: typeof Route
      • Readonly kind: MethodKind.Unary
      • Readonly name: "GetRoute"
    • Readonly listEdges: {
          I: typeof Empty;
          O: typeof MeshEdges;
          kind: MethodKind.Unary;
          name: "ListEdges";
      }

      ListEdges gets all current edges.

      +

      Generated

      from rpc v1.Admin.ListEdges

      +
      • Readonly I: typeof Empty
      • Readonly O: typeof MeshEdges
      • Readonly kind: MethodKind.Unary
      • Readonly name: "ListEdges"
    • Readonly listGroups: {
          I: typeof Empty;
          O: typeof Groups;
          kind: MethodKind.Unary;
          name: "ListGroups";
      }

      ListGroups gets all groups.

      +

      Generated

      from rpc v1.Admin.ListGroups

      +
      • Readonly I: typeof Empty
      • Readonly O: typeof Groups
      • Readonly kind: MethodKind.Unary
      • Readonly name: "ListGroups"
    • Readonly listNetworkACLs: {
          I: typeof Empty;
          O: typeof NetworkACLs;
          kind: MethodKind.Unary;
          name: "ListNetworkACLs";
      }

      ListNetworkACLs gets all network ACLs.

      +

      Generated

      from rpc v1.Admin.ListNetworkACLs

      +
      • Readonly I: typeof Empty
      • Readonly O: typeof NetworkACLs
      • Readonly kind: MethodKind.Unary
      • Readonly name: "ListNetworkACLs"
    • Readonly listRoleBindings: {
          I: typeof Empty;
          O: typeof RoleBindings;
          kind: MethodKind.Unary;
          name: "ListRoleBindings";
      }

      ListRoleBindings gets all role bindings.

      +

      Generated

      from rpc v1.Admin.ListRoleBindings

      +
      • Readonly I: typeof Empty
      • Readonly O: typeof RoleBindings
      • Readonly kind: MethodKind.Unary
      • Readonly name: "ListRoleBindings"
    • Readonly listRoles: {
          I: typeof Empty;
          O: typeof Roles;
          kind: MethodKind.Unary;
          name: "ListRoles";
      }

      ListRoles gets all roles.

      +

      Generated

      from rpc v1.Admin.ListRoles

      +
      • Readonly I: typeof Empty
      • Readonly O: typeof Roles
      • Readonly kind: MethodKind.Unary
      • Readonly name: "ListRoles"
    • Readonly listRoutes: {
          I: typeof Empty;
          O: typeof Routes;
          kind: MethodKind.Unary;
          name: "ListRoutes";
      }

      ListRoutes gets all routes.

      +

      Generated

      from rpc v1.Admin.ListRoutes

      +
      • Readonly I: typeof Empty
      • Readonly O: typeof Routes
      • Readonly kind: MethodKind.Unary
      • Readonly name: "ListRoutes"
    • Readonly putEdge: {
          I: typeof MeshEdge;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "PutEdge";
      }

      PutEdge creates or updates an edge between two nodes.

      +

      Generated

      from rpc v1.Admin.PutEdge

      +
      • Readonly I: typeof MeshEdge
      • Readonly O: typeof Empty
      • Readonly kind: MethodKind.Unary
      • Readonly name: "PutEdge"
    • Readonly putGroup: {
          I: typeof Group;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "PutGroup";
      }

      PutGroup creates or updates a group.

      +

      Generated

      from rpc v1.Admin.PutGroup

      +
      • Readonly I: typeof Group
      • Readonly O: typeof Empty
      • Readonly kind: MethodKind.Unary
      • Readonly name: "PutGroup"
    • Readonly putNetworkACL: {
          I: typeof NetworkACL;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "PutNetworkACL";
      }

      PutNetworkACL creates or updates a network ACL.

      +

      Generated

      from rpc v1.Admin.PutNetworkACL

      +
      • Readonly I: typeof NetworkACL
      • Readonly O: typeof Empty
      • Readonly kind: MethodKind.Unary
      • Readonly name: "PutNetworkACL"
    • Readonly putRole: {
          I: typeof Role;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "PutRole";
      }

      PutRole creates or updates a role.

      +

      Generated

      from rpc v1.Admin.PutRole

      +
      • Readonly I: typeof Role
      • Readonly O: typeof Empty
      • Readonly kind: MethodKind.Unary
      • Readonly name: "PutRole"
    • Readonly putRoleBinding: {
          I: typeof RoleBinding;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "PutRoleBinding";
      }

      PutRoleBinding creates or updates a role binding.

      +

      Generated

      from rpc v1.Admin.PutRoleBinding

      +
      • Readonly I: typeof RoleBinding
      • Readonly O: typeof Empty
      • Readonly kind: MethodKind.Unary
      • Readonly name: "PutRoleBinding"
    • Readonly putRoute: {
          I: typeof Route;
          O: typeof Empty;
          kind: MethodKind.Unary;
          name: "PutRoute";
      }

      PutRoute creates or updates a route.

      +

      Generated

      from rpc v1.Admin.PutRoute

      +
      • Readonly I: typeof Route
      • Readonly O: typeof Empty
      • Readonly kind: MethodKind.Unary
      • Readonly name: "PutRoute"
  • Readonly typeName: "v1.Admin"

Generated

from service v1.Admin

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/app_connect.AppDaemon.html b/docs/variables/app_connect.AppDaemon.html index b93e30e4..71aabda6 100644 --- a/docs/variables/app_connect.AppDaemon.html +++ b/docs/variables/app_connect.AppDaemon.html @@ -1,160 +1,15 @@ -AppDaemon | Webmesh API
-
- -
-
-
-
- -

Variable AppDaemonConst

-
AppDaemon: {
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: MethodKind.Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: MethodKind.Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: MethodKind.Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: MethodKind.Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: MethodKind.Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}
-

AppDaemon is exposed by nodes running in the app-daemon mode. This mode -allows the node to run in an idle state and be controlled by an application. -The application can send commands to the node to execute tasks and receive -responses.

-
-
-

Type declaration

-
    -
  • -
    Readonly methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: MethodKind.Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: MethodKind.Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: MethodKind.Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: MethodKind.Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: MethodKind.Unary;
            name: "Status";
        };
    }
    -
      -
    • -
      Readonly connect: {
          I: typeof ConnectRequest;
          O: typeof ConnectResponse;
          kind: MethodKind.Unary;
          name: "Connect";
      }
      -

      Connect is used to establish a connection between the node and a mesh.

      -
      -
      -

      Generated

      from rpc v1.AppDaemon.Connect

      -
      -
      • -
    • -
      Readonly disconnect: {
          I: typeof DisconnectRequest;
          O: typeof DisconnectResponse;
          kind: MethodKind.Unary;
          name: "Disconnect";
      }
      -

      Disconnect is used to disconnect the node from a mesh.

      -
      -
      -

      Generated

      from rpc v1.AppDaemon.Disconnect

      -
      -
      • -
    • -
      Readonly metrics: {
          I: typeof MetricsRequest;
          O: typeof MetricsResponse;
          kind: MethodKind.Unary;
          name: "Metrics";
      }
      -

      Metrics is used to retrieve interface metrics for one or more mesh connections.

      -
      -
      -

      Generated

      from rpc v1.AppDaemon.Metrics

      -
      -
      • -
    • -
      Readonly query: {
          I: typeof AppQueryRequest;
          O: typeof QueryResponse;
          kind: MethodKind.Unary;
          name: "Query";
      }
      -

      Query is used to query a mesh connection for information.

      -
      -
      -

      Generated

      from rpc v1.AppDaemon.Query

      -
      -
      • -
    • -
      Readonly status: {
          I: typeof StatusRequest;
          O: typeof StatusResponse;
          kind: MethodKind.Unary;
          name: "Status";
      }
      -

      Status is used to retrieve the status of a mesh connection.

      -
      -
      -

      Generated

      from rpc v1.AppDaemon.Status

      -
      -
        -
      • -
        Readonly I: typeof StatusRequest
        • -
      • -
        Readonly O: typeof StatusResponse
        • -
      • -
        Readonly kind: MethodKind.Unary
        • -
      • -
        Readonly name: "Status"
    • -
  • -
    Readonly typeName: "v1.AppDaemon"
-
-

Generated

from service v1.AppDaemon

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +AppDaemon | Webmesh API

Variable AppDaemonConst

AppDaemon: {
    methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: MethodKind.Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: MethodKind.Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: MethodKind.Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: MethodKind.Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: MethodKind.Unary;
            name: "Status";
        };
    };
    typeName: "v1.AppDaemon";
}

AppDaemon is exposed by nodes running in the daemon mode. This mode allows the +node to run in an idle state and be controlled by an application. The application +can send commands to the node to execute tasks and receive responses.

+

Type declaration

  • Readonly methods: {
        connect: {
            I: typeof ConnectRequest;
            O: typeof ConnectResponse;
            kind: MethodKind.Unary;
            name: "Connect";
        };
        disconnect: {
            I: typeof DisconnectRequest;
            O: typeof DisconnectResponse;
            kind: MethodKind.Unary;
            name: "Disconnect";
        };
        metrics: {
            I: typeof MetricsRequest;
            O: typeof MetricsResponse;
            kind: MethodKind.Unary;
            name: "Metrics";
        };
        query: {
            I: typeof AppQueryRequest;
            O: typeof QueryResponse;
            kind: MethodKind.Unary;
            name: "Query";
        };
        status: {
            I: typeof StatusRequest;
            O: typeof StatusResponse;
            kind: MethodKind.Unary;
            name: "Status";
        };
    }
    • Readonly connect: {
          I: typeof ConnectRequest;
          O: typeof ConnectResponse;
          kind: MethodKind.Unary;
          name: "Connect";
      }

      Connect is used to establish a connection between the node and a mesh.

      +

      Generated

      from rpc v1.AppDaemon.Connect

      +
    • Readonly disconnect: {
          I: typeof DisconnectRequest;
          O: typeof DisconnectResponse;
          kind: MethodKind.Unary;
          name: "Disconnect";
      }

      Disconnect is used to disconnect the node from a mesh.

      +

      Generated

      from rpc v1.AppDaemon.Disconnect

      +
    • Readonly metrics: {
          I: typeof MetricsRequest;
          O: typeof MetricsResponse;
          kind: MethodKind.Unary;
          name: "Metrics";
      }

      Metrics is used to retrieve interface metrics for one or more mesh connections.

      +

      Generated

      from rpc v1.AppDaemon.Metrics

      +
    • Readonly query: {
          I: typeof AppQueryRequest;
          O: typeof QueryResponse;
          kind: MethodKind.Unary;
          name: "Query";
      }

      Query is used to query a mesh connection for information.

      +

      Generated

      from rpc v1.AppDaemon.Query

      +
    • Readonly status: {
          I: typeof StatusRequest;
          O: typeof StatusResponse;
          kind: MethodKind.Unary;
          name: "Status";
      }

      Status is used to retrieve the status of a mesh connection.

      +

      Generated

      from rpc v1.AppDaemon.Status

      +
  • Readonly typeName: "v1.AppDaemon"

Generated

from service v1.AppDaemon

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/members_connect.Membership.html b/docs/variables/members_connect.Membership.html index e31dacc8..9f80de8c 100644 --- a/docs/variables/members_connect.Membership.html +++ b/docs/variables/members_connect.Membership.html @@ -1,182 +1,24 @@ -Membership | Webmesh API
-
- -
-
-
-
- -

Variable MembershipConst

-
Membership: {
    methods: {
        apply: {
            I: typeof RaftLogEntry;
            O: typeof RaftApplyResponse;
            kind: MethodKind.Unary;
            name: "Apply";
        };
        getCurrentConsensus: {
            I: typeof StorageConsensusRequest;
            O: typeof StorageConsensusResponse;
            kind: MethodKind.Unary;
            name: "GetCurrentConsensus";
        };
        join: {
            I: typeof JoinRequest;
            O: typeof JoinResponse;
            kind: MethodKind.Unary;
            name: "Join";
        };
        leave: {
            I: typeof LeaveRequest;
            O: typeof LeaveResponse;
            kind: MethodKind.Unary;
            name: "Leave";
        };
        subscribePeers: {
            I: typeof SubscribePeersRequest;
            O: typeof PeerConfigurations;
            kind: MethodKind.ServerStreaming;
            name: "SubscribePeers";
        };
        update: {
            I: typeof UpdateRequest;
            O: typeof UpdateResponse;
            kind: MethodKind.Unary;
            name: "Update";
        };
    };
    typeName: "v1.Membership";
}
-

The membership service is exposed on storage-providing nodes to allow nodes to join +Membership | Webmesh API

Variable MembershipConst

Membership: {
    methods: {
        apply: {
            I: typeof RaftLogEntry;
            O: typeof RaftApplyResponse;
            kind: MethodKind.Unary;
            name: "Apply";
        };
        getCurrentConsensus: {
            I: typeof StorageConsensusRequest;
            O: typeof StorageConsensusResponse;
            kind: MethodKind.Unary;
            name: "GetCurrentConsensus";
        };
        join: {
            I: typeof JoinRequest;
            O: typeof JoinResponse;
            kind: MethodKind.Unary;
            name: "Join";
        };
        leave: {
            I: typeof LeaveRequest;
            O: typeof LeaveResponse;
            kind: MethodKind.Unary;
            name: "Leave";
        };
        subscribePeers: {
            I: typeof SubscribePeersRequest;
            O: typeof PeerConfigurations;
            kind: MethodKind.ServerStreaming;
            name: "SubscribePeers";
        };
        update: {
            I: typeof UpdateRequest;
            O: typeof UpdateResponse;
            kind: MethodKind.Unary;
            name: "Update";
        };
    };
    typeName: "v1.Membership";
}

The membership service is exposed on storage-providing nodes to allow nodes to join and leave the cluster. This service is meant to be made available publicly to allow people in from the outside.

-
-
-

Type declaration

-
    -
  • -
    Readonly methods: {
        apply: {
            I: typeof RaftLogEntry;
            O: typeof RaftApplyResponse;
            kind: MethodKind.Unary;
            name: "Apply";
        };
        getCurrentConsensus: {
            I: typeof StorageConsensusRequest;
            O: typeof StorageConsensusResponse;
            kind: MethodKind.Unary;
            name: "GetCurrentConsensus";
        };
        join: {
            I: typeof JoinRequest;
            O: typeof JoinResponse;
            kind: MethodKind.Unary;
            name: "Join";
        };
        leave: {
            I: typeof LeaveRequest;
            O: typeof LeaveResponse;
            kind: MethodKind.Unary;
            name: "Leave";
        };
        subscribePeers: {
            I: typeof SubscribePeersRequest;
            O: typeof PeerConfigurations;
            kind: MethodKind.ServerStreaming;
            name: "SubscribePeers";
        };
        update: {
            I: typeof UpdateRequest;
            O: typeof UpdateResponse;
            kind: MethodKind.Unary;
            name: "Update";
        };
    }
    -
      -
    • -
      Readonly apply: {
          I: typeof RaftLogEntry;
          O: typeof RaftApplyResponse;
          kind: MethodKind.Unary;
          name: "Apply";
      }
      -

      Apply is used by voting nodes to request a log entry be applied to the state machine. +

      Type declaration

      • Readonly methods: {
            apply: {
                I: typeof RaftLogEntry;
                O: typeof RaftApplyResponse;
                kind: MethodKind.Unary;
                name: "Apply";
            };
            getCurrentConsensus: {
                I: typeof StorageConsensusRequest;
                O: typeof StorageConsensusResponse;
                kind: MethodKind.Unary;
                name: "GetCurrentConsensus";
            };
            join: {
                I: typeof JoinRequest;
                O: typeof JoinResponse;
                kind: MethodKind.Unary;
                name: "Join";
            };
            leave: {
                I: typeof LeaveRequest;
                O: typeof LeaveResponse;
                kind: MethodKind.Unary;
                name: "Leave";
            };
            subscribePeers: {
                I: typeof SubscribePeersRequest;
                O: typeof PeerConfigurations;
                kind: MethodKind.ServerStreaming;
                name: "SubscribePeers";
            };
            update: {
                I: typeof UpdateRequest;
                O: typeof UpdateResponse;
                kind: MethodKind.Unary;
                name: "Update";
            };
        }
        • Readonly apply: {
              I: typeof RaftLogEntry;
              O: typeof RaftApplyResponse;
              kind: MethodKind.Unary;
              name: "Apply";
          }

          Apply is used by voting nodes to request a log entry be applied to the state machine. This is only available on the leader, and can only be called by nodes that are allowed to vote. This is only used by the built-in raft storage implementation.

          -
          -
          -

          Generated

          from rpc v1.Membership.Apply

          -
          -
          • -
        • -
          Readonly getCurrentConsensus: {
              I: typeof StorageConsensusRequest;
              O: typeof StorageConsensusResponse;
              kind: MethodKind.Unary;
              name: "GetCurrentConsensus";
          }
          -

          GetCurrentConsensus returns the current Storage consensus configuration.

          -
          -
          -

          Generated

          from rpc v1.Membership.GetCurrentConsensus

          -
          -
          • -
        • -
          Readonly join: {
              I: typeof JoinRequest;
              O: typeof JoinResponse;
              kind: MethodKind.Unary;
              name: "Join";
          }
          -

          Join is used to join a node to the mesh.

          -
          -
          -

          Generated

          from rpc v1.Membership.Join

          -
          -
            -
          • -
            Readonly I: typeof JoinRequest
            • -
          • -
            Readonly O: typeof JoinResponse
            • -
          • -
            Readonly kind: MethodKind.Unary
            • -
          • -
            Readonly name: "Join"
          • -
        • -
          Readonly leave: {
              I: typeof LeaveRequest;
              O: typeof LeaveResponse;
              kind: MethodKind.Unary;
              name: "Leave";
          }
          -

          Leave is used to remove a node from the mesh. The node will be removed from the mesh +

          Generated

          from rpc v1.Membership.Apply

          +
        • Readonly getCurrentConsensus: {
              I: typeof StorageConsensusRequest;
              O: typeof StorageConsensusResponse;
              kind: MethodKind.Unary;
              name: "GetCurrentConsensus";
          }

          GetCurrentConsensus returns the current Storage consensus configuration.

          +

          Generated

          from rpc v1.Membership.GetCurrentConsensus

          +
        • Readonly join: {
              I: typeof JoinRequest;
              O: typeof JoinResponse;
              kind: MethodKind.Unary;
              name: "Join";
          }

          Join is used to join a node to the mesh.

          +

          Generated

          from rpc v1.Membership.Join

          +
        • Readonly leave: {
              I: typeof LeaveRequest;
              O: typeof LeaveResponse;
              kind: MethodKind.Unary;
              name: "Leave";
          }

          Leave is used to remove a node from the mesh. The node will be removed from the mesh and will no longer be able to query the mesh state or vote in elections.

          -
          -
          -

          Generated

          from rpc v1.Membership.Leave

          -
          -
            -
          • -
            Readonly I: typeof LeaveRequest
            • -
          • -
            Readonly O: typeof LeaveResponse
            • -
          • -
            Readonly kind: MethodKind.Unary
            • -
          • -
            Readonly name: "Leave"
          • -
        • -
          Readonly subscribePeers: {
              I: typeof SubscribePeersRequest;
              O: typeof PeerConfigurations;
              kind: MethodKind.ServerStreaming;
              name: "SubscribePeers";
          }
          -

          SubscribePeers subscribes to the peer configuration for the given node. The node +

          Generated

          from rpc v1.Membership.Leave

          +
        • Readonly subscribePeers: {
              I: typeof SubscribePeersRequest;
              O: typeof PeerConfigurations;
              kind: MethodKind.ServerStreaming;
              name: "SubscribePeers";
          }

          SubscribePeers subscribes to the peer configuration for the given node. The node will receive updates to the peer configuration as it changes.

          -
          -
          -

          Generated

          from rpc v1.Membership.SubscribePeers

          -
          -
          • -
        • -
          Readonly update: {
              I: typeof UpdateRequest;
              O: typeof UpdateResponse;
              kind: MethodKind.Unary;
              name: "Update";
          }
          -

          Update is used by a node to update its state in the mesh. The node will be updated +

          Generated

          from rpc v1.Membership.SubscribePeers

          +
        • Readonly update: {
              I: typeof UpdateRequest;
              O: typeof UpdateResponse;
              kind: MethodKind.Unary;
              name: "Update";
          }

          Update is used by a node to update its state in the mesh. The node will be updated in the mesh and will be able to query the mesh state or vote in elections. Only non-empty fields will be updated. It is almost semantically equivalent to a join request with the same ID, but redefined to avoid confusion and to allow for expansion.

          -
          -
          -

          Generated

          from rpc v1.Membership.Update

          -
          -
            -
          • -
            Readonly I: typeof UpdateRequest
            • -
          • -
            Readonly O: typeof UpdateResponse
            • -
          • -
            Readonly kind: MethodKind.Unary
            • -
          • -
            Readonly name: "Update"
        • -
      • -
        Readonly typeName: "v1.Membership"
      -
      -

      Generated

      from service v1.Membership

      -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated

from rpc v1.Membership.Update

+
  • Readonly typeName: "v1.Membership"

    • Generated

    from service v1.Membership

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/mesh_connect.Mesh.html b/docs/variables/mesh_connect.Mesh.html index 7cf22f47..8700dd4c 100644 --- a/docs/variables/mesh_connect.Mesh.html +++ b/docs/variables/mesh_connect.Mesh.html @@ -1,127 +1,11 @@ -Mesh | Webmesh API
    -
    - -
    -
    -
    -
    - -

    Variable MeshConst

    -
    Mesh: {
        methods: {
            getMeshGraph: {
                I: typeof Empty;
                O: typeof MeshGraph;
                kind: MethodKind.Unary;
                name: "GetMeshGraph";
            };
            getNode: {
                I: typeof GetNodeRequest;
                O: typeof MeshNode;
                kind: MethodKind.Unary;
                name: "GetNode";
            };
            listNodes: {
                I: typeof Empty;
                O: typeof NodeList;
                kind: MethodKind.Unary;
                name: "ListNodes";
            };
        };
        typeName: "v1.Mesh";
    }
    -

    Mesh is a service that can optionally be exposed by a node. It provides methods for +Mesh | Webmesh API

    Variable MeshConst

    Mesh: {
        methods: {
            getMeshGraph: {
                I: typeof Empty;
                O: typeof MeshGraph;
                kind: MethodKind.Unary;
                name: "GetMeshGraph";
            };
            getNode: {
                I: typeof GetNodeRequest;
                O: typeof MeshNode;
                kind: MethodKind.Unary;
                name: "GetNode";
            };
            listNodes: {
                I: typeof Empty;
                O: typeof NodeList;
                kind: MethodKind.Unary;
                name: "ListNodes";
            };
        };
        typeName: "v1.Mesh";
    }

    Mesh is a service that can optionally be exposed by a node. It provides methods for interfacing with the webmesh from the outside.

    -
    -
    -

    Type declaration

    -
      -
    • -
      Readonly methods: {
          getMeshGraph: {
              I: typeof Empty;
              O: typeof MeshGraph;
              kind: MethodKind.Unary;
              name: "GetMeshGraph";
          };
          getNode: {
              I: typeof GetNodeRequest;
              O: typeof MeshNode;
              kind: MethodKind.Unary;
              name: "GetNode";
          };
          listNodes: {
              I: typeof Empty;
              O: typeof NodeList;
              kind: MethodKind.Unary;
              name: "ListNodes";
          };
      }
      -
        -
      • -
        Readonly getMeshGraph: {
            I: typeof Empty;
            O: typeof MeshGraph;
            kind: MethodKind.Unary;
            name: "GetMeshGraph";
        }
        -

        GetMeshGraph fetches the mesh graph. It returns a list of nodes, +

        Type declaration

        • Readonly methods: {
              getMeshGraph: {
                  I: typeof Empty;
                  O: typeof MeshGraph;
                  kind: MethodKind.Unary;
                  name: "GetMeshGraph";
              };
              getNode: {
                  I: typeof GetNodeRequest;
                  O: typeof MeshNode;
                  kind: MethodKind.Unary;
                  name: "GetNode";
              };
              listNodes: {
                  I: typeof Empty;
                  O: typeof NodeList;
                  kind: MethodKind.Unary;
                  name: "ListNodes";
              };
          }
          • Readonly getMeshGraph: {
                I: typeof Empty;
                O: typeof MeshGraph;
                kind: MethodKind.Unary;
                name: "GetMeshGraph";
            }

            GetMeshGraph fetches the mesh graph. It returns a list of nodes, edges, and a rendering in the dot format.

            -
            -
            -

            Generated

            from rpc v1.Mesh.GetMeshGraph

            -
            -
              -
            • -
              Readonly I: typeof Empty
              • -
            • -
              Readonly O: typeof MeshGraph
              • -
            • -
              Readonly kind: MethodKind.Unary
              • -
            • -
              Readonly name: "GetMeshGraph"
            • -
          • -
            Readonly getNode: {
                I: typeof GetNodeRequest;
                O: typeof MeshNode;
                kind: MethodKind.Unary;
                name: "GetNode";
            }
            -

            GetNode gets a node by ID.

            -
            -
            -

            Generated

            from rpc v1.Mesh.GetNode

            -
            -
              -
            • -
              Readonly I: typeof GetNodeRequest
              • -
            • -
              Readonly O: typeof MeshNode
              • -
            • -
              Readonly kind: MethodKind.Unary
              • -
            • -
              Readonly name: "GetNode"
            • -
          • -
            Readonly listNodes: {
                I: typeof Empty;
                O: typeof NodeList;
                kind: MethodKind.Unary;
                name: "ListNodes";
            }
            -

            ListNodes lists all nodes.

            -
            -
            -

            Generated

            from rpc v1.Mesh.ListNodes

            -
            -
              -
            • -
              Readonly I: typeof Empty
              • -
            • -
              Readonly O: typeof NodeList
              • -
            • -
              Readonly kind: MethodKind.Unary
              • -
            • -
              Readonly name: "ListNodes"
          • -
        • -
          Readonly typeName: "v1.Mesh"
        -
        -

        Generated

        from service v1.Mesh

        -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated

    from rpc v1.Mesh.GetMeshGraph

    +
    • Readonly I: typeof Empty
    • Readonly O: typeof MeshGraph
    • Readonly kind: MethodKind.Unary
    • Readonly name: "GetMeshGraph"
  • Readonly getNode: {
        I: typeof GetNodeRequest;
        O: typeof MeshNode;
        kind: MethodKind.Unary;
        name: "GetNode";
    }

    GetNode gets a node by ID.

    +

    Generated

    from rpc v1.Mesh.GetNode

    +
    • Readonly I: typeof GetNodeRequest
    • Readonly O: typeof MeshNode
    • Readonly kind: MethodKind.Unary
    • Readonly name: "GetNode"
  • Readonly listNodes: {
        I: typeof Empty;
        O: typeof NodeList;
        kind: MethodKind.Unary;
        name: "ListNodes";
    }

    ListNodes lists all nodes.

    +

    Generated

    from rpc v1.Mesh.ListNodes

    +
    • Readonly I: typeof Empty
    • Readonly O: typeof NodeList
    • Readonly kind: MethodKind.Unary
    • Readonly name: "ListNodes"
  • Readonly typeName: "v1.Mesh"

    • Generated

    from service v1.Mesh

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/node_connect.Node.html b/docs/variables/node_connect.Node.html index eaadc6b3..ad6b7c12 100644 --- a/docs/variables/node_connect.Node.html +++ b/docs/variables/node_connect.Node.html @@ -1,135 +1,19 @@ -Node | Webmesh API
    -
    - -
    -
    -
    -
    - -

    Variable NodeConst

    -
    Node: {
        methods: {
            getStatus: {
                I: typeof GetStatusRequest;
                O: typeof Status;
                kind: MethodKind.Unary;
                name: "GetStatus";
            };
            negotiateDataChannel: {
                I: typeof DataChannelNegotiation;
                O: typeof DataChannelNegotiation;
                kind: MethodKind.BiDiStreaming;
                name: "NegotiateDataChannel";
            };
            receiveSignalChannel: {
                I: typeof WebRTCSignal;
                O: typeof WebRTCSignal;
                kind: MethodKind.BiDiStreaming;
                name: "ReceiveSignalChannel";
            };
        };
        typeName: "v1.Node";
    }
    -

    Node is the service exposed on every node in the mesh to communicate network +Node | Webmesh API

    Variable NodeConst

    Node: {
        methods: {
            getStatus: {
                I: typeof GetStatusRequest;
                O: typeof Status;
                kind: MethodKind.Unary;
                name: "GetStatus";
            };
            negotiateDataChannel: {
                I: typeof DataChannelNegotiation;
                O: typeof DataChannelNegotiation;
                kind: MethodKind.BiDiStreaming;
                name: "NegotiateDataChannel";
            };
            receiveSignalChannel: {
                I: typeof WebRTCSignal;
                O: typeof WebRTCSignal;
                kind: MethodKind.BiDiStreaming;
                name: "ReceiveSignalChannel";
            };
        };
        typeName: "v1.Node";
    }

    Node is the service exposed on every node in the mesh to communicate network information amongst themselves and facilitate inbound/outbound connections.

    -
    -
    -

    Type declaration

    -
      -
    • -
      Readonly methods: {
          getStatus: {
              I: typeof GetStatusRequest;
              O: typeof Status;
              kind: MethodKind.Unary;
              name: "GetStatus";
          };
          negotiateDataChannel: {
              I: typeof DataChannelNegotiation;
              O: typeof DataChannelNegotiation;
              kind: MethodKind.BiDiStreaming;
              name: "NegotiateDataChannel";
          };
          receiveSignalChannel: {
              I: typeof WebRTCSignal;
              O: typeof WebRTCSignal;
              kind: MethodKind.BiDiStreaming;
              name: "ReceiveSignalChannel";
          };
      }
      -
        -
      • -
        Readonly getStatus: {
            I: typeof GetStatusRequest;
            O: typeof Status;
            kind: MethodKind.Unary;
            name: "GetStatus";
        }
        -

        GetStatus gets the status of a node in the cluster. If the node is not able +

        Type declaration

        • Readonly methods: {
              getStatus: {
                  I: typeof GetStatusRequest;
                  O: typeof Status;
                  kind: MethodKind.Unary;
                  name: "GetStatus";
              };
              negotiateDataChannel: {
                  I: typeof DataChannelNegotiation;
                  O: typeof DataChannelNegotiation;
                  kind: MethodKind.BiDiStreaming;
                  name: "NegotiateDataChannel";
              };
              receiveSignalChannel: {
                  I: typeof WebRTCSignal;
                  O: typeof WebRTCSignal;
                  kind: MethodKind.BiDiStreaming;
                  name: "ReceiveSignalChannel";
              };
          }
          • Readonly getStatus: {
                I: typeof GetStatusRequest;
                O: typeof Status;
                kind: MethodKind.Unary;
                name: "GetStatus";
            }

            GetStatus gets the status of a node in the cluster. If the node is not able to return the status of the ID requested, it should return an error.

            -
            -
            -

            Generated

            from rpc v1.Node.GetStatus

            -
            -
              -
            • -
              Readonly I: typeof GetStatusRequest
              • -
            • -
              Readonly O: typeof Status
              • -
            • -
              Readonly kind: MethodKind.Unary
              • -
            • -
              Readonly name: "GetStatus"
            • -
          • -
            Readonly negotiateDataChannel: {
                I: typeof DataChannelNegotiation;
                O: typeof DataChannelNegotiation;
                kind: MethodKind.BiDiStreaming;
                name: "NegotiateDataChannel";
            }
            -

            NegotiateDataChannel is used to negotiate a WebRTC connection between a webmesh client +

            Generated

            from rpc v1.Node.GetStatus

            +
            • Readonly I: typeof GetStatusRequest
            • Readonly O: typeof Status
            • Readonly kind: MethodKind.Unary
            • Readonly name: "GetStatus"
          • Readonly negotiateDataChannel: {
                I: typeof DataChannelNegotiation;
                O: typeof DataChannelNegotiation;
                kind: MethodKind.BiDiStreaming;
                name: "NegotiateDataChannel";
            }

            NegotiateDataChannel is used to negotiate a WebRTC connection between a webmesh client and a node in the cluster. The handling server will send the target node the source address, the destination for traffic, and STUN/TURN servers to use for the negotiation. The node responds with an offer to be forwarded to the client. When the handler receives an answer from the client, it forwards it to the node. Once the node receives the answer, the stream can optionally be used to exchange ICE candidates.

            -
            -
            -

            Generated

            from rpc v1.Node.NegotiateDataChannel

            -
            -
            • -
          • -
            Readonly receiveSignalChannel: {
                I: typeof WebRTCSignal;
                O: typeof WebRTCSignal;
                kind: MethodKind.BiDiStreaming;
                name: "ReceiveSignalChannel";
            }
            -

            ReceiveSignalChannel is used to receive a request to start a WebRTC connection between a remote +

            Generated

            from rpc v1.Node.NegotiateDataChannel

            +
          • Readonly receiveSignalChannel: {
                I: typeof WebRTCSignal;
                O: typeof WebRTCSignal;
                kind: MethodKind.BiDiStreaming;
                name: "ReceiveSignalChannel";
            }

            ReceiveSignalChannel is used to receive a request to start a WebRTC connection between a remote node and this node. The node should wait for the client to send an offer, and then respond with an answer. Once the node receives the answer, the stream can optionally be used to exchange ICE candidates.

            -
            -
            -

            Generated

            from rpc v1.Node.ReceiveSignalChannel

            -
            -
              -
            • -
              Readonly I: typeof WebRTCSignal
              • -
            • -
              Readonly O: typeof WebRTCSignal
              • -
            • -
              Readonly kind: MethodKind.BiDiStreaming
              • -
            • -
              Readonly name: "ReceiveSignalChannel"
          • -
        • -
          Readonly typeName: "v1.Node"
        -
        -

        Generated

        from service v1.Node

        -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated

    from rpc v1.Node.ReceiveSignalChannel

    +
    • Readonly I: typeof WebRTCSignal
    • Readonly O: typeof WebRTCSignal
    • Readonly kind: MethodKind.BiDiStreaming
    • Readonly name: "ReceiveSignalChannel"
  • Readonly typeName: "v1.Node"

    • Generated

    from service v1.Node

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/plugin_connect.AuthPlugin.html b/docs/variables/plugin_connect.AuthPlugin.html index bc3a72ca..0ee82cd1 100644 --- a/docs/variables/plugin_connect.AuthPlugin.html +++ b/docs/variables/plugin_connect.AuthPlugin.html @@ -1,93 +1,5 @@ -AuthPlugin | Webmesh API
    -
    - -
    -
    -
    -
    - -

    Variable AuthPluginConst

    -
    AuthPlugin: {
        methods: {
            authenticate: {
                I: typeof AuthenticationRequest;
                O: typeof AuthenticationResponse;
                kind: MethodKind.Unary;
                name: "Authenticate";
            };
        };
        typeName: "v1.AuthPlugin";
    }
    -

    AuthPlugin is the service definition for a Webmesh auth plugin.

    -
    -
    -

    Type declaration

    -
      -
    • -
      Readonly methods: {
          authenticate: {
              I: typeof AuthenticationRequest;
              O: typeof AuthenticationResponse;
              kind: MethodKind.Unary;
              name: "Authenticate";
          };
      }
      -
      • -
    • -
      Readonly typeName: "v1.AuthPlugin"
    -
    -

    Generated

    from service v1.AuthPlugin

    -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +AuthPlugin | Webmesh API

    Variable AuthPluginConst

    AuthPlugin: {
        methods: {
            authenticate: {
                I: typeof AuthenticationRequest;
                O: typeof AuthenticationResponse;
                kind: MethodKind.Unary;
                name: "Authenticate";
            };
        };
        typeName: "v1.AuthPlugin";
    }

    AuthPlugin is the service definition for a Webmesh auth plugin.

    +

    Type declaration

    • Readonly methods: {
          authenticate: {
              I: typeof AuthenticationRequest;
              O: typeof AuthenticationResponse;
              kind: MethodKind.Unary;
              name: "Authenticate";
          };
      }
    • Readonly typeName: "v1.AuthPlugin"

    Generated

    from service v1.AuthPlugin

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/plugin_connect.IPAMPlugin.html b/docs/variables/plugin_connect.IPAMPlugin.html index e28de68f..f733cc23 100644 --- a/docs/variables/plugin_connect.IPAMPlugin.html +++ b/docs/variables/plugin_connect.IPAMPlugin.html @@ -1,109 +1,7 @@ -IPAMPlugin | Webmesh API
    -
    - -
    -
    -
    -
    - -

    Variable IPAMPluginConst

    -
    IPAMPlugin: {
        methods: {
            allocate: {
                I: typeof AllocateIPRequest;
                O: typeof AllocatedIP;
                kind: MethodKind.Unary;
                name: "Allocate";
            };
            release: {
                I: typeof ReleaseIPRequest;
                O: typeof Empty;
                kind: MethodKind.Unary;
                name: "Release";
            };
        };
        typeName: "v1.IPAMPlugin";
    }
    -

    IPAMPlugin is the service definition for a Webmesh IPAM plugin.

    -
    -
    -

    Type declaration

    -
      -
    • -
      Readonly methods: {
          allocate: {
              I: typeof AllocateIPRequest;
              O: typeof AllocatedIP;
              kind: MethodKind.Unary;
              name: "Allocate";
          };
          release: {
              I: typeof ReleaseIPRequest;
              O: typeof Empty;
              kind: MethodKind.Unary;
              name: "Release";
          };
      }
      -
        -
      • -
        Readonly allocate: {
            I: typeof AllocateIPRequest;
            O: typeof AllocatedIP;
            kind: MethodKind.Unary;
            name: "Allocate";
        }
        -

        Allocate allocates an IP for a node.

        -
        -
        -

        Generated

        from rpc v1.IPAMPlugin.Allocate

        -
        -
        • -
      • -
        Readonly release: {
            I: typeof ReleaseIPRequest;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "Release";
        }
        -

        Release releases an IP for a node.

        -
        -
        -

        Generated

        from rpc v1.IPAMPlugin.Release

        -
        -
          -
        • -
          Readonly I: typeof ReleaseIPRequest
          • -
        • -
          Readonly O: typeof Empty
          • -
        • -
          Readonly kind: MethodKind.Unary
          • -
        • -
          Readonly name: "Release"
      • -
    • -
      Readonly typeName: "v1.IPAMPlugin"
    -
    -

    Generated

    from service v1.IPAMPlugin

    -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +IPAMPlugin | Webmesh API

    Variable IPAMPluginConst

    IPAMPlugin: {
        methods: {
            allocate: {
                I: typeof AllocateIPRequest;
                O: typeof AllocatedIP;
                kind: MethodKind.Unary;
                name: "Allocate";
            };
            release: {
                I: typeof ReleaseIPRequest;
                O: typeof Empty;
                kind: MethodKind.Unary;
                name: "Release";
            };
        };
        typeName: "v1.IPAMPlugin";
    }

    IPAMPlugin is the service definition for a Webmesh IPAM plugin.

    +

    Type declaration

    • Readonly methods: {
          allocate: {
              I: typeof AllocateIPRequest;
              O: typeof AllocatedIP;
              kind: MethodKind.Unary;
              name: "Allocate";
          };
          release: {
              I: typeof ReleaseIPRequest;
              O: typeof Empty;
              kind: MethodKind.Unary;
              name: "Release";
          };
      }
      • Readonly allocate: {
            I: typeof AllocateIPRequest;
            O: typeof AllocatedIP;
            kind: MethodKind.Unary;
            name: "Allocate";
        }

        Allocate allocates an IP for a node.

        +

        Generated

        from rpc v1.IPAMPlugin.Allocate

        +
      • Readonly release: {
            I: typeof ReleaseIPRequest;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "Release";
        }

        Release releases an IP for a node.

        +

        Generated

        from rpc v1.IPAMPlugin.Release

        +
        • Readonly I: typeof ReleaseIPRequest
        • Readonly O: typeof Empty
        • Readonly kind: MethodKind.Unary
        • Readonly name: "Release"
    • Readonly typeName: "v1.IPAMPlugin"

    Generated

    from service v1.IPAMPlugin

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/plugin_connect.Plugin.html b/docs/variables/plugin_connect.Plugin.html index 04c8c782..1baf089e 100644 --- a/docs/variables/plugin_connect.Plugin.html +++ b/docs/variables/plugin_connect.Plugin.html @@ -1,126 +1,10 @@ -Plugin | Webmesh API
    -
    - -
    -
    -
    -
    - -

    Variable PluginConst

    -
    Plugin: {
        methods: {
            close: {
                I: typeof Empty;
                O: typeof Empty;
                kind: MethodKind.Unary;
                name: "Close";
            };
            configure: {
                I: typeof PluginConfiguration;
                O: typeof Empty;
                kind: MethodKind.Unary;
                name: "Configure";
            };
            getInfo: {
                I: typeof Empty;
                O: typeof PluginInfo;
                kind: MethodKind.Unary;
                name: "GetInfo";
            };
        };
        typeName: "v1.Plugin";
    }
    -

    Plugin is the general service definition for a Webmesh plugin. +Plugin | Webmesh API

    Variable PluginConst

    Plugin: {
        methods: {
            close: {
                I: typeof Empty;
                O: typeof Empty;
                kind: MethodKind.Unary;
                name: "Close";
            };
            configure: {
                I: typeof PluginConfiguration;
                O: typeof Empty;
                kind: MethodKind.Unary;
                name: "Configure";
            };
            getInfo: {
                I: typeof Empty;
                O: typeof PluginInfo;
                kind: MethodKind.Unary;
                name: "GetInfo";
            };
        };
        typeName: "v1.Plugin";
    }

    Plugin is the general service definition for a Webmesh plugin. It must be implemented by all plugins.

    -
    -
    -

    Type declaration

    -
      -
    • -
      Readonly methods: {
          close: {
              I: typeof Empty;
              O: typeof Empty;
              kind: MethodKind.Unary;
              name: "Close";
          };
          configure: {
              I: typeof PluginConfiguration;
              O: typeof Empty;
              kind: MethodKind.Unary;
              name: "Configure";
          };
          getInfo: {
              I: typeof Empty;
              O: typeof PluginInfo;
              kind: MethodKind.Unary;
              name: "GetInfo";
          };
      }
      -
        -
      • -
        Readonly close: {
            I: typeof Empty;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "Close";
        }
        -

        Close closes the plugin. It is called when the node is shutting down.

        -
        -
        -

        Generated

        from rpc v1.Plugin.Close

        -
        -
          -
        • -
          Readonly I: typeof Empty
          • -
        • -
          Readonly O: typeof Empty
          • -
        • -
          Readonly kind: MethodKind.Unary
          • -
        • -
          Readonly name: "Close"
        • -
      • -
        Readonly configure: {
            I: typeof PluginConfiguration;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "Configure";
        }
        -

        Configure starts and configures the plugin.

        -
        -
        -

        Generated

        from rpc v1.Plugin.Configure

        -
        -
          -
        • -
          Readonly I: typeof PluginConfiguration
          • -
        • -
          Readonly O: typeof Empty
          • -
        • -
          Readonly kind: MethodKind.Unary
          • -
        • -
          Readonly name: "Configure"
        • -
      • -
        Readonly getInfo: {
            I: typeof Empty;
            O: typeof PluginInfo;
            kind: MethodKind.Unary;
            name: "GetInfo";
        }
        -

        GetInfo returns the information for the plugin.

        -
        -
        -

        Generated

        from rpc v1.Plugin.GetInfo

        -
        -
          -
        • -
          Readonly I: typeof Empty
          • -
        • -
          Readonly O: typeof PluginInfo
          • -
        • -
          Readonly kind: MethodKind.Unary
          • -
        • -
          Readonly name: "GetInfo"
      • -
    • -
      Readonly typeName: "v1.Plugin"
    -
    -

    Generated

    from service v1.Plugin

    -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Type declaration

    • Readonly methods: {
          close: {
              I: typeof Empty;
              O: typeof Empty;
              kind: MethodKind.Unary;
              name: "Close";
          };
          configure: {
              I: typeof PluginConfiguration;
              O: typeof Empty;
              kind: MethodKind.Unary;
              name: "Configure";
          };
          getInfo: {
              I: typeof Empty;
              O: typeof PluginInfo;
              kind: MethodKind.Unary;
              name: "GetInfo";
          };
      }
      • Readonly close: {
            I: typeof Empty;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "Close";
        }

        Close closes the plugin. It is called when the node is shutting down.

        +

        Generated

        from rpc v1.Plugin.Close

        +
        • Readonly I: typeof Empty
        • Readonly O: typeof Empty
        • Readonly kind: MethodKind.Unary
        • Readonly name: "Close"
      • Readonly configure: {
            I: typeof PluginConfiguration;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "Configure";
        }

        Configure starts and configures the plugin.

        +

        Generated

        from rpc v1.Plugin.Configure

        +
        • Readonly I: typeof PluginConfiguration
        • Readonly O: typeof Empty
        • Readonly kind: MethodKind.Unary
        • Readonly name: "Configure"
      • Readonly getInfo: {
            I: typeof Empty;
            O: typeof PluginInfo;
            kind: MethodKind.Unary;
            name: "GetInfo";
        }

        GetInfo returns the information for the plugin.

        +

        Generated

        from rpc v1.Plugin.GetInfo

        +
        • Readonly I: typeof Empty
        • Readonly O: typeof PluginInfo
        • Readonly kind: MethodKind.Unary
        • Readonly name: "GetInfo"
    • Readonly typeName: "v1.Plugin"

    Generated

    from service v1.Plugin

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/plugin_connect.StorageQuerierPlugin.html b/docs/variables/plugin_connect.StorageQuerierPlugin.html index 4cc3dd6e..cdfe7097 100644 --- a/docs/variables/plugin_connect.StorageQuerierPlugin.html +++ b/docs/variables/plugin_connect.StorageQuerierPlugin.html @@ -1,97 +1,9 @@ -StorageQuerierPlugin | Webmesh API
    -
    - -
    -
    -
    -
    - -

    Variable StorageQuerierPluginConst

    -
    StorageQuerierPlugin: {
        methods: {
            injectQuerier: {
                I: typeof QueryResponse;
                O: typeof QueryRequest;
                kind: MethodKind.BiDiStreaming;
                name: "InjectQuerier";
            };
        };
        typeName: "v1.StorageQuerierPlugin";
    }
    -

    StorageQuerierPlugin is the service definition for a Webmesh storage querier plugin.

    -
    -
    -

    Type declaration

    -
      -
    • -
      Readonly methods: {
          injectQuerier: {
              I: typeof QueryResponse;
              O: typeof QueryRequest;
              kind: MethodKind.BiDiStreaming;
              name: "InjectQuerier";
          };
      }
      -
        -
      • -
        Readonly injectQuerier: {
            I: typeof QueryResponse;
            O: typeof QueryRequest;
            kind: MethodKind.BiDiStreaming;
            name: "InjectQuerier";
        }
        -

        InjectQuerier is a stream opened by the node to faciliate read operations +StorageQuerierPlugin | Webmesh API

        Variable StorageQuerierPluginConst

        StorageQuerierPlugin: {
            methods: {
                injectQuerier: {
                    I: typeof QueryResponse;
                    O: typeof QueryRequest;
                    kind: MethodKind.BiDiStreaming;
                    name: "InjectQuerier";
                };
            };
            typeName: "v1.StorageQuerierPlugin";
        }

        StorageQuerierPlugin is the service definition for a Webmesh storage querier plugin.

        +

        Type declaration

        • Readonly methods: {
              injectQuerier: {
                  I: typeof QueryResponse;
                  O: typeof QueryRequest;
                  kind: MethodKind.BiDiStreaming;
                  name: "InjectQuerier";
              };
          }
          • Readonly injectQuerier: {
                I: typeof QueryResponse;
                O: typeof QueryRequest;
                kind: MethodKind.BiDiStreaming;
                name: "InjectQuerier";
            }

            InjectQuerier is a stream opened by the node to faciliate read operations against the mesh state. The signature is misleading, but it is required to be able to stream the query results back to the node. The node will open a stream to the plugin and send a PluginQueryResult message for every query that is received.

            -
            -
            -

            Generated

            from rpc v1.StorageQuerierPlugin.InjectQuerier

            -
            -
              -
            • -
              Readonly I: typeof QueryResponse
              • -
            • -
              Readonly O: typeof QueryRequest
              • -
            • -
              Readonly kind: MethodKind.BiDiStreaming
              • -
            • -
              Readonly name: "InjectQuerier"
          • -
        • -
          Readonly typeName: "v1.StorageQuerierPlugin"
        -
        -

        Generated

        from service v1.StorageQuerierPlugin

        -
        -
        -
        -
        -
        -

        Settings

         -
        -
        -

        Member Visibility

        -
          -
          • -
          • -
          • -
        -
        -

        Theme

        -
        -
        -
        -

        Generated using TypeDoc

        -
        \ No newline at end of file +

        Generated

        from rpc v1.StorageQuerierPlugin.InjectQuerier

        +
        • Readonly I: typeof QueryResponse
        • Readonly O: typeof QueryRequest
        • Readonly kind: MethodKind.BiDiStreaming
        • Readonly name: "InjectQuerier"
    • Readonly typeName: "v1.StorageQuerierPlugin"

    Generated

    from service v1.StorageQuerierPlugin

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/plugin_connect.WatchPlugin.html b/docs/variables/plugin_connect.WatchPlugin.html index e5320660..6cc3ebc3 100644 --- a/docs/variables/plugin_connect.WatchPlugin.html +++ b/docs/variables/plugin_connect.WatchPlugin.html @@ -1,93 +1,5 @@ -WatchPlugin | Webmesh API
    -
    - -
    -
    -
    -
    - -

    Variable WatchPluginConst

    -
    WatchPlugin: {
        methods: {
            emit: {
                I: typeof Event;
                O: typeof Empty;
                kind: MethodKind.Unary;
                name: "Emit";
            };
        };
        typeName: "v1.WatchPlugin";
    }
    -

    WatchPlugin is the service definition for a Webmesh watch plugin.

    -
    -
    -

    Type declaration

    -
      -
    • -
      Readonly methods: {
          emit: {
              I: typeof Event;
              O: typeof Empty;
              kind: MethodKind.Unary;
              name: "Emit";
          };
      }
      -
        -
      • -
        Readonly emit: {
            I: typeof Event;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "Emit";
        }
        -

        Emit handles a watch event.

        -
        -
        -

        Generated

        from rpc v1.WatchPlugin.Emit

        -
        -
          -
        • -
          Readonly I: typeof Event
          • -
        • -
          Readonly O: typeof Empty
          • -
        • -
          Readonly kind: MethodKind.Unary
          • -
        • -
          Readonly name: "Emit"
      • -
    • -
      Readonly typeName: "v1.WatchPlugin"
    -
    -

    Generated

    from service v1.WatchPlugin

    -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +WatchPlugin | Webmesh API

    Variable WatchPluginConst

    WatchPlugin: {
        methods: {
            emit: {
                I: typeof Event;
                O: typeof Empty;
                kind: MethodKind.Unary;
                name: "Emit";
            };
        };
        typeName: "v1.WatchPlugin";
    }

    WatchPlugin is the service definition for a Webmesh watch plugin.

    +

    Type declaration

    • Readonly methods: {
          emit: {
              I: typeof Event;
              O: typeof Empty;
              kind: MethodKind.Unary;
              name: "Emit";
          };
      }
      • Readonly emit: {
            I: typeof Event;
            O: typeof Empty;
            kind: MethodKind.Unary;
            name: "Emit";
        }

        Emit handles a watch event.

        +

        Generated

        from rpc v1.WatchPlugin.Emit

        +
        • Readonly I: typeof Event
        • Readonly O: typeof Empty
        • Readonly kind: MethodKind.Unary
        • Readonly name: "Emit"
    • Readonly typeName: "v1.WatchPlugin"

    Generated

    from service v1.WatchPlugin

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/registrar_connect.Registrar.html b/docs/variables/registrar_connect.Registrar.html index a455f26f..cee623c1 100644 --- a/docs/variables/registrar_connect.Registrar.html +++ b/docs/variables/registrar_connect.Registrar.html @@ -1,117 +1,15 @@ -Registrar | Webmesh API
    -
    - -
    -
    -
    -
    - -

    Variable RegistrarConst

    -
    Registrar: {
        methods: {
            lookup: {
                I: typeof LookupRequest;
                O: typeof LookupResponse;
                kind: MethodKind.Unary;
                name: "Lookup";
            };
            register: {
                I: typeof RegisterRequest;
                O: typeof RegisterResponse;
                kind: MethodKind.Unary;
                name: "Register";
            };
        };
        typeName: "v1.Registrar";
    }
    -

    The registrar service can be used as a means of providing off-network storage of public +Registrar | Webmesh API

    Variable RegistrarConst

    Registrar: {
        methods: {
            lookup: {
                I: typeof LookupRequest;
                O: typeof LookupResponse;
                kind: MethodKind.Unary;
                name: "Lookup";
            };
            register: {
                I: typeof RegisterRequest;
                O: typeof RegisterResponse;
                kind: MethodKind.Unary;
                name: "Register";
            };
        };
        typeName: "v1.Registrar";
    }

    The registrar service can be used as a means of providing off-network storage of public keys and other information. This is useful for (and should only be used with) public-key derived ID authentication where one might want to register simpler aliases for a public key. This service could eventually evolve into a full key-server, but for now it is just a simple registrar.

    -
    -
    -

    Type declaration

    -
      -
    • -
      Readonly methods: {
          lookup: {
              I: typeof LookupRequest;
              O: typeof LookupResponse;
              kind: MethodKind.Unary;
              name: "Lookup";
          };
          register: {
              I: typeof RegisterRequest;
              O: typeof RegisterResponse;
              kind: MethodKind.Unary;
              name: "Register";
          };
      }
      -
        -
      • -
        Readonly lookup: {
            I: typeof LookupRequest;
            O: typeof LookupResponse;
            kind: MethodKind.Unary;
            name: "Lookup";
        }
        -

        Lookup a public key by ID or alias. If the ID is not found, the +

        Type declaration

        • Readonly methods: {
              lookup: {
                  I: typeof LookupRequest;
                  O: typeof LookupResponse;
                  kind: MethodKind.Unary;
                  name: "Lookup";
              };
              register: {
                  I: typeof RegisterRequest;
                  O: typeof RegisterResponse;
                  kind: MethodKind.Unary;
                  name: "Register";
              };
          }
          • Readonly lookup: {
                I: typeof LookupRequest;
                O: typeof LookupResponse;
                kind: MethodKind.Unary;
                name: "Lookup";
            }

            Lookup a public key by ID or alias. If the ID is not found, the request will fail.

            -
            -
            -

            Generated

            from rpc v1.Registrar.Lookup

            -
            -
              -
            • -
              Readonly I: typeof LookupRequest
              • -
            • -
              Readonly O: typeof LookupResponse
              • -
            • -
              Readonly kind: MethodKind.Unary
              • -
            • -
              Readonly name: "Lookup"
            • -
          • -
            Readonly register: {
                I: typeof RegisterRequest;
                O: typeof RegisterResponse;
                kind: MethodKind.Unary;
                name: "Register";
            }
            -

            Register a public key with the registrar. An alias can be provided to make it easier +

            Generated

            from rpc v1.Registrar.Lookup

            +
          • Readonly register: {
                I: typeof RegisterRequest;
                O: typeof RegisterResponse;
                kind: MethodKind.Unary;
                name: "Register";
            }

            Register a public key with the registrar. An alias can be provided to make it easier to lookup the public key later. If the alias is already in use, the request will fail. This method can be used to change the alias of a public key by providing the same public key with a different alias.

            -
            -
            -

            Generated

            from rpc v1.Registrar.Register

            -
            -
          • -
        • -
          Readonly typeName: "v1.Registrar"
        -
        -

        Generated

        from service v1.Registrar

        -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated

    from rpc v1.Registrar.Register

    +
  • Readonly typeName: "v1.Registrar"

    • Generated

    from service v1.Registrar

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/storage_provider_connect.StorageProviderPlugin.html b/docs/variables/storage_provider_connect.StorageProviderPlugin.html index c55fcdaf..051f3ed1 100644 --- a/docs/variables/storage_provider_connect.StorageProviderPlugin.html +++ b/docs/variables/storage_provider_connect.StorageProviderPlugin.html @@ -1,321 +1,51 @@ -StorageProviderPlugin | Webmesh API
    -
    - -
    -
    -
    -
    - -

    Variable StorageProviderPluginConst

    -
    StorageProviderPlugin: {
        methods: {
            addObserver: {
                I: typeof StoragePeer;
                O: typeof AddObserverResponse;
                kind: MethodKind.Unary;
                name: "AddObserver";
            };
            addVoter: {
                I: typeof StoragePeer;
                O: typeof AddVoterResponse;
                kind: MethodKind.Unary;
                name: "AddVoter";
            };
            bootstrap: {
                I: typeof BootstrapRequest;
                O: typeof BootstrapResponse;
                kind: MethodKind.Unary;
                name: "Bootstrap";
            };
            deleteValue: {
                I: typeof DeleteValueRequest;
                O: typeof DeleteValueResponse;
                kind: MethodKind.Unary;
                name: "DeleteValue";
            };
            demoteVoter: {
                I: typeof StoragePeer;
                O: typeof DemoteVoterResponse;
                kind: MethodKind.Unary;
                name: "DemoteVoter";
            };
            getLeader: {
                I: typeof GetLeaderRequest;
                O: typeof StoragePeer;
                kind: MethodKind.Unary;
                name: "GetLeader";
            };
            getPeers: {
                I: typeof GetPeersRequest;
                O: typeof StoragePeers;
                kind: MethodKind.Unary;
                name: "GetPeers";
            };
            getStatus: {
                I: typeof StorageStatusRequest;
                O: typeof StorageStatus;
                kind: MethodKind.Unary;
                name: "GetStatus";
            };
            getValue: {
                I: typeof GetValueRequest;
                O: typeof GetValueResponse;
                kind: MethodKind.Unary;
                name: "GetValue";
            };
            listKeys: {
                I: typeof ListKeysRequest;
                O: typeof ListKeysResponse;
                kind: MethodKind.Unary;
                name: "ListKeys";
            };
            listValues: {
                I: typeof ListValuesRequest;
                O: typeof ListValuesResponse;
                kind: MethodKind.Unary;
                name: "ListValues";
            };
            putValue: {
                I: typeof PutValueRequest;
                O: typeof PutValueResponse;
                kind: MethodKind.Unary;
                name: "PutValue";
            };
            removePeer: {
                I: typeof StoragePeer;
                O: typeof RemoveServerResponse;
                kind: MethodKind.Unary;
                name: "RemovePeer";
            };
            subscribePrefix: {
                I: typeof SubscribePrefixRequest;
                O: typeof PrefixEvent;
                kind: MethodKind.ServerStreaming;
                name: "SubscribePrefix";
            };
        };
        typeName: "v1.StorageProviderPlugin";
    }
    -

    StorageProviderPlugin is the service definition for a Webmesh storage provider.

    -
    -
    -

    Type declaration

    -
      -
    • -
      Readonly methods: {
          addObserver: {
              I: typeof StoragePeer;
              O: typeof AddObserverResponse;
              kind: MethodKind.Unary;
              name: "AddObserver";
          };
          addVoter: {
              I: typeof StoragePeer;
              O: typeof AddVoterResponse;
              kind: MethodKind.Unary;
              name: "AddVoter";
          };
          bootstrap: {
              I: typeof BootstrapRequest;
              O: typeof BootstrapResponse;
              kind: MethodKind.Unary;
              name: "Bootstrap";
          };
          deleteValue: {
              I: typeof DeleteValueRequest;
              O: typeof DeleteValueResponse;
              kind: MethodKind.Unary;
              name: "DeleteValue";
          };
          demoteVoter: {
              I: typeof StoragePeer;
              O: typeof DemoteVoterResponse;
              kind: MethodKind.Unary;
              name: "DemoteVoter";
          };
          getLeader: {
              I: typeof GetLeaderRequest;
              O: typeof StoragePeer;
              kind: MethodKind.Unary;
              name: "GetLeader";
          };
          getPeers: {
              I: typeof GetPeersRequest;
              O: typeof StoragePeers;
              kind: MethodKind.Unary;
              name: "GetPeers";
          };
          getStatus: {
              I: typeof StorageStatusRequest;
              O: typeof StorageStatus;
              kind: MethodKind.Unary;
              name: "GetStatus";
          };
          getValue: {
              I: typeof GetValueRequest;
              O: typeof GetValueResponse;
              kind: MethodKind.Unary;
              name: "GetValue";
          };
          listKeys: {
              I: typeof ListKeysRequest;
              O: typeof ListKeysResponse;
              kind: MethodKind.Unary;
              name: "ListKeys";
          };
          listValues: {
              I: typeof ListValuesRequest;
              O: typeof ListValuesResponse;
              kind: MethodKind.Unary;
              name: "ListValues";
          };
          putValue: {
              I: typeof PutValueRequest;
              O: typeof PutValueResponse;
              kind: MethodKind.Unary;
              name: "PutValue";
          };
          removePeer: {
              I: typeof StoragePeer;
              O: typeof RemoveServerResponse;
              kind: MethodKind.Unary;
              name: "RemovePeer";
          };
          subscribePrefix: {
              I: typeof SubscribePrefixRequest;
              O: typeof PrefixEvent;
              kind: MethodKind.ServerStreaming;
              name: "SubscribePrefix";
          };
      }
      -
        -
      • -
        Readonly addObserver: {
            I: typeof StoragePeer;
            O: typeof AddObserverResponse;
            kind: MethodKind.Unary;
            name: "AddObserver";
        }
        -

        AddObserver adds an observer to the storage. The underlying implementation +StorageProviderPlugin | Webmesh API

        Variable StorageProviderPluginConst

        StorageProviderPlugin: {
            methods: {
                addObserver: {
                    I: typeof StoragePeer;
                    O: typeof AddObserverResponse;
                    kind: MethodKind.Unary;
                    name: "AddObserver";
                };
                addVoter: {
                    I: typeof StoragePeer;
                    O: typeof AddVoterResponse;
                    kind: MethodKind.Unary;
                    name: "AddVoter";
                };
                bootstrap: {
                    I: typeof BootstrapRequest;
                    O: typeof BootstrapResponse;
                    kind: MethodKind.Unary;
                    name: "Bootstrap";
                };
                deleteValue: {
                    I: typeof DeleteValueRequest;
                    O: typeof DeleteValueResponse;
                    kind: MethodKind.Unary;
                    name: "DeleteValue";
                };
                demoteVoter: {
                    I: typeof StoragePeer;
                    O: typeof DemoteVoterResponse;
                    kind: MethodKind.Unary;
                    name: "DemoteVoter";
                };
                getLeader: {
                    I: typeof GetLeaderRequest;
                    O: typeof StoragePeer;
                    kind: MethodKind.Unary;
                    name: "GetLeader";
                };
                getPeers: {
                    I: typeof GetPeersRequest;
                    O: typeof StoragePeers;
                    kind: MethodKind.Unary;
                    name: "GetPeers";
                };
                getStatus: {
                    I: typeof StorageStatusRequest;
                    O: typeof StorageStatus;
                    kind: MethodKind.Unary;
                    name: "GetStatus";
                };
                getValue: {
                    I: typeof GetValueRequest;
                    O: typeof GetValueResponse;
                    kind: MethodKind.Unary;
                    name: "GetValue";
                };
                listKeys: {
                    I: typeof ListKeysRequest;
                    O: typeof ListKeysResponse;
                    kind: MethodKind.Unary;
                    name: "ListKeys";
                };
                listValues: {
                    I: typeof ListValuesRequest;
                    O: typeof ListValuesResponse;
                    kind: MethodKind.Unary;
                    name: "ListValues";
                };
                putValue: {
                    I: typeof PutValueRequest;
                    O: typeof PutValueResponse;
                    kind: MethodKind.Unary;
                    name: "PutValue";
                };
                removePeer: {
                    I: typeof StoragePeer;
                    O: typeof RemoveServerResponse;
                    kind: MethodKind.Unary;
                    name: "RemovePeer";
                };
                subscribePrefix: {
                    I: typeof SubscribePrefixRequest;
                    O: typeof PrefixEvent;
                    kind: MethodKind.ServerStreaming;
                    name: "SubscribePrefix";
                };
            };
            typeName: "v1.StorageProviderPlugin";
        }

        StorageProviderPlugin is the service definition for a Webmesh storage provider.

        +

        Type declaration

        • Readonly methods: {
              addObserver: {
                  I: typeof StoragePeer;
                  O: typeof AddObserverResponse;
                  kind: MethodKind.Unary;
                  name: "AddObserver";
              };
              addVoter: {
                  I: typeof StoragePeer;
                  O: typeof AddVoterResponse;
                  kind: MethodKind.Unary;
                  name: "AddVoter";
              };
              bootstrap: {
                  I: typeof BootstrapRequest;
                  O: typeof BootstrapResponse;
                  kind: MethodKind.Unary;
                  name: "Bootstrap";
              };
              deleteValue: {
                  I: typeof DeleteValueRequest;
                  O: typeof DeleteValueResponse;
                  kind: MethodKind.Unary;
                  name: "DeleteValue";
              };
              demoteVoter: {
                  I: typeof StoragePeer;
                  O: typeof DemoteVoterResponse;
                  kind: MethodKind.Unary;
                  name: "DemoteVoter";
              };
              getLeader: {
                  I: typeof GetLeaderRequest;
                  O: typeof StoragePeer;
                  kind: MethodKind.Unary;
                  name: "GetLeader";
              };
              getPeers: {
                  I: typeof GetPeersRequest;
                  O: typeof StoragePeers;
                  kind: MethodKind.Unary;
                  name: "GetPeers";
              };
              getStatus: {
                  I: typeof StorageStatusRequest;
                  O: typeof StorageStatus;
                  kind: MethodKind.Unary;
                  name: "GetStatus";
              };
              getValue: {
                  I: typeof GetValueRequest;
                  O: typeof GetValueResponse;
                  kind: MethodKind.Unary;
                  name: "GetValue";
              };
              listKeys: {
                  I: typeof ListKeysRequest;
                  O: typeof ListKeysResponse;
                  kind: MethodKind.Unary;
                  name: "ListKeys";
              };
              listValues: {
                  I: typeof ListValuesRequest;
                  O: typeof ListValuesResponse;
                  kind: MethodKind.Unary;
                  name: "ListValues";
              };
              putValue: {
                  I: typeof PutValueRequest;
                  O: typeof PutValueResponse;
                  kind: MethodKind.Unary;
                  name: "PutValue";
              };
              removePeer: {
                  I: typeof StoragePeer;
                  O: typeof RemoveServerResponse;
                  kind: MethodKind.Unary;
                  name: "RemovePeer";
              };
              subscribePrefix: {
                  I: typeof SubscribePrefixRequest;
                  O: typeof PrefixEvent;
                  kind: MethodKind.ServerStreaming;
                  name: "SubscribePrefix";
              };
          }
          • Readonly addObserver: {
                I: typeof StoragePeer;
                O: typeof AddObserverResponse;
                kind: MethodKind.Unary;
                name: "AddObserver";
            }

            AddObserver adds an observer to the storage. The underlying implementation should ensure that the observer is added to the storage and that the storage is in a consistent state before returning. If observers are not supported the underlying implementation can silently ignore this RPC, but it should keep track of the observer in the GetStatus RPC if possible.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.AddObserver

            -
            -
            • -
          • -
            Readonly addVoter: {
                I: typeof StoragePeer;
                O: typeof AddVoterResponse;
                kind: MethodKind.Unary;
                name: "AddVoter";
            }
            -

            AddVoter adds a voter to the storage. The underlying implementation +

            Generated

            from rpc v1.StorageProviderPlugin.AddObserver

            +
          • Readonly addVoter: {
                I: typeof StoragePeer;
                O: typeof AddVoterResponse;
                kind: MethodKind.Unary;
                name: "AddVoter";
            }

            AddVoter adds a voter to the storage. The underlying implementation should ensure that the voter is added to the storage and that the storage is in a consistent state before returning.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.AddVoter

            -
            -
              -
            • -
              Readonly I: typeof StoragePeer
              • -
            • -
              Readonly O: typeof AddVoterResponse
              • -
            • -
              Readonly kind: MethodKind.Unary
              • -
            • -
              Readonly name: "AddVoter"
            • -
          • -
            Readonly bootstrap: {
                I: typeof BootstrapRequest;
                O: typeof BootstrapResponse;
                kind: MethodKind.Unary;
                name: "Bootstrap";
            }
            -

            Bootstrap is called when the storage is created for the first time. +

            Generated

            from rpc v1.StorageProviderPlugin.AddVoter

            +
          • Readonly bootstrap: {
                I: typeof BootstrapRequest;
                O: typeof BootstrapResponse;
                kind: MethodKind.Unary;
                name: "Bootstrap";
            }

            Bootstrap is called when the storage is created for the first time. It is assumed that this node has been elected as the leader of the cluster. FailedPrecondition should be returned if the storage is already bootstrapped.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.Bootstrap

            -
            -
            • -
          • -
            Readonly deleteValue: {
                I: typeof DeleteValueRequest;
                O: typeof DeleteValueResponse;
                kind: MethodKind.Unary;
                name: "DeleteValue";
            }
            -

            DeleteValue deletes a value for a key.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.DeleteValue

            -
            -
            • -
          • -
            Readonly demoteVoter: {
                I: typeof StoragePeer;
                O: typeof DemoteVoterResponse;
                kind: MethodKind.Unary;
                name: "DemoteVoter";
            }
            -

            DemoteVoter demotes a voter to an observer. The underlying implementation +

            Generated

            from rpc v1.StorageProviderPlugin.Bootstrap

            +
          • Readonly deleteValue: {
                I: typeof DeleteValueRequest;
                O: typeof DeleteValueResponse;
                kind: MethodKind.Unary;
                name: "DeleteValue";
            }

            DeleteValue deletes a value for a key.

            +

            Generated

            from rpc v1.StorageProviderPlugin.DeleteValue

            +
          • Readonly demoteVoter: {
                I: typeof StoragePeer;
                O: typeof DemoteVoterResponse;
                kind: MethodKind.Unary;
                name: "DemoteVoter";
            }

            DemoteVoter demotes a voter to an observer. The underlying implementation should ensure that the voter is demoted and that the storage is in a consistent state before returning. If observers are not supported the underlying implementation can silently ignore this RPC, but it should keep track of the observer in the GetStatus RPC if possible.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.DemoteVoter

            -
            -
            • -
          • -
            Readonly getLeader: {
                I: typeof GetLeaderRequest;
                O: typeof StoragePeer;
                kind: MethodKind.Unary;
                name: "GetLeader";
            }
            -

            GetLeader returns the leader of the storage. Leader may be loosely defined +

            Generated

            from rpc v1.StorageProviderPlugin.DemoteVoter

            +
          • Readonly getLeader: {
                I: typeof GetLeaderRequest;
                O: typeof StoragePeer;
                kind: MethodKind.Unary;
                name: "GetLeader";
            }

            GetLeader returns the leader of the storage. Leader may be loosely defined by the implementation, but must be a node that can reliably be used to mutate the storage.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.GetLeader

            -
            -
              -
            • -
              Readonly I: typeof GetLeaderRequest
              • -
            • -
              Readonly O: typeof StoragePeer
              • -
            • -
              Readonly kind: MethodKind.Unary
              • -
            • -
              Readonly name: "GetLeader"
            • -
          • -
            Readonly getPeers: {
                I: typeof GetPeersRequest;
                O: typeof StoragePeers;
                kind: MethodKind.Unary;
                name: "GetPeers";
            }
            -

            GetPeers returns all peers of the storage. Peer status may be loosely defined +

            Generated

            from rpc v1.StorageProviderPlugin.GetLeader

            +
          • Readonly getPeers: {
                I: typeof GetPeersRequest;
                O: typeof StoragePeers;
                kind: MethodKind.Unary;
                name: "GetPeers";
            }

            GetPeers returns all peers of the storage. Peer status may be loosely defined by the implementation, but must correlate to nodes that can reliably be used to mutate the storage.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.GetPeers

            -
            -
              -
            • -
              Readonly I: typeof GetPeersRequest
              • -
            • -
              Readonly O: typeof StoragePeers
              • -
            • -
              Readonly kind: MethodKind.Unary
              • -
            • -
              Readonly name: "GetPeers"
            • -
          • -
            Readonly getStatus: {
                I: typeof StorageStatusRequest;
                O: typeof StorageStatus;
                kind: MethodKind.Unary;
                name: "GetStatus";
            }
            -

            GetStatus returns the status of the storage.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.GetStatus

            -
            -
            • -
          • -
            Readonly getValue: {
                I: typeof GetValueRequest;
                O: typeof GetValueResponse;
                kind: MethodKind.Unary;
                name: "GetValue";
            }
            -

            GetValue returns the value for a key.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.GetValue

            -
            -
            • -
          • -
            Readonly listKeys: {
                I: typeof ListKeysRequest;
                O: typeof ListKeysResponse;
                kind: MethodKind.Unary;
                name: "ListKeys";
            }
            -

            ListKeys lists all keys for a prefix.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.ListKeys

            -
            -
            • -
          • -
            Readonly listValues: {
                I: typeof ListValuesRequest;
                O: typeof ListValuesResponse;
                kind: MethodKind.Unary;
                name: "ListValues";
            }
            -

            ListValues lists all values for a prefix.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.ListValues

            -
            -
            • -
          • -
            Readonly putValue: {
                I: typeof PutValueRequest;
                O: typeof PutValueResponse;
                kind: MethodKind.Unary;
                name: "PutValue";
            }
            -

            PutValue puts a value for a key.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.PutValue

            -
            -
            • -
          • -
            Readonly removePeer: {
                I: typeof StoragePeer;
                O: typeof RemoveServerResponse;
                kind: MethodKind.Unary;
                name: "RemovePeer";
            }
            -

            RemovePeer removes a peer from the storage. The underlying implementation +

            Generated

            from rpc v1.StorageProviderPlugin.GetPeers

            +
          • Readonly getStatus: {
                I: typeof StorageStatusRequest;
                O: typeof StorageStatus;
                kind: MethodKind.Unary;
                name: "GetStatus";
            }

            GetStatus returns the status of the storage.

            +

            Generated

            from rpc v1.StorageProviderPlugin.GetStatus

            +
          • Readonly getValue: {
                I: typeof GetValueRequest;
                O: typeof GetValueResponse;
                kind: MethodKind.Unary;
                name: "GetValue";
            }

            GetValue returns the value for a key.

            +

            Generated

            from rpc v1.StorageProviderPlugin.GetValue

            +
          • Readonly listKeys: {
                I: typeof ListKeysRequest;
                O: typeof ListKeysResponse;
                kind: MethodKind.Unary;
                name: "ListKeys";
            }

            ListKeys lists all keys for a prefix.

            +

            Generated

            from rpc v1.StorageProviderPlugin.ListKeys

            +
          • Readonly listValues: {
                I: typeof ListValuesRequest;
                O: typeof ListValuesResponse;
                kind: MethodKind.Unary;
                name: "ListValues";
            }

            ListValues lists all values for a prefix.

            +

            Generated

            from rpc v1.StorageProviderPlugin.ListValues

            +
          • Readonly putValue: {
                I: typeof PutValueRequest;
                O: typeof PutValueResponse;
                kind: MethodKind.Unary;
                name: "PutValue";
            }

            PutValue puts a value for a key.

            +

            Generated

            from rpc v1.StorageProviderPlugin.PutValue

            +
          • Readonly removePeer: {
                I: typeof StoragePeer;
                O: typeof RemoveServerResponse;
                kind: MethodKind.Unary;
                name: "RemovePeer";
            }

            RemovePeer removes a peer from the storage. The underlying implementation should ensure that the server is removed and that the storage is in a consistent state before returning. When called with the current ID of the leader, the underlying implementation should relinquish leadership to another peer if possible.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.RemovePeer

            -
            -
            • -
          • -
            Readonly subscribePrefix: {
                I: typeof SubscribePrefixRequest;
                O: typeof PrefixEvent;
                kind: MethodKind.ServerStreaming;
                name: "SubscribePrefix";
            }
            -

            SubscribePrefix subscribes to events for a prefix.

            -
            -
            -

            Generated

            from rpc v1.StorageProviderPlugin.SubscribePrefix

            -
            -
          • -
        • -
          Readonly typeName: "v1.StorageProviderPlugin"
        -
        -

        Generated

        from service v1.StorageProviderPlugin

        -
        -
        -
        -
        -
        -

        Settings

         -
        -
        -

        Member Visibility

        -
          -
          • -
          • -
          • -
        -
        -

        Theme

        -
        -
        -
        -

        Generated using TypeDoc

        -
        \ No newline at end of file +

        Generated

        from rpc v1.StorageProviderPlugin.RemovePeer

        +
      • Readonly subscribePrefix: {
            I: typeof SubscribePrefixRequest;
            O: typeof PrefixEvent;
            kind: MethodKind.ServerStreaming;
            name: "SubscribePrefix";
        }

        SubscribePrefix subscribes to events for a prefix.

        +

        Generated

        from rpc v1.StorageProviderPlugin.SubscribePrefix

        +
    • Readonly typeName: "v1.StorageProviderPlugin"

    Generated

    from service v1.StorageProviderPlugin

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/storage_query_connect.StorageQueryService.html b/docs/variables/storage_query_connect.StorageQueryService.html index 1a3f1aa2..598104b4 100644 --- a/docs/variables/storage_query_connect.StorageQueryService.html +++ b/docs/variables/storage_query_connect.StorageQueryService.html @@ -1,128 +1,12 @@ -StorageQueryService | Webmesh API
    -
    - -
    -
    -
    -
    - -

    Variable StorageQueryServiceConst

    -
    StorageQueryService: {
        methods: {
            publish: {
                I: typeof PublishRequest;
                O: typeof PublishResponse;
                kind: MethodKind.Unary;
                name: "Publish";
            };
            query: {
                I: typeof QueryRequest;
                O: typeof QueryResponse;
                kind: MethodKind.Unary;
                name: "Query";
            };
            subscribe: {
                I: typeof SubscribeRequest;
                O: typeof SubscriptionEvent;
                kind: MethodKind.ServerStreaming;
                name: "Subscribe";
            };
        };
        typeName: "v1.StorageQueryService";
    }
    -

    StorageQueryService is the service for querying information about the mesh state.

    -
    -
    -

    Type declaration

    -
      -
    • -
      Readonly methods: {
          publish: {
              I: typeof PublishRequest;
              O: typeof PublishResponse;
              kind: MethodKind.Unary;
              name: "Publish";
          };
          query: {
              I: typeof QueryRequest;
              O: typeof QueryResponse;
              kind: MethodKind.Unary;
              name: "Query";
          };
          subscribe: {
              I: typeof SubscribeRequest;
              O: typeof SubscriptionEvent;
              kind: MethodKind.ServerStreaming;
              name: "Subscribe";
          };
      }
      -
        -
      • -
        Readonly publish: {
            I: typeof PublishRequest;
            O: typeof PublishResponse;
            kind: MethodKind.Unary;
            name: "Publish";
        }
        -

        Publish is used to publish events to the mesh database. A restricted set +StorageQueryService | Webmesh API

        Variable StorageQueryServiceConst

        StorageQueryService: {
            methods: {
                publish: {
                    I: typeof PublishRequest;
                    O: typeof PublishResponse;
                    kind: MethodKind.Unary;
                    name: "Publish";
                };
                query: {
                    I: typeof QueryRequest;
                    O: typeof QueryResponse;
                    kind: MethodKind.Unary;
                    name: "Query";
                };
                subscribe: {
                    I: typeof SubscribeRequest;
                    O: typeof SubscriptionEvent;
                    kind: MethodKind.ServerStreaming;
                    name: "Subscribe";
                };
            };
            typeName: "v1.StorageQueryService";
        }

        StorageQueryService is the service for querying information about the mesh state.

        +

        Type declaration

        • Readonly methods: {
              publish: {
                  I: typeof PublishRequest;
                  O: typeof PublishResponse;
                  kind: MethodKind.Unary;
                  name: "Publish";
              };
              query: {
                  I: typeof QueryRequest;
                  O: typeof QueryResponse;
                  kind: MethodKind.Unary;
                  name: "Query";
              };
              subscribe: {
                  I: typeof SubscribeRequest;
                  O: typeof SubscriptionEvent;
                  kind: MethodKind.ServerStreaming;
                  name: "Subscribe";
              };
          }
          • Readonly publish: {
                I: typeof PublishRequest;
                O: typeof PublishResponse;
                kind: MethodKind.Unary;
                name: "Publish";
            }

            Publish is used to publish events to the mesh database. A restricted set of keys are allowed to be published to. This is only available on nodes that are able to provide storage.

            -
            -
            -

            Generated

            from rpc v1.StorageQueryService.Publish

            -
            -
            • -
          • -
            Readonly query: {
                I: typeof QueryRequest;
                O: typeof QueryResponse;
                kind: MethodKind.Unary;
                name: "Query";
            }
            -

            Query is used to query the mesh for information.

            -
            -
            -

            Generated

            from rpc v1.StorageQueryService.Query

            -
            -
              -
            • -
              Readonly I: typeof QueryRequest
              • -
            • -
              Readonly O: typeof QueryResponse
              • -
            • -
              Readonly kind: MethodKind.Unary
              • -
            • -
              Readonly name: "Query"
            • -
          • -
            Readonly subscribe: {
                I: typeof SubscribeRequest;
                O: typeof SubscriptionEvent;
                kind: MethodKind.ServerStreaming;
                name: "Subscribe";
            }
            -

            Subscribe is used to subscribe to events at a particular prefix. This is +

            Generated

            from rpc v1.StorageQueryService.Publish

            +
          • Readonly query: {
                I: typeof QueryRequest;
                O: typeof QueryResponse;
                kind: MethodKind.Unary;
                name: "Query";
            }

            Query is used to query the mesh for information.

            +

            Generated

            from rpc v1.StorageQueryService.Query

            +
          • Readonly subscribe: {
                I: typeof SubscribeRequest;
                O: typeof SubscriptionEvent;
                kind: MethodKind.ServerStreaming;
                name: "Subscribe";
            }

            Subscribe is used to subscribe to events at a particular prefix. This is only available on nodes that are able to provide storage.

            -
            -
            -

            Generated

            from rpc v1.StorageQueryService.Subscribe

            -
            -
          • -
        • -
          Readonly typeName: "v1.StorageQueryService"
        -
        -

        Generated

        from service v1.StorageQueryService

        -
        -
        -
        -
        -
        -

        Settings

         -
        -
        -

        Member Visibility

        -
          -
          • -
          • -
          • -
        -
        -

        Theme

        -
        -
        -
        -

        Generated using TypeDoc

        -
        \ No newline at end of file +

        Generated

        from rpc v1.StorageQueryService.Subscribe

        +
    • Readonly typeName: "v1.StorageQueryService"

    Generated

    from service v1.StorageQueryService

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/webrtc_connect.WebRTC.html b/docs/variables/webrtc_connect.WebRTC.html index cf3f00eb..f40d0636 100644 --- a/docs/variables/webrtc_connect.WebRTC.html +++ b/docs/variables/webrtc_connect.WebRTC.html @@ -1,35 +1,7 @@ -WebRTC | Webmesh API
    -
    - -
    -
    -
    -
    - -

    Variable WebRTCConst

    -
    WebRTC: {
        methods: {
            startDataChannel: {
                I: typeof StartDataChannelRequest;
                O: typeof DataChannelOffer;
                kind: MethodKind.BiDiStreaming;
                name: "StartDataChannel";
            };
            startSignalChannel: {
                I: typeof WebRTCSignal;
                O: typeof WebRTCSignal;
                kind: MethodKind.BiDiStreaming;
                name: "StartSignalChannel";
            };
        };
        typeName: "v1.WebRTC";
    }
    -

    WebRTC is a service for negotiating WebRTC connections to nodes in the mesh. +WebRTC | Webmesh API

    Variable WebRTCConst

    WebRTC: {
        methods: {
            startDataChannel: {
                I: typeof StartDataChannelRequest;
                O: typeof DataChannelOffer;
                kind: MethodKind.BiDiStreaming;
                name: "StartDataChannel";
            };
            startSignalChannel: {
                I: typeof WebRTCSignal;
                O: typeof WebRTCSignal;
                kind: MethodKind.BiDiStreaming;
                name: "StartSignalChannel";
            };
        };
        typeName: "v1.WebRTC";
    }

    WebRTC is a service for negotiating WebRTC connections to nodes in the mesh. It is typically run alongside a TURN server, however the server can be configured to use public STUN servers instead.

    -
    -
    -

    Type declaration

    -
      -
    • -
      Readonly methods: {
          startDataChannel: {
              I: typeof StartDataChannelRequest;
              O: typeof DataChannelOffer;
              kind: MethodKind.BiDiStreaming;
              name: "StartDataChannel";
          };
          startSignalChannel: {
              I: typeof WebRTCSignal;
              O: typeof WebRTCSignal;
              kind: MethodKind.BiDiStreaming;
              name: "StartSignalChannel";
          };
      }
      -
        -
      • -
        Readonly startDataChannel: {
            I: typeof StartDataChannelRequest;
            O: typeof DataChannelOffer;
            kind: MethodKind.BiDiStreaming;
            name: "StartDataChannel";
        }
        -

        StartDataChannel requests a new WebRTC connection to a node. +

        Type declaration

        • Readonly methods: {
              startDataChannel: {
                  I: typeof StartDataChannelRequest;
                  O: typeof DataChannelOffer;
                  kind: MethodKind.BiDiStreaming;
                  name: "StartDataChannel";
              };
              startSignalChannel: {
                  I: typeof WebRTCSignal;
                  O: typeof WebRTCSignal;
                  kind: MethodKind.BiDiStreaming;
                  name: "StartSignalChannel";
              };
          }
          • Readonly startDataChannel: {
                I: typeof StartDataChannelRequest;
                O: typeof DataChannelOffer;
                kind: MethodKind.BiDiStreaming;
                name: "StartDataChannel";
            }

            StartDataChannel requests a new WebRTC connection to a node. The client speaks first with the request containing the node ID and where forwarded packets should be sent. The server responds with an offer and STUN servers to be used to establish a WebRTC connection. @@ -37,84 +9,10 @@

            Readonly -

            Generated

            from rpc v1.WebRTC.StartDataChannel

            -
            -
            • -
          • -
            Readonly startSignalChannel: {
                I: typeof WebRTCSignal;
                O: typeof WebRTCSignal;
                kind: MethodKind.BiDiStreaming;
                name: "StartSignalChannel";
            }
            -

            StartSignalChannel starts a signaling channel to a remote node. This can be used to +

            Generated

            from rpc v1.WebRTC.StartDataChannel

            +
          • Readonly startSignalChannel: {
                I: typeof WebRTCSignal;
                O: typeof WebRTCSignal;
                kind: MethodKind.BiDiStreaming;
                name: "StartSignalChannel";
            }

            StartSignalChannel starts a signaling channel to a remote node. This can be used to negotiate WebRTC connections both inside and outside of the mesh. Messages on the wire are proxied to the remote node.

            -
            -
            -

            Generated

            from rpc v1.WebRTC.StartSignalChannel

            -
            -
              -
            • -
              Readonly I: typeof WebRTCSignal
              • -
            • -
              Readonly O: typeof WebRTCSignal
              • -
            • -
              Readonly kind: MethodKind.BiDiStreaming
              • -
            • -
              Readonly name: "StartSignalChannel"
          • -
        • -
          Readonly typeName: "v1.WebRTC"
        -
        -

        Generated

        from service v1.WebRTC

        -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated

    from rpc v1.WebRTC.StartSignalChannel

    +
    • Readonly I: typeof WebRTCSignal
    • Readonly O: typeof WebRTCSignal
    • Readonly kind: MethodKind.BiDiStreaming
    • Readonly name: "StartSignalChannel"
  • Readonly typeName: "v1.WebRTC"

    • Generated

    from service v1.WebRTC

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/go/v1/app.pb.go b/go/v1/app.pb.go index 3776dc50..e50f188d 100644 --- a/go/v1/app.pb.go +++ b/go/v1/app.pb.go @@ -830,9 +830,7 @@ func (x *ConnectResponse) GetIpv6Network() string { return "" } -// DisconnectRequest is sent by an application to a daemon to disconnect -// from a mesh. This message will eventually contain unique identifiers -// for allowing the application to disconnect from a specific mesh. +// DisconnectRequest is sent by an application to a daemon to disconnect from a mesh. type DisconnectRequest struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache @@ -920,8 +918,7 @@ func (*DisconnectResponse) Descriptor() ([]byte, []int) { return file_v1_app_proto_rawDescGZIP(), []int{7} } -// MetricsRequest is sent by the application to a daemon to retrieve interface -// metrics for a mesh connection. +// MetricsRequest is sent by the application to a daemon to retrieve interface metrics for a mesh connection. type MetricsRequest struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache @@ -1020,8 +1017,7 @@ func (x *MetricsResponse) GetInterfaces() map[string]*InterfaceMetrics { return nil } -// StatusRequest is sent by the application to a daemon to retrieve the status -// of a mesh connection. +// StatusRequest is sent by the application to a daemon to retrieve the status of a mesh connection. type StatusRequest struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache diff --git a/proto/v1/app.proto b/proto/v1/app.proto index 38ae19d4..81613db3 100644 --- a/proto/v1/app.proto +++ b/proto/v1/app.proto @@ -190,9 +190,7 @@ message ConnectResponse { string ipv6Network = 7; } -// DisconnectRequest is sent by an application to a daemon to disconnect -// from a mesh. This message will eventually contain unique identifiers -// for allowing the application to disconnect from a specific mesh. +// DisconnectRequest is sent by an application to a daemon to disconnect from a mesh. message DisconnectRequest { // ID is the unique identifier of this connection. string id = 1 [ @@ -205,8 +203,7 @@ message DisconnectRequest { // DisconnectResponse is returned by the Disconnect RPC. message DisconnectResponse {} -// MetricsRequest is sent by the application to a daemon to retrieve interface -// metrics for a mesh connection. +// MetricsRequest is sent by the application to a daemon to retrieve interface metrics for a mesh connection. message MetricsRequest { // IDs are the unique identifiers of the connections to retrieve metrics for. // If not provided, metrics for all connections will be returned. @@ -219,8 +216,7 @@ message MetricsResponse { map interfaces = 1; } -// StatusRequest is sent by the application to a daemon to retrieve the status -// of a mesh connection. +// StatusRequest is sent by the application to a daemon to retrieve the status of a mesh connection. message StatusRequest { // ID is the unique identifier of this connection. string id = 1 [ @@ -258,10 +254,9 @@ message AppQueryRequest { QueryRequest query = 2; } -// AppDaemon is exposed by nodes running in the app-daemon mode. This mode -// allows the node to run in an idle state and be controlled by an application. -// The application can send commands to the node to execute tasks and receive -// responses. +// AppDaemon is exposed by nodes running in the daemon mode. This mode allows the +// node to run in an idle state and be controlled by an application. The application +// can send commands to the node to execute tasks and receive responses. service AppDaemon { // Connect is used to establish a connection between the node and a mesh. rpc Connect(ConnectRequest) returns (ConnectResponse) {} diff --git a/ts/v1/app_connect.d.ts b/ts/v1/app_connect.d.ts index acf41a5f..272150f6 100644 --- a/ts/v1/app_connect.d.ts +++ b/ts/v1/app_connect.d.ts @@ -23,10 +23,9 @@ import { MethodKind } from "@bufbuild/protobuf"; import { QueryResponse } from "./storage_query_pb.js"; /** - * AppDaemon is exposed by nodes running in the app-daemon mode. This mode - * allows the node to run in an idle state and be controlled by an application. - * The application can send commands to the node to execute tasks and receive - * responses. + * AppDaemon is exposed by nodes running in the daemon mode. This mode allows the + * node to run in an idle state and be controlled by an application. The application + * can send commands to the node to execute tasks and receive responses. * * @generated from service v1.AppDaemon */ diff --git a/ts/v1/app_connect.js b/ts/v1/app_connect.js index 97738e97..967fa6aa 100644 --- a/ts/v1/app_connect.js +++ b/ts/v1/app_connect.js @@ -23,10 +23,9 @@ import { MethodKind } from "@bufbuild/protobuf"; import { QueryResponse } from "./storage_query_pb.js"; /** - * AppDaemon is exposed by nodes running in the app-daemon mode. This mode - * allows the node to run in an idle state and be controlled by an application. - * The application can send commands to the node to execute tasks and receive - * responses. + * AppDaemon is exposed by nodes running in the daemon mode. This mode allows the + * node to run in an idle state and be controlled by an application. The application + * can send commands to the node to execute tasks and receive responses. * * @generated from service v1.AppDaemon */ diff --git a/ts/v1/app_pb.d.ts b/ts/v1/app_pb.d.ts index 0257aea8..726b8b31 100644 --- a/ts/v1/app_pb.d.ts +++ b/ts/v1/app_pb.d.ts @@ -496,9 +496,7 @@ export declare class ConnectResponse extends Message { } /** - * DisconnectRequest is sent by an application to a daemon to disconnect - * from a mesh. This message will eventually contain unique identifiers - * for allowing the application to disconnect from a specific mesh. + * DisconnectRequest is sent by an application to a daemon to disconnect from a mesh. * * @generated from message v1.DisconnectRequest */ @@ -547,8 +545,7 @@ export declare class DisconnectResponse extends Message { } /** - * MetricsRequest is sent by the application to a daemon to retrieve interface - * metrics for a mesh connection. + * MetricsRequest is sent by the application to a daemon to retrieve interface metrics for a mesh connection. * * @generated from message v1.MetricsRequest */ @@ -605,8 +602,7 @@ export declare class MetricsResponse extends Message { } /** - * StatusRequest is sent by the application to a daemon to retrieve the status - * of a mesh connection. + * StatusRequest is sent by the application to a daemon to retrieve the status of a mesh connection. * * @generated from message v1.StatusRequest */ diff --git a/ts/v1/app_pb.js b/ts/v1/app_pb.js index 4d749325..82637d49 100644 --- a/ts/v1/app_pb.js +++ b/ts/v1/app_pb.js @@ -178,9 +178,7 @@ export const ConnectResponse = proto3.makeMessageType( ); /** - * DisconnectRequest is sent by an application to a daemon to disconnect - * from a mesh. This message will eventually contain unique identifiers - * for allowing the application to disconnect from a specific mesh. + * DisconnectRequest is sent by an application to a daemon to disconnect from a mesh. * * @generated from message v1.DisconnectRequest */ @@ -202,8 +200,7 @@ export const DisconnectResponse = proto3.makeMessageType( ); /** - * MetricsRequest is sent by the application to a daemon to retrieve interface - * metrics for a mesh connection. + * MetricsRequest is sent by the application to a daemon to retrieve interface metrics for a mesh connection. * * @generated from message v1.MetricsRequest */ @@ -227,8 +224,7 @@ export const MetricsResponse = proto3.makeMessageType( ); /** - * StatusRequest is sent by the application to a daemon to retrieve the status - * of a mesh connection. + * StatusRequest is sent by the application to a daemon to retrieve the status of a mesh connection. * * @generated from message v1.StatusRequest */
    Method NameRequest TypeResponse TypeDescription