org.lightningj.lnd.proto

Class LightningApi.Payment

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.lightningj.lnd.proto.LightningApi.Payment

All Implemented Interfaces:

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

Enclosing class:

LightningApi

public static final class LightningApi.Payment
extends com.google.protobuf.GeneratedMessageV3
implements LightningApi.PaymentOrBuilder

Protobuf type lnrpc.Payment

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LightningApi.Payment.Builder Protobuf type lnrpc.Payment
static class	LightningApi.Payment.PaymentStatus Protobuf enum lnrpc.Payment.PaymentStatus

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	CREATION_DATE_FIELD_NUMBER
static int	CREATION_TIME_NS_FIELD_NUMBER
static int	FAILURE_REASON_FIELD_NUMBER
static int	FEE_FIELD_NUMBER
static int	FEE_MSAT_FIELD_NUMBER
static int	FEE_SAT_FIELD_NUMBER
static int	HTLCS_FIELD_NUMBER
static int	PAYMENT_HASH_FIELD_NUMBER
static int	PAYMENT_INDEX_FIELD_NUMBER
static int	PAYMENT_PREIMAGE_FIELD_NUMBER
static int	PAYMENT_REQUEST_FIELD_NUMBER
static int	STATUS_FIELD_NUMBER
static int	VALUE_FIELD_NUMBER
static int	VALUE_MSAT_FIELD_NUMBER
static int	VALUE_SAT_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

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
long	getCreationDate() Deprecated. lnrpc.Payment.creation_date is deprecated. See lightning.api.proto;l=3892
long	getCreationTimeNs() The time in UNIX nanoseconds at which the payment was created.
static LightningApi.Payment	getDefaultInstance()
LightningApi.Payment	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
LightningApi.PaymentFailureReason	getFailureReason() .lnrpc.PaymentFailureReason failure_reason = 16;
int	getFailureReasonValue() .lnrpc.PaymentFailureReason failure_reason = 16;
long	getFee() Deprecated. lnrpc.Payment.fee is deprecated. See lightning.api.proto;l=3897
long	getFeeMsat() The fee paid for this payment in milli-satoshis
long	getFeeSat() The fee paid for this payment in satoshis
LightningApi.HTLCAttempt	getHtlcs(int index) The HTLCs made in attempt to settle the payment.
int	getHtlcsCount() The HTLCs made in attempt to settle the payment.
java.util.List<LightningApi.HTLCAttempt>	getHtlcsList() The HTLCs made in attempt to settle the payment.
LightningApi.HTLCAttemptOrBuilder	getHtlcsOrBuilder(int index) The HTLCs made in attempt to settle the payment.
java.util.List<? extends LightningApi.HTLCAttemptOrBuilder>	getHtlcsOrBuilderList() The HTLCs made in attempt to settle the payment.
com.google.protobuf.Parser<LightningApi.Payment>	getParserForType()
java.lang.String	getPaymentHash() The payment hash
com.google.protobuf.ByteString	getPaymentHashBytes() The payment hash
long	getPaymentIndex() The creation index of this payment.
java.lang.String	getPaymentPreimage() The payment preimage
com.google.protobuf.ByteString	getPaymentPreimageBytes() The payment preimage
java.lang.String	getPaymentRequest() The optional payment request being fulfilled.
com.google.protobuf.ByteString	getPaymentRequestBytes() The optional payment request being fulfilled.
int	getSerializedSize()
LightningApi.Payment.PaymentStatus	getStatus() The status of the payment.
int	getStatusValue() The status of the payment.
long	getValue() Deprecated. lnrpc.Payment.value is deprecated. See lightning.api.proto;l=3889
long	getValueMsat() The value of the payment in milli-satoshis
long	getValueSat() The value of the payment in satoshis
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LightningApi.Payment.Builder	newBuilder()
static LightningApi.Payment.Builder	newBuilder(LightningApi.Payment prototype)
LightningApi.Payment.Builder	newBuilderForType()
protected LightningApi.Payment.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static LightningApi.Payment	parseDelimitedFrom(java.io.InputStream input)
static LightningApi.Payment	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Payment	parseFrom(byte[] data)
static LightningApi.Payment	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Payment	parseFrom(java.nio.ByteBuffer data)
static LightningApi.Payment	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Payment	parseFrom(com.google.protobuf.ByteString data)
static LightningApi.Payment	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Payment	parseFrom(com.google.protobuf.CodedInputStream input)
static LightningApi.Payment	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LightningApi.Payment	parseFrom(java.io.InputStream input)
static LightningApi.Payment	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LightningApi.Payment>	parser()
LightningApi.Payment.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, internalGetMapField, 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

PAYMENT_HASH_FIELD_NUMBER

