org.lightningj.lnd.proto

Class LightningApi.Route.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>

org.lightningj.lnd.proto.LightningApi.Route.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, LightningApi.RouteOrBuilder

Enclosing class:

LightningApi.Route

public static final class LightningApi.Route.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>
implements LightningApi.RouteOrBuilder

A path through the channel graph which runs over one or more channels in
succession. This struct carries all the information required to craft the
Sphinx onion packet, and send the payment along the first hop in the path. A
route is only selected as valid if all the channels have sufficient capacity to
carry the initial payment amount after fees are accounted for.
 

Protobuf type lnrpc.Route

Method Summary

Modifier and Type	Method and Description
LightningApi.Route.Builder	addAllHops(java.lang.Iterable<? extends LightningApi.Hop> values) Contains details concerning the specific forwarding details at each hop.
LightningApi.Route.Builder	addHops(int index, LightningApi.Hop.Builder builderForValue) Contains details concerning the specific forwarding details at each hop.
LightningApi.Route.Builder	addHops(int index, LightningApi.Hop value) Contains details concerning the specific forwarding details at each hop.
LightningApi.Route.Builder	addHops(LightningApi.Hop.Builder builderForValue) Contains details concerning the specific forwarding details at each hop.
LightningApi.Route.Builder	addHops(LightningApi.Hop value) Contains details concerning the specific forwarding details at each hop.
LightningApi.Hop.Builder	addHopsBuilder() Contains details concerning the specific forwarding details at each hop.
LightningApi.Hop.Builder	addHopsBuilder(int index) Contains details concerning the specific forwarding details at each hop.
LightningApi.Route	build()
LightningApi.Route	buildPartial()
LightningApi.Route.Builder	clear()
LightningApi.Route.Builder	clearHops() Contains details concerning the specific forwarding details at each hop.
LightningApi.Route.Builder	clearTotalAmt() Deprecated. lnrpc.Route.total_amt is deprecated. See lightning.api.proto;l=3179
LightningApi.Route.Builder	clearTotalAmtMsat() The total amount in millisatoshis.
LightningApi.Route.Builder	clearTotalFees() Deprecated. lnrpc.Route.total_fees is deprecated. See lightning.api.proto;l=3170
LightningApi.Route.Builder	clearTotalFeesMsat() The total fees in millisatoshis.
LightningApi.Route.Builder	clearTotalTimeLock() The cumulative (final) time lock across the entire route.
LightningApi.Route	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
LightningApi.Hop	getHops(int index) Contains details concerning the specific forwarding details at each hop.
LightningApi.Hop.Builder	getHopsBuilder(int index) Contains details concerning the specific forwarding details at each hop.
java.util.List<LightningApi.Hop.Builder>	getHopsBuilderList() Contains details concerning the specific forwarding details at each hop.
int	getHopsCount() Contains details concerning the specific forwarding details at each hop.
java.util.List<LightningApi.Hop>	getHopsList() Contains details concerning the specific forwarding details at each hop.
LightningApi.HopOrBuilder	getHopsOrBuilder(int index) Contains details concerning the specific forwarding details at each hop.
java.util.List<? extends LightningApi.HopOrBuilder>	getHopsOrBuilderList() Contains details concerning the specific forwarding details at each hop.
long	getTotalAmt() Deprecated. lnrpc.Route.total_amt is deprecated. See lightning.api.proto;l=3179
long	getTotalAmtMsat() The total amount in millisatoshis.
long	getTotalFees() Deprecated. lnrpc.Route.total_fees is deprecated. See lightning.api.proto;l=3170
long	getTotalFeesMsat() The total fees in millisatoshis.
int	getTotalTimeLock() The cumulative (final) time lock across the entire route.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
LightningApi.Route.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
LightningApi.Route.Builder	mergeFrom(LightningApi.Route other)
LightningApi.Route.Builder	mergeFrom(com.google.protobuf.Message other)
LightningApi.Route.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
LightningApi.Route.Builder	removeHops(int index) Contains details concerning the specific forwarding details at each hop.
LightningApi.Route.Builder	setHops(int index, LightningApi.Hop.Builder builderForValue) Contains details concerning the specific forwarding details at each hop.
LightningApi.Route.Builder	setHops(int index, LightningApi.Hop value) Contains details concerning the specific forwarding details at each hop.
LightningApi.Route.Builder	setTotalAmt(long value) Deprecated. lnrpc.Route.total_amt is deprecated. See lightning.api.proto;l=3179
LightningApi.Route.Builder	setTotalAmtMsat(long value) The total amount in millisatoshis.
LightningApi.Route.Builder	setTotalFees(long value) Deprecated. lnrpc.Route.total_fees is deprecated. See lightning.api.proto;l=3170
LightningApi.Route.Builder	setTotalFeesMsat(long value) The total fees in millisatoshis.
LightningApi.Route.Builder	setTotalTimeLock(int value) The cumulative (final) time lock across the entire route.
LightningApi.Route.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<LightningApi.Route.Builder>

