public static final class LightningApi.ListPaymentsRequest extends com.google.protobuf.GeneratedMessageV3 implements LightningApi.ListPaymentsRequestOrBuilder
lnrpc.ListPaymentsRequest
Modifier and Type | Class and Description |
---|---|
static class |
LightningApi.ListPaymentsRequest.Builder
Protobuf type
lnrpc.ListPaymentsRequest |
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
Modifier and Type | Field and Description |
---|---|
static int |
COUNT_TOTAL_PAYMENTS_FIELD_NUMBER |
static int |
CREATION_DATE_END_FIELD_NUMBER |
static int |
CREATION_DATE_START_FIELD_NUMBER |
static int |
INCLUDE_INCOMPLETE_FIELD_NUMBER |
static int |
INDEX_OFFSET_FIELD_NUMBER |
static int |
MAX_PAYMENTS_FIELD_NUMBER |
static int |
REVERSED_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
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.
|
static LightningApi.ListPaymentsRequest |
getDefaultInstance() |
LightningApi.ListPaymentsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<LightningApi.ListPaymentsRequest> |
getParserForType() |
boolean |
getReversed()
If set, the payments returned will result from seeking backwards from the
specified index offset.
|
int |
getSerializedSize() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static LightningApi.ListPaymentsRequest.Builder |
newBuilder() |
static LightningApi.ListPaymentsRequest.Builder |
newBuilder(LightningApi.ListPaymentsRequest prototype) |
LightningApi.ListPaymentsRequest.Builder |
newBuilderForType() |
protected LightningApi.ListPaymentsRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected java.lang.Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static LightningApi.ListPaymentsRequest |
parseDelimitedFrom(java.io.InputStream input) |
static LightningApi.ListPaymentsRequest |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.ListPaymentsRequest |
parseFrom(byte[] data) |
static LightningApi.ListPaymentsRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.ListPaymentsRequest |
parseFrom(java.nio.ByteBuffer data) |
static LightningApi.ListPaymentsRequest |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.ListPaymentsRequest |
parseFrom(com.google.protobuf.ByteString data) |
static LightningApi.ListPaymentsRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.ListPaymentsRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static LightningApi.ListPaymentsRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.ListPaymentsRequest |
parseFrom(java.io.InputStream input) |
static LightningApi.ListPaymentsRequest |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<LightningApi.ListPaymentsRequest> |
parser() |
LightningApi.ListPaymentsRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int INCLUDE_INCOMPLETE_FIELD_NUMBER
public static final int INDEX_OFFSET_FIELD_NUMBER
public static final int MAX_PAYMENTS_FIELD_NUMBER
public static final int REVERSED_FIELD_NUMBER
public static final int COUNT_TOTAL_PAYMENTS_FIELD_NUMBER
public static final int CREATION_DATE_START_FIELD_NUMBER
public static final int CREATION_DATE_END_FIELD_NUMBER
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public 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;
getIncludeIncomplete
in interface LightningApi.ListPaymentsRequestOrBuilder
public 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;
getIndexOffset
in interface LightningApi.ListPaymentsRequestOrBuilder
public long getMaxPayments()
The maximal number of payments returned in the response to this query.
uint64 max_payments = 3;
getMaxPayments
in interface LightningApi.ListPaymentsRequestOrBuilder
public 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;
getReversed
in interface LightningApi.ListPaymentsRequestOrBuilder
public 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;
getCountTotalPayments
in interface LightningApi.ListPaymentsRequestOrBuilder
public 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;
getCreationDateStart
in interface LightningApi.ListPaymentsRequestOrBuilder
public 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;
getCreationDateEnd
in interface LightningApi.ListPaymentsRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(java.lang.Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static LightningApi.ListPaymentsRequest parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.ListPaymentsRequest parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.ListPaymentsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.ListPaymentsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.ListPaymentsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.ListPaymentsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.ListPaymentsRequest parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.ListPaymentsRequest parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static LightningApi.ListPaymentsRequest parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.ListPaymentsRequest parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static LightningApi.ListPaymentsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.ListPaymentsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public LightningApi.ListPaymentsRequest.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static LightningApi.ListPaymentsRequest.Builder newBuilder()
public static LightningApi.ListPaymentsRequest.Builder newBuilder(LightningApi.ListPaymentsRequest prototype)
public LightningApi.ListPaymentsRequest.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected LightningApi.ListPaymentsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static LightningApi.ListPaymentsRequest getDefaultInstance()
public static com.google.protobuf.Parser<LightningApi.ListPaymentsRequest> parser()
public com.google.protobuf.Parser<LightningApi.ListPaymentsRequest> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public LightningApi.ListPaymentsRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder