Class ResponseMapper
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3.ResponseMapper
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,ResponseMapperOrBuilder
,Serializable
public final class ResponseMapper
extends com.google.protobuf.GeneratedMessage
implements ResponseMapperOrBuilder
The configuration to filter and change local response. [#next-free-field: 6]Protobuf type
envoy.extensions.filters.network.http_connection_manager.v3.ResponseMapper
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
The configuration to filter and change local response.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private DataSource
static final int
static final int
private SubstitutionFormatString
private static final ResponseMapper
private AccessLogFilter
static final int
static final int
private List
<HeaderValueOption> private byte
private static final com.google.protobuf.Parser
<ResponseMapper> private static final long
static final int
private com.google.protobuf.UInt32Value
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
ResponseMapper
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
getBody()
The new local reply body text if specified.A per mapper ``body_format`` to override the :ref:`body_format <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.LocalReplyConfig.body_format>`.A per mapper ``body_format`` to override the :ref:`body_format <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.LocalReplyConfig.body_format>`.The new local reply body text if specified.static ResponseMapper
static final com.google.protobuf.Descriptors.Descriptor
Filter to determine if this mapper should apply.Filter to determine if this mapper should apply.getHeadersToAdd
(int index) HTTP headers to add to a local reply.int
HTTP headers to add to a local reply.HTTP headers to add to a local reply.getHeadersToAddOrBuilder
(int index) HTTP headers to add to a local reply.List
<? extends HeaderValueOptionOrBuilder> HTTP headers to add to a local reply.com.google.protobuf.Parser
<ResponseMapper> int
com.google.protobuf.UInt32Value
The new response status code if specified.com.google.protobuf.UInt32ValueOrBuilder
The new response status code if specified.boolean
hasBody()
The new local reply body text if specified.boolean
A per mapper ``body_format`` to override the :ref:`body_format <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.LocalReplyConfig.body_format>`.boolean
Filter to determine if this mapper should apply.int
hashCode()
boolean
The new response status code if specified.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static ResponseMapper.Builder
static ResponseMapper.Builder
newBuilder
(ResponseMapper prototype) protected ResponseMapper.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static ResponseMapper
parseDelimitedFrom
(InputStream input) static ResponseMapper
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ResponseMapper
parseFrom
(byte[] data) static ResponseMapper
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ResponseMapper
parseFrom
(com.google.protobuf.ByteString data) static ResponseMapper
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ResponseMapper
parseFrom
(com.google.protobuf.CodedInputStream input) static ResponseMapper
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ResponseMapper
parseFrom
(InputStream input) static ResponseMapper
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ResponseMapper
parseFrom
(ByteBuffer data) static ResponseMapper
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<ResponseMapper> parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER- See Also:
-
filter_
-
STATUS_CODE_FIELD_NUMBER
public static final int STATUS_CODE_FIELD_NUMBER- See Also:
-
statusCode_
private com.google.protobuf.UInt32Value statusCode_ -
BODY_FIELD_NUMBER
public static final int BODY_FIELD_NUMBER- See Also:
-
body_
-
BODY_FORMAT_OVERRIDE_FIELD_NUMBER
public static final int BODY_FORMAT_OVERRIDE_FIELD_NUMBER- See Also:
-
bodyFormatOverride_
-
HEADERS_TO_ADD_FIELD_NUMBER
public static final int HEADERS_TO_ADD_FIELD_NUMBER- See Also:
-
headersToAdd_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
ResponseMapper
private ResponseMapper(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
ResponseMapper
private ResponseMapper()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
hasFilter
public boolean hasFilter()Filter to determine if this mapper should apply.
.envoy.config.accesslog.v3.AccessLogFilter filter = 1 [(.validate.rules) = { ... }
- Specified by:
hasFilter
in interfaceResponseMapperOrBuilder
- Returns:
- Whether the filter field is set.
-
getFilter
Filter to determine if this mapper should apply.
.envoy.config.accesslog.v3.AccessLogFilter filter = 1 [(.validate.rules) = { ... }
- Specified by:
getFilter
in interfaceResponseMapperOrBuilder
- Returns:
- The filter.
-
getFilterOrBuilder
Filter to determine if this mapper should apply.
.envoy.config.accesslog.v3.AccessLogFilter filter = 1 [(.validate.rules) = { ... }
- Specified by:
getFilterOrBuilder
in interfaceResponseMapperOrBuilder
-
hasStatusCode
public boolean hasStatusCode()The new response status code if specified.
.google.protobuf.UInt32Value status_code = 2 [(.validate.rules) = { ... }
- Specified by:
hasStatusCode
in interfaceResponseMapperOrBuilder
- Returns:
- Whether the statusCode field is set.
-
getStatusCode
public com.google.protobuf.UInt32Value getStatusCode()The new response status code if specified.
.google.protobuf.UInt32Value status_code = 2 [(.validate.rules) = { ... }
- Specified by:
getStatusCode
in interfaceResponseMapperOrBuilder
- Returns:
- The statusCode.
-
getStatusCodeOrBuilder
public com.google.protobuf.UInt32ValueOrBuilder getStatusCodeOrBuilder()The new response status code if specified.
.google.protobuf.UInt32Value status_code = 2 [(.validate.rules) = { ... }
- Specified by:
getStatusCodeOrBuilder
in interfaceResponseMapperOrBuilder
-
hasBody
public boolean hasBody()The new local reply body text if specified. It will be used in the ``%LOCAL_REPLY_BODY%`` command operator in the ``body_format``.
.envoy.config.core.v3.DataSource body = 3;
- Specified by:
hasBody
in interfaceResponseMapperOrBuilder
- Returns:
- Whether the body field is set.
-
getBody
The new local reply body text if specified. It will be used in the ``%LOCAL_REPLY_BODY%`` command operator in the ``body_format``.
.envoy.config.core.v3.DataSource body = 3;
- Specified by:
getBody
in interfaceResponseMapperOrBuilder
- Returns:
- The body.
-
getBodyOrBuilder
The new local reply body text if specified. It will be used in the ``%LOCAL_REPLY_BODY%`` command operator in the ``body_format``.
.envoy.config.core.v3.DataSource body = 3;
- Specified by:
getBodyOrBuilder
in interfaceResponseMapperOrBuilder
-
hasBodyFormatOverride
public boolean hasBodyFormatOverride()A per mapper ``body_format`` to override the :ref:`body_format <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.LocalReplyConfig.body_format>`. It will be used when this mapper is matched.
.envoy.config.core.v3.SubstitutionFormatString body_format_override = 4;
- Specified by:
hasBodyFormatOverride
in interfaceResponseMapperOrBuilder
- Returns:
- Whether the bodyFormatOverride field is set.
-
getBodyFormatOverride
A per mapper ``body_format`` to override the :ref:`body_format <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.LocalReplyConfig.body_format>`. It will be used when this mapper is matched.
.envoy.config.core.v3.SubstitutionFormatString body_format_override = 4;
- Specified by:
getBodyFormatOverride
in interfaceResponseMapperOrBuilder
- Returns:
- The bodyFormatOverride.
-
getBodyFormatOverrideOrBuilder
A per mapper ``body_format`` to override the :ref:`body_format <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.LocalReplyConfig.body_format>`. It will be used when this mapper is matched.
.envoy.config.core.v3.SubstitutionFormatString body_format_override = 4;
- Specified by:
getBodyFormatOverrideOrBuilder
in interfaceResponseMapperOrBuilder
-
getHeadersToAddList
HTTP headers to add to a local reply. This allows the response mapper to append, to add or to override headers of any local reply before it is sent to a downstream client.
repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
- Specified by:
getHeadersToAddList
in interfaceResponseMapperOrBuilder
-
getHeadersToAddOrBuilderList
HTTP headers to add to a local reply. This allows the response mapper to append, to add or to override headers of any local reply before it is sent to a downstream client.
repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
- Specified by:
getHeadersToAddOrBuilderList
in interfaceResponseMapperOrBuilder
-
getHeadersToAddCount
public int getHeadersToAddCount()HTTP headers to add to a local reply. This allows the response mapper to append, to add or to override headers of any local reply before it is sent to a downstream client.
repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
- Specified by:
getHeadersToAddCount
in interfaceResponseMapperOrBuilder
-
getHeadersToAdd
HTTP headers to add to a local reply. This allows the response mapper to append, to add or to override headers of any local reply before it is sent to a downstream client.
repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
- Specified by:
getHeadersToAdd
in interfaceResponseMapperOrBuilder
-
getHeadersToAddOrBuilder
HTTP headers to add to a local reply. This allows the response mapper to append, to add or to override headers of any local reply before it is sent to a downstream client.
repeated .envoy.config.core.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
- Specified by:
getHeadersToAddOrBuilder
in interfaceResponseMapperOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ResponseMapper parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ResponseMapper parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ResponseMapper parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ResponseMapper parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ResponseMapper parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ResponseMapper parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ResponseMapper parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ResponseMapper parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ResponseMapper parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ResponseMapper parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ResponseMapper.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-