Package io.envoyproxy.envoy.config.tap.v3

Enum OutputSink.Format

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<OutputSink.Format>
    Enclosing class:
    OutputSink
    public static enum OutputSink.Format
extends Enum<OutputSink.Format>
implements com.google.protobuf.ProtocolMessageEnum
     Output format. All output is in the form of one or more :ref:`TraceWrapper
 <envoy_v3_api_msg_data.tap.v3.TraceWrapper>` messages. This enumeration indicates
 how those messages are written. Note that not all sinks support all output formats. See
 individual sink documentation for more information.
    Protobuf enum envoy.config.tap.v3.OutputSink.Format

    • Enum Constant Detail

      • JSON_BODY_AS_BYTES

        public static final OutputSink.Format JSON_BODY_AS_BYTES
         Each message will be written as JSON. Any :ref:`body <envoy_v3_api_msg_data.tap.v3.Body>`
 data will be present in the :ref:`as_bytes
 <envoy_v3_api_field_data.tap.v3.Body.as_bytes>` field. This means that body data will be
 base64 encoded as per the `proto3 JSON mappings
 <https://developers.google.com/protocol-buffers/docs/proto3#json>`_.
        JSON_BODY_AS_BYTES = 0;

      • JSON_BODY_AS_STRING

        public static final OutputSink.Format JSON_BODY_AS_STRING
         Each message will be written as JSON. Any :ref:`body <envoy_v3_api_msg_data.tap.v3.Body>`
 data will be present in the :ref:`as_string
 <envoy_v3_api_field_data.tap.v3.Body.as_string>` field. This means that body data will be
 string encoded as per the `proto3 JSON mappings
 <https://developers.google.com/protocol-buffers/docs/proto3#json>`_. This format type is
 useful when it is known that that body is human readable (e.g., JSON over HTTP) and the
 user wishes to view it directly without being forced to base64 decode the body.
        JSON_BODY_AS_STRING = 1;

      • PROTO_BINARY

        public static final OutputSink.Format PROTO_BINARY
         Binary proto format. Note that binary proto is not self-delimiting. If a sink writes
 multiple binary messages without any length information the data stream will not be
 useful. However, for certain sinks that are self-delimiting (e.g., one message per file)
 this output format makes consumption simpler.
        PROTO_BINARY = 2;

      • PROTO_BINARY_LENGTH_DELIMITED

        public static final OutputSink.Format PROTO_BINARY_LENGTH_DELIMITED
         Messages are written as a sequence tuples, where each tuple is the message length encoded
 as a `protobuf 32-bit varint
 <https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.io.coded_stream>`_
 followed by the binary message. The messages can be read back using the language specific
 protobuf coded stream implementation to obtain the message length and the message.
        PROTO_BINARY_LENGTH_DELIMITED = 3;

      • PROTO_TEXT

        public static final OutputSink.Format PROTO_TEXT
         Text proto format.
        PROTO_TEXT = 4;

    • Field Detail

      • JSON_BODY_AS_BYTES_VALUE

        public static final int JSON_BODY_AS_BYTES_VALUE
         Each message will be written as JSON. Any :ref:`body <envoy_v3_api_msg_data.tap.v3.Body>`
 data will be present in the :ref:`as_bytes
 <envoy_v3_api_field_data.tap.v3.Body.as_bytes>` field. This means that body data will be
 base64 encoded as per the `proto3 JSON mappings
 <https://developers.google.com/protocol-buffers/docs/proto3#json>`_.
        JSON_BODY_AS_BYTES = 0;
        See Also:
        Constant Field Values

      • JSON_BODY_AS_STRING_VALUE

        public static final int JSON_BODY_AS_STRING_VALUE
         Each message will be written as JSON. Any :ref:`body <envoy_v3_api_msg_data.tap.v3.Body>`
 data will be present in the :ref:`as_string
 <envoy_v3_api_field_data.tap.v3.Body.as_string>` field. This means that body data will be
 string encoded as per the `proto3 JSON mappings
 <https://developers.google.com/protocol-buffers/docs/proto3#json>`_. This format type is
 useful when it is known that that body is human readable (e.g., JSON over HTTP) and the
 user wishes to view it directly without being forced to base64 decode the body.
        JSON_BODY_AS_STRING = 1;
        See Also:
        Constant Field Values

      • PROTO_BINARY_VALUE

        public static final int PROTO_BINARY_VALUE
         Binary proto format. Note that binary proto is not self-delimiting. If a sink writes
 multiple binary messages without any length information the data stream will not be
 useful. However, for certain sinks that are self-delimiting (e.g., one message per file)
 this output format makes consumption simpler.
        PROTO_BINARY = 2;
        See Also:
        Constant Field Values

      • PROTO_BINARY_LENGTH_DELIMITED_VALUE

        public static final int PROTO_BINARY_LENGTH_DELIMITED_VALUE
         Messages are written as a sequence tuples, where each tuple is the message length encoded
 as a `protobuf 32-bit varint
 <https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.io.coded_stream>`_
 followed by the binary message. The messages can be read back using the language specific
 protobuf coded stream implementation to obtain the message length and the message.
        PROTO_BINARY_LENGTH_DELIMITED = 3;
        See Also:
        Constant Field Values

      • PROTO_TEXT_VALUE

        public static final int PROTO_TEXT_VALUE
         Text proto format.
        PROTO_TEXT = 4;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static OutputSink.Format[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (OutputSink.Format c : OutputSink.Format.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static OutputSink.Format valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum

      • valueOf

        @Deprecated
public static OutputSink.Format valueOf​(int value)
        Deprecated.
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • forNumber

        public static OutputSink.Format forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • internalGetValueMap

        public static com.google.protobuf.Internal.EnumLiteMap<OutputSink.Format> internalGetValueMap()

      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptor

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

      • valueOf

        public static OutputSink.Format valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null