public static final class LightningApi.ListPaymentsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.ListPaymentsRequest.Builder> implements LightningApi.ListPaymentsRequestOrBuilder
lnrpc.ListPaymentsRequest
Modifier and Type | Method and Description |
---|---|
LightningApi.ListPaymentsRequest |
build() |
LightningApi.ListPaymentsRequest |
buildPartial() |
LightningApi.ListPaymentsRequest.Builder |
clear() |
LightningApi.ListPaymentsRequest.Builder |
clearCountTotalPayments()
If set, all payments (complete and incomplete, independent of the
max_payments parameter) will be counted.
|
LightningApi.ListPaymentsRequest.Builder |
clearCreationDateEnd()
If set, returns all invoices with a creation date less than or equal to
it.
|
LightningApi.ListPaymentsRequest.Builder |
clearCreationDateStart()
If set, returns all invoices with a creation date greater than or equal
to it.
|
LightningApi.ListPaymentsRequest.Builder |
clearIncludeIncomplete()
If true, then return payments that have not yet fully completed.
|
LightningApi.ListPaymentsRequest.Builder |
clearIndexOffset()
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.
|
LightningApi.ListPaymentsRequest.Builder |
clearMaxPayments()
The maximal number of payments returned in the response to this query.
|
LightningApi.ListPaymentsRequest.Builder |
clearReversed()
If set, the payments returned will result from seeking backwards from the
specified index offset.
|
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.
|
LightningApi.ListPaymentsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
LightningApi.ListPaymentsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
LightningApi.ListPaymentsRequest.Builder |
mergeFrom(LightningApi.ListPaymentsRequest other) |
LightningApi.ListPaymentsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
LightningApi.ListPaymentsRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
LightningApi.ListPaymentsRequest.Builder |
setCountTotalPayments(boolean value)
If set, all payments (complete and incomplete, independent of the
max_payments parameter) will be counted.
|
LightningApi.ListPaymentsRequest.Builder |
setCreationDateEnd(long value)
If set, returns all invoices with a creation date less than or equal to
it.
|
LightningApi.ListPaymentsRequest.Builder |
setCreationDateStart(long value)
If set, returns all invoices with a creation date greater than or equal
to it.
|
LightningApi.ListPaymentsRequest.Builder |
setIncludeIncomplete(boolean value)
If true, then return payments that have not yet fully completed.
|
LightningApi.ListPaymentsRequest.Builder |
setIndexOffset(long value)
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.
|
LightningApi.ListPaymentsRequest.Builder |
setMaxPayments(long value)
The maximal number of payments returned in the response to this query.
|
LightningApi.ListPaymentsRequest.Builder |
setReversed(boolean value)
If set, the payments returned will result from seeking backwards from the
specified index offset.
|
LightningApi.ListPaymentsRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
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
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.ListPaymentsRequest.Builder>
public LightningApi.ListPaymentsRequest.Builder clear()
clear
in interface com.google.protobuf.Message.Builder
clear
in interface com.google.protobuf.MessageLite.Builder
clear
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.ListPaymentsRequest.Builder>
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface com.google.protobuf.Message.Builder
getDescriptorForType
in interface com.google.protobuf.MessageOrBuilder
getDescriptorForType
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.ListPaymentsRequest.Builder>
public LightningApi.ListPaymentsRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
public LightningApi.ListPaymentsRequest build()
build
in interface com.google.protobuf.Message.Builder
build
in interface com.google.protobuf.MessageLite.Builder
public LightningApi.ListPaymentsRequest buildPartial()
buildPartial
in interface com.google.protobuf.Message.Builder
buildPartial
in interface com.google.protobuf.MessageLite.Builder
public LightningApi.ListPaymentsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<LightningApi.ListPaymentsRequest.Builder>
public LightningApi.ListPaymentsRequest.Builder mergeFrom(LightningApi.ListPaymentsRequest other)
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.ListPaymentsRequest.Builder>
public LightningApi.ListPaymentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in interface com.google.protobuf.MessageLite.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<LightningApi.ListPaymentsRequest.Builder>
java.io.IOException
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 LightningApi.ListPaymentsRequest.Builder setIncludeIncomplete(boolean value)
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;
value
- The includeIncomplete to set.public LightningApi.ListPaymentsRequest.Builder clearIncludeIncomplete()
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;
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 LightningApi.ListPaymentsRequest.Builder setIndexOffset(long value)
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;
value
- The indexOffset to set.public LightningApi.ListPaymentsRequest.Builder clearIndexOffset()
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;
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 LightningApi.ListPaymentsRequest.Builder setMaxPayments(long value)
The maximal number of payments returned in the response to this query.
uint64 max_payments = 3;
value
- The maxPayments to set.public LightningApi.ListPaymentsRequest.Builder clearMaxPayments()
The maximal number of payments returned in the response to this query.
uint64 max_payments = 3;
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 LightningApi.ListPaymentsRequest.Builder setReversed(boolean value)
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;
value
- The reversed to set.public LightningApi.ListPaymentsRequest.Builder clearReversed()
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;
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 LightningApi.ListPaymentsRequest.Builder setCountTotalPayments(boolean value)
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;
value
- The countTotalPayments to set.public LightningApi.ListPaymentsRequest.Builder clearCountTotalPayments()
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;
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 LightningApi.ListPaymentsRequest.Builder setCreationDateStart(long value)
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;
value
- The creationDateStart to set.public LightningApi.ListPaymentsRequest.Builder clearCreationDateStart()
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;
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 LightningApi.ListPaymentsRequest.Builder setCreationDateEnd(long value)
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;
value
- The creationDateEnd to set.public LightningApi.ListPaymentsRequest.Builder clearCreationDateEnd()
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;
public final LightningApi.ListPaymentsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields
in interface com.google.protobuf.Message.Builder
setUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.ListPaymentsRequest.Builder>
public final LightningApi.ListPaymentsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields
in interface com.google.protobuf.Message.Builder
mergeUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.ListPaymentsRequest.Builder>