Class SubstitutionFormatString.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<SubstitutionFormatString.Builder>
com.google.protobuf.GeneratedMessage.Builder<SubstitutionFormatString.Builder>
io.envoyproxy.envoy.config.core.v3.SubstitutionFormatString.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SubstitutionFormatStringOrBuilder, Cloneable
Enclosing class:
SubstitutionFormatString
public static final class SubstitutionFormatString.Builder extends com.google.protobuf.GeneratedMessage.Builder<SubstitutionFormatString.Builder> implements SubstitutionFormatStringOrBuilder
Configuration to use multiple :ref:`command operators <config_access_log_command_operators>`
to generate a new string in either plain text or JSON format.
[#next-free-field: 8]
Protobuf type envoy.config.core.v3.SubstitutionFormatString

  • Field Details

  • Constructor Details

    • Builder

      private Builder()

    • Builder

      private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)

  • 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<SubstitutionFormatString.Builder>

    • maybeForceBuilderInitialization

      private void maybeForceBuilderInitialization()

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • buildPartialRepeatedFields

      private void buildPartialRepeatedFields(SubstitutionFormatString result)

    • buildPartial0

      private void buildPartial0(SubstitutionFormatString result)

    • buildPartialOneofs

      private void buildPartialOneofs(SubstitutionFormatString result)

    • mergeFrom

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

    • mergeFrom

      public SubstitutionFormatString.Builder mergeFrom(SubstitutionFormatString other)

    • isInitialized

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

    • mergeFrom

      public SubstitutionFormatString.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<SubstitutionFormatString.Builder>
      Throws:
      IOException

    • getFormatCase

      public SubstitutionFormatString.FormatCase getFormatCase()
      Specified by:
      getFormatCase in interface SubstitutionFormatStringOrBuilder

    • clearFormat

      public SubstitutionFormatString.Builder clearFormat()

    • hasTextFormat

      @Deprecated public boolean hasTextFormat()
      Deprecated.
      envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated. See envoy/config/core/v3/substitution_format_string.proto;l=51
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo

Deprecated in favor of :ref:`text_format_source <envoy_v3_api_field_config.core.v3.SubstitutionFormatString.text_format_source>`. To migrate text format strings, use the :ref:`inline_string <envoy_v3_api_field_config.core.v3.DataSource.inline_string>` field.
      string text_format = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      hasTextFormat in interface SubstitutionFormatStringOrBuilder
      Returns:
      Whether the textFormat field is set.

    • getTextFormat

      @Deprecated public String getTextFormat()
      Deprecated.
      envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated. See envoy/config/core/v3/substitution_format_string.proto;l=51
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo

Deprecated in favor of :ref:`text_format_source <envoy_v3_api_field_config.core.v3.SubstitutionFormatString.text_format_source>`. To migrate text format strings, use the :ref:`inline_string <envoy_v3_api_field_config.core.v3.DataSource.inline_string>` field.
      string text_format = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getTextFormat in interface SubstitutionFormatStringOrBuilder
      Returns:
      The textFormat.

    • getTextFormatBytes

      @Deprecated public com.google.protobuf.ByteString getTextFormatBytes()
      Deprecated.
      envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated. See envoy/config/core/v3/substitution_format_string.proto;l=51
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo

Deprecated in favor of :ref:`text_format_source <envoy_v3_api_field_config.core.v3.SubstitutionFormatString.text_format_source>`. To migrate text format strings, use the :ref:`inline_string <envoy_v3_api_field_config.core.v3.DataSource.inline_string>` field.
      string text_format = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Specified by:
      getTextFormatBytes in interface SubstitutionFormatStringOrBuilder
      Returns:
      The bytes for textFormat.

    • setTextFormat

      @Deprecated public SubstitutionFormatString.Builder setTextFormat(String value)
      Deprecated.
      envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated. See envoy/config/core/v3/substitution_format_string.proto;l=51
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo

