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 Summary
FieldsModifier and TypeFieldDescriptionprivate int
private Object
private Object
private int
private List
<TypedExtensionConfig> private com.google.protobuf.RepeatedFieldBuilder
<TypedExtensionConfig, TypedExtensionConfig.Builder, TypedExtensionConfigOrBuilder> private com.google.protobuf.SingleFieldBuilder
<com.google.protobuf.Struct, com.google.protobuf.Struct.Builder, com.google.protobuf.StructOrBuilder> private JsonFormatOptions
private com.google.protobuf.SingleFieldBuilder
<JsonFormatOptions, JsonFormatOptions.Builder, JsonFormatOptionsOrBuilder> private boolean
private com.google.protobuf.SingleFieldBuilder
<DataSource, DataSource.Builder, DataSourceOrBuilder> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAllFormatters
(Iterable<? extends TypedExtensionConfig> values) Specifies a collection of Formatter plugins that can be called from the access log configuration.addFormatters
(int index, TypedExtensionConfig value) Specifies a collection of Formatter plugins that can be called from the access log configuration.addFormatters
(int index, TypedExtensionConfig.Builder builderForValue) 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.addFormatters
(TypedExtensionConfig.Builder builderForValue) 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.addFormattersBuilder
(int index) Specifies a collection of Formatter plugins that can be called from the access log configuration.build()
private void
private void
private void
clear()
Specify a ``content_type`` field.Specifies a collection of Formatter plugins that can be called from the access log configuration.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 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.Specify a format with command operators to form a text string.private void
Specify a ``content_type`` field.com.google.protobuf.ByteString
Specify a ``content_type`` field.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
getFormatters
(int index) Specifies a collection of Formatter plugins that can be called from the access log configuration.getFormattersBuilder
(int index) 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.int
Specifies a collection of Formatter plugins that can be called from the access log configuration.private com.google.protobuf.RepeatedFieldBuilder
<TypedExtensionConfig, TypedExtensionConfig.Builder, TypedExtensionConfigOrBuilder> 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.com.google.protobuf.Struct.Builder
Specify a format with command operators to form a JSON string.private com.google.protobuf.SingleFieldBuilder
<com.google.protobuf.Struct, com.google.protobuf.Struct.Builder, com.google.protobuf.StructOrBuilder> 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.private com.google.protobuf.SingleFieldBuilder
<JsonFormatOptions, JsonFormatOptions.Builder, JsonFormatOptionsOrBuilder> 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.private com.google.protobuf.SingleFieldBuilder
<DataSource, DataSource.Builder, DataSourceOrBuilder> 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.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
private void
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeJsonFormat
(com.google.protobuf.Struct value) 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.mergeTextFormatSource
(DataSource value) Specify a format with command operators to form a text string.removeFormatters
(int index) Specifies a collection of Formatter plugins that can be called from the access log configuration.setContentType
(String value) Specify a ``content_type`` field.setContentTypeBytes
(com.google.protobuf.ByteString value) Specify a ``content_type`` field.setFormatters
(int index, TypedExtensionConfig value) Specifies a collection of Formatter plugins that can be called from the access log configuration.setFormatters
(int index, TypedExtensionConfig.Builder builderForValue) Specifies a collection of Formatter plugins that can be called from the access log configuration.setJsonFormat
(com.google.protobuf.Struct value) Specify a format with command operators to form a JSON string.setJsonFormat
(com.google.protobuf.Struct.Builder builderForValue) 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.setJsonFormatOptions
(JsonFormatOptions.Builder builderForValue) If json_format is used, the options will be applied to the output JSON string.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.setTextFormat
(String value) Deprecated.envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated.setTextFormatBytes
(com.google.protobuf.ByteString value) Deprecated.envoy.config.core.v3.SubstitutionFormatString.text_format is deprecated.setTextFormatSource
(DataSource value) Specify a format with command operators to form a text string.setTextFormatSource
(DataSource.Builder builderForValue) Specify a format with command operators to form a text string.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
formatCase_
private int formatCase_ -
format_
-
bitField0_
private int bitField0_ -
jsonFormatBuilder_
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Struct,com.google.protobuf.Struct.Builder, jsonFormatBuilder_com.google.protobuf.StructOrBuilder> -
textFormatSourceBuilder_
private com.google.protobuf.SingleFieldBuilder<DataSource,DataSource.Builder, textFormatSourceBuilder_DataSourceOrBuilder> -
omitEmptyValues_
private boolean omitEmptyValues_ -
contentType_
-
formatters_
-
formattersBuilder_
private com.google.protobuf.RepeatedFieldBuilder<TypedExtensionConfig,TypedExtensionConfig.Builder, formattersBuilder_TypedExtensionConfigOrBuilder> -
jsonFormatOptions_
-
jsonFormatOptionsBuilder_
private com.google.protobuf.SingleFieldBuilder<JsonFormatOptions,JsonFormatOptions.Builder, jsonFormatOptionsBuilder_JsonFormatOptionsOrBuilder>
-
-
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 classcom.google.protobuf.GeneratedMessage.Builder<SubstitutionFormatString.Builder>
-
maybeForceBuilderInitialization
private void maybeForceBuilderInitialization() -
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessage.Builder<SubstitutionFormatString.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<SubstitutionFormatString.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartialRepeatedFields
-
buildPartial0
-
buildPartialOneofs
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<SubstitutionFormatString.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.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 interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<SubstitutionFormatString.Builder>
- Throws:
IOException
-
getFormatCase
- Specified by:
getFormatCase
in interfaceSubstitutionFormatStringOrBuilder
-
clearFormat
-
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"];
- Specified by:
hasTextFormat
in interfaceSubstitutionFormatStringOrBuilder
- 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"];
- Specified by:
getTextFormat
in interfaceSubstitutionFormatStringOrBuilder
- 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"];
- Specified by:
getTextFormatBytes
in interfaceSubstitutionFormatStringOrBuilder
- Returns:
- The bytes for textFormat.
-
setTextFormat
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"];
- Parameters:
value
- The textFormat to set.- Returns:
- This builder for chaining.
-
clearTextFormat
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:
- 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=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"];
- 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 interfaceSubstitutionFormatStringOrBuilder
- 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 interfaceSubstitutionFormatStringOrBuilder
- Returns:
- The jsonFormat.
-
setJsonFormat
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
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
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 interfaceSubstitutionFormatStringOrBuilder
-
getJsonFormatFieldBuilder
private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.Struct,com.google.protobuf.Struct.Builder, getJsonFormatFieldBuilder()com.google.protobuf.StructOrBuilder> 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 interfaceSubstitutionFormatStringOrBuilder
- Returns:
- Whether the textFormatSource field is set.
-
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 interfaceSubstitutionFormatStringOrBuilder
- Returns:
- The textFormatSource.
-
setTextFormatSource
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
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
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
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
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
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 interfaceSubstitutionFormatStringOrBuilder
-
getTextFormatSourceFieldBuilder
private com.google.protobuf.SingleFieldBuilder<DataSource,DataSource.Builder, getTextFormatSourceFieldBuilder()DataSourceOrBuilder> 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 interfaceSubstitutionFormatStringOrBuilder
- Returns:
- The omitEmptyValues.
-
setOmitEmptyValues
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
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
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 interfaceSubstitutionFormatStringOrBuilder
- 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 interfaceSubstitutionFormatStringOrBuilder
- Returns:
- The bytes for contentType.
-
setContentType
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
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
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
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 interfaceSubstitutionFormatStringOrBuilder
-
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 interfaceSubstitutionFormatStringOrBuilder
-
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;
- Specified by:
getFormatters
in interfaceSubstitutionFormatStringOrBuilder
-
setFormatters
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
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
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
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
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
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
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;
- Specified by:
getFormattersOrBuilder
in interfaceSubstitutionFormatStringOrBuilder
-
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 interfaceSubstitutionFormatStringOrBuilder
-
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
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
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;
-
getFormattersFieldBuilder
private com.google.protobuf.RepeatedFieldBuilder<TypedExtensionConfig,TypedExtensionConfig.Builder, getFormattersFieldBuilder()TypedExtensionConfigOrBuilder> -
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 interfaceSubstitutionFormatStringOrBuilder
- Returns:
- Whether the jsonFormatOptions field is set.
-
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 interfaceSubstitutionFormatStringOrBuilder
- Returns:
- The jsonFormatOptions.
-
setJsonFormatOptions
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
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
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
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
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 interfaceSubstitutionFormatStringOrBuilder
-
getJsonFormatOptionsFieldBuilder
private com.google.protobuf.SingleFieldBuilder<JsonFormatOptions,JsonFormatOptions.Builder, getJsonFormatOptionsFieldBuilder()JsonFormatOptionsOrBuilder> If json_format is used, the options will be applied to the output JSON string.
.envoy.config.core.v3.JsonFormatOptions json_format_options = 7;
-