io.envoyproxy.envoy.config.core.v4alpha

Class SubstitutionFormatString

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.core.v4alpha.SubstitutionFormatString

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SubstitutionFormatStringOrBuilder, Serializable

public final class SubstitutionFormatString
extends com.google.protobuf.GeneratedMessageV3
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: 6]
 

Protobuf type envoy.config.core.v4alpha.SubstitutionFormatString

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubstitutionFormatString.Builder Configuration to use multiple :ref:`command operators <config_access_log_command_operators>` to generate a new string in either plain text or JSON format.
static class	SubstitutionFormatString.FormatCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTENT_TYPE_FIELD_NUMBER
static int	JSON_FORMAT_FIELD_NUMBER
static int	OMIT_EMPTY_VALUES_FIELD_NUMBER
static int	TEXT_FORMAT_SOURCE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getContentType() Specify a *content_type* field.
com.google.protobuf.ByteString	getContentTypeBytes() Specify a *content_type* field.
static SubstitutionFormatString	getDefaultInstance()
SubstitutionFormatString	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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
com.google.protobuf.Parser<SubstitutionFormatString>	getParserForType()
int	getSerializedSize()
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.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SubstitutionFormatString.Builder	newBuilder()
static SubstitutionFormatString.Builder	newBuilder(SubstitutionFormatString prototype)
SubstitutionFormatString.Builder	newBuilderForType()
protected SubstitutionFormatString.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SubstitutionFormatString	parseDelimitedFrom(InputStream input)
static SubstitutionFormatString	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SubstitutionFormatString	parseFrom(byte[] data)
static SubstitutionFormatString	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SubstitutionFormatString	parseFrom(ByteBuffer data)
static SubstitutionFormatString	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SubstitutionFormatString	parseFrom(com.google.protobuf.ByteString data)
static SubstitutionFormatString	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SubstitutionFormatString	parseFrom(com.google.protobuf.CodedInputStream input)
static SubstitutionFormatString	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SubstitutionFormatString	parseFrom(InputStream input)
static SubstitutionFormatString	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SubstitutionFormatString>	parser()
SubstitutionFormatString.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

JSON_FORMAT_FIELD_NUMBER

public static final int JSON_FORMAT_FIELD_NUMBER

See Also:

Constant Field Values

TEXT_FORMAT_SOURCE_FIELD_NUMBER

public static final int TEXT_FORMAT_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

OMIT_EMPTY_VALUES_FIELD_NUMBER

public static final int OMIT_EMPTY_VALUES_FIELD_NUMBER

See Also:

Constant Field Values

CONTENT_TYPE_FIELD_NUMBER

public static final int CONTENT_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getFormatCase

public SubstitutionFormatString.FormatCase getFormatCase()

Specified by:

getFormatCase in interface SubstitutionFormatStringOrBuilder

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

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

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

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

Specified by:

hasTextFormatSource in interface SubstitutionFormatStringOrBuilder

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

Specified by:

getTextFormatSource in interface SubstitutionFormatStringOrBuilder

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

Specified by:

getTextFormatSourceOrBuilder in interface SubstitutionFormatStringOrBuilder

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

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;

Specified by:

getContentType in interface SubstitutionFormatStringOrBuilder

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;

Specified by:

getContentTypeBytes in interface SubstitutionFormatStringOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SubstitutionFormatString parseFrom(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SubstitutionFormatString parseFrom(ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SubstitutionFormatString parseFrom(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SubstitutionFormatString parseFrom(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SubstitutionFormatString parseFrom(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SubstitutionFormatString parseFrom(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SubstitutionFormatString parseFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

public static SubstitutionFormatString parseFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static SubstitutionFormatString parseDelimitedFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static SubstitutionFormatString parseDelimitedFrom(InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

parseFrom

public static SubstitutionFormatString parseFrom(com.google.protobuf.CodedInputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

public static SubstitutionFormatString parseFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

newBuilderForType

public SubstitutionFormatString.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SubstitutionFormatString.Builder newBuilder()

newBuilder

public static SubstitutionFormatString.Builder newBuilder(SubstitutionFormatString prototype)

toBuilder

public SubstitutionFormatString.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SubstitutionFormatString.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SubstitutionFormatString getDefaultInstance()

parser

public static com.google.protobuf.Parser<SubstitutionFormatString> parser()

getParserForType

public com.google.protobuf.Parser<SubstitutionFormatString> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SubstitutionFormatString getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder