LightningApi.SendRequest (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.SendRequest

All Implemented Interfaces:

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

Enclosing class:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LightningApi.SendRequest.Builder
Protobuf type lnrpc.SendRequest
- 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

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALLOW_SELF_PAYMENT_FIELD_NUMBER`
`static int`	`AMT_FIELD_NUMBER`
`static int`	`AMT_MSAT_FIELD_NUMBER`
`static int`	`CLTV_LIMIT_FIELD_NUMBER`
`static int`	`DEST_CUSTOM_RECORDS_FIELD_NUMBER`
`static int`	`DEST_FEATURES_FIELD_NUMBER`
`static int`	`DEST_FIELD_NUMBER`
`static int`	`DEST_STRING_FIELD_NUMBER`
`static int`	`FEE_LIMIT_FIELD_NUMBER`
`static int`	`FINAL_CLTV_DELTA_FIELD_NUMBER`
`static int`	`LAST_HOP_PUBKEY_FIELD_NUMBER`
`static int`	`OUTGOING_CHAN_ID_FIELD_NUMBER`
`static int`	`PAYMENT_ADDR_FIELD_NUMBER`
`static int`	`PAYMENT_HASH_FIELD_NUMBER`
`static int`	`PAYMENT_HASH_STRING_FIELD_NUMBER`
`static int`	`PAYMENT_REQUEST_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`	`containsDestCustomRecords(long key)` An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records.
`boolean`	`equals(java.lang.Object obj)`
`boolean`	`getAllowSelfPayment()` If set, circular payments to self are permitted.
`long`	`getAmt()` The amount to send expressed in satoshis.
`long`	`getAmtMsat()` The amount to send expressed in millisatoshis.
`int`	`getCltvLimit()` An optional maximum total time lock for the route.
`static LightningApi.SendRequest`	`getDefaultInstance()`
`LightningApi.SendRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.ByteString`	`getDest()` The identity pubkey of the payment recipient.
`java.util.Map<java.lang.Long,com.google.protobuf.ByteString>`	`getDestCustomRecords()` Deprecated.
`int`	`getDestCustomRecordsCount()` An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records.
`java.util.Map<java.lang.Long,com.google.protobuf.ByteString>`	`getDestCustomRecordsMap()` An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records.
`com.google.protobuf.ByteString`	`getDestCustomRecordsOrDefault(long key, com.google.protobuf.ByteString defaultValue)` An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records.
`com.google.protobuf.ByteString`	`getDestCustomRecordsOrThrow(long key)` An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records.
`LightningApi.FeatureBit`	`getDestFeatures(int index)` Features assumed to be supported by the final node.
`int`	`getDestFeaturesCount()` Features assumed to be supported by the final node.
`java.util.List<LightningApi.FeatureBit>`	`getDestFeaturesList()` Features assumed to be supported by the final node.
`int`	`getDestFeaturesValue(int index)` Features assumed to be supported by the final node.
`java.util.List<java.lang.Integer>`	`getDestFeaturesValueList()` Features assumed to be supported by the final node.
`java.lang.String`	`getDestString()` Deprecated. lnrpc.SendRequest.dest_string is deprecated. See lightning.api.proto;l=796
`com.google.protobuf.ByteString`	`getDestStringBytes()` Deprecated. lnrpc.SendRequest.dest_string is deprecated. See lightning.api.proto;l=796
`LightningApi.FeeLimit`	`getFeeLimit()` The maximum number of satoshis that will be paid as a fee of the payment.
`LightningApi.FeeLimitOrBuilder`	`getFeeLimitOrBuilder()` The maximum number of satoshis that will be paid as a fee of the payment.
`int`	`getFinalCltvDelta()` The CLTV delta from the current height that should be used to set the timelock for the final hop.
`com.google.protobuf.ByteString`	`getLastHopPubkey()` The pubkey of the last hop of the route.
`long`	`getOutgoingChanId()` The channel id of the channel that must be taken to the first hop.
`com.google.protobuf.Parser<LightningApi.SendRequest>`	`getParserForType()`
`com.google.protobuf.ByteString`	`getPaymentAddr()` The payment address of the generated invoice.
`com.google.protobuf.ByteString`	`getPaymentHash()` The hash to use within the payment's HTLC.
`java.lang.String`	`getPaymentHashString()` Deprecated. lnrpc.SendRequest.payment_hash_string is deprecated. See lightning.api.proto;l=822
`com.google.protobuf.ByteString`	`getPaymentHashStringBytes()` Deprecated. lnrpc.SendRequest.payment_hash_string is deprecated. See lightning.api.proto;l=822
`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.
`int`	`getSerializedSize()`
`boolean`	`hasFeeLimit()` The maximum number of satoshis that will be paid as a fee of the payment.
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static LightningApi.SendRequest.Builder`	`newBuilder()`
`static LightningApi.SendRequest.Builder`	`newBuilder(LightningApi.SendRequest prototype)`
`LightningApi.SendRequest.Builder`	`newBuilderForType()`
`protected LightningApi.SendRequest.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected java.lang.Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static LightningApi.SendRequest`	`parseDelimitedFrom(java.io.InputStream input)`
`static LightningApi.SendRequest`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static LightningApi.SendRequest`	`parseFrom(byte[] data)`
`static LightningApi.SendRequest`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static LightningApi.SendRequest`	`parseFrom(java.nio.ByteBuffer data)`
`static LightningApi.SendRequest`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static LightningApi.SendRequest`	`parseFrom(com.google.protobuf.ByteString data)`
`static LightningApi.SendRequest`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static LightningApi.SendRequest`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static LightningApi.SendRequest`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static LightningApi.SendRequest`	`parseFrom(java.io.InputStream input)`
`static LightningApi.SendRequest`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<LightningApi.SendRequest>`	`parser()`
`LightningApi.SendRequest.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
- DEST_FIELD_NUMBER
```
public static final int DEST_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEST_STRING_FIELD_NUMBER
```
public static final int DEST_STRING_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- AMT_FIELD_NUMBER
```
public static final int AMT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- AMT_MSAT_FIELD_NUMBER
```
public static final int AMT_MSAT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAYMENT_HASH_FIELD_NUMBER
```
public static final int PAYMENT_HASH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAYMENT_HASH_STRING_FIELD_NUMBER
```
public static final int PAYMENT_HASH_STRING_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAYMENT_REQUEST_FIELD_NUMBER
```
public static final int PAYMENT_REQUEST_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FINAL_CLTV_DELTA_FIELD_NUMBER
```
public static final int FINAL_CLTV_DELTA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FEE_LIMIT_FIELD_NUMBER
```
public static final int FEE_LIMIT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OUTGOING_CHAN_ID_FIELD_NUMBER
```
public static final int OUTGOING_CHAN_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LAST_HOP_PUBKEY_FIELD_NUMBER
```
public static final int LAST_HOP_PUBKEY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CLTV_LIMIT_FIELD_NUMBER
```
public static final int CLTV_LIMIT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEST_CUSTOM_RECORDS_FIELD_NUMBER
```
public static final int DEST_CUSTOM_RECORDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ALLOW_SELF_PAYMENT_FIELD_NUMBER
```
public static final int ALLOW_SELF_PAYMENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEST_FEATURES_FIELD_NUMBER
```
public static final int DEST_FEATURES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAYMENT_ADDR_FIELD_NUMBER
```
public static final int PAYMENT_ADDR_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

getDest

public com.google.protobuf.ByteString getDest()


The identity pubkey of the payment recipient. When using REST, this field
must be encoded as base64.

bytes dest = 1;

Specified by:: getDest in interface LightningApi.SendRequestOrBuilder
Returns:: The dest.

getDestString
```
@Deprecated
public java.lang.String getDestString()
```
Deprecated. lnrpc.SendRequest.dest_string is deprecated. See lightning.api.proto;l=796
```
The hex-encoded identity pubkey of the payment recipient. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
 
```
string dest_string = 2 [deprecated = true];
Specified by:

getDestString in interface LightningApi.SendRequestOrBuilder

Returns:

The destString.

getDestStringBytes
```
@Deprecated
public com.google.protobuf.ByteString getDestStringBytes()
```
Deprecated. lnrpc.SendRequest.dest_string is deprecated. See lightning.api.proto;l=796
```
The hex-encoded identity pubkey of the payment recipient. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
 
```
string dest_string = 2 [deprecated = true];
Specified by:

getDestStringBytes in interface LightningApi.SendRequestOrBuilder

Returns:

The bytes for destString.

getAmt

public long getAmt()


The amount to send expressed in satoshis.

The fields amt and amt_msat are mutually exclusive.

int64 amt = 3;

Specified by:: getAmt in interface LightningApi.SendRequestOrBuilder
Returns:: The amt.

getAmtMsat

public long getAmtMsat()


The amount to send expressed in millisatoshis.

The fields amt and amt_msat are mutually exclusive.

int64 amt_msat = 12;

Specified by:: getAmtMsat in interface LightningApi.SendRequestOrBuilder
Returns:: The amtMsat.

getPaymentHash

public com.google.protobuf.ByteString getPaymentHash()


The hash to use within the payment's HTLC. When using REST, this field
must be encoded as base64.

bytes payment_hash = 4;

Specified by:: getPaymentHash in interface LightningApi.SendRequestOrBuilder
Returns:: The paymentHash.

getPaymentHashString
```
@Deprecated
public java.lang.String getPaymentHashString()
```
Deprecated. lnrpc.SendRequest.payment_hash_string is deprecated. See lightning.api.proto;l=822
```
The hex-encoded hash to use within the payment's HTLC. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
 
```
string payment_hash_string = 5 [deprecated = true];
Specified by:

getPaymentHashString in interface LightningApi.SendRequestOrBuilder

Returns:

The paymentHashString.

getPaymentHashStringBytes
```
@Deprecated
public com.google.protobuf.ByteString getPaymentHashStringBytes()
```
Deprecated. lnrpc.SendRequest.payment_hash_string is deprecated. See lightning.api.proto;l=822
```
The hex-encoded hash to use within the payment's HTLC. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.
 
```
string payment_hash_string = 5 [deprecated = true];
Specified by:

getPaymentHashStringBytes in interface LightningApi.SendRequestOrBuilder

Returns:

The bytes for paymentHashString.

getPaymentRequest

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.

string payment_request = 6;

Specified by:: getPaymentRequest in interface LightningApi.SendRequestOrBuilder
Returns:: The paymentRequest.

getPaymentRequestBytes

public 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.

string payment_request = 6;

Specified by:: getPaymentRequestBytes in interface LightningApi.SendRequestOrBuilder
Returns:: The bytes for paymentRequest.

getFinalCltvDelta
```
public int getFinalCltvDelta()
```
```
The CLTV delta from the current height that should be used to set the
timelock for the final hop.
 
```
int32 final_cltv_delta = 7;
Specified by:

getFinalCltvDelta in interface LightningApi.SendRequestOrBuilder

Returns:

The finalCltvDelta.

hasFeeLimit

public boolean hasFeeLimit()


The maximum number of satoshis that will be paid as a fee of the payment.
This value can be represented either as a percentage of the amount being
sent, or as a fixed amount of the maximum fee the user is willing the pay to
send the payment. If not specified, lnd will use a default value of 100%
fees for small amounts (<=1k sat) or 5% fees for larger amounts.

.lnrpc.FeeLimit fee_limit = 8;

Specified by:: hasFeeLimit in interface LightningApi.SendRequestOrBuilder
Returns:: Whether the feeLimit field is set.

getFeeLimit

public LightningApi.FeeLimit getFeeLimit()


The maximum number of satoshis that will be paid as a fee of the payment.
This value can be represented either as a percentage of the amount being
sent, or as a fixed amount of the maximum fee the user is willing the pay to
send the payment. If not specified, lnd will use a default value of 100%
fees for small amounts (<=1k sat) or 5% fees for larger amounts.

.lnrpc.FeeLimit fee_limit = 8;

Specified by:: getFeeLimit in interface LightningApi.SendRequestOrBuilder
Returns:: The feeLimit.

getFeeLimitOrBuilder

public LightningApi.FeeLimitOrBuilder getFeeLimitOrBuilder()


The maximum number of satoshis that will be paid as a fee of the payment.
This value can be represented either as a percentage of the amount being
sent, or as a fixed amount of the maximum fee the user is willing the pay to
send the payment. If not specified, lnd will use a default value of 100%
fees for small amounts (<=1k sat) or 5% fees for larger amounts.

.lnrpc.FeeLimit fee_limit = 8;

Specified by:: getFeeLimitOrBuilder in interface LightningApi.SendRequestOrBuilder

getOutgoingChanId
```
public long getOutgoingChanId()
```
```
The channel id of the channel that must be taken to the first hop. If zero,
any channel may be used.
 
```
uint64 outgoing_chan_id = 9 [jstype = JS_STRING];
Specified by:

getOutgoingChanId in interface LightningApi.SendRequestOrBuilder

Returns:

The outgoingChanId.

getLastHopPubkey
```
public com.google.protobuf.ByteString getLastHopPubkey()
```
```
The pubkey of the last hop of the route. If empty, any hop may be used.
 
```
bytes last_hop_pubkey = 13;
Specified by:

getLastHopPubkey in interface LightningApi.SendRequestOrBuilder

Returns:

The lastHopPubkey.

getCltvLimit

public int getCltvLimit()


An optional maximum total time lock for the route. This should not exceed
lnd's `--max-cltv-expiry` setting. If zero, then the value of
`--max-cltv-expiry` is enforced.

uint32 cltv_limit = 10;

Specified by:: getCltvLimit in interface LightningApi.SendRequestOrBuilder
Returns:: The cltvLimit.