org.lightningj.lnd.proto

Class LightningApi.CloseChannelRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

org.lightningj.lnd.proto.LightningApi.CloseChannelRequest.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.CloseChannelRequestOrBuilder

Enclosing class:

LightningApi.CloseChannelRequest

public static final class LightningApi.CloseChannelRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.CloseChannelRequest.Builder>
implements LightningApi.CloseChannelRequestOrBuilder

Protobuf type lnrpc.CloseChannelRequest

Method Summary

Modifier and Type	Method and Description
LightningApi.CloseChannelRequest	build()
LightningApi.CloseChannelRequest	buildPartial()
LightningApi.CloseChannelRequest.Builder	clear()
LightningApi.CloseChannelRequest.Builder	clearChannelPoint() The outpoint (txid:index) of the funding transaction.
LightningApi.CloseChannelRequest.Builder	clearDeliveryAddress() An optional address to send funds to in the case of a cooperative close.
LightningApi.CloseChannelRequest.Builder	clearForce() If true, then the channel will be closed forcibly.
LightningApi.CloseChannelRequest.Builder	clearMaxFeePerVbyte() The maximum fee rate the closer is willing to pay.
LightningApi.CloseChannelRequest.Builder	clearSatPerByte() Deprecated. lnrpc.CloseChannelRequest.sat_per_byte is deprecated. See lightning.api.proto;l=2018
LightningApi.CloseChannelRequest.Builder	clearSatPerVbyte() A manual fee rate set in sat/vbyte that should be used when crafting the closure transaction.
LightningApi.CloseChannelRequest.Builder	clearTargetConf() The target number of blocks that the closure transaction should be confirmed by.
LightningApi.ChannelPoint	getChannelPoint() The outpoint (txid:index) of the funding transaction.
LightningApi.ChannelPoint.Builder	getChannelPointBuilder() The outpoint (txid:index) of the funding transaction.
LightningApi.ChannelPointOrBuilder	getChannelPointOrBuilder() The outpoint (txid:index) of the funding transaction.
LightningApi.CloseChannelRequest	getDefaultInstanceForType()
java.lang.String	getDeliveryAddress() An optional address to send funds to in the case of a cooperative close.
com.google.protobuf.ByteString	getDeliveryAddressBytes() An optional address to send funds to in the case of a cooperative close.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getForce() If true, then the channel will be closed forcibly.
long	getMaxFeePerVbyte() The maximum fee rate the closer is willing to pay.
long	getSatPerByte() Deprecated. lnrpc.CloseChannelRequest.sat_per_byte is deprecated. See lightning.api.proto;l=2018
long	getSatPerVbyte() A manual fee rate set in sat/vbyte that should be used when crafting the closure transaction.
int	getTargetConf() The target number of blocks that the closure transaction should be confirmed by.
boolean	hasChannelPoint() The outpoint (txid:index) of the funding transaction.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
LightningApi.CloseChannelRequest.Builder	mergeChannelPoint(LightningApi.ChannelPoint value) The outpoint (txid:index) of the funding transaction.
LightningApi.CloseChannelRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
LightningApi.CloseChannelRequest.Builder	mergeFrom(LightningApi.CloseChannelRequest other)
LightningApi.CloseChannelRequest.Builder	mergeFrom(com.google.protobuf.Message other)
LightningApi.CloseChannelRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
LightningApi.CloseChannelRequest.Builder	setChannelPoint(LightningApi.ChannelPoint.Builder builderForValue) The outpoint (txid:index) of the funding transaction.
LightningApi.CloseChannelRequest.Builder	setChannelPoint(LightningApi.ChannelPoint value) The outpoint (txid:index) of the funding transaction.
LightningApi.CloseChannelRequest.Builder	setDeliveryAddress(java.lang.String value) An optional address to send funds to in the case of a cooperative close.
LightningApi.CloseChannelRequest.Builder	setDeliveryAddressBytes(com.google.protobuf.ByteString value) An optional address to send funds to in the case of a cooperative close.
LightningApi.CloseChannelRequest.Builder	setForce(boolean value) If true, then the channel will be closed forcibly.
LightningApi.CloseChannelRequest.Builder	setMaxFeePerVbyte(long value) The maximum fee rate the closer is willing to pay.
LightningApi.CloseChannelRequest.Builder	setSatPerByte(long value) Deprecated. lnrpc.CloseChannelRequest.sat_per_byte is deprecated. See lightning.api.proto;l=2018
LightningApi.CloseChannelRequest.Builder	setSatPerVbyte(long value) A manual fee rate set in sat/vbyte that should be used when crafting the closure transaction.
LightningApi.CloseChannelRequest.Builder	setTargetConf(int value) The target number of blocks that the closure transaction should be confirmed by.
LightningApi.CloseChannelRequest.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.CloseChannelRequest.Builder>

