LightningApi.Peer (lightningj 0.17.4-Beta API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - org.lightningj.lnd.proto.LightningApi.Peer

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, LightningApi.PeerOrBuilder

Enclosing class:

LightningApi
```
public static final class LightningApi.Peer
extends com.google.protobuf.GeneratedMessageV3
implements LightningApi.PeerOrBuilder
```
Protobuf type lnrpc.Peer

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`LightningApi.Peer.Builder` Protobuf type `lnrpc.Peer`
`static class`	`LightningApi.Peer.SyncType` Protobuf enum `lnrpc.Peer.SyncType`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADDRESS_FIELD_NUMBER`
`static int`	`BYTES_RECV_FIELD_NUMBER`
`static int`	`BYTES_SENT_FIELD_NUMBER`
`static int`	`ERRORS_FIELD_NUMBER`
`static int`	`FEATURES_FIELD_NUMBER`
`static int`	`FLAP_COUNT_FIELD_NUMBER`
`static int`	`INBOUND_FIELD_NUMBER`
`static int`	`LAST_FLAP_NS_FIELD_NUMBER`
`static int`	`LAST_PING_PAYLOAD_FIELD_NUMBER`
`static int`	`PING_TIME_FIELD_NUMBER`
`static int`	`PUB_KEY_FIELD_NUMBER`
`static int`	`SAT_RECV_FIELD_NUMBER`
`static int`	`SAT_SENT_FIELD_NUMBER`
`static int`	`SYNC_TYPE_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsFeatures(int key)` Features advertised by the remote peer in their init message.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAddress()` Network address of the peer; eg `127.0.0.1:10011`
`com.google.protobuf.ByteString`	`getAddressBytes()` Network address of the peer; eg `127.0.0.1:10011`
`long`	`getBytesRecv()` Bytes of data transmitted from this peer
`long`	`getBytesSent()` Bytes of data transmitted to this peer
`static LightningApi.Peer`	`getDefaultInstance()`
`LightningApi.Peer`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`LightningApi.TimestampedError`	`getErrors(int index)` The latest errors received from our peer with timestamps, limited to the 10 most recent errors.
`int`	`getErrorsCount()` The latest errors received from our peer with timestamps, limited to the 10 most recent errors.
`java.util.List<LightningApi.TimestampedError>`	`getErrorsList()` The latest errors received from our peer with timestamps, limited to the 10 most recent errors.
`LightningApi.TimestampedErrorOrBuilder`	`getErrorsOrBuilder(int index)` The latest errors received from our peer with timestamps, limited to the 10 most recent errors.
`java.util.List<? extends LightningApi.TimestampedErrorOrBuilder>`	`getErrorsOrBuilderList()` The latest errors received from our peer with timestamps, limited to the 10 most recent errors.
`java.util.Map<java.lang.Integer,LightningApi.Feature>`	`getFeatures()` Deprecated.
`int`	`getFeaturesCount()` Features advertised by the remote peer in their init message.
`java.util.Map<java.lang.Integer,LightningApi.Feature>`	`getFeaturesMap()` Features advertised by the remote peer in their init message.
`LightningApi.Feature`	`getFeaturesOrDefault(int key, LightningApi.Feature defaultValue)` Features advertised by the remote peer in their init message.
`LightningApi.Feature`	`getFeaturesOrThrow(int key)` Features advertised by the remote peer in their init message.
`int`	`getFlapCount()` The number of times we have recorded this peer going offline or coming online, recorded across restarts.
`boolean`	`getInbound()` A channel is inbound if the counterparty initiated the channel
`long`	`getLastFlapNs()` The timestamp of the last flap we observed for this peer.
`com.google.protobuf.ByteString`	`getLastPingPayload()` The last ping payload the peer has sent to us.
`com.google.protobuf.Parser<LightningApi.Peer>`	`getParserForType()`
`long`	`getPingTime()` Ping time to this peer
`java.lang.String`	`getPubKey()` The identity pubkey of the peer
`com.google.protobuf.ByteString`	`getPubKeyBytes()` The identity pubkey of the peer
`long`	`getSatRecv()` Satoshis received from this peer
`long`	`getSatSent()` Satoshis sent to this peer
`int`	`getSerializedSize()`
`LightningApi.Peer.SyncType`	`getSyncType()` The type of sync we are currently performing with this peer.
`int`	`getSyncTypeValue()` The type of sync we are currently performing with this peer.
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static LightningApi.Peer.Builder`	`newBuilder()`
`static LightningApi.Peer.Builder`	`newBuilder(LightningApi.Peer prototype)`
`LightningApi.Peer.Builder`	`newBuilderForType()`
`protected LightningApi.Peer.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected java.lang.Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static LightningApi.Peer`	`parseDelimitedFrom(java.io.InputStream input)`
`static LightningApi.Peer`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static LightningApi.Peer`	`parseFrom(byte[] data)`
`static LightningApi.Peer`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static LightningApi.Peer`	`parseFrom(java.nio.ByteBuffer data)`
`static LightningApi.Peer`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static LightningApi.Peer`	`parseFrom(com.google.protobuf.ByteString data)`
`static LightningApi.Peer`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static LightningApi.Peer`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static LightningApi.Peer`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static LightningApi.Peer`	`parseFrom(java.io.InputStream input)`
`static LightningApi.Peer`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<LightningApi.Peer>`	`parser()`
`LightningApi.Peer.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- PUB_KEY_FIELD_NUMBER
```
public static final int PUB_KEY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ADDRESS_FIELD_NUMBER
```
public static final int ADDRESS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BYTES_SENT_FIELD_NUMBER
```
public static final int BYTES_SENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BYTES_RECV_FIELD_NUMBER
```
public static final int BYTES_RECV_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SAT_SENT_FIELD_NUMBER
```
public static final int SAT_SENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SAT_RECV_FIELD_NUMBER
```
public static final int SAT_RECV_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INBOUND_FIELD_NUMBER
```
public static final int INBOUND_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PING_TIME_FIELD_NUMBER
```
public static final int PING_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SYNC_TYPE_FIELD_NUMBER
```
public static final int SYNC_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FEATURES_FIELD_NUMBER
```
public static final int FEATURES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ERRORS_FIELD_NUMBER
```
public static final int ERRORS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FLAP_COUNT_FIELD_NUMBER
```
public static final int FLAP_COUNT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LAST_FLAP_NS_FIELD_NUMBER
```
public static final int LAST_FLAP_NS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LAST_PING_PAYLOAD_FIELD_NUMBER
```
public static final int LAST_PING_PAYLOAD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPubKey
```
public java.lang.String getPubKey()
```
```
 The identity pubkey of the peer
 
```
string pub_key = 1;
Specified by:

getPubKey in interface LightningApi.PeerOrBuilder

Returns:

The pubKey.

getPubKeyBytes
```
public com.google.protobuf.ByteString getPubKeyBytes()
```
```
 The identity pubkey of the peer
 
```
string pub_key = 1;
Specified by:

getPubKeyBytes in interface LightningApi.PeerOrBuilder

Returns:

The bytes for pubKey.

getAddress
```
public java.lang.String getAddress()
```
```
 Network address of the peer; eg `127.0.0.1:10011`
 
```
string address = 3;
Specified by:

getAddress in interface LightningApi.PeerOrBuilder

Returns:

The address.

getAddressBytes
```
public com.google.protobuf.ByteString getAddressBytes()
```
```
 Network address of the peer; eg `127.0.0.1:10011`
 
```
string address = 3;
Specified by:

getAddressBytes in interface LightningApi.PeerOrBuilder

Returns:

The bytes for address.

getBytesSent
```
public long getBytesSent()
```
```
 Bytes of data transmitted to this peer
 
```
uint64 bytes_sent = 4;
Specified by:

getBytesSent in interface LightningApi.PeerOrBuilder

Returns:

The bytesSent.

getBytesRecv
```
public long getBytesRecv()
```
```
 Bytes of data transmitted from this peer
 
```
uint64 bytes_recv = 5;
Specified by:

getBytesRecv in interface LightningApi.PeerOrBuilder

Returns:

The bytesRecv.

getSatSent
```
public long getSatSent()
```
```
 Satoshis sent to this peer
 
```
int64 sat_sent = 6;
Specified by:

getSatSent in interface LightningApi.PeerOrBuilder

Returns:

The satSent.

getSatRecv
```
public long getSatRecv()
```
```
 Satoshis received from this peer
 
```
int64 sat_recv = 7;
Specified by:

getSatRecv in interface LightningApi.PeerOrBuilder

Returns:

The satRecv.

getInbound
```
public boolean getInbound()
```
```
 A channel is inbound if the counterparty initiated the channel
 
```
bool inbound = 8;
Specified by:

getInbound in interface LightningApi.PeerOrBuilder

Returns:

The inbound.

getPingTime
```
public long getPingTime()
```
```
 Ping time to this peer
 
```
int64 ping_time = 9;
Specified by:

getPingTime in interface LightningApi.PeerOrBuilder

Returns:

The pingTime.

getSyncTypeValue
```
public int getSyncTypeValue()
```
```
 The type of sync we are currently performing with this peer.
 
```
.lnrpc.Peer.SyncType sync_type = 10;
Specified by:

getSyncTypeValue in interface LightningApi.PeerOrBuilder

Returns:

The enum numeric value on the wire for syncType.

getSyncType
```
public LightningApi.Peer.SyncType getSyncType()
```
```
 The type of sync we are currently performing with this peer.
 
```
.lnrpc.Peer.SyncType sync_type = 10;
Specified by:

getSyncType in interface LightningApi.PeerOrBuilder

Returns:

The syncType.

getFeaturesCount
```
public int getFeaturesCount()
```
Description copied from interface: LightningApi.PeerOrBuilder
```
 Features advertised by the remote peer in their init message.
 
```
map<uint32, .lnrpc.Feature> features = 11;
Specified by:

getFeaturesCount in interface LightningApi.PeerOrBuilder

containsFeatures
```
public boolean containsFeatures(int key)
```
```
 Features advertised by the remote peer in their init message.
 
```
map<uint32, .lnrpc.Feature> features = 11;
Specified by:

containsFeatures in interface LightningApi.PeerOrBuilder

getFeatures
```
@Deprecated
public java.util.Map<java.lang.Integer,LightningApi.Feature> getFeatures()
```
Deprecated.

Use getFeaturesMap() instead.

Specified by:

getFeatures in interface LightningApi.PeerOrBuilder

getFeaturesMap

public java.util.Map<java.lang.Integer,LightningApi.Feature> getFeaturesMap()

 Features advertised by the remote peer in their init message.

map<uint32, .lnrpc.Feature> features = 11;

Specified by:: getFeaturesMap in interface LightningApi.PeerOrBuilder

getFeaturesOrDefault

public LightningApi.Feature getFeaturesOrDefault(int key,
                                                 LightningApi.Feature defaultValue)

 Features advertised by the remote peer in their init message.

map<uint32, .lnrpc.Feature> features = 11;

Specified by:: getFeaturesOrDefault in interface LightningApi.PeerOrBuilder

getFeaturesOrThrow

public LightningApi.Feature getFeaturesOrThrow(int key)

 Features advertised by the remote peer in their init message.

map<uint32, .lnrpc.Feature> features = 11;

Specified by:: getFeaturesOrThrow in interface LightningApi.PeerOrBuilder