public static final int PAYMENT_HASH_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER

See Also:

Constant Field Values

CREATION_DATE_FIELD_NUMBER

public static final int CREATION_DATE_FIELD_NUMBER

See Also:

Constant Field Values

FEE_FIELD_NUMBER

public static final int FEE_FIELD_NUMBER

See Also:

Constant Field Values

PAYMENT_PREIMAGE_FIELD_NUMBER

public static final int PAYMENT_PREIMAGE_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_SAT_FIELD_NUMBER

public static final int VALUE_SAT_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_MSAT_FIELD_NUMBER

public static final int VALUE_MSAT_FIELD_NUMBER

See Also:

Constant Field Values

PAYMENT_REQUEST_FIELD_NUMBER

public static final int PAYMENT_REQUEST_FIELD_NUMBER

See Also:

Constant Field Values

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER

See Also:

Constant Field Values

FEE_SAT_FIELD_NUMBER

public static final int FEE_SAT_FIELD_NUMBER

See Also:

Constant Field Values

FEE_MSAT_FIELD_NUMBER

public static final int FEE_MSAT_FIELD_NUMBER

See Also:

Constant Field Values

CREATION_TIME_NS_FIELD_NUMBER

public static final int CREATION_TIME_NS_FIELD_NUMBER

See Also:

Constant Field Values

HTLCS_FIELD_NUMBER

public static final int HTLCS_FIELD_NUMBER

See Also:

Constant Field Values

PAYMENT_INDEX_FIELD_NUMBER

public static final int PAYMENT_INDEX_FIELD_NUMBER

See Also:

Constant Field Values

FAILURE_REASON_FIELD_NUMBER

public static final int FAILURE_REASON_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()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPaymentHash

public java.lang.String getPaymentHash()

 The payment hash
 

string payment_hash = 1;

Specified by:

getPaymentHash in interface LightningApi.PaymentOrBuilder

Returns:

The paymentHash.

getPaymentHashBytes

public com.google.protobuf.ByteString getPaymentHashBytes()

 The payment hash
 

string payment_hash = 1;

Specified by:

getPaymentHashBytes in interface LightningApi.PaymentOrBuilder

Returns:

The bytes for paymentHash.

getValue

@Deprecated
public long getValue()

Deprecated. lnrpc.Payment.value is deprecated. See lightning.api.proto;l=3889

 Deprecated, use value_sat or value_msat.
 

int64 value = 2 [deprecated = true];

Specified by:

getValue in interface LightningApi.PaymentOrBuilder

Returns:

The value.

getCreationDate

@Deprecated
public long getCreationDate()

Deprecated. lnrpc.Payment.creation_date is deprecated. See lightning.api.proto;l=3892

 Deprecated, use creation_time_ns
 

int64 creation_date = 3 [deprecated = true];

Specified by:

getCreationDate in interface LightningApi.PaymentOrBuilder

Returns:

The creationDate.

getFee

@Deprecated
public long getFee()

Deprecated. lnrpc.Payment.fee is deprecated. See lightning.api.proto;l=3897

 Deprecated, use fee_sat or fee_msat.
 

int64 fee = 5 [deprecated = true];

Specified by:

getFee in interface LightningApi.PaymentOrBuilder

Returns:

The fee.

getPaymentPreimage

public java.lang.String getPaymentPreimage()

 The payment preimage
 

string payment_preimage = 6;

Specified by:

getPaymentPreimage in interface LightningApi.PaymentOrBuilder

Returns:

The paymentPreimage.

getPaymentPreimageBytes

public com.google.protobuf.ByteString getPaymentPreimageBytes()

 The payment preimage
 

string payment_preimage = 6;

Specified by:

getPaymentPreimageBytes in interface LightningApi.PaymentOrBuilder

Returns:

The bytes for paymentPreimage.

getValueSat

public long getValueSat()

 The value of the payment in satoshis
 

int64 value_sat = 7;

Specified by:

getValueSat in interface LightningApi.PaymentOrBuilder

Returns:

The valueSat.

getValueMsat

public long getValueMsat()

 The value of the payment in milli-satoshis
 

int64 value_msat = 8;

Specified by:

getValueMsat in interface LightningApi.PaymentOrBuilder

Returns:

The valueMsat.

getPaymentRequest

public java.lang.String getPaymentRequest()

 The optional payment request being fulfilled.
 

string payment_request = 9;

Specified by:

getPaymentRequest in interface LightningApi.PaymentOrBuilder

Returns:

The paymentRequest.

getPaymentRequestBytes

public com.google.protobuf.ByteString getPaymentRequestBytes()

 The optional payment request being fulfilled.
 

string payment_request = 9;

Specified by:

getPaymentRequestBytes in interface LightningApi.PaymentOrBuilder