clear

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

getDefaultInstanceForType

public LightningApi.CloseChannelRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public LightningApi.CloseChannelRequest build()

Specified by:

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

Specified by:

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

buildPartial

public LightningApi.CloseChannelRequest buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

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

mergeFrom

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

mergeFrom

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

Throws:

java.io.IOException

hasChannelPoint

public boolean hasChannelPoint()

The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.
 

.lnrpc.ChannelPoint channel_point = 1;

Specified by:

hasChannelPoint in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

Whether the channelPoint field is set.

getChannelPoint

public LightningApi.ChannelPoint getChannelPoint()

The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.
 

.lnrpc.ChannelPoint channel_point = 1;

Specified by:

getChannelPoint in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The channelPoint.

setChannelPoint

public LightningApi.CloseChannelRequest.Builder setChannelPoint(LightningApi.ChannelPoint value)

The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.
 

.lnrpc.ChannelPoint channel_point = 1;

setChannelPoint

public LightningApi.CloseChannelRequest.Builder setChannelPoint(LightningApi.ChannelPoint.Builder builderForValue)

The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.
 

.lnrpc.ChannelPoint channel_point = 1;

mergeChannelPoint

public LightningApi.CloseChannelRequest.Builder mergeChannelPoint(LightningApi.ChannelPoint value)

The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.
 

.lnrpc.ChannelPoint channel_point = 1;

clearChannelPoint

public LightningApi.CloseChannelRequest.Builder clearChannelPoint()

The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.
 

.lnrpc.ChannelPoint channel_point = 1;

getChannelPointBuilder

public LightningApi.ChannelPoint.Builder getChannelPointBuilder()

The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.
 

.lnrpc.ChannelPoint channel_point = 1;

getChannelPointOrBuilder

public LightningApi.ChannelPointOrBuilder getChannelPointOrBuilder()

The outpoint (txid:index) of the funding transaction. With this value, Bob
will be able to generate a signature for Alice's version of the commitment
transaction.
 

.lnrpc.ChannelPoint channel_point = 1;

Specified by:

getChannelPointOrBuilder in interface LightningApi.CloseChannelRequestOrBuilder

getForce

public boolean getForce()

 If true, then the channel will be closed forcibly. This means the
 current commitment transaction will be signed and broadcast.
 

bool force = 2;

Specified by:

getForce in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The force.

setForce

public LightningApi.CloseChannelRequest.Builder setForce(boolean value)

 If true, then the channel will be closed forcibly. This means the
 current commitment transaction will be signed and broadcast.
 

bool force = 2;

Parameters:

value - The force to set.

Returns:

This builder for chaining.

clearForce

public LightningApi.CloseChannelRequest.Builder clearForce()

 If true, then the channel will be closed forcibly. This means the
 current commitment transaction will be signed and broadcast.
 

bool force = 2;

Returns:

This builder for chaining.

getTargetConf

public int getTargetConf()

 The target number of blocks that the closure transaction should be
 confirmed by.
 

int32 target_conf = 3;

Specified by:

getTargetConf in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The targetConf.

setTargetConf

public LightningApi.CloseChannelRequest.Builder setTargetConf(int value)

 The target number of blocks that the closure transaction should be
 confirmed by.
 

int32 target_conf = 3;

Parameters:

value - The targetConf to set.

Returns:

This builder for chaining.

clearTargetConf

public LightningApi.CloseChannelRequest.Builder clearTargetConf()

 The target number of blocks that the closure transaction should be
 confirmed by.
 

int32 target_conf = 3;

Returns:

This builder for chaining.

getSatPerByte

@Deprecated
public long getSatPerByte()

Deprecated. lnrpc.CloseChannelRequest.sat_per_byte is deprecated. See lightning.api.proto;l=2018

 Deprecated, use sat_per_vbyte.
 A manual fee rate set in sat/vbyte that should be used when crafting the
 closure transaction.
 

int64 sat_per_byte = 4 [deprecated = true];

Specified by:

getSatPerByte in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The satPerByte.

setSatPerByte

@Deprecated
public LightningApi.CloseChannelRequest.Builder setSatPerByte(long value)

Deprecated. lnrpc.CloseChannelRequest.sat_per_byte is deprecated. See lightning.api.proto;l=2018

 Deprecated, use sat_per_vbyte.
 A manual fee rate set in sat/vbyte that should be used when crafting the
 closure transaction.
 

int64 sat_per_byte = 4 [deprecated = true];

