Interface SubstitutionFormatStringOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
SubstitutionFormatString
,SubstitutionFormatString.Builder
public interface SubstitutionFormatStringOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionSpecify a ``content_type`` field.com.google.protobuf.ByteString
Specify a ``content_type`` field.getFormatters
(int index) Specifies a collection of Formatter plugins that can be called from the access log configuration.int
Specifies a collection of Formatter plugins that can be called from the access log configuration.Specifies a collection of Formatter plugins that can be called from the access log configuration.getFormattersOrBuilder
(int index) Specifies a collection of Formatter plugins that can be called from the access log configuration.List
<? extends TypedExtensionConfigOrBuilder> Specifies a collection of Formatter plugins that can be called from the access log configuration.com.google.protobuf.Struct
Specify a format with command operators to form a JSON string.If json_format is used, the options will be applied to the output JSON string.If json_format is used, the options will be applied to the output JSON string.com.google.protobuf.StructOrBuilder
Specify a format with command operators to form a JSON string.boolean
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.Deprecated.envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated.com.google.protobuf.ByteString
Deprecated.envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated.Specify a format with command operators to form a text string.Specify a format with command operators to form a text string.boolean
Specify a format with command operators to form a JSON string.boolean
If json_format is used, the options will be applied to the output JSON string.boolean
Deprecated.envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated.boolean
Specify a format with command operators to form a text string.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasTextFormat
Deprecated.envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated. See envoy/config/core/v3/substitution_format_string.proto;l=51Specify 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:
- Whether the textFormat field is set.
-
getTextFormat
Deprecated.envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated. See envoy/config/core/v3/substitution_format_string.proto;l=51Specify 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:
- The textFormat.
-
getTextFormatBytes
Deprecated.envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated. See envoy/config/core/v3/substitution_format_string.proto;l=51Specify 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:
- The bytes for textFormat.
-
hasJsonFormat
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) = { ... }
- Returns:
- Whether the jsonFormat field is set.
-
getJsonFormat
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) = { ... }
- Returns:
- The jsonFormat.
-
getJsonFormatOrBuilder
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) = { ... }
-
hasTextFormatSource
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;
- Returns:
- Whether the textFormatSource field is set.
-
getTextFormatSource
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;
- Returns:
- The textFormatSource.
-
getTextFormatSourceOrBuilder
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;
-
getOmitEmptyValues
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;
- Returns:
- The omitEmptyValues.
-
getContentType
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) = { ... }
- Returns:
- The contentType.
-
getContentTypeBytes
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) = { ... }
- Returns:
- The bytes for contentType.
-
getFormattersList
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;
-
getFormatters
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;
-
getFormattersCount
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;
-
getFormattersOrBuilderList
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;
-
getFormattersOrBuilder
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;
-
hasJsonFormatOptions
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;
- Returns:
- Whether the jsonFormatOptions field is set.
-
getJsonFormatOptions
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;
- Returns:
- The jsonFormatOptions.
-
getJsonFormatOptionsOrBuilder
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;
-
getFormatCase
SubstitutionFormatString.FormatCase getFormatCase()
-