public static final class LightningApi.Invoice.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Invoice.Builder> implements LightningApi.InvoiceOrBuilder
lnrpc.Invoice| Modifier and Type | Method and Description |
|---|---|
LightningApi.Invoice.Builder |
addAllHtlcs(java.lang.Iterable<? extends LightningApi.InvoiceHTLC> values)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.Invoice.Builder |
addAllRouteHints(java.lang.Iterable<? extends LightningApi.RouteHint> values)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.Invoice.Builder |
addHtlcs(int index,
LightningApi.InvoiceHTLC.Builder builderForValue)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.Invoice.Builder |
addHtlcs(int index,
LightningApi.InvoiceHTLC value)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.Invoice.Builder |
addHtlcs(LightningApi.InvoiceHTLC.Builder builderForValue)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.Invoice.Builder |
addHtlcs(LightningApi.InvoiceHTLC value)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.InvoiceHTLC.Builder |
addHtlcsBuilder()
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.InvoiceHTLC.Builder |
addHtlcsBuilder(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.Invoice.Builder |
addRouteHints(int index,
LightningApi.RouteHint.Builder builderForValue)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.Invoice.Builder |
addRouteHints(int index,
LightningApi.RouteHint value)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.Invoice.Builder |
addRouteHints(LightningApi.RouteHint.Builder builderForValue)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.Invoice.Builder |
addRouteHints(LightningApi.RouteHint value)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.RouteHint.Builder |
addRouteHintsBuilder()
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.RouteHint.Builder |
addRouteHintsBuilder(int index)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.Invoice |
build() |
LightningApi.Invoice |
buildPartial() |
LightningApi.Invoice.Builder |
clear() |
LightningApi.Invoice.Builder |
clearAddIndex()
The "add" index of this invoice.
|
LightningApi.Invoice.Builder |
clearAmpInvoiceState() |
LightningApi.Invoice.Builder |
clearAmtPaid()
Deprecated.
lnrpc.Invoice.amt_paid is deprecated.
See lightning.api.proto;l=3595
|
LightningApi.Invoice.Builder |
clearAmtPaidMsat()
The amount that was accepted for this invoice, in millisatoshis.
|
LightningApi.Invoice.Builder |
clearAmtPaidSat()
The amount that was accepted for this invoice, in satoshis.
|
LightningApi.Invoice.Builder |
clearCltvExpiry()
Delta to use for the time-lock of the CLTV extended to the final hop.
|
LightningApi.Invoice.Builder |
clearCreationDate()
When this invoice was created.
|
LightningApi.Invoice.Builder |
clearDescriptionHash()
Hash (SHA-256) of a description of the payment.
|
LightningApi.Invoice.Builder |
clearExpiry()
Payment request expiry time in seconds.
|
LightningApi.Invoice.Builder |
clearFallbackAddr()
Fallback on-chain address.
|
LightningApi.Invoice.Builder |
clearFeatures() |
LightningApi.Invoice.Builder |
clearHtlcs()
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.Invoice.Builder |
clearIsAmp()
Signals whether or not this is an AMP invoice.
|
LightningApi.Invoice.Builder |
clearIsKeysend()
Indicates if this invoice was a spontaneous payment that arrived via keysend
[EXPERIMENTAL].
|
LightningApi.Invoice.Builder |
clearMemo()
An optional memo to attach along with the invoice.
|
LightningApi.Invoice.Builder |
clearPaymentAddr()
The payment address of this invoice.
|
LightningApi.Invoice.Builder |
clearPaymentRequest()
A bare-bones invoice for a payment within the Lightning Network.
|
LightningApi.Invoice.Builder |
clearPrivate()
Whether this invoice should include routing hints for private channels.
|
LightningApi.Invoice.Builder |
clearRHash()
The hash of the preimage.
|
LightningApi.Invoice.Builder |
clearRouteHints()
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.Invoice.Builder |
clearRPreimage()
The hex-encoded preimage (32 byte) which will allow settling an incoming
HTLC payable to this preimage.
|
LightningApi.Invoice.Builder |
clearSettled()
Deprecated.
lnrpc.Invoice.settled is deprecated.
See lightning.api.proto;l=3524
|
LightningApi.Invoice.Builder |
clearSettleDate()
When this invoice was settled.
|
LightningApi.Invoice.Builder |
clearSettleIndex()
The "settle" index of this invoice.
|
LightningApi.Invoice.Builder |
clearState()
The state the invoice is in.
|
LightningApi.Invoice.Builder |
clearValue()
The value of this invoice in satoshis
The fields value and value_msat are mutually exclusive.
|
LightningApi.Invoice.Builder |
clearValueMsat()
The value of this invoice in millisatoshis
The fields value and value_msat are mutually exclusive.
|
boolean |
containsAmpInvoiceState(java.lang.String key)
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
boolean |
containsFeatures(int key)
List of features advertised on the invoice.
|
long |
getAddIndex()
The "add" index of this invoice.
|
java.util.Map<java.lang.String,LightningApi.AMPInvoiceState> |
getAmpInvoiceState()
Deprecated.
|
int |
getAmpInvoiceStateCount()
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
java.util.Map<java.lang.String,LightningApi.AMPInvoiceState> |
getAmpInvoiceStateMap()
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
LightningApi.AMPInvoiceState |
getAmpInvoiceStateOrDefault(java.lang.String key,
LightningApi.AMPInvoiceState defaultValue)
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
LightningApi.AMPInvoiceState |
getAmpInvoiceStateOrThrow(java.lang.String key)
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
long |
getAmtPaid()
Deprecated.
lnrpc.Invoice.amt_paid is deprecated.
See lightning.api.proto;l=3595
|
long |
getAmtPaidMsat()
The amount that was accepted for this invoice, in millisatoshis.
|
long |
getAmtPaidSat()
The amount that was accepted for this invoice, in satoshis.
|
long |
getCltvExpiry()
Delta to use for the time-lock of the CLTV extended to the final hop.
|
long |
getCreationDate()
When this invoice was created.
|
LightningApi.Invoice |
getDefaultInstanceForType() |
com.google.protobuf.ByteString |
getDescriptionHash()
Hash (SHA-256) of a description of the payment.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
long |
getExpiry()
Payment request expiry time in seconds.
|
java.lang.String |
getFallbackAddr()
Fallback on-chain address.
|
com.google.protobuf.ByteString |
getFallbackAddrBytes()
Fallback on-chain address.
|
java.util.Map<java.lang.Integer,LightningApi.Feature> |
getFeatures()
Deprecated.
|
int |
getFeaturesCount()
List of features advertised on the invoice.
|
java.util.Map<java.lang.Integer,LightningApi.Feature> |
getFeaturesMap()
List of features advertised on the invoice.
|
LightningApi.Feature |
getFeaturesOrDefault(int key,
LightningApi.Feature defaultValue)
List of features advertised on the invoice.
|
LightningApi.Feature |
getFeaturesOrThrow(int key)
List of features advertised on the invoice.
|
LightningApi.InvoiceHTLC |
getHtlcs(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.InvoiceHTLC.Builder |
getHtlcsBuilder(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
java.util.List<LightningApi.InvoiceHTLC.Builder> |
getHtlcsBuilderList()
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
int |
getHtlcsCount()
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
java.util.List<LightningApi.InvoiceHTLC> |
getHtlcsList()
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.InvoiceHTLCOrBuilder |
getHtlcsOrBuilder(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
java.util.List<? extends LightningApi.InvoiceHTLCOrBuilder> |
getHtlcsOrBuilderList()
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
boolean |
getIsAmp()
Signals whether or not this is an AMP invoice.
|
boolean |
getIsKeysend()
Indicates if this invoice was a spontaneous payment that arrived via keysend
[EXPERIMENTAL].
|
java.lang.String |
getMemo()
An optional memo to attach along with the invoice.
|
com.google.protobuf.ByteString |
getMemoBytes()
An optional memo to attach along with the invoice.
|
java.util.Map<java.lang.String,LightningApi.AMPInvoiceState> |
getMutableAmpInvoiceState()
Deprecated.
|
java.util.Map<java.lang.Integer,LightningApi.Feature> |
getMutableFeatures()
Deprecated.
|
com.google.protobuf.ByteString |
getPaymentAddr()
The payment address of this invoice.
|
java.lang.String |
getPaymentRequest()
A bare-bones invoice for a payment within the Lightning Network.
|
com.google.protobuf.ByteString |
getPaymentRequestBytes()
A bare-bones invoice for a payment within the Lightning Network.
|
boolean |
getPrivate()
Whether this invoice should include routing hints for private channels.
|
com.google.protobuf.ByteString |
getRHash()
The hash of the preimage.
|
LightningApi.RouteHint |
getRouteHints(int index)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.RouteHint.Builder |
getRouteHintsBuilder(int index)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
java.util.List<LightningApi.RouteHint.Builder> |
getRouteHintsBuilderList()
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
int |
getRouteHintsCount()
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
java.util.List<LightningApi.RouteHint> |
getRouteHintsList()
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.RouteHintOrBuilder |
getRouteHintsOrBuilder(int index)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
java.util.List<? extends LightningApi.RouteHintOrBuilder> |
getRouteHintsOrBuilderList()
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
com.google.protobuf.ByteString |
getRPreimage()
The hex-encoded preimage (32 byte) which will allow settling an incoming
HTLC payable to this preimage.
|
boolean |
getSettled()
Deprecated.
lnrpc.Invoice.settled is deprecated.
See lightning.api.proto;l=3524
|
long |
getSettleDate()
When this invoice was settled.
|
long |
getSettleIndex()
The "settle" index of this invoice.
|
LightningApi.Invoice.InvoiceState |
getState()
The state the invoice is in.
|
int |
getStateValue()
The state the invoice is in.
|
long |
getValue()
The value of this invoice in satoshis
The fields value and value_msat are mutually exclusive.
|
long |
getValueMsat()
The value of this invoice in millisatoshis
The fields value and value_msat are mutually exclusive.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
protected com.google.protobuf.MapField |
internalGetMutableMapField(int number) |
boolean |
isInitialized() |
LightningApi.Invoice.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
LightningApi.Invoice.Builder |
mergeFrom(LightningApi.Invoice other) |
LightningApi.Invoice.Builder |
mergeFrom(com.google.protobuf.Message other) |
LightningApi.Invoice.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
LightningApi.Invoice.Builder |
putAllAmpInvoiceState(java.util.Map<java.lang.String,LightningApi.AMPInvoiceState> values)
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
LightningApi.Invoice.Builder |
putAllFeatures(java.util.Map<java.lang.Integer,LightningApi.Feature> values)
List of features advertised on the invoice.
|
LightningApi.Invoice.Builder |
putAmpInvoiceState(java.lang.String key,
LightningApi.AMPInvoiceState value)
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
LightningApi.Invoice.Builder |
putFeatures(int key,
LightningApi.Feature value)
List of features advertised on the invoice.
|
LightningApi.Invoice.Builder |
removeAmpInvoiceState(java.lang.String key)
[EXPERIMENTAL]:
Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the
given set ID.
|
LightningApi.Invoice.Builder |
removeFeatures(int key)
List of features advertised on the invoice.
|
LightningApi.Invoice.Builder |
removeHtlcs(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.Invoice.Builder |
removeRouteHints(int index)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.Invoice.Builder |
setAddIndex(long value)
The "add" index of this invoice.
|
LightningApi.Invoice.Builder |
setAmtPaid(long value)
Deprecated.
lnrpc.Invoice.amt_paid is deprecated.
See lightning.api.proto;l=3595
|
LightningApi.Invoice.Builder |
setAmtPaidMsat(long value)
The amount that was accepted for this invoice, in millisatoshis.
|
LightningApi.Invoice.Builder |
setAmtPaidSat(long value)
The amount that was accepted for this invoice, in satoshis.
|
LightningApi.Invoice.Builder |
setCltvExpiry(long value)
Delta to use for the time-lock of the CLTV extended to the final hop.
|
LightningApi.Invoice.Builder |
setCreationDate(long value)
When this invoice was created.
|
LightningApi.Invoice.Builder |
setDescriptionHash(com.google.protobuf.ByteString value)
Hash (SHA-256) of a description of the payment.
|
LightningApi.Invoice.Builder |
setExpiry(long value)
Payment request expiry time in seconds.
|
LightningApi.Invoice.Builder |
setFallbackAddr(java.lang.String value)
Fallback on-chain address.
|
LightningApi.Invoice.Builder |
setFallbackAddrBytes(com.google.protobuf.ByteString value)
Fallback on-chain address.
|
LightningApi.Invoice.Builder |
setHtlcs(int index,
LightningApi.InvoiceHTLC.Builder builderForValue)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.Invoice.Builder |
setHtlcs(int index,
LightningApi.InvoiceHTLC value)
List of HTLCs paying to this invoice [EXPERIMENTAL].
|
LightningApi.Invoice.Builder |
setIsAmp(boolean value)
Signals whether or not this is an AMP invoice.
|
LightningApi.Invoice.Builder |
setIsKeysend(boolean value)
Indicates if this invoice was a spontaneous payment that arrived via keysend
[EXPERIMENTAL].
|
LightningApi.Invoice.Builder |
setMemo(java.lang.String value)
An optional memo to attach along with the invoice.
|
LightningApi.Invoice.Builder |
setMemoBytes(com.google.protobuf.ByteString value)
An optional memo to attach along with the invoice.
|
LightningApi.Invoice.Builder |
setPaymentAddr(com.google.protobuf.ByteString value)
The payment address of this invoice.
|
LightningApi.Invoice.Builder |
setPaymentRequest(java.lang.String value)
A bare-bones invoice for a payment within the Lightning Network.
|
LightningApi.Invoice.Builder |
setPaymentRequestBytes(com.google.protobuf.ByteString value)
A bare-bones invoice for a payment within the Lightning Network.
|
LightningApi.Invoice.Builder |
setPrivate(boolean value)
Whether this invoice should include routing hints for private channels.
|
LightningApi.Invoice.Builder |
setRHash(com.google.protobuf.ByteString value)
The hash of the preimage.
|
LightningApi.Invoice.Builder |
setRouteHints(int index,
LightningApi.RouteHint.Builder builderForValue)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.Invoice.Builder |
setRouteHints(int index,
LightningApi.RouteHint value)
Route hints that can each be individually used to assist in reaching the
invoice's destination.
|
LightningApi.Invoice.Builder |
setRPreimage(com.google.protobuf.ByteString value)
The hex-encoded preimage (32 byte) which will allow settling an incoming
HTLC payable to this preimage.
|
LightningApi.Invoice.Builder |
setSettled(boolean value)
Deprecated.
lnrpc.Invoice.settled is deprecated.
See lightning.api.proto;l=3524
|
LightningApi.Invoice.Builder |
setSettleDate(long value)
When this invoice was settled.
|
LightningApi.Invoice.Builder |
setSettleIndex(long value)
The "settle" index of this invoice.
|
LightningApi.Invoice.Builder |
setState(LightningApi.Invoice.InvoiceState value)
The state the invoice is in.
|
LightningApi.Invoice.Builder |
setStateValue(int value)
The state the invoice is in.
|
LightningApi.Invoice.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
LightningApi.Invoice.Builder |
setValue(long value)
The value of this invoice in satoshis
The fields value and value_msat are mutually exclusive.
|
LightningApi.Invoice.Builder |
setValueMsat(long value)
The value of this invoice in millisatoshis
The fields value and value_msat are mutually exclusive.
|
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapFieldReflection, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Invoice.Builder>protected com.google.protobuf.MapField internalGetMutableMapField(int number)
internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Invoice.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Invoice.Builder>public LightningApi.Invoice.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Invoice.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Invoice.Builder>public LightningApi.Invoice getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic LightningApi.Invoice build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic LightningApi.Invoice buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic LightningApi.Invoice.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<LightningApi.Invoice.Builder>public LightningApi.Invoice.Builder mergeFrom(LightningApi.Invoice other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Invoice.Builder>public LightningApi.Invoice.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<LightningApi.Invoice.Builder>java.io.IOExceptionpublic java.lang.String getMemo()
An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice's creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used.
string memo = 1;getMemo in interface LightningApi.InvoiceOrBuilderpublic com.google.protobuf.ByteString getMemoBytes()
An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice's creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used.
string memo = 1;getMemoBytes in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setMemo(java.lang.String value)
An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice's creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used.
string memo = 1;value - The memo to set.public LightningApi.Invoice.Builder clearMemo()
An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice's creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used.
string memo = 1;public LightningApi.Invoice.Builder setMemoBytes(com.google.protobuf.ByteString value)
An optional memo to attach along with the invoice. Used for record keeping purposes for the invoice's creator, and will also be set in the description field of the encoded payment request if the description_hash field is not being used.
string memo = 1;value - The bytes for memo to set.public com.google.protobuf.ByteString getRPreimage()
The hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage. When using REST, this field must be encoded as base64.
bytes r_preimage = 3;getRPreimage in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setRPreimage(com.google.protobuf.ByteString value)
The hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage. When using REST, this field must be encoded as base64.
bytes r_preimage = 3;value - The rPreimage to set.public LightningApi.Invoice.Builder clearRPreimage()
The hex-encoded preimage (32 byte) which will allow settling an incoming HTLC payable to this preimage. When using REST, this field must be encoded as base64.
bytes r_preimage = 3;public com.google.protobuf.ByteString getRHash()
The hash of the preimage. When using REST, this field must be encoded as base64. Note: Output only, don't specify for creating an invoice.
bytes r_hash = 4;getRHash in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setRHash(com.google.protobuf.ByteString value)
The hash of the preimage. When using REST, this field must be encoded as base64. Note: Output only, don't specify for creating an invoice.
bytes r_hash = 4;value - The rHash to set.public LightningApi.Invoice.Builder clearRHash()
The hash of the preimage. When using REST, this field must be encoded as base64. Note: Output only, don't specify for creating an invoice.
bytes r_hash = 4;public long getValue()
The value of this invoice in satoshis The fields value and value_msat are mutually exclusive.
int64 value = 5;getValue in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setValue(long value)
The value of this invoice in satoshis The fields value and value_msat are mutually exclusive.
int64 value = 5;value - The value to set.public LightningApi.Invoice.Builder clearValue()
The value of this invoice in satoshis The fields value and value_msat are mutually exclusive.
int64 value = 5;public long getValueMsat()
The value of this invoice in millisatoshis The fields value and value_msat are mutually exclusive.
int64 value_msat = 23;getValueMsat in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setValueMsat(long value)
The value of this invoice in millisatoshis The fields value and value_msat are mutually exclusive.
int64 value_msat = 23;value - The valueMsat to set.public LightningApi.Invoice.Builder clearValueMsat()
The value of this invoice in millisatoshis The fields value and value_msat are mutually exclusive.
int64 value_msat = 23;@Deprecated public boolean getSettled()
Whether this invoice has been fulfilled. The field is deprecated. Use the state field instead (compare to SETTLED).
bool settled = 6 [deprecated = true];getSettled in interface LightningApi.InvoiceOrBuilder@Deprecated public LightningApi.Invoice.Builder setSettled(boolean value)
Whether this invoice has been fulfilled. The field is deprecated. Use the state field instead (compare to SETTLED).
bool settled = 6 [deprecated = true];value - The settled to set.@Deprecated public LightningApi.Invoice.Builder clearSettled()
Whether this invoice has been fulfilled. The field is deprecated. Use the state field instead (compare to SETTLED).
bool settled = 6 [deprecated = true];public long getCreationDate()
When this invoice was created. Measured in seconds since the unix epoch. Note: Output only, don't specify for creating an invoice.
int64 creation_date = 7;getCreationDate in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setCreationDate(long value)
When this invoice was created. Measured in seconds since the unix epoch. Note: Output only, don't specify for creating an invoice.
int64 creation_date = 7;value - The creationDate to set.public LightningApi.Invoice.Builder clearCreationDate()
When this invoice was created. Measured in seconds since the unix epoch. Note: Output only, don't specify for creating an invoice.
int64 creation_date = 7;public long getSettleDate()
When this invoice was settled. Measured in seconds since the unix epoch. Note: Output only, don't specify for creating an invoice.
int64 settle_date = 8;getSettleDate in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setSettleDate(long value)
When this invoice was settled. Measured in seconds since the unix epoch. Note: Output only, don't specify for creating an invoice.
int64 settle_date = 8;value - The settleDate to set.public LightningApi.Invoice.Builder clearSettleDate()
When this invoice was settled. Measured in seconds since the unix epoch. Note: Output only, don't specify for creating an invoice.
int64 settle_date = 8;public java.lang.String getPaymentRequest()
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. Note: Output only, don't specify for creating an invoice.
string payment_request = 9;getPaymentRequest in interface LightningApi.InvoiceOrBuilderpublic com.google.protobuf.ByteString getPaymentRequestBytes()
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. Note: Output only, don't specify for creating an invoice.
string payment_request = 9;getPaymentRequestBytes in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setPaymentRequest(java.lang.String value)
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. Note: Output only, don't specify for creating an invoice.
string payment_request = 9;value - The paymentRequest to set.public LightningApi.Invoice.Builder clearPaymentRequest()
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. Note: Output only, don't specify for creating an invoice.
string payment_request = 9;public LightningApi.Invoice.Builder setPaymentRequestBytes(com.google.protobuf.ByteString value)
A bare-bones invoice for a payment within the Lightning Network. With the details of the invoice, the sender has all the data necessary to send a payment to the recipient. Note: Output only, don't specify for creating an invoice.
string payment_request = 9;value - The bytes for paymentRequest to set.public com.google.protobuf.ByteString getDescriptionHash()
Hash (SHA-256) of a description of the payment. Used if the description of payment (memo) is too long to naturally fit within the description field of an encoded payment request. When using REST, this field must be encoded as base64.
bytes description_hash = 10;getDescriptionHash in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setDescriptionHash(com.google.protobuf.ByteString value)
Hash (SHA-256) of a description of the payment. Used if the description of payment (memo) is too long to naturally fit within the description field of an encoded payment request. When using REST, this field must be encoded as base64.
bytes description_hash = 10;value - The descriptionHash to set.public LightningApi.Invoice.Builder clearDescriptionHash()
Hash (SHA-256) of a description of the payment. Used if the description of payment (memo) is too long to naturally fit within the description field of an encoded payment request. When using REST, this field must be encoded as base64.
bytes description_hash = 10;public long getExpiry()
Payment request expiry time in seconds. Default is 86400 (24 hours).
int64 expiry = 11;getExpiry in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setExpiry(long value)
Payment request expiry time in seconds. Default is 86400 (24 hours).
int64 expiry = 11;value - The expiry to set.public LightningApi.Invoice.Builder clearExpiry()
Payment request expiry time in seconds. Default is 86400 (24 hours).
int64 expiry = 11;public java.lang.String getFallbackAddr()
Fallback on-chain address.
string fallback_addr = 12;getFallbackAddr in interface LightningApi.InvoiceOrBuilderpublic com.google.protobuf.ByteString getFallbackAddrBytes()
Fallback on-chain address.
string fallback_addr = 12;getFallbackAddrBytes in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setFallbackAddr(java.lang.String value)
Fallback on-chain address.
string fallback_addr = 12;value - The fallbackAddr to set.public LightningApi.Invoice.Builder clearFallbackAddr()
Fallback on-chain address.
string fallback_addr = 12;public LightningApi.Invoice.Builder setFallbackAddrBytes(com.google.protobuf.ByteString value)
Fallback on-chain address.
string fallback_addr = 12;value - The bytes for fallbackAddr to set.public long getCltvExpiry()
Delta to use for the time-lock of the CLTV extended to the final hop.
uint64 cltv_expiry = 13;getCltvExpiry in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setCltvExpiry(long value)
Delta to use for the time-lock of the CLTV extended to the final hop.
uint64 cltv_expiry = 13;value - The cltvExpiry to set.public LightningApi.Invoice.Builder clearCltvExpiry()
Delta to use for the time-lock of the CLTV extended to the final hop.
uint64 cltv_expiry = 13;public java.util.List<LightningApi.RouteHint> getRouteHintsList()
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;getRouteHintsList in interface LightningApi.InvoiceOrBuilderpublic int getRouteHintsCount()
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;getRouteHintsCount in interface LightningApi.InvoiceOrBuilderpublic LightningApi.RouteHint getRouteHints(int index)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;getRouteHints in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setRouteHints(int index, LightningApi.RouteHint value)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public LightningApi.Invoice.Builder setRouteHints(int index, LightningApi.RouteHint.Builder builderForValue)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public LightningApi.Invoice.Builder addRouteHints(LightningApi.RouteHint value)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public LightningApi.Invoice.Builder addRouteHints(int index, LightningApi.RouteHint value)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public LightningApi.Invoice.Builder addRouteHints(LightningApi.RouteHint.Builder builderForValue)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public LightningApi.Invoice.Builder addRouteHints(int index, LightningApi.RouteHint.Builder builderForValue)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public LightningApi.Invoice.Builder addAllRouteHints(java.lang.Iterable<? extends LightningApi.RouteHint> values)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public LightningApi.Invoice.Builder clearRouteHints()
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public LightningApi.Invoice.Builder removeRouteHints(int index)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public LightningApi.RouteHint.Builder getRouteHintsBuilder(int index)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public LightningApi.RouteHintOrBuilder getRouteHintsOrBuilder(int index)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;getRouteHintsOrBuilder in interface LightningApi.InvoiceOrBuilderpublic java.util.List<? extends LightningApi.RouteHintOrBuilder> getRouteHintsOrBuilderList()
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;getRouteHintsOrBuilderList in interface LightningApi.InvoiceOrBuilderpublic LightningApi.RouteHint.Builder addRouteHintsBuilder()
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public LightningApi.RouteHint.Builder addRouteHintsBuilder(int index)
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public java.util.List<LightningApi.RouteHint.Builder> getRouteHintsBuilderList()
Route hints that can each be individually used to assist in reaching the invoice's destination.
repeated .lnrpc.RouteHint route_hints = 14;public boolean getPrivate()
Whether this invoice should include routing hints for private channels. Note: When enabled, if value and value_msat are zero, a large number of hints with these channels can be included, which might not be desirable.
bool private = 15;getPrivate in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setPrivate(boolean value)
Whether this invoice should include routing hints for private channels. Note: When enabled, if value and value_msat are zero, a large number of hints with these channels can be included, which might not be desirable.
bool private = 15;value - The private to set.public LightningApi.Invoice.Builder clearPrivate()
Whether this invoice should include routing hints for private channels. Note: When enabled, if value and value_msat are zero, a large number of hints with these channels can be included, which might not be desirable.
bool private = 15;public long getAddIndex()
The "add" index of this invoice. Each newly created invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all added invoices with an add_index greater than this one. Note: Output only, don't specify for creating an invoice.
uint64 add_index = 16;getAddIndex in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setAddIndex(long value)
The "add" index of this invoice. Each newly created invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all added invoices with an add_index greater than this one. Note: Output only, don't specify for creating an invoice.
uint64 add_index = 16;value - The addIndex to set.public LightningApi.Invoice.Builder clearAddIndex()
The "add" index of this invoice. Each newly created invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all added invoices with an add_index greater than this one. Note: Output only, don't specify for creating an invoice.
uint64 add_index = 16;public long getSettleIndex()
The "settle" index of this invoice. Each newly settled invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all settled invoices with an settle_index greater than this one. Note: Output only, don't specify for creating an invoice.
uint64 settle_index = 17;getSettleIndex in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setSettleIndex(long value)
The "settle" index of this invoice. Each newly settled invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all settled invoices with an settle_index greater than this one. Note: Output only, don't specify for creating an invoice.
uint64 settle_index = 17;value - The settleIndex to set.public LightningApi.Invoice.Builder clearSettleIndex()
The "settle" index of this invoice. Each newly settled invoice will increment this index making it monotonically increasing. Callers to the SubscribeInvoices call can use this to instantly get notified of all settled invoices with an settle_index greater than this one. Note: Output only, don't specify for creating an invoice.
uint64 settle_index = 17;@Deprecated public long getAmtPaid()
Deprecated, use amt_paid_sat or amt_paid_msat.
int64 amt_paid = 18 [deprecated = true];getAmtPaid in interface LightningApi.InvoiceOrBuilder@Deprecated public LightningApi.Invoice.Builder setAmtPaid(long value)
Deprecated, use amt_paid_sat or amt_paid_msat.
int64 amt_paid = 18 [deprecated = true];value - The amtPaid to set.@Deprecated public LightningApi.Invoice.Builder clearAmtPaid()
Deprecated, use amt_paid_sat or amt_paid_msat.
int64 amt_paid = 18 [deprecated = true];public long getAmtPaidSat()
The amount that was accepted for this invoice, in satoshis. This will ONLY be set if this invoice has been settled or accepted. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well. Note: Output only, don't specify for creating an invoice.
int64 amt_paid_sat = 19;getAmtPaidSat in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setAmtPaidSat(long value)
The amount that was accepted for this invoice, in satoshis. This will ONLY be set if this invoice has been settled or accepted. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well. Note: Output only, don't specify for creating an invoice.
int64 amt_paid_sat = 19;value - The amtPaidSat to set.public LightningApi.Invoice.Builder clearAmtPaidSat()
The amount that was accepted for this invoice, in satoshis. This will ONLY be set if this invoice has been settled or accepted. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well. Note: Output only, don't specify for creating an invoice.
int64 amt_paid_sat = 19;public long getAmtPaidMsat()
The amount that was accepted for this invoice, in millisatoshis. This will ONLY be set if this invoice has been settled or accepted. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well. Note: Output only, don't specify for creating an invoice.
int64 amt_paid_msat = 20;getAmtPaidMsat in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setAmtPaidMsat(long value)
The amount that was accepted for this invoice, in millisatoshis. This will ONLY be set if this invoice has been settled or accepted. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well. Note: Output only, don't specify for creating an invoice.
int64 amt_paid_msat = 20;value - The amtPaidMsat to set.public LightningApi.Invoice.Builder clearAmtPaidMsat()
The amount that was accepted for this invoice, in millisatoshis. This will ONLY be set if this invoice has been settled or accepted. We provide this field as if the invoice was created with a zero value, then we need to record what amount was ultimately accepted. Additionally, it's possible that the sender paid MORE that was specified in the original invoice. So we'll record that here as well. Note: Output only, don't specify for creating an invoice.
int64 amt_paid_msat = 20;public int getStateValue()
The state the invoice is in. Note: Output only, don't specify for creating an invoice.
.lnrpc.Invoice.InvoiceState state = 21;getStateValue in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setStateValue(int value)
The state the invoice is in. Note: Output only, don't specify for creating an invoice.
.lnrpc.Invoice.InvoiceState state = 21;value - The enum numeric value on the wire for state to set.public LightningApi.Invoice.InvoiceState getState()
The state the invoice is in. Note: Output only, don't specify for creating an invoice.
.lnrpc.Invoice.InvoiceState state = 21;getState in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setState(LightningApi.Invoice.InvoiceState value)
The state the invoice is in. Note: Output only, don't specify for creating an invoice.
.lnrpc.Invoice.InvoiceState state = 21;value - The state to set.public LightningApi.Invoice.Builder clearState()
The state the invoice is in. Note: Output only, don't specify for creating an invoice.
.lnrpc.Invoice.InvoiceState state = 21;public java.util.List<LightningApi.InvoiceHTLC> getHtlcsList()
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;getHtlcsList in interface LightningApi.InvoiceOrBuilderpublic int getHtlcsCount()
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;getHtlcsCount in interface LightningApi.InvoiceOrBuilderpublic LightningApi.InvoiceHTLC getHtlcs(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;getHtlcs in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setHtlcs(int index, LightningApi.InvoiceHTLC value)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public LightningApi.Invoice.Builder setHtlcs(int index, LightningApi.InvoiceHTLC.Builder builderForValue)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public LightningApi.Invoice.Builder addHtlcs(LightningApi.InvoiceHTLC value)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public LightningApi.Invoice.Builder addHtlcs(int index, LightningApi.InvoiceHTLC value)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public LightningApi.Invoice.Builder addHtlcs(LightningApi.InvoiceHTLC.Builder builderForValue)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public LightningApi.Invoice.Builder addHtlcs(int index, LightningApi.InvoiceHTLC.Builder builderForValue)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public LightningApi.Invoice.Builder addAllHtlcs(java.lang.Iterable<? extends LightningApi.InvoiceHTLC> values)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public LightningApi.Invoice.Builder clearHtlcs()
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public LightningApi.Invoice.Builder removeHtlcs(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public LightningApi.InvoiceHTLC.Builder getHtlcsBuilder(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public LightningApi.InvoiceHTLCOrBuilder getHtlcsOrBuilder(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;getHtlcsOrBuilder in interface LightningApi.InvoiceOrBuilderpublic java.util.List<? extends LightningApi.InvoiceHTLCOrBuilder> getHtlcsOrBuilderList()
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;getHtlcsOrBuilderList in interface LightningApi.InvoiceOrBuilderpublic LightningApi.InvoiceHTLC.Builder addHtlcsBuilder()
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public LightningApi.InvoiceHTLC.Builder addHtlcsBuilder(int index)
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public java.util.List<LightningApi.InvoiceHTLC.Builder> getHtlcsBuilderList()
List of HTLCs paying to this invoice [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
repeated .lnrpc.InvoiceHTLC htlcs = 22;public int getFeaturesCount()
LightningApi.InvoiceOrBuilderList of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;getFeaturesCount in interface LightningApi.InvoiceOrBuilderpublic boolean containsFeatures(int key)
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;containsFeatures in interface LightningApi.InvoiceOrBuilder@Deprecated public java.util.Map<java.lang.Integer,LightningApi.Feature> getFeatures()
getFeaturesMap() instead.getFeatures in interface LightningApi.InvoiceOrBuilderpublic java.util.Map<java.lang.Integer,LightningApi.Feature> getFeaturesMap()
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;getFeaturesMap in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Feature getFeaturesOrDefault(int key, LightningApi.Feature defaultValue)
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;getFeaturesOrDefault in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Feature getFeaturesOrThrow(int key)
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;getFeaturesOrThrow in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder clearFeatures()
public LightningApi.Invoice.Builder removeFeatures(int key)
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;@Deprecated public java.util.Map<java.lang.Integer,LightningApi.Feature> getMutableFeatures()
public LightningApi.Invoice.Builder putFeatures(int key, LightningApi.Feature value)
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;public LightningApi.Invoice.Builder putAllFeatures(java.util.Map<java.lang.Integer,LightningApi.Feature> values)
List of features advertised on the invoice. Note: Output only, don't specify for creating an invoice.
map<uint32, .lnrpc.Feature> features = 24;public boolean getIsKeysend()
Indicates if this invoice was a spontaneous payment that arrived via keysend [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
bool is_keysend = 25;getIsKeysend in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setIsKeysend(boolean value)
Indicates if this invoice was a spontaneous payment that arrived via keysend [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
bool is_keysend = 25;value - The isKeysend to set.public LightningApi.Invoice.Builder clearIsKeysend()
Indicates if this invoice was a spontaneous payment that arrived via keysend [EXPERIMENTAL]. Note: Output only, don't specify for creating an invoice.
bool is_keysend = 25;public com.google.protobuf.ByteString getPaymentAddr()
The payment address of this invoice. This value will be used in MPP payments, and also for newer invoices that always require the MPP payload for added end-to-end security. Note: Output only, don't specify for creating an invoice.
bytes payment_addr = 26;getPaymentAddr in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setPaymentAddr(com.google.protobuf.ByteString value)
The payment address of this invoice. This value will be used in MPP payments, and also for newer invoices that always require the MPP payload for added end-to-end security. Note: Output only, don't specify for creating an invoice.
bytes payment_addr = 26;value - The paymentAddr to set.public LightningApi.Invoice.Builder clearPaymentAddr()
The payment address of this invoice. This value will be used in MPP payments, and also for newer invoices that always require the MPP payload for added end-to-end security. Note: Output only, don't specify for creating an invoice.
bytes payment_addr = 26;public boolean getIsAmp()
Signals whether or not this is an AMP invoice.
bool is_amp = 27;getIsAmp in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder setIsAmp(boolean value)
Signals whether or not this is an AMP invoice.
bool is_amp = 27;value - The isAmp to set.public LightningApi.Invoice.Builder clearIsAmp()
Signals whether or not this is an AMP invoice.
bool is_amp = 27;public int getAmpInvoiceStateCount()
LightningApi.InvoiceOrBuilder[EXPERIMENTAL]: Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the given set ID. This field is always populated for AMP invoices, and can be used along side LookupInvoice to obtain the HTLC information related to a given sub-invoice. Note: Output only, don't specify for creating an invoice.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;getAmpInvoiceStateCount in interface LightningApi.InvoiceOrBuilderpublic boolean containsAmpInvoiceState(java.lang.String key)
[EXPERIMENTAL]: Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the given set ID. This field is always populated for AMP invoices, and can be used along side LookupInvoice to obtain the HTLC information related to a given sub-invoice. Note: Output only, don't specify for creating an invoice.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;containsAmpInvoiceState in interface LightningApi.InvoiceOrBuilder@Deprecated public java.util.Map<java.lang.String,LightningApi.AMPInvoiceState> getAmpInvoiceState()
getAmpInvoiceStateMap() instead.getAmpInvoiceState in interface LightningApi.InvoiceOrBuilderpublic java.util.Map<java.lang.String,LightningApi.AMPInvoiceState> getAmpInvoiceStateMap()
[EXPERIMENTAL]: Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the given set ID. This field is always populated for AMP invoices, and can be used along side LookupInvoice to obtain the HTLC information related to a given sub-invoice. Note: Output only, don't specify for creating an invoice.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;getAmpInvoiceStateMap in interface LightningApi.InvoiceOrBuilderpublic LightningApi.AMPInvoiceState getAmpInvoiceStateOrDefault(java.lang.String key, LightningApi.AMPInvoiceState defaultValue)
[EXPERIMENTAL]: Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the given set ID. This field is always populated for AMP invoices, and can be used along side LookupInvoice to obtain the HTLC information related to a given sub-invoice. Note: Output only, don't specify for creating an invoice.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;getAmpInvoiceStateOrDefault in interface LightningApi.InvoiceOrBuilderpublic LightningApi.AMPInvoiceState getAmpInvoiceStateOrThrow(java.lang.String key)
[EXPERIMENTAL]: Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the given set ID. This field is always populated for AMP invoices, and can be used along side LookupInvoice to obtain the HTLC information related to a given sub-invoice. Note: Output only, don't specify for creating an invoice.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;getAmpInvoiceStateOrThrow in interface LightningApi.InvoiceOrBuilderpublic LightningApi.Invoice.Builder clearAmpInvoiceState()
public LightningApi.Invoice.Builder removeAmpInvoiceState(java.lang.String key)
[EXPERIMENTAL]: Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the given set ID. This field is always populated for AMP invoices, and can be used along side LookupInvoice to obtain the HTLC information related to a given sub-invoice. Note: Output only, don't specify for creating an invoice.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;@Deprecated public java.util.Map<java.lang.String,LightningApi.AMPInvoiceState> getMutableAmpInvoiceState()
public LightningApi.Invoice.Builder putAmpInvoiceState(java.lang.String key, LightningApi.AMPInvoiceState value)
[EXPERIMENTAL]: Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the given set ID. This field is always populated for AMP invoices, and can be used along side LookupInvoice to obtain the HTLC information related to a given sub-invoice. Note: Output only, don't specify for creating an invoice.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;public LightningApi.Invoice.Builder putAllAmpInvoiceState(java.util.Map<java.lang.String,LightningApi.AMPInvoiceState> values)
[EXPERIMENTAL]: Maps a 32-byte hex-encoded set ID to the sub-invoice AMP state for the given set ID. This field is always populated for AMP invoices, and can be used along side LookupInvoice to obtain the HTLC information related to a given sub-invoice. Note: Output only, don't specify for creating an invoice.
map<string, .lnrpc.AMPInvoiceState> amp_invoice_state = 28;public final LightningApi.Invoice.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Invoice.Builder>public final LightningApi.Invoice.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Invoice.Builder>