Deprecated in favor of :ref:`text_format_source <envoy_v3_api_field_config.core.v3.SubstitutionFormatString.text_format_source>`. To migrate text format strings, use the :ref:`inline_string <envoy_v3_api_field_config.core.v3.DataSource.inline_string>` field.
      string text_format = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Parameters:
      value - The textFormat to set.
      Returns:
      This builder for chaining.

    • clearTextFormat

      @Deprecated public SubstitutionFormatString.Builder clearTextFormat()
      Deprecated.
      envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated. See envoy/config/core/v3/substitution_format_string.proto;l=51
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo

Deprecated in favor of :ref:`text_format_source <envoy_v3_api_field_config.core.v3.SubstitutionFormatString.text_format_source>`. To migrate text format strings, use the :ref:`inline_string <envoy_v3_api_field_config.core.v3.DataSource.inline_string>` field.
      string text_format = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      This builder for chaining.

    • setTextFormatBytes

      @Deprecated public SubstitutionFormatString.Builder setTextFormatBytes(com.google.protobuf.ByteString value)
      Deprecated.
      envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated. See envoy/config/core/v3/substitution_format_string.proto;l=51
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo

Deprecated in favor of :ref:`text_format_source <envoy_v3_api_field_config.core.v3.SubstitutionFormatString.text_format_source>`. To migrate text format strings, use the :ref:`inline_string <envoy_v3_api_field_config.core.v3.DataSource.inline_string>` field.
      string text_format = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Parameters:
      value - The bytes for textFormat to set.
      Returns:
      This builder for chaining.

    • hasJsonFormat

      public boolean hasJsonFormat()
      Specify a format with command operators to form a JSON string.
Its details is described in :ref:`format dictionary<config_access_log_format_dictionaries>`.
Values are rendered as strings, numbers, or boolean values as appropriate.
Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
See the documentation for a specific command operator for details.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

json_format:
status: "%RESPONSE_CODE%"
message: "%LOCAL_REPLY_BODY%"

The following JSON object would be created:

.. code-block:: json