Returns:

The bytes for paymentRequest.

getStatusValue

public int getStatusValue()

 The status of the payment.
 

.lnrpc.Payment.PaymentStatus status = 10;

Specified by:

getStatusValue in interface LightningApi.PaymentOrBuilder

Returns:

The enum numeric value on the wire for status.

getStatus

public LightningApi.Payment.PaymentStatus getStatus()

 The status of the payment.
 

.lnrpc.Payment.PaymentStatus status = 10;

Specified by:

getStatus in interface LightningApi.PaymentOrBuilder

Returns:

The status.

getFeeSat

public long getFeeSat()

  The fee paid for this payment in satoshis
 

int64 fee_sat = 11;

Specified by:

getFeeSat in interface LightningApi.PaymentOrBuilder

Returns:

The feeSat.

getFeeMsat

public long getFeeMsat()

  The fee paid for this payment in milli-satoshis
 

int64 fee_msat = 12;

Specified by:

getFeeMsat in interface LightningApi.PaymentOrBuilder

Returns:

The feeMsat.

getCreationTimeNs

public long getCreationTimeNs()

 The time in UNIX nanoseconds at which the payment was created.
 

int64 creation_time_ns = 13;

Specified by:

getCreationTimeNs in interface LightningApi.PaymentOrBuilder

Returns:

The creationTimeNs.

getHtlcsList

public java.util.List<LightningApi.HTLCAttempt> getHtlcsList()

 The HTLCs made in attempt to settle the payment.
 

repeated .lnrpc.HTLCAttempt htlcs = 14;

Specified by:

getHtlcsList in interface LightningApi.PaymentOrBuilder

getHtlcsOrBuilderList

public java.util.List<? extends LightningApi.HTLCAttemptOrBuilder> getHtlcsOrBuilderList()

 The HTLCs made in attempt to settle the payment.
 

repeated .lnrpc.HTLCAttempt htlcs = 14;

Specified by:

getHtlcsOrBuilderList in interface LightningApi.PaymentOrBuilder

getHtlcsCount

public int getHtlcsCount()

 The HTLCs made in attempt to settle the payment.
 

repeated .lnrpc.HTLCAttempt htlcs = 14;

Specified by:

getHtlcsCount in interface LightningApi.PaymentOrBuilder

getHtlcs

public LightningApi.HTLCAttempt getHtlcs(int index)

 The HTLCs made in attempt to settle the payment.
 

repeated .lnrpc.HTLCAttempt htlcs = 14;

Specified by:

getHtlcs in interface LightningApi.PaymentOrBuilder

getHtlcsOrBuilder

public LightningApi.HTLCAttemptOrBuilder getHtlcsOrBuilder(int index)

 The HTLCs made in attempt to settle the payment.
 

repeated .lnrpc.HTLCAttempt htlcs = 14;

Specified by:

getHtlcsOrBuilder in interface LightningApi.PaymentOrBuilder

getPaymentIndex

public long getPaymentIndex()

The creation index of this payment. Each payment can be uniquely identified
by this index, which may not strictly increment by 1 for payments made in
older versions of lnd.
 

uint64 payment_index = 15;

Specified by:

getPaymentIndex in interface LightningApi.PaymentOrBuilder

Returns:

The paymentIndex.

getFailureReasonValue

public int getFailureReasonValue()

.lnrpc.PaymentFailureReason failure_reason = 16;

Specified by:

getFailureReasonValue in interface LightningApi.PaymentOrBuilder

Returns:

The enum numeric value on the wire for failureReason.

getFailureReason

public LightningApi.PaymentFailureReason getFailureReason()

.lnrpc.PaymentFailureReason failure_reason = 16;

Specified by:

getFailureReason in interface LightningApi.PaymentOrBuilder

Returns:

The failureReason.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static LightningApi.Payment parseFrom(java.nio.ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Payment parseFrom(java.nio.ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Payment parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Payment parseFrom(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Payment parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Payment parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.Payment parseFrom(java.io.InputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.Payment parseFrom(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LightningApi.Payment parseDelimitedFrom(java.io.InputStream input)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LightningApi.Payment parseDelimitedFrom(java.io.InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.Payment parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.Payment parseFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public LightningApi.Payment.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LightningApi.Payment.Builder newBuilder()

newBuilder

public static LightningApi.Payment.Builder newBuilder(LightningApi.Payment prototype)

toBuilder

public LightningApi.Payment.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected LightningApi.Payment.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LightningApi.Payment getDefaultInstance()

parser

public static com.google.protobuf.Parser<LightningApi.Payment> parser()

getParserForType

public com.google.protobuf.Parser<LightningApi.Payment> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public LightningApi.Payment getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder