InvoicesOuterClass.AddHoldInvoiceRequest.Builder (lightningj 0.17.4-Beta API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<InvoicesOuterClass.AddHoldInvoiceRequest.Builder>
    - - org.lightningj.lnd.invoices.proto.InvoicesOuterClass.AddHoldInvoiceRequest.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, InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder

Enclosing class:

InvoicesOuterClass.AddHoldInvoiceRequest
```
public static final class InvoicesOuterClass.AddHoldInvoiceRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<InvoicesOuterClass.AddHoldInvoiceRequest.Builder>
implements InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder
```
Protobuf type invoicesrpc.AddHoldInvoiceRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`addAllRouteHints(java.lang.Iterable<? extends LightningApi.RouteHint> values)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`addRouteHints(int index, LightningApi.RouteHint.Builder builderForValue)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`addRouteHints(int index, LightningApi.RouteHint value)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`addRouteHints(LightningApi.RouteHint.Builder builderForValue)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`addRouteHints(LightningApi.RouteHint value)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`LightningApi.RouteHint.Builder`	`addRouteHintsBuilder()` Route hints that can each be individually used to assist in reaching the invoice's destination.
`LightningApi.RouteHint.Builder`	`addRouteHintsBuilder(int index)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`InvoicesOuterClass.AddHoldInvoiceRequest`	`build()`
`InvoicesOuterClass.AddHoldInvoiceRequest`	`buildPartial()`
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`clear()`
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`clearCltvExpiry()` Delta to use for the time-lock of the CLTV extended to the final hop.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`clearDescriptionHash()` Hash (SHA-256) of a description of the payment.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`clearExpiry()` Payment request expiry time in seconds.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`clearFallbackAddr()` Fallback on-chain address.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`clearHash()` The hash of the preimage
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`clearMemo()` An optional memo to attach along with the invoice.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`clearPrivate()` Whether this invoice should include routing hints for private channels.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`clearRouteHints()` Route hints that can each be individually used to assist in reaching the invoice's destination.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`clearValue()` The value of this invoice in satoshis The fields value and value_msat are mutually exclusive.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`clearValueMsat()` The value of this invoice in millisatoshis The fields value and value_msat are mutually exclusive.
`long`	`getCltvExpiry()` Delta to use for the time-lock of the CLTV extended to the final hop.
`InvoicesOuterClass.AddHoldInvoiceRequest`	`getDefaultInstanceForType()`
`com.google.protobuf.ByteString`	`getDescriptionHash()` Hash (SHA-256) of a description of the payment.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`long`	`getExpiry()` Payment request expiry time in seconds.
`java.lang.String`	`getFallbackAddr()` Fallback on-chain address.
`com.google.protobuf.ByteString`	`getFallbackAddrBytes()` Fallback on-chain address.
`com.google.protobuf.ByteString`	`getHash()` The hash of the preimage
`java.lang.String`	`getMemo()` An optional memo to attach along with the invoice.
`com.google.protobuf.ByteString`	`getMemoBytes()` An optional memo to attach along with the invoice.
`boolean`	`getPrivate()` Whether this invoice should include routing hints for private channels.
`LightningApi.RouteHint`	`getRouteHints(int index)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`LightningApi.RouteHint.Builder`	`getRouteHintsBuilder(int index)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`java.util.List<LightningApi.RouteHint.Builder>`	`getRouteHintsBuilderList()` Route hints that can each be individually used to assist in reaching the invoice's destination.
`int`	`getRouteHintsCount()` Route hints that can each be individually used to assist in reaching the invoice's destination.
`java.util.List<LightningApi.RouteHint>`	`getRouteHintsList()` Route hints that can each be individually used to assist in reaching the invoice's destination.
`LightningApi.RouteHintOrBuilder`	`getRouteHintsOrBuilder(int index)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`java.util.List<? extends LightningApi.RouteHintOrBuilder>`	`getRouteHintsOrBuilderList()` Route hints that can each be individually used to assist in reaching the invoice's destination.
`long`	`getValue()` The value of this invoice in satoshis The fields value and value_msat are mutually exclusive.
`long`	`getValueMsat()` The value of this invoice in millisatoshis The fields value and value_msat are mutually exclusive.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`mergeFrom(InvoicesOuterClass.AddHoldInvoiceRequest other)`
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`removeRouteHints(int index)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setCltvExpiry(long value)` Delta to use for the time-lock of the CLTV extended to the final hop.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setDescriptionHash(com.google.protobuf.ByteString value)` Hash (SHA-256) of a description of the payment.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setExpiry(long value)` Payment request expiry time in seconds.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setFallbackAddr(java.lang.String value)` Fallback on-chain address.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setFallbackAddrBytes(com.google.protobuf.ByteString value)` Fallback on-chain address.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setHash(com.google.protobuf.ByteString value)` The hash of the preimage
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setMemo(java.lang.String value)` An optional memo to attach along with the invoice.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setMemoBytes(com.google.protobuf.ByteString value)` An optional memo to attach along with the invoice.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setPrivate(boolean value)` Whether this invoice should include routing hints for private channels.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setRouteHints(int index, LightningApi.RouteHint.Builder builderForValue)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setRouteHints(int index, LightningApi.RouteHint value)` Route hints that can each be individually used to assist in reaching the invoice's destination.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setValue(long value)` The value of this invoice in satoshis The fields value and value_msat are mutually exclusive.
`InvoicesOuterClass.AddHoldInvoiceRequest.Builder`	`setValueMsat(long value)` The value of this invoice in millisatoshis The fields value and value_msat are mutually exclusive.

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<InvoicesOuterClass.AddHoldInvoiceRequest.Builder>

clear
```
public InvoicesOuterClass.AddHoldInvoiceRequest.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<InvoicesOuterClass.AddHoldInvoiceRequest.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<InvoicesOuterClass.AddHoldInvoiceRequest.Builder>

getDefaultInstanceForType
```
public InvoicesOuterClass.AddHoldInvoiceRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public InvoicesOuterClass.AddHoldInvoiceRequest build()
```
Specified by:

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

Specified by:

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

buildPartial
```
public InvoicesOuterClass.AddHoldInvoiceRequest buildPartial()
```
Specified by:

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

Specified by:

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

mergeFrom
```
public InvoicesOuterClass.AddHoldInvoiceRequest.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<InvoicesOuterClass.AddHoldInvoiceRequest.Builder>

mergeFrom

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder mergeFrom(InvoicesOuterClass.AddHoldInvoiceRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<InvoicesOuterClass.AddHoldInvoiceRequest.Builder>

mergeFrom

public InvoicesOuterClass.AddHoldInvoiceRequest.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<InvoicesOuterClass.AddHoldInvoiceRequest.Builder>
Throws:: java.io.IOException

getMemo

public java.lang.String getMemo()


An optional memo to attach along with the invoice. Used for record keeping
purposes for the invoice's creator, and will also be set in the description
field of the encoded payment request if the description_hash field is not
being used.

string memo = 1;

Specified by:: getMemo in interface InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder
Returns:: The memo.

getMemoBytes

public com.google.protobuf.ByteString getMemoBytes()


An optional memo to attach along with the invoice. Used for record keeping
purposes for the invoice's creator, and will also be set in the description
field of the encoded payment request if the description_hash field is not
being used.

string memo = 1;

Specified by:: getMemoBytes in interface InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder
Returns:: The bytes for memo.

setMemo

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder setMemo(java.lang.String value)


An optional memo to attach along with the invoice. Used for record keeping
purposes for the invoice's creator, and will also be set in the description
field of the encoded payment request if the description_hash field is not
being used.

string memo = 1;

Parameters:: value - The memo to set.
Returns:: This builder for chaining.

clearMemo

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder clearMemo()


An optional memo to attach along with the invoice. Used for record keeping
purposes for the invoice's creator, and will also be set in the description
field of the encoded payment request if the description_hash field is not
being used.

string memo = 1;

Returns:: This builder for chaining.

setMemoBytes

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder setMemoBytes(com.google.protobuf.ByteString value)


An optional memo to attach along with the invoice. Used for record keeping
purposes for the invoice's creator, and will also be set in the description
field of the encoded payment request if the description_hash field is not
being used.

string memo = 1;

Parameters:: value - The bytes for memo to set.
Returns:: This builder for chaining.

getHash
```
public com.google.protobuf.ByteString getHash()
```
```
 The hash of the preimage
 
```
bytes hash = 2;
Specified by:

getHash in interface InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder

Returns:

The hash.

setHash

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder setHash(com.google.protobuf.ByteString value)

 The hash of the preimage

bytes hash = 2;

Parameters:: value - The hash to set.
Returns:: This builder for chaining.

clearHash

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder clearHash()

 The hash of the preimage

bytes hash = 2;

Returns:: This builder for chaining.

getValue
```
public long getValue()
```
```
The value of this invoice in satoshis
The fields value and value_msat are mutually exclusive.
 
```
int64 value = 3;
Specified by:

getValue in interface InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder

Returns:

The value.

setValue

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder setValue(long value)


The value of this invoice in satoshis
The fields value and value_msat are mutually exclusive.

int64 value = 3;

Parameters:: value - The value to set.
Returns:: This builder for chaining.

clearValue

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder clearValue()


The value of this invoice in satoshis
The fields value and value_msat are mutually exclusive.

int64 value = 3;

Returns:: This builder for chaining.

getValueMsat
```
public long getValueMsat()
```
```
The value of this invoice in millisatoshis
The fields value and value_msat are mutually exclusive.
 
```
int64 value_msat = 10;
Specified by:

getValueMsat in interface InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder

Returns:

The valueMsat.

setValueMsat

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder setValueMsat(long value)


The value of this invoice in millisatoshis
The fields value and value_msat are mutually exclusive.

int64 value_msat = 10;

Parameters:: value - The valueMsat to set.
Returns:: This builder for chaining.

clearValueMsat

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder clearValueMsat()


The value of this invoice in millisatoshis
The fields value and value_msat are mutually exclusive.

int64 value_msat = 10;

Returns:: This builder for chaining.

getDescriptionHash

public com.google.protobuf.ByteString getDescriptionHash()


Hash (SHA-256) of a description of the payment. Used if the description of
payment (memo) is too long to naturally fit within the description field
of an encoded payment request.

bytes description_hash = 4;

Specified by:: getDescriptionHash in interface InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder
Returns:: The descriptionHash.

setDescriptionHash

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder setDescriptionHash(com.google.protobuf.ByteString value)


Hash (SHA-256) of a description of the payment. Used if the description of
payment (memo) is too long to naturally fit within the description field
of an encoded payment request.

bytes description_hash = 4;

Parameters:: value - The descriptionHash to set.
Returns:: This builder for chaining.

clearDescriptionHash

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder clearDescriptionHash()


Hash (SHA-256) of a description of the payment. Used if the description of
payment (memo) is too long to naturally fit within the description field
of an encoded payment request.

bytes description_hash = 4;

Returns:: This builder for chaining.

getExpiry
```
public long getExpiry()
```
```
 Payment request expiry time in seconds. Default is 86400 (24 hours).
 
```
int64 expiry = 5;
Specified by:

getExpiry in interface InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder

Returns:

The expiry.

setExpiry

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder setExpiry(long value)

 Payment request expiry time in seconds. Default is 86400 (24 hours).

int64 expiry = 5;

Parameters:: value - The expiry to set.
Returns:: This builder for chaining.

clearExpiry

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder clearExpiry()

 Payment request expiry time in seconds. Default is 86400 (24 hours).

int64 expiry = 5;

Returns:: This builder for chaining.

getFallbackAddr
```
public java.lang.String getFallbackAddr()
```
```
 Fallback on-chain address.
 
```
string fallback_addr = 6;
Specified by:

getFallbackAddr in interface InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder

Returns:

The fallbackAddr.

getFallbackAddrBytes
```
public com.google.protobuf.ByteString getFallbackAddrBytes()
```
```
 Fallback on-chain address.
 
```
string fallback_addr = 6;
Specified by:

getFallbackAddrBytes in interface InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder

Returns:

The bytes for fallbackAddr.

setFallbackAddr

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder setFallbackAddr(java.lang.String value)

 Fallback on-chain address.

string fallback_addr = 6;

Parameters:: value - The fallbackAddr to set.
Returns:: This builder for chaining.

clearFallbackAddr

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder clearFallbackAddr()

 Fallback on-chain address.

string fallback_addr = 6;

Returns:: This builder for chaining.

setFallbackAddrBytes

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder setFallbackAddrBytes(com.google.protobuf.ByteString value)

 Fallback on-chain address.

string fallback_addr = 6;

Parameters:: value - The bytes for fallbackAddr to set.
Returns:: This builder for chaining.

getCltvExpiry
```
public long getCltvExpiry()
```
```
 Delta to use for the time-lock of the CLTV extended to the final hop.
 
```
uint64 cltv_expiry = 7;
Specified by:

getCltvExpiry in interface InvoicesOuterClass.AddHoldInvoiceRequestOrBuilder

Returns:

The cltvExpiry.

setCltvExpiry

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder setCltvExpiry(long value)

 Delta to use for the time-lock of the CLTV extended to the final hop.

uint64 cltv_expiry = 7;

Parameters:: value - The cltvExpiry to set.
Returns:: This builder for chaining.

clearCltvExpiry

public InvoicesOuterClass.AddHoldInvoiceRequest.Builder clearCltvExpiry()

 Delta to use for the time-lock of the CLTV extended to the final hop.

uint64 cltv_expiry = 7;

Returns:: This builder for chaining.