public static final class LightningApi.MiddlewareRegistration.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.MiddlewareRegistration.Builder> implements LightningApi.MiddlewareRegistrationOrBuilder
lnrpc.MiddlewareRegistration
Modifier and Type | Method and Description |
---|---|
LightningApi.MiddlewareRegistration |
build() |
LightningApi.MiddlewareRegistration |
buildPartial() |
LightningApi.MiddlewareRegistration.Builder |
clear() |
LightningApi.MiddlewareRegistration.Builder |
clearCustomMacaroonCaveatName()
The name of the custom macaroon caveat that this middleware is responsible
for.
|
LightningApi.MiddlewareRegistration.Builder |
clearMiddlewareName()
The name of the middleware to register.
|
LightningApi.MiddlewareRegistration.Builder |
clearReadOnlyMode()
Instead of defining a custom macaroon caveat name a middleware can register
itself for read-only access only.
|
java.lang.String |
getCustomMacaroonCaveatName()
The name of the custom macaroon caveat that this middleware is responsible
for.
|
com.google.protobuf.ByteString |
getCustomMacaroonCaveatNameBytes()
The name of the custom macaroon caveat that this middleware is responsible
for.
|
LightningApi.MiddlewareRegistration |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
java.lang.String |
getMiddlewareName()
The name of the middleware to register.
|
com.google.protobuf.ByteString |
getMiddlewareNameBytes()
The name of the middleware to register.
|
boolean |
getReadOnlyMode()
Instead of defining a custom macaroon caveat name a middleware can register
itself for read-only access only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
LightningApi.MiddlewareRegistration.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
LightningApi.MiddlewareRegistration.Builder |
mergeFrom(LightningApi.MiddlewareRegistration other) |
LightningApi.MiddlewareRegistration.Builder |
mergeFrom(com.google.protobuf.Message other) |
LightningApi.MiddlewareRegistration.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
LightningApi.MiddlewareRegistration.Builder |
setCustomMacaroonCaveatName(java.lang.String value)
The name of the custom macaroon caveat that this middleware is responsible
for.
|
LightningApi.MiddlewareRegistration.Builder |
setCustomMacaroonCaveatNameBytes(com.google.protobuf.ByteString value)
The name of the custom macaroon caveat that this middleware is responsible
for.
|
LightningApi.MiddlewareRegistration.Builder |
setMiddlewareName(java.lang.String value)
The name of the middleware to register.
|
LightningApi.MiddlewareRegistration.Builder |
setMiddlewareNameBytes(com.google.protobuf.ByteString value)
The name of the middleware to register.
|
LightningApi.MiddlewareRegistration.Builder |
setReadOnlyMode(boolean value)
Instead of defining a custom macaroon caveat name a middleware can register
itself for read-only access only.
|
LightningApi.MiddlewareRegistration.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.MiddlewareRegistration.Builder>
public LightningApi.MiddlewareRegistration.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.MiddlewareRegistration.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.MiddlewareRegistration.Builder>
public LightningApi.MiddlewareRegistration getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
public LightningApi.MiddlewareRegistration build()
build
in interface com.google.protobuf.Message.Builder
build
in interface com.google.protobuf.MessageLite.Builder
public LightningApi.MiddlewareRegistration buildPartial()
buildPartial
in interface com.google.protobuf.Message.Builder
buildPartial
in interface com.google.protobuf.MessageLite.Builder
public LightningApi.MiddlewareRegistration.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<LightningApi.MiddlewareRegistration.Builder>
public LightningApi.MiddlewareRegistration.Builder mergeFrom(LightningApi.MiddlewareRegistration other)
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.MiddlewareRegistration.Builder>
public LightningApi.MiddlewareRegistration.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.MiddlewareRegistration.Builder>
java.io.IOException
public java.lang.String getMiddlewareName()
The name of the middleware to register. The name should be as informative as possible and is logged on registration.
string middleware_name = 1;
getMiddlewareName
in interface LightningApi.MiddlewareRegistrationOrBuilder
public com.google.protobuf.ByteString getMiddlewareNameBytes()
The name of the middleware to register. The name should be as informative as possible and is logged on registration.
string middleware_name = 1;
getMiddlewareNameBytes
in interface LightningApi.MiddlewareRegistrationOrBuilder
public LightningApi.MiddlewareRegistration.Builder setMiddlewareName(java.lang.String value)
The name of the middleware to register. The name should be as informative as possible and is logged on registration.
string middleware_name = 1;
value
- The middlewareName to set.public LightningApi.MiddlewareRegistration.Builder clearMiddlewareName()
The name of the middleware to register. The name should be as informative as possible and is logged on registration.
string middleware_name = 1;
public LightningApi.MiddlewareRegistration.Builder setMiddlewareNameBytes(com.google.protobuf.ByteString value)
The name of the middleware to register. The name should be as informative as possible and is logged on registration.
string middleware_name = 1;
value
- The bytes for middlewareName to set.public java.lang.String getCustomMacaroonCaveatName()
The name of the custom macaroon caveat that this middleware is responsible for. Only requests/responses that contain a macaroon with the registered custom caveat are forwarded for interception to the middleware. The exception being the read-only mode: All requests/responses are forwarded to a middleware that requests read-only access but such a middleware won't be allowed to _alter_ responses. As a security measure, _no_ middleware can change responses to requests made with _unencumbered_ macaroons! NOTE: Cannot be used at the same time as read_only_mode.
string custom_macaroon_caveat_name = 2;
getCustomMacaroonCaveatName
in interface LightningApi.MiddlewareRegistrationOrBuilder
public com.google.protobuf.ByteString getCustomMacaroonCaveatNameBytes()
The name of the custom macaroon caveat that this middleware is responsible for. Only requests/responses that contain a macaroon with the registered custom caveat are forwarded for interception to the middleware. The exception being the read-only mode: All requests/responses are forwarded to a middleware that requests read-only access but such a middleware won't be allowed to _alter_ responses. As a security measure, _no_ middleware can change responses to requests made with _unencumbered_ macaroons! NOTE: Cannot be used at the same time as read_only_mode.
string custom_macaroon_caveat_name = 2;
getCustomMacaroonCaveatNameBytes
in interface LightningApi.MiddlewareRegistrationOrBuilder
public LightningApi.MiddlewareRegistration.Builder setCustomMacaroonCaveatName(java.lang.String value)
The name of the custom macaroon caveat that this middleware is responsible for. Only requests/responses that contain a macaroon with the registered custom caveat are forwarded for interception to the middleware. The exception being the read-only mode: All requests/responses are forwarded to a middleware that requests read-only access but such a middleware won't be allowed to _alter_ responses. As a security measure, _no_ middleware can change responses to requests made with _unencumbered_ macaroons! NOTE: Cannot be used at the same time as read_only_mode.
string custom_macaroon_caveat_name = 2;
value
- The customMacaroonCaveatName to set.public LightningApi.MiddlewareRegistration.Builder clearCustomMacaroonCaveatName()
The name of the custom macaroon caveat that this middleware is responsible for. Only requests/responses that contain a macaroon with the registered custom caveat are forwarded for interception to the middleware. The exception being the read-only mode: All requests/responses are forwarded to a middleware that requests read-only access but such a middleware won't be allowed to _alter_ responses. As a security measure, _no_ middleware can change responses to requests made with _unencumbered_ macaroons! NOTE: Cannot be used at the same time as read_only_mode.
string custom_macaroon_caveat_name = 2;
public LightningApi.MiddlewareRegistration.Builder setCustomMacaroonCaveatNameBytes(com.google.protobuf.ByteString value)
The name of the custom macaroon caveat that this middleware is responsible for. Only requests/responses that contain a macaroon with the registered custom caveat are forwarded for interception to the middleware. The exception being the read-only mode: All requests/responses are forwarded to a middleware that requests read-only access but such a middleware won't be allowed to _alter_ responses. As a security measure, _no_ middleware can change responses to requests made with _unencumbered_ macaroons! NOTE: Cannot be used at the same time as read_only_mode.
string custom_macaroon_caveat_name = 2;
value
- The bytes for customMacaroonCaveatName to set.public boolean getReadOnlyMode()
Instead of defining a custom macaroon caveat name a middleware can register itself for read-only access only. In that mode all requests/responses are forwarded to the middleware but the middleware isn't allowed to alter any of the responses. NOTE: Cannot be used at the same time as custom_macaroon_caveat_name.
bool read_only_mode = 3;
getReadOnlyMode
in interface LightningApi.MiddlewareRegistrationOrBuilder
public LightningApi.MiddlewareRegistration.Builder setReadOnlyMode(boolean value)
Instead of defining a custom macaroon caveat name a middleware can register itself for read-only access only. In that mode all requests/responses are forwarded to the middleware but the middleware isn't allowed to alter any of the responses. NOTE: Cannot be used at the same time as custom_macaroon_caveat_name.
bool read_only_mode = 3;
value
- The readOnlyMode to set.public LightningApi.MiddlewareRegistration.Builder clearReadOnlyMode()
Instead of defining a custom macaroon caveat name a middleware can register itself for read-only access only. In that mode all requests/responses are forwarded to the middleware but the middleware isn't allowed to alter any of the responses. NOTE: Cannot be used at the same time as custom_macaroon_caveat_name.
bool read_only_mode = 3;
public final LightningApi.MiddlewareRegistration.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields
in interface com.google.protobuf.Message.Builder
setUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.MiddlewareRegistration.Builder>
public final LightningApi.MiddlewareRegistration.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields
in interface com.google.protobuf.Message.Builder
mergeUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.MiddlewareRegistration.Builder>