Class ResponseMapper.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<ResponseMapper.Builder>
com.google.protobuf.GeneratedMessage.Builder<ResponseMapper.Builder>
io.envoyproxy.envoy.extensions.filters.network.http_connection_manager.v3.ResponseMapper.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ResponseMapperOrBuilder, Cloneable
Enclosing class:
ResponseMapper
public static final class ResponseMapper.Builder extends com.google.protobuf.GeneratedMessage.Builder<ResponseMapper.Builder> 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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ResponseMapper.Builder>

    • clear

      public ResponseMapper.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.GeneratedMessage.Builder<ResponseMapper.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.GeneratedMessage.Builder<ResponseMapper.Builder>

    • getDefaultInstanceForType

      public ResponseMapper getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ResponseMapper build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ResponseMapper buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ResponseMapper.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<ResponseMapper.Builder>

    • mergeFrom

      public ResponseMapper.Builder mergeFrom(ResponseMapper other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ResponseMapper.Builder>

    • mergeFrom

      public ResponseMapper.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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<ResponseMapper.Builder>
      Throws:
      IOException

    • 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 interface ResponseMapperOrBuilder
      Returns:
      Whether the filter field is set.

    • getFilter

      public AccessLogFilter getFilter()
      Filter to determine if this mapper should apply.
      .envoy.config.accesslog.v3.AccessLogFilter filter = 1 [(.validate.rules) = { ... }
      Specified by:
      getFilter in interface ResponseMapperOrBuilder
      Returns:
      The filter.

    • setFilter

      public ResponseMapper.Builder setFilter(AccessLogFilter value)
      Filter to determine if this mapper should apply.
      .envoy.config.accesslog.v3.AccessLogFilter filter = 1 [(.validate.rules) = { ... }

    • setFilter

      public ResponseMapper.Builder setFilter(AccessLogFilter.Builder builderForValue)
      Filter to determine if this mapper should apply.
      .envoy.config.accesslog.v3.AccessLogFilter filter = 1 [(.validate.rules) = { ... }

    • mergeFilter

      public ResponseMapper.Builder mergeFilter(AccessLogFilter value)
      Filter to determine if this mapper should apply.
      .envoy.config.accesslog.v3.AccessLogFilter filter = 1 [(.validate.rules) = { ... }

    • clearFilter

      public ResponseMapper.Builder clearFilter()
      Filter to determine if this mapper should apply.
      .envoy.config.accesslog.v3.AccessLogFilter filter = 1 [(.validate.rules) = { ... }

    • getFilterBuilder

      public AccessLogFilter.Builder getFilterBuilder()
      Filter to determine if this mapper should apply.
      .envoy.config.accesslog.v3.AccessLogFilter filter = 1 [(.validate.rules) = { ... }

    • getFilterOrBuilder

      public AccessLogFilterOrBuilder getFilterOrBuilder()
      Filter to determine if this mapper should apply.
      .envoy.config.accesslog.v3.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
      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 interface ResponseMapperOrBuilder
      Returns:
      The statusCode.

    • setStatusCode

      public ResponseMapper.Builder setStatusCode(com.google.protobuf.UInt32Value value)
      The new response status code if specified.
      .google.protobuf.UInt32Value status_code = 2 [(.validate.rules) = { ... }

    • setStatusCode

      public ResponseMapper.Builder setStatusCode(com.google.protobuf.UInt32Value.Builder builderForValue)
      The new response status code if specified.
      .google.protobuf.UInt32Value status_code = 2 [(.validate.rules) = { ... }

    • mergeStatusCode

      public ResponseMapper.Builder mergeStatusCode(com.google.protobuf.UInt32Value value)
      The new response status code if specified.
      .google.protobuf.UInt32Value status_code = 2 [(.validate.rules) = { ... }

    • clearStatusCode

      public ResponseMapper.Builder clearStatusCode()
      The new response status code if specified.
      .google.protobuf.UInt32Value status_code = 2 [(.validate.rules) = { ... }

    • getStatusCodeBuilder

      public com.google.protobuf.UInt32Value.Builder getStatusCodeBuilder()
      The new response status code if specified.
      .google.protobuf.UInt32Value status_code = 2 [(.validate.rules) = { ... }

    • 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.v3.DataSource body = 3;
      Specified by:
      hasBody in interface ResponseMapperOrBuilder
      Returns:
      Whether the body field is set.

    • 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.v3.DataSource body = 3;
      Specified by:
      getBody in interface ResponseMapperOrBuilder
      Returns:
      The body.

    • setBody

      public ResponseMapper.Builder setBody(DataSource value)
      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;

    • setBody

      public ResponseMapper.Builder setBody(DataSource.Builder builderForValue)
      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;

    • mergeBody

      public ResponseMapper.Builder mergeBody(DataSource value)
      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;

    • clearBody

      public ResponseMapper.Builder clearBody()
      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;

    • getBodyBuilder

      public DataSource.Builder getBodyBuilder()
      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;

    • 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.v3.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.v3.SubstitutionFormatString body_format_override = 4;
      Specified by:
      hasBodyFormatOverride in interface ResponseMapperOrBuilder
      Returns:
      Whether the bodyFormatOverride field is set.

    • 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.v3.SubstitutionFormatString body_format_override = 4;
      Specified by:
      getBodyFormatOverride in interface ResponseMapperOrBuilder
      Returns:
      The bodyFormatOverride.

    • setBodyFormatOverride

      public ResponseMapper.Builder setBodyFormatOverride(SubstitutionFormatString value)
      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;

    • setBodyFormatOverride

      public ResponseMapper.Builder setBodyFormatOverride(SubstitutionFormatString.Builder builderForValue)
      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;

    • mergeBodyFormatOverride

      public ResponseMapper.Builder mergeBodyFormatOverride(SubstitutionFormatString value)
      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;

    • clearBodyFormatOverride

      public ResponseMapper.Builder clearBodyFormatOverride()
      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;

    • getBodyFormatOverrideBuilder

      public SubstitutionFormatString.Builder getBodyFormatOverrideBuilder()
      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;

    • 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.v3.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.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
      Specified by:
      getHeadersToAddList 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.v3.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.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
      Specified by:
      getHeadersToAdd in interface ResponseMapperOrBuilder

    • setHeadersToAdd

      public ResponseMapper.Builder setHeadersToAdd(int index, HeaderValueOption value)
      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) = { ... }

    • setHeadersToAdd

      public ResponseMapper.Builder setHeadersToAdd(int index, HeaderValueOption.Builder builderForValue)
      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) = { ... }

    • addHeadersToAdd

      public ResponseMapper.Builder addHeadersToAdd(HeaderValueOption value)
      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) = { ... }

    • addHeadersToAdd

      public ResponseMapper.Builder addHeadersToAdd(int index, HeaderValueOption value)
      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) = { ... }

    • addHeadersToAdd

      public ResponseMapper.Builder addHeadersToAdd(HeaderValueOption.Builder builderForValue)
      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) = { ... }

    • addHeadersToAdd

      public ResponseMapper.Builder addHeadersToAdd(int index, HeaderValueOption.Builder builderForValue)
      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) = { ... }

    • addAllHeadersToAdd

      public ResponseMapper.Builder addAllHeadersToAdd(Iterable<? extends HeaderValueOption> values)
      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) = { ... }

    • clearHeadersToAdd

      public ResponseMapper.Builder clearHeadersToAdd()
      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) = { ... }

    • removeHeadersToAdd

      public ResponseMapper.Builder removeHeadersToAdd(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.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }

    • getHeadersToAddBuilder

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

    • 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.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
      Specified by:
      getHeadersToAddOrBuilder 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.v3.HeaderValueOption headers_to_add = 5 [(.validate.rules) = { ... }
      Specified by:
      getHeadersToAddOrBuilderList in interface ResponseMapperOrBuilder

    • addHeadersToAddBuilder

      public HeaderValueOption.Builder addHeadersToAddBuilder()
      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) = { ... }

    • addHeadersToAddBuilder

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

    • getHeadersToAddBuilderList

      public List<HeaderValueOption.Builder> getHeadersToAddBuilderList()
      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) = { ... }