io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v4alpha

Class ResponseMapper

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v4alpha.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.GeneratedMessageV3
implements ResponseMapperOrBuilder

 The configuration to filter and change local response.
 [#next-free-field: 6]
 

Protobuf type envoy.extensions.filters.network.http_connection_manager.v4alpha.ResponseMapper

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResponseMapper.Builder The configuration to filter and change local response.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	BODY_FIELD_NUMBER
static int	BODY_FORMAT_OVERRIDE_FIELD_NUMBER
static int	FILTER_FIELD_NUMBER
static int	HEADERS_TO_ADD_FIELD_NUMBER
static int	STATUS_CODE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
DataSource	getBody() The new local reply body text if specified.
SubstitutionFormatString	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>`.
SubstitutionFormatStringOrBuilder	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>`.
DataSourceOrBuilder	getBodyOrBuilder() The new local reply body text if specified.
static ResponseMapper	getDefaultInstance()
ResponseMapper	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
AccessLogFilter	getFilter() Filter to determine if this mapper should apply.
AccessLogFilterOrBuilder	getFilterOrBuilder() Filter to determine if this mapper should apply.
HeaderValueOption	getHeadersToAdd(int index) HTTP headers to add to a local reply.
int	getHeadersToAddCount() HTTP headers to add to a local reply.
List<HeaderValueOption>	getHeadersToAddList() HTTP headers to add to a local reply.
HeaderValueOptionOrBuilder	getHeadersToAddOrBuilder(int index) HTTP headers to add to a local reply.
List<? extends HeaderValueOptionOrBuilder>	getHeadersToAddOrBuilderList() HTTP headers to add to a local reply.
com.google.protobuf.Parser<ResponseMapper>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UInt32Value	getStatusCode() The new response status code if specified.
com.google.protobuf.UInt32ValueOrBuilder	getStatusCodeOrBuilder() The new response status code if specified.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasBody() The new local reply body text if specified.
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>`.
boolean	hasFilter() Filter to determine if this mapper should apply.
int	hashCode()
boolean	hasStatusCode() The new response status code if specified.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ResponseMapper.Builder	newBuilder()
static ResponseMapper.Builder	newBuilder(ResponseMapper prototype)
ResponseMapper.Builder	newBuilderForType()
protected ResponseMapper.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
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(ByteBuffer data)
static ResponseMapper	parseFrom(ByteBuffer 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 com.google.protobuf.Parser<ResponseMapper>	parser()
ResponseMapper.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

STATUS_CODE_FIELD_NUMBER

public static final int STATUS_CODE_FIELD_NUMBER

See Also:

Constant Field Values

BODY_FIELD_NUMBER

public static final int BODY_FIELD_NUMBER

See Also:

Constant Field Values

BODY_FORMAT_OVERRIDE_FIELD_NUMBER

public static final int BODY_FORMAT_OVERRIDE_FIELD_NUMBER

See Also:

Constant Field Values

HEADERS_TO_ADD_FIELD_NUMBER

public static final int HEADERS_TO_ADD_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

hasFilter

public boolean hasFilter()

 Filter to determine if this mapper should apply.
 

.envoy.config.accesslog.v4alpha.AccessLogFilter filter = 1 [(.validate.rules) = { ... }

Specified by:

hasFilter in interface ResponseMapperOrBuilder

getFilter

public AccessLogFilter getFilter()

 Filter to determine if this mapper should apply.
 

.envoy.config.accesslog.v4alpha.AccessLogFilter filter = 1 [(.validate.rules) = { ... }

Specified by:

getFilter in interface ResponseMapperOrBuilder

getFilterOrBuilder

public AccessLogFilterOrBuilder getFilterOrBuilder()

 Filter to determine if this mapper should apply.
 

.envoy.config.accesslog.v4alpha.AccessLogFilter filter = 1 [(.validate.rules) = { ... }

Specified by:

getFilterOrBuilder in interface ResponseMapperOrBuilder

hasStatusCode

public boolean hasStatusCode()

 The new response status code if specified.
 

.google.protobuf.UInt32Value status_code = 2 [(.validate.rules) = { ... }

Specified by:

hasStatusCode in interface ResponseMapperOrBuilder

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 interface ResponseMapperOrBuilder

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 interface ResponseMapperOrBuilder

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.v4alpha.DataSource body = 3;

Specified by:

hasBody in interface ResponseMapperOrBuilder

getBody

public DataSource 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.v4alpha.DataSource body = 3;

Specified by:

getBody in interface ResponseMapperOrBuilder

getBodyOrBuilder

public DataSourceOrBuilder 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.v4alpha.DataSource body = 3;

Specified by:

getBodyOrBuilder in interface ResponseMapperOrBuilder

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.v4alpha.SubstitutionFormatString body_format_override = 4;

Specified by:

hasBodyFormatOverride in interface ResponseMapperOrBuilder

getBodyFormatOverride

public SubstitutionFormatString 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.v4alpha.SubstitutionFormatString body_format_override = 4;

Specified by:

getBodyFormatOverride in interface ResponseMapperOrBuilder

getBodyFormatOverrideOrBuilder

public SubstitutionFormatStringOrBuilder 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.v4alpha.SubstitutionFormatString body_format_override = 4;

Specified by:

getBodyFormatOverrideOrBuilder in interface ResponseMapperOrBuilder

getHeadersToAddList

public List<HeaderValueOption> 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.v4alpha.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }

Specified by:

getHeadersToAddList in interface ResponseMapperOrBuilder

getHeadersToAddOrBuilderList

public List<? extends HeaderValueOptionOrBuilder> 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.v4alpha.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }

Specified by:

getHeadersToAddOrBuilderList in interface ResponseMapperOrBuilder

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.v4alpha.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }

Specified by:

getHeadersToAddCount in interface ResponseMapperOrBuilder

getHeadersToAdd

public HeaderValueOption getHeadersToAdd(int index)

 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.v4alpha.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }

Specified by:

getHeadersToAdd in interface ResponseMapperOrBuilder

getHeadersToAddOrBuilder

public HeaderValueOptionOrBuilder getHeadersToAddOrBuilder(int index)

 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.v4alpha.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }

Specified by:

getHeadersToAddOrBuilder in interface ResponseMapperOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.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

public static ResponseMapper parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static ResponseMapper parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static ResponseMapper parseDelimitedFrom(InputStream input)
                                         throws IOException

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

public ResponseMapper.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ResponseMapper.Builder newBuilder()

newBuilder

public static ResponseMapper.Builder newBuilder(ResponseMapper prototype)

toBuilder

public ResponseMapper.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ResponseMapper.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ResponseMapper getDefaultInstance()

parser

public static com.google.protobuf.Parser<ResponseMapper> parser()

getParserForType

public com.google.protobuf.Parser<ResponseMapper> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ResponseMapper getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder