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

Interface TapConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TapConfig, TapConfig.Builder
public interface TapConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasMatchConfig

      @Deprecated boolean hasMatchConfig()
      Deprecated.
      envoy.config.tap.v3.TapConfig.match_config is deprecated. See envoy/config/tap/v3/common.proto;l=38
       The match configuration. If the configuration matches the data source being tapped, a tap will
 occur, with the result written to the configured output.
 Exactly one of :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` and
 :ref:`match_config <envoy_v3_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
 are set, the :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` will be used.
      .envoy.config.tap.v3.MatchPredicate match_config = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      Whether the matchConfig field is set.

    • getMatchConfig

      @Deprecated MatchPredicate getMatchConfig()
      Deprecated.
      envoy.config.tap.v3.TapConfig.match_config is deprecated. See envoy/config/tap/v3/common.proto;l=38
       The match configuration. If the configuration matches the data source being tapped, a tap will
 occur, with the result written to the configured output.
 Exactly one of :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` and
 :ref:`match_config <envoy_v3_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
 are set, the :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` will be used.
      .envoy.config.tap.v3.MatchPredicate match_config = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The matchConfig.

    • getMatchConfigOrBuilder

      @Deprecated MatchPredicateOrBuilder getMatchConfigOrBuilder()
      Deprecated.
       The match configuration. If the configuration matches the data source being tapped, a tap will
 occur, with the result written to the configured output.
 Exactly one of :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` and
 :ref:`match_config <envoy_v3_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
 are set, the :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` will be used.
      .envoy.config.tap.v3.MatchPredicate match_config = 1 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

    • hasMatch

      boolean hasMatch()
       The match configuration. If the configuration matches the data source being tapped, a tap will
 occur, with the result written to the configured output.
 Exactly one of :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` and
 :ref:`match_config <envoy_v3_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
 are set, the :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` will be used.
      .envoy.config.common.matcher.v3.MatchPredicate match = 4;
      Returns:
      Whether the match field is set.

    • getMatch

      MatchPredicate getMatch()
       The match configuration. If the configuration matches the data source being tapped, a tap will
 occur, with the result written to the configured output.
 Exactly one of :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` and
 :ref:`match_config <envoy_v3_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
 are set, the :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` will be used.
      .envoy.config.common.matcher.v3.MatchPredicate match = 4;
      Returns:
      The match.

    • getMatchOrBuilder

      MatchPredicateOrBuilder getMatchOrBuilder()
       The match configuration. If the configuration matches the data source being tapped, a tap will
 occur, with the result written to the configured output.
 Exactly one of :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` and
 :ref:`match_config <envoy_v3_api_field_config.tap.v3.TapConfig.match_config>` must be set. If both
 are set, the :ref:`match <envoy_v3_api_field_config.tap.v3.TapConfig.match>` will be used.
      .envoy.config.common.matcher.v3.MatchPredicate match = 4;

    • hasOutputConfig

      boolean hasOutputConfig()
       The tap output configuration. If a match configuration matches a data source being tapped,
 a tap will occur and the data will be written to the configured output.
      .envoy.config.tap.v3.OutputConfig output_config = 2 [(.validate.rules) = { ... }
      Returns:
      Whether the outputConfig field is set.

    • getOutputConfig

      OutputConfig getOutputConfig()
       The tap output configuration. If a match configuration matches a data source being tapped,
 a tap will occur and the data will be written to the configured output.
      .envoy.config.tap.v3.OutputConfig output_config = 2 [(.validate.rules) = { ... }
      Returns:
      The outputConfig.

    • getOutputConfigOrBuilder

      OutputConfigOrBuilder getOutputConfigOrBuilder()
       The tap output configuration. If a match configuration matches a data source being tapped,
 a tap will occur and the data will be written to the configured output.
      .envoy.config.tap.v3.OutputConfig output_config = 2 [(.validate.rules) = { ... }

    • hasTapEnabled

      boolean hasTapEnabled()
       [#not-implemented-hide:] Specify if Tap matching is enabled. The % of requests\connections for
 which the tap matching is enabled. When not enabled, the request\connection will not be
 recorded.

 .. note::

   This field defaults to 100/:ref:`HUNDRED
   <envoy_v3_api_enum_type.v3.FractionalPercent.DenominatorType>`.
      .envoy.config.core.v3.RuntimeFractionalPercent tap_enabled = 3;
      Returns:
      Whether the tapEnabled field is set.

    • getTapEnabled

      RuntimeFractionalPercent getTapEnabled()
       [#not-implemented-hide:] Specify if Tap matching is enabled. The % of requests\connections for
 which the tap matching is enabled. When not enabled, the request\connection will not be
 recorded.

 .. note::

   This field defaults to 100/:ref:`HUNDRED
   <envoy_v3_api_enum_type.v3.FractionalPercent.DenominatorType>`.
      .envoy.config.core.v3.RuntimeFractionalPercent tap_enabled = 3;
      Returns:
      The tapEnabled.

    • getTapEnabledOrBuilder

      RuntimeFractionalPercentOrBuilder getTapEnabledOrBuilder()
       [#not-implemented-hide:] Specify if Tap matching is enabled. The % of requests\connections for
 which the tap matching is enabled. When not enabled, the request\connection will not be
 recorded.

 .. note::

   This field defaults to 100/:ref:`HUNDRED
   <envoy_v3_api_enum_type.v3.FractionalPercent.DenominatorType>`.
      .envoy.config.core.v3.RuntimeFractionalPercent tap_enabled = 3;