org.lightningj.lnd.proto

Interface LightningApi.ListPaymentsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

LightningApi.ListPaymentsRequest, LightningApi.ListPaymentsRequest.Builder

Enclosing class:

LightningApi

public static interface LightningApi.ListPaymentsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getCountTotalPayments() If set, all payments (complete and incomplete, independent of the max_payments parameter) will be counted.
long	getCreationDateEnd() If set, returns all invoices with a creation date less than or equal to it.
long	getCreationDateStart() If set, returns all invoices with a creation date greater than or equal to it.
boolean	getIncludeIncomplete() If true, then return payments that have not yet fully completed.
long	getIndexOffset() The index of a payment that will be used as either the start or end of a query to determine which payments should be returned in the response.
long	getMaxPayments() The maximal number of payments returned in the response to this query.
boolean	getReversed() If set, the payments returned will result from seeking backwards from the specified index offset.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getIncludeIncomplete

boolean getIncludeIncomplete()

If true, then return payments that have not yet fully completed. This means
that pending payments, as well as failed payments will show up if this
field is set to true. This flag doesn't change the meaning of the indices,
which are tied to individual payments.
 

bool include_incomplete = 1;

Returns:

The includeIncomplete.

getIndexOffset

long getIndexOffset()

The index of a payment that will be used as either the start or end of a
query to determine which payments should be returned in the response. The
index_offset is exclusive. In the case of a zero index_offset, the query
will start with the oldest payment when paginating forwards, or will end
with the most recent payment when paginating backwards.
 

uint64 index_offset = 2;

Returns:

The indexOffset.

getMaxPayments

long getMaxPayments()

 The maximal number of payments returned in the response to this query.
 

uint64 max_payments = 3;

Returns:

The maxPayments.

getReversed

boolean getReversed()

If set, the payments returned will result from seeking backwards from the
specified index offset. This can be used to paginate backwards. The order
of the returned payments is always oldest first (ascending index order).
 

bool reversed = 4;

Returns:

The reversed.

getCountTotalPayments

boolean getCountTotalPayments()

If set, all payments (complete and incomplete, independent of the
max_payments parameter) will be counted. Note that setting this to true will
increase the run time of the call significantly on systems that have a lot
of payments, as all of them have to be iterated through to be counted.
 

bool count_total_payments = 5;

Returns:

The countTotalPayments.

getCreationDateStart

long getCreationDateStart()

 If set, returns all invoices with a creation date greater than or equal
 to it. Measured in seconds since the unix epoch.
 

uint64 creation_date_start = 6;

Returns:

The creationDateStart.

getCreationDateEnd

long getCreationDateEnd()

 If set, returns all invoices with a creation date less than or equal to
 it. Measured in seconds since the unix epoch.
 

uint64 creation_date_end = 7;

Returns:

The creationDateEnd.