.. _envoy_api_file_envoy/data/tap/v2alpha/common.proto:

Tap common data
===============


.. _envoy_api_msg_data.tap.v2alpha.Body:

data.tap.v2alpha.Body
---------------------

`[data.tap.v2alpha.Body proto] <https://github.com/envoyproxy/envoy/blob/v1.17.4/api/envoy/data/tap/v2alpha/common.proto#L15>`_

Wrapper for tapped body data. This includes HTTP request/response body, transport socket received
and transmitted data, etc.

.. code-block:: json

  {
    "as_bytes": "...",
    "as_string": "...",
    "truncated": "..."
  }

.. _envoy_api_field_data.tap.v2alpha.Body.as_bytes:

as_bytes
  (`bytes <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Body data as bytes. By default, tap body data will be present in this field, as the proto
  `bytes` type can contain any valid byte.
  
  
  
  Only one of :ref:`as_bytes <envoy_api_field_data.tap.v2alpha.Body.as_bytes>`, :ref:`as_string <envoy_api_field_data.tap.v2alpha.Body.as_string>` may be set.
  
.. _envoy_api_field_data.tap.v2alpha.Body.as_string:

as_string
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Body data as string. This field is only used when the :ref:`JSON_BODY_AS_STRING
  <envoy_api_enum_value_service.tap.v2alpha.OutputSink.Format.JSON_BODY_AS_STRING>` sink
  format type is selected. See the documentation for that option for why this is useful.
  
  
  
  Only one of :ref:`as_bytes <envoy_api_field_data.tap.v2alpha.Body.as_bytes>`, :ref:`as_string <envoy_api_field_data.tap.v2alpha.Body.as_string>` may be set.
  
.. _envoy_api_field_data.tap.v2alpha.Body.truncated:

truncated
  (`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies whether body data has been truncated to fit within the specified
  :ref:`max_buffered_rx_bytes
  <envoy_api_field_service.tap.v2alpha.OutputConfig.max_buffered_rx_bytes>` and
  :ref:`max_buffered_tx_bytes
  <envoy_api_field_service.tap.v2alpha.OutputConfig.max_buffered_tx_bytes>` settings.