clear

public LightningApi.Route.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>

getDefaultInstanceForType

public LightningApi.Route getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public LightningApi.Route build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public LightningApi.Route buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public LightningApi.Route.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LightningApi.Route.Builder>

mergeFrom

public LightningApi.Route.Builder mergeFrom(LightningApi.Route other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>

mergeFrom

public LightningApi.Route.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LightningApi.Route.Builder>

Throws:

java.io.IOException

getTotalTimeLock

public int getTotalTimeLock()

The cumulative (final) time lock across the entire route. This is the CLTV
value that should be extended to the first hop in the route. All other hops
will decrement the time-lock as advertised, leaving enough time for all
hops to wait for or present the payment preimage to complete the payment.
 

uint32 total_time_lock = 1;

Specified by:

getTotalTimeLock in interface LightningApi.RouteOrBuilder

Returns:

The totalTimeLock.

setTotalTimeLock

public LightningApi.Route.Builder setTotalTimeLock(int value)

The cumulative (final) time lock across the entire route. This is the CLTV
value that should be extended to the first hop in the route. All other hops
will decrement the time-lock as advertised, leaving enough time for all
hops to wait for or present the payment preimage to complete the payment.
 

uint32 total_time_lock = 1;

Parameters:

value - The totalTimeLock to set.

Returns:

This builder for chaining.

clearTotalTimeLock

public LightningApi.Route.Builder clearTotalTimeLock()

The cumulative (final) time lock across the entire route. This is the CLTV
value that should be extended to the first hop in the route. All other hops
will decrement the time-lock as advertised, leaving enough time for all
hops to wait for or present the payment preimage to complete the payment.
 

uint32 total_time_lock = 1;

Returns:

This builder for chaining.

getTotalFees

@Deprecated
public long getTotalFees()

Deprecated. lnrpc.Route.total_fees is deprecated. See lightning.api.proto;l=3170

The sum of the fees paid at each hop within the final route. In the case
of a one-hop payment, this value will be zero as we don't need to pay a fee
to ourselves.
 

int64 total_fees = 2 [deprecated = true];

Specified by:

getTotalFees in interface LightningApi.RouteOrBuilder

Returns:

The totalFees.

setTotalFees

@Deprecated
public LightningApi.Route.Builder setTotalFees(long value)

Deprecated. lnrpc.Route.total_fees is deprecated. See lightning.api.proto;l=3170

The sum of the fees paid at each hop within the final route. In the case
of a one-hop payment, this value will be zero as we don't need to pay a fee
to ourselves.
 

int64 total_fees = 2 [deprecated = true];

Parameters:

value - The totalFees to set.

Returns:

This builder for chaining.

clearTotalFees

@Deprecated
public LightningApi.Route.Builder clearTotalFees()

Deprecated. lnrpc.Route.total_fees is deprecated. See lightning.api.proto;l=3170

The sum of the fees paid at each hop within the final route. In the case
of a one-hop payment, this value will be zero as we don't need to pay a fee
to ourselves.
 

int64 total_fees = 2 [deprecated = true];

Returns:

This builder for chaining.

getTotalAmt

@Deprecated
public long getTotalAmt()

Deprecated. lnrpc.Route.total_amt is deprecated. See lightning.api.proto;l=3179

The total amount of funds required to complete a payment over this route.
This value includes the cumulative fees at each hop. As a result, the HTLC
extended to the first-hop in the route will need to have at least this many
satoshis, otherwise the route will fail at an intermediate node due to an
insufficient amount of fees.
 

int64 total_amt = 3 [deprecated = true];

Specified by:

getTotalAmt in interface LightningApi.RouteOrBuilder

Returns:

The totalAmt.

setTotalAmt

@Deprecated
public LightningApi.Route.Builder setTotalAmt(long value)

Deprecated. lnrpc.Route.total_amt is deprecated. See lightning.api.proto;l=3179

The total amount of funds required to complete a payment over this route.
This value includes the cumulative fees at each hop. As a result, the HTLC
extended to the first-hop in the route will need to have at least this many
satoshis, otherwise the route will fail at an intermediate node due to an
insufficient amount of fees.
 

int64 total_amt = 3 [deprecated = true];

Parameters:

value - The totalAmt to set.

Returns:

This builder for chaining.

clearTotalAmt

@Deprecated
public LightningApi.Route.Builder clearTotalAmt()

Deprecated. lnrpc.Route.total_amt is deprecated. See lightning.api.proto;l=3179

The total amount of funds required to complete a payment over this route.
This value includes the cumulative fees at each hop. As a result, the HTLC
extended to the first-hop in the route will need to have at least this many
satoshis, otherwise the route will fail at an intermediate node due to an
insufficient amount of fees.
 

int64 total_amt = 3 [deprecated = true];

Returns:

This builder for chaining.

getHopsList

public java.util.List<LightningApi.Hop> getHopsList()

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

Specified by:

getHopsList in interface LightningApi.RouteOrBuilder

getHopsCount

public int getHopsCount()

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

Specified by:

getHopsCount in interface LightningApi.RouteOrBuilder

getHops

public LightningApi.Hop getHops(int index)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

Specified by:

getHops in interface LightningApi.RouteOrBuilder

setHops

public LightningApi.Route.Builder setHops(int index,
                                          LightningApi.Hop value)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

setHops

public LightningApi.Route.Builder setHops(int index,
                                          LightningApi.Hop.Builder builderForValue)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

addHops

public LightningApi.Route.Builder addHops(LightningApi.Hop value)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

addHops

public LightningApi.Route.Builder addHops(int index,
                                          LightningApi.Hop value)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

addHops

public LightningApi.Route.Builder addHops(LightningApi.Hop.Builder builderForValue)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

addHops

public LightningApi.Route.Builder addHops(int index,
                                          LightningApi.Hop.Builder builderForValue)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

addAllHops

public LightningApi.Route.Builder addAllHops(java.lang.Iterable<? extends LightningApi.Hop> values)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

clearHops

public LightningApi.Route.Builder clearHops()

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

removeHops

public LightningApi.Route.Builder removeHops(int index)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

getHopsBuilder

public LightningApi.Hop.Builder getHopsBuilder(int index)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

getHopsOrBuilder

public LightningApi.HopOrBuilder getHopsOrBuilder(int index)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

Specified by:

getHopsOrBuilder in interface LightningApi.RouteOrBuilder

getHopsOrBuilderList

public java.util.List<? extends LightningApi.HopOrBuilder> getHopsOrBuilderList()

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

Specified by:

getHopsOrBuilderList in interface LightningApi.RouteOrBuilder

addHopsBuilder

public LightningApi.Hop.Builder addHopsBuilder()

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

addHopsBuilder

public LightningApi.Hop.Builder addHopsBuilder(int index)

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

getHopsBuilderList

public java.util.List<LightningApi.Hop.Builder> getHopsBuilderList()

Contains details concerning the specific forwarding details at each hop.
 

repeated .lnrpc.Hop hops = 4;

getTotalFeesMsat

public long getTotalFeesMsat()

The total fees in millisatoshis.
 

int64 total_fees_msat = 5;

Specified by:

getTotalFeesMsat in interface LightningApi.RouteOrBuilder

Returns:

The totalFeesMsat.

setTotalFeesMsat

public LightningApi.Route.Builder setTotalFeesMsat(long value)

The total fees in millisatoshis.
 

int64 total_fees_msat = 5;

Parameters:

value - The totalFeesMsat to set.

Returns:

This builder for chaining.

clearTotalFeesMsat

public LightningApi.Route.Builder clearTotalFeesMsat()

The total fees in millisatoshis.
 

int64 total_fees_msat = 5;

Returns:

This builder for chaining.

getTotalAmtMsat

public long getTotalAmtMsat()

The total amount in millisatoshis.
 

int64 total_amt_msat = 6;

Specified by:

getTotalAmtMsat in interface LightningApi.RouteOrBuilder

Returns:

The totalAmtMsat.

setTotalAmtMsat

public LightningApi.Route.Builder setTotalAmtMsat(long value)

The total amount in millisatoshis.
 

int64 total_amt_msat = 6;

Parameters:

value - The totalAmtMsat to set.

Returns:

This builder for chaining.

clearTotalAmtMsat

public LightningApi.Route.Builder clearTotalAmtMsat()

The total amount in millisatoshis.
 

int64 total_amt_msat = 6;

Returns:

This builder for chaining.

setUnknownFields

public final LightningApi.Route.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>

mergeUnknownFields

public final LightningApi.Route.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.Route.Builder>