io.envoyproxy.envoy.config.core.v4alpha

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 Type	Method and Description
String	getContentType() Specify a *content_type* field.
com.google.protobuf.ByteString	getContentTypeBytes() Specify a *content_type* field.
SubstitutionFormatString.FormatCase	getFormatCase()
com.google.protobuf.Struct	getJsonFormat() Specify a format with command operators to form a JSON string.
com.google.protobuf.StructOrBuilder	getJsonFormatOrBuilder() Specify a format with command operators to form a JSON string.
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
DataSource	getTextFormatSource() Specify a format with command operators to form a text string.
DataSourceOrBuilder	getTextFormatSourceOrBuilder() Specify a format with command operators to form a text string.
boolean	hasJsonFormat() Specify a format with command operators to form a JSON string.
boolean	hasTextFormatSource() Specify a format with command operators to form a text string.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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) = { ... }

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) = { ... }

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.v4alpha.DataSource text_format_source = 5;

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.v4alpha.DataSource text_format_source = 5;

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.v4alpha.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;

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;

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;

getFormatCase

SubstitutionFormatString.FormatCase getFormatCase()