{
"status": 500,
"message": "My error message"
}
      .google.protobuf.Struct json_format = 2 [(.validate.rules) = { ... }
      Specified by:
      hasJsonFormat in interface SubstitutionFormatStringOrBuilder
      Returns:
      Whether the jsonFormat field is set.

    • getJsonFormat

      public com.google.protobuf.Struct getJsonFormat()
      Specify a format with command operators to form a JSON string.
Its details is described in :ref:`format dictionary<config_access_log_format_dictionaries>`.
Values are rendered as strings, numbers, or boolean values as appropriate.
Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
See the documentation for a specific command operator for details.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

json_format:
status: "%RESPONSE_CODE%"
message: "%LOCAL_REPLY_BODY%"

The following JSON object would be created:

.. code-block:: json

{
"status": 500,
"message": "My error message"
}
      .google.protobuf.Struct json_format = 2 [(.validate.rules) = { ... }
      Specified by:
      getJsonFormat in interface SubstitutionFormatStringOrBuilder
      Returns:
      The jsonFormat.

    • setJsonFormat

      public SubstitutionFormatString.Builder setJsonFormat(com.google.protobuf.Struct value)
      Specify a format with command operators to form a JSON string.
Its details is described in :ref:`format dictionary<config_access_log_format_dictionaries>`.
Values are rendered as strings, numbers, or boolean values as appropriate.
Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
See the documentation for a specific command operator for details.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

json_format:
status: "%RESPONSE_CODE%"
message: "%LOCAL_REPLY_BODY%"

The following JSON object would be created:

.. code-block:: json

{
"status": 500,
"message": "My error message"
}
      .google.protobuf.Struct json_format = 2 [(.validate.rules) = { ... }

    • setJsonFormat

      public SubstitutionFormatString.Builder setJsonFormat(com.google.protobuf.Struct.Builder builderForValue)
      Specify a format with command operators to form a JSON string.
Its details is described in :ref:`format dictionary<config_access_log_format_dictionaries>`.
Values are rendered as strings, numbers, or boolean values as appropriate.
Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
See the documentation for a specific command operator for details.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

json_format:
status: "%RESPONSE_CODE%"
message: "%LOCAL_REPLY_BODY%"

The following JSON object would be created:

.. code-block:: json

{
"status": 500,
"message": "My error message"
}
      .google.protobuf.Struct json_format = 2 [(.validate.rules) = { ... }

    • mergeJsonFormat

      public SubstitutionFormatString.Builder mergeJsonFormat(com.google.protobuf.Struct value)
      Specify a format with command operators to form a JSON string.
Its details is described in :ref:`format dictionary<config_access_log_format_dictionaries>`.
Values are rendered as strings, numbers, or boolean values as appropriate.
Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
See the documentation for a specific command operator for details.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

json_format:
status: "%RESPONSE_CODE%"
message: "%LOCAL_REPLY_BODY%"

The following JSON object would be created:

.. code-block:: json

{
"status": 500,
"message": "My error message"
}
      .google.protobuf.Struct json_format = 2 [(.validate.rules) = { ... }

    • clearJsonFormat

      public SubstitutionFormatString.Builder clearJsonFormat()
      Specify a format with command operators to form a JSON string.
Its details is described in :ref:`format dictionary<config_access_log_format_dictionaries>`.
Values are rendered as strings, numbers, or boolean values as appropriate.
Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
See the documentation for a specific command operator for details.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

json_format:
status: "%RESPONSE_CODE%"
message: "%LOCAL_REPLY_BODY%"

The following JSON object would be created:

.. code-block:: json

{
"status": 500,
"message": "My error message"
}
      .google.protobuf.Struct json_format = 2 [(.validate.rules) = { ... }

    • getJsonFormatBuilder

      public com.google.protobuf.Struct.Builder getJsonFormatBuilder()
      Specify a format with command operators to form a JSON string.
Its details is described in :ref:`format dictionary<config_access_log_format_dictionaries>`.
Values are rendered as strings, numbers, or boolean values as appropriate.
Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
See the documentation for a specific command operator for details.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

json_format:
status: "%RESPONSE_CODE%"
message: "%LOCAL_REPLY_BODY%"

The following JSON object would be created:

.. code-block:: json

{
"status": 500,
"message": "My error message"
}
      .google.protobuf.Struct json_format = 2 [(.validate.rules) = { ... }

    • getJsonFormatOrBuilder

      public com.google.protobuf.StructOrBuilder getJsonFormatOrBuilder()
      Specify a format with command operators to form a JSON string.
Its details is described in :ref:`format dictionary<config_access_log_format_dictionaries>`.
Values are rendered as strings, numbers, or boolean values as appropriate.
Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
See the documentation for a specific command operator for details.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

json_format:
status: "%RESPONSE_CODE%"
message: "%LOCAL_REPLY_BODY%"

The following JSON object would be created:

.. code-block:: json

{
"status": 500,
"message": "My error message"
}
      .google.protobuf.Struct json_format = 2 [(.validate.rules) = { ... }
      Specified by:
      getJsonFormatOrBuilder in interface SubstitutionFormatStringOrBuilder

    • internalGetJsonFormatFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Struct, com.google.protobuf.Struct.Builder, com.google.protobuf.StructOrBuilder> internalGetJsonFormatFieldBuilder()
      Specify a format with command operators to form a JSON string.
Its details is described in :ref:`format dictionary<config_access_log_format_dictionaries>`.
Values are rendered as strings, numbers, or boolean values as appropriate.
Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
See the documentation for a specific command operator for details.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

json_format:
status: "%RESPONSE_CODE%"
message: "%LOCAL_REPLY_BODY%"

The following JSON object would be created:

.. code-block:: json

{
"status": 500,
"message": "My error message"
}
      .google.protobuf.Struct json_format = 2 [(.validate.rules) = { ... }

    • hasTextFormatSource

      public boolean hasTextFormatSource()
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format_source:
inline_string: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo
      .envoy.config.core.v3.DataSource text_format_source = 5;
      Specified by:
      hasTextFormatSource in interface SubstitutionFormatStringOrBuilder
      Returns:
      Whether the textFormatSource field is set.

    • getTextFormatSource

      public DataSource getTextFormatSource()
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format_source:
inline_string: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo
      .envoy.config.core.v3.DataSource text_format_source = 5;
      Specified by:
      getTextFormatSource in interface SubstitutionFormatStringOrBuilder
      Returns:
      The textFormatSource.

    • setTextFormatSource

      public SubstitutionFormatString.Builder setTextFormatSource(DataSource value)
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format_source:
inline_string: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo
      .envoy.config.core.v3.DataSource text_format_source = 5;

    • setTextFormatSource

      public SubstitutionFormatString.Builder setTextFormatSource(DataSource.Builder builderForValue)
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format_source:
inline_string: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo
      .envoy.config.core.v3.DataSource text_format_source = 5;

    • mergeTextFormatSource

      public SubstitutionFormatString.Builder mergeTextFormatSource(DataSource value)
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format_source:
inline_string: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo
      .envoy.config.core.v3.DataSource text_format_source = 5;

    • clearTextFormatSource

      public SubstitutionFormatString.Builder clearTextFormatSource()
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format_source:
inline_string: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo
      .envoy.config.core.v3.DataSource text_format_source = 5;

    • getTextFormatSourceBuilder

      public DataSource.Builder getTextFormatSourceBuilder()
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format_source:
inline_string: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo
      .envoy.config.core.v3.DataSource text_format_source = 5;

    • getTextFormatSourceOrBuilder

      public DataSourceOrBuilder getTextFormatSourceOrBuilder()
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format_source:
inline_string: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo
      .envoy.config.core.v3.DataSource text_format_source = 5;
      Specified by:
      getTextFormatSourceOrBuilder in interface SubstitutionFormatStringOrBuilder

    • internalGetTextFormatSourceFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<DataSource, DataSource.Builder, DataSourceOrBuilder> internalGetTextFormatSourceFieldBuilder()
      Specify a format with command operators to form a text string.
Its details is described in :ref:`format string<config_access_log_format_strings>`.

For example, setting ``text_format`` like below,

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

text_format_source:
inline_string: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"

generates plain text similar to:

.. code-block:: text

upstream connect error:503:path=/foo
      .envoy.config.core.v3.DataSource text_format_source = 5;

    • getOmitEmptyValues

      public boolean getOmitEmptyValues()
      If set to true, when command operators are evaluated to null,

* for ``text_format``, the output of the empty operator is changed from ``-`` to an
empty string, so that empty values are omitted entirely.
* for ``json_format`` the keys with null values are omitted in the output structure.
      bool omit_empty_values = 3;
      Specified by:
      getOmitEmptyValues in interface SubstitutionFormatStringOrBuilder
      Returns:
      The omitEmptyValues.

    • setOmitEmptyValues

      public SubstitutionFormatString.Builder setOmitEmptyValues(boolean value)
      If set to true, when command operators are evaluated to null,

* for ``text_format``, the output of the empty operator is changed from ``-`` to an
empty string, so that empty values are omitted entirely.
* for ``json_format`` the keys with null values are omitted in the output structure.
      bool omit_empty_values = 3;
      Parameters:
      value - The omitEmptyValues to set.
      Returns:
      This builder for chaining.

    • clearOmitEmptyValues

      public SubstitutionFormatString.Builder clearOmitEmptyValues()
      If set to true, when command operators are evaluated to null,

* for ``text_format``, the output of the empty operator is changed from ``-`` to an
empty string, so that empty values are omitted entirely.
* for ``json_format`` the keys with null values are omitted in the output structure.
      bool omit_empty_values = 3;
      Returns:
      This builder for chaining.

    • getContentType

      public String getContentType()
      Specify a ``content_type`` field.
If this field is not set then ``text/plain`` is used for ``text_format`` and
``application/json`` is used for ``json_format``.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

content_type: "text/html; charset=UTF-8"
      string content_type = 4 [(.validate.rules) = { ... }
      Specified by:
      getContentType in interface SubstitutionFormatStringOrBuilder
      Returns:
      The contentType.

    • getContentTypeBytes

      public com.google.protobuf.ByteString getContentTypeBytes()
      Specify a ``content_type`` field.
If this field is not set then ``text/plain`` is used for ``text_format`` and
``application/json`` is used for ``json_format``.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

content_type: "text/html; charset=UTF-8"
      string content_type = 4 [(.validate.rules) = { ... }
      Specified by:
      getContentTypeBytes in interface SubstitutionFormatStringOrBuilder
      Returns:
      The bytes for contentType.

    • setContentType

      public SubstitutionFormatString.Builder setContentType(String value)
      Specify a ``content_type`` field.
If this field is not set then ``text/plain`` is used for ``text_format`` and
``application/json`` is used for ``json_format``.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

content_type: "text/html; charset=UTF-8"
      string content_type = 4 [(.validate.rules) = { ... }
      Parameters:
      value - The contentType to set.
      Returns:
      This builder for chaining.

    • clearContentType

      public SubstitutionFormatString.Builder clearContentType()
      Specify a ``content_type`` field.
If this field is not set then ``text/plain`` is used for ``text_format`` and
``application/json`` is used for ``json_format``.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

content_type: "text/html; charset=UTF-8"
      string content_type = 4 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setContentTypeBytes

      public SubstitutionFormatString.Builder setContentTypeBytes(com.google.protobuf.ByteString value)
      Specify a ``content_type`` field.
If this field is not set then ``text/plain`` is used for ``text_format`` and
``application/json`` is used for ``json_format``.

.. validated-code-block:: yaml
:type-name: envoy.config.core.v3.SubstitutionFormatString

content_type: "text/html; charset=UTF-8"
      string content_type = 4 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for contentType to set.
      Returns:
      This builder for chaining.

    • ensureFormattersIsMutable

      private void ensureFormattersIsMutable()

    • getFormattersList

      public List<TypedExtensionConfig> getFormattersList()
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;
      Specified by:
      getFormattersList in interface SubstitutionFormatStringOrBuilder

    • getFormattersCount

      public int getFormattersCount()
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;
      Specified by:
      getFormattersCount in interface SubstitutionFormatStringOrBuilder

    • getFormatters

      public TypedExtensionConfig getFormatters(int index)
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;
      Specified by:
      getFormatters in interface SubstitutionFormatStringOrBuilder

    • setFormatters

      public SubstitutionFormatString.Builder setFormatters(int index, TypedExtensionConfig value)
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • setFormatters

      public SubstitutionFormatString.Builder setFormatters(int index, TypedExtensionConfig.Builder builderForValue)
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • addFormatters

      public SubstitutionFormatString.Builder addFormatters(TypedExtensionConfig value)
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • addFormatters

      public SubstitutionFormatString.Builder addFormatters(int index, TypedExtensionConfig value)
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • addFormatters

      public SubstitutionFormatString.Builder addFormatters(TypedExtensionConfig.Builder builderForValue)
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • addFormatters

      public SubstitutionFormatString.Builder addFormatters(int index, TypedExtensionConfig.Builder builderForValue)
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • addAllFormatters

      public SubstitutionFormatString.Builder addAllFormatters(Iterable<? extends TypedExtensionConfig> values)
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • clearFormatters

      public SubstitutionFormatString.Builder clearFormatters()
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • removeFormatters

      public SubstitutionFormatString.Builder removeFormatters(int index)
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • getFormattersBuilder

      public TypedExtensionConfig.Builder getFormattersBuilder(int index)
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • getFormattersOrBuilder

      public TypedExtensionConfigOrBuilder getFormattersOrBuilder(int index)
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;
      Specified by:
      getFormattersOrBuilder in interface SubstitutionFormatStringOrBuilder

    • getFormattersOrBuilderList

      public List<? extends TypedExtensionConfigOrBuilder> getFormattersOrBuilderList()
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;
      Specified by:
      getFormattersOrBuilderList in interface SubstitutionFormatStringOrBuilder

    • addFormattersBuilder

      public TypedExtensionConfig.Builder addFormattersBuilder()
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • addFormattersBuilder

      public TypedExtensionConfig.Builder addFormattersBuilder(int index)
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • getFormattersBuilderList

      public List<TypedExtensionConfig.Builder> getFormattersBuilderList()
      Specifies a collection of Formatter plugins that can be called from the access log configuration.
See the formatters extensions documentation for details.
[#extension-category: envoy.formatter]
      repeated .envoy.config.core.v3.TypedExtensionConfig formatters = 6;

    • internalGetFormattersFieldBuilder

      private com.google.protobuf.RepeatedFieldBuilder<TypedExtensionConfig, TypedExtensionConfig.Builder, TypedExtensionConfigOrBuilder> internalGetFormattersFieldBuilder()

    • hasJsonFormatOptions

      public boolean hasJsonFormatOptions()
      If json_format is used, the options will be applied to the output JSON string.
      .envoy.config.core.v3.JsonFormatOptions json_format_options = 7;
      Specified by:
      hasJsonFormatOptions in interface SubstitutionFormatStringOrBuilder
      Returns:
      Whether the jsonFormatOptions field is set.

    • getJsonFormatOptions

      public JsonFormatOptions getJsonFormatOptions()
      If json_format is used, the options will be applied to the output JSON string.
      .envoy.config.core.v3.JsonFormatOptions json_format_options = 7;
      Specified by:
      getJsonFormatOptions in interface SubstitutionFormatStringOrBuilder
      Returns:
      The jsonFormatOptions.

    • setJsonFormatOptions

      public SubstitutionFormatString.Builder setJsonFormatOptions(JsonFormatOptions value)
      If json_format is used, the options will be applied to the output JSON string.
      .envoy.config.core.v3.JsonFormatOptions json_format_options = 7;

    • setJsonFormatOptions

      public SubstitutionFormatString.Builder setJsonFormatOptions(JsonFormatOptions.Builder builderForValue)
      If json_format is used, the options will be applied to the output JSON string.
      .envoy.config.core.v3.JsonFormatOptions json_format_options = 7;

    • mergeJsonFormatOptions

      public SubstitutionFormatString.Builder mergeJsonFormatOptions(JsonFormatOptions value)
      If json_format is used, the options will be applied to the output JSON string.
      .envoy.config.core.v3.JsonFormatOptions json_format_options = 7;

    • clearJsonFormatOptions

      public SubstitutionFormatString.Builder clearJsonFormatOptions()
      If json_format is used, the options will be applied to the output JSON string.
      .envoy.config.core.v3.JsonFormatOptions json_format_options = 7;

    • getJsonFormatOptionsBuilder

      public JsonFormatOptions.Builder getJsonFormatOptionsBuilder()
      If json_format is used, the options will be applied to the output JSON string.
      .envoy.config.core.v3.JsonFormatOptions json_format_options = 7;

    • getJsonFormatOptionsOrBuilder

      public JsonFormatOptionsOrBuilder getJsonFormatOptionsOrBuilder()
      If json_format is used, the options will be applied to the output JSON string.
      .envoy.config.core.v3.JsonFormatOptions json_format_options = 7;
      Specified by:
      getJsonFormatOptionsOrBuilder in interface SubstitutionFormatStringOrBuilder

    • internalGetJsonFormatOptionsFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<JsonFormatOptions, JsonFormatOptions.Builder, JsonFormatOptionsOrBuilder> internalGetJsonFormatOptionsFieldBuilder()
      If json_format is used, the options will be applied to the output JSON string.
      .envoy.config.core.v3.JsonFormatOptions json_format_options = 7;