org.lightningj.lnd.proto

Class LightningApi.ListPaymentsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

org.lightningj.lnd.proto.LightningApi.ListPaymentsRequest.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.ListPaymentsRequestOrBuilder

Enclosing class:

LightningApi.ListPaymentsRequest

public static final class LightningApi.ListPaymentsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.ListPaymentsRequest.Builder>
implements LightningApi.ListPaymentsRequestOrBuilder

Protobuf type lnrpc.ListPaymentsRequest

Method Summary

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)

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.ListPaymentsRequest.Builder>

clear

public LightningApi.ListPaymentsRequest.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.ListPaymentsRequest.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.ListPaymentsRequest.Builder>

getDefaultInstanceForType

public LightningApi.ListPaymentsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public LightningApi.ListPaymentsRequest build()

Specified by:

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

Specified by:

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

buildPartial

public LightningApi.ListPaymentsRequest buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

public LightningApi.ListPaymentsRequest.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.ListPaymentsRequest.Builder>

mergeFrom

public LightningApi.ListPaymentsRequest.Builder mergeFrom(LightningApi.ListPaymentsRequest 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.ListPaymentsRequest.Builder>

mergeFrom

public LightningApi.ListPaymentsRequest.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.ListPaymentsRequest.Builder>

Throws:

java.io.IOException

getIncludeIncomplete

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;

Specified by:

getIncludeIncomplete in interface LightningApi.ListPaymentsRequestOrBuilder

Returns:

The includeIncomplete.

setIncludeIncomplete

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;

Parameters:

value - The includeIncomplete to set.

Returns:

This builder for chaining.

clearIncludeIncomplete

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;

Returns:

This builder for chaining.

getIndexOffset

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;

Specified by:

getIndexOffset in interface LightningApi.ListPaymentsRequestOrBuilder

Returns:

The indexOffset.

setIndexOffset

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;

Parameters:

value - The indexOffset to set.

Returns:

This builder for chaining.

clearIndexOffset

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;

Returns:

This builder for chaining.

getMaxPayments

public long getMaxPayments()

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

uint64 max_payments = 3;

Specified by:

getMaxPayments in interface LightningApi.ListPaymentsRequestOrBuilder

Returns:

The maxPayments.

setMaxPayments

public LightningApi.ListPaymentsRequest.Builder setMaxPayments(long value)

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

uint64 max_payments = 3;

Parameters:

value - The maxPayments to set.

Returns:

This builder for chaining.

clearMaxPayments

public LightningApi.ListPaymentsRequest.Builder clearMaxPayments()

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

uint64 max_payments = 3;

Returns:

This builder for chaining.

getReversed

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;

Specified by:

getReversed in interface LightningApi.ListPaymentsRequestOrBuilder

Returns:

The reversed.

setReversed

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;

Parameters:

value - The reversed to set.

Returns:

This builder for chaining.

clearReversed

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;

Returns:

This builder for chaining.

getCountTotalPayments

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;

Specified by:

getCountTotalPayments in interface LightningApi.ListPaymentsRequestOrBuilder

Returns:

The countTotalPayments.

setCountTotalPayments

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;

Parameters:

value - The countTotalPayments to set.

Returns:

This builder for chaining.

clearCountTotalPayments

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;

Returns:

This builder for chaining.

getCreationDateStart

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;

Specified by:

getCreationDateStart in interface LightningApi.ListPaymentsRequestOrBuilder

Returns:

The creationDateStart.

setCreationDateStart

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;

Parameters:

value - The creationDateStart to set.

Returns:

This builder for chaining.

clearCreationDateStart

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;

Returns:

This builder for chaining.

getCreationDateEnd

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;

Specified by:

getCreationDateEnd in interface LightningApi.ListPaymentsRequestOrBuilder

Returns:

The creationDateEnd.

setCreationDateEnd

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;

Parameters:

value - The creationDateEnd to set.

Returns:

This builder for chaining.

clearCreationDateEnd

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;

Returns:

This builder for chaining.

setUnknownFields

public final LightningApi.ListPaymentsRequest.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.ListPaymentsRequest.Builder>

mergeUnknownFields

public final LightningApi.ListPaymentsRequest.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.ListPaymentsRequest.Builder>