Parameters:

value - The satPerByte to set.

Returns:

This builder for chaining.

clearSatPerByte

@Deprecated
public LightningApi.CloseChannelRequest.Builder clearSatPerByte()

Deprecated. lnrpc.CloseChannelRequest.sat_per_byte is deprecated. See lightning.api.proto;l=2018

 Deprecated, use sat_per_vbyte.
 A manual fee rate set in sat/vbyte that should be used when crafting the
 closure transaction.
 

int64 sat_per_byte = 4 [deprecated = true];

Returns:

This builder for chaining.

getDeliveryAddress

public java.lang.String getDeliveryAddress()

An optional address to send funds to in the case of a cooperative close.
If the channel was opened with an upfront shutdown script and this field
is set, the request to close will fail because the channel must pay out
to the upfront shutdown addresss.
 

string delivery_address = 5;

Specified by:

getDeliveryAddress in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The deliveryAddress.

getDeliveryAddressBytes

public com.google.protobuf.ByteString getDeliveryAddressBytes()

An optional address to send funds to in the case of a cooperative close.
If the channel was opened with an upfront shutdown script and this field
is set, the request to close will fail because the channel must pay out
to the upfront shutdown addresss.
 

string delivery_address = 5;

Specified by:

getDeliveryAddressBytes in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The bytes for deliveryAddress.

setDeliveryAddress

public LightningApi.CloseChannelRequest.Builder setDeliveryAddress(java.lang.String value)

An optional address to send funds to in the case of a cooperative close.
If the channel was opened with an upfront shutdown script and this field
is set, the request to close will fail because the channel must pay out
to the upfront shutdown addresss.
 

string delivery_address = 5;

Parameters:

value - The deliveryAddress to set.

Returns:

This builder for chaining.

clearDeliveryAddress

public LightningApi.CloseChannelRequest.Builder clearDeliveryAddress()

An optional address to send funds to in the case of a cooperative close.
If the channel was opened with an upfront shutdown script and this field
is set, the request to close will fail because the channel must pay out
to the upfront shutdown addresss.
 

string delivery_address = 5;

Returns:

This builder for chaining.

setDeliveryAddressBytes

public LightningApi.CloseChannelRequest.Builder setDeliveryAddressBytes(com.google.protobuf.ByteString value)

An optional address to send funds to in the case of a cooperative close.
If the channel was opened with an upfront shutdown script and this field
is set, the request to close will fail because the channel must pay out
to the upfront shutdown addresss.
 

string delivery_address = 5;

Parameters:

value - The bytes for deliveryAddress to set.

Returns:

This builder for chaining.

getSatPerVbyte

public long getSatPerVbyte()

 A manual fee rate set in sat/vbyte that should be used when crafting the
 closure transaction.
 

uint64 sat_per_vbyte = 6;

Specified by:

getSatPerVbyte in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The satPerVbyte.

setSatPerVbyte

public LightningApi.CloseChannelRequest.Builder setSatPerVbyte(long value)

 A manual fee rate set in sat/vbyte that should be used when crafting the
 closure transaction.
 

uint64 sat_per_vbyte = 6;

Parameters:

value - The satPerVbyte to set.

Returns:

This builder for chaining.

clearSatPerVbyte

public LightningApi.CloseChannelRequest.Builder clearSatPerVbyte()

 A manual fee rate set in sat/vbyte that should be used when crafting the
 closure transaction.
 

uint64 sat_per_vbyte = 6;

Returns:

This builder for chaining.

getMaxFeePerVbyte

public long getMaxFeePerVbyte()

 The maximum fee rate the closer is willing to pay.

 NOTE: This field is only respected if we're the initiator of the channel.
 

uint64 max_fee_per_vbyte = 7;

Specified by:

getMaxFeePerVbyte in interface LightningApi.CloseChannelRequestOrBuilder

Returns:

The maxFeePerVbyte.

setMaxFeePerVbyte

public LightningApi.CloseChannelRequest.Builder setMaxFeePerVbyte(long value)

 The maximum fee rate the closer is willing to pay.

 NOTE: This field is only respected if we're the initiator of the channel.
 

uint64 max_fee_per_vbyte = 7;

Parameters:

value - The maxFeePerVbyte to set.

Returns:

This builder for chaining.

clearMaxFeePerVbyte

public LightningApi.CloseChannelRequest.Builder clearMaxFeePerVbyte()

 The maximum fee rate the closer is willing to pay.

 NOTE: This field is only respected if we're the initiator of the channel.
 

uint64 max_fee_per_vbyte = 7;

Returns:

This builder for chaining.

setUnknownFields

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

mergeUnknownFields

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