Package io.envoyproxy.envoy.extensions.filters.network.thrift_proxy.v3

Interface ThriftProxyOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    AccessLog
    getAccessLog(int index)
    Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by Thrift proxy.
    int
    getAccessLogCount()
    Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by Thrift proxy.
    List<AccessLog>
    getAccessLogList()
    Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by Thrift proxy.
    AccessLogOrBuilder
    getAccessLogOrBuilder(int index)
    Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by Thrift proxy.
    List<? extends AccessLogOrBuilder>
    getAccessLogOrBuilderList()
    Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by Thrift proxy.
    boolean
    getHeaderKeysPreserveCase()
    If set to true, Envoy will preserve the case of Thrift header keys instead of serializing them to lower case as per the default behavior.
    com.google.protobuf.UInt32Value
    getMaxRequestsPerConnection()
    Optional maximum requests for a single downstream connection.
    com.google.protobuf.UInt32ValueOrBuilder
    getMaxRequestsPerConnectionOrBuilder()
    Optional maximum requests for a single downstream connection.
    boolean
    getPayloadPassthrough()
    If set to true, Envoy will try to skip decode data after metadata in the Thrift message.
    ProtocolType
    getProtocol()
    Supplies the type of protocol that the Thrift proxy should use.
    int
    getProtocolValue()
    Supplies the type of protocol that the Thrift proxy should use.
    RouteConfiguration
    getRouteConfig()
    The route table for the connection manager is static and is specified in this property.
    RouteConfigurationOrBuilder
    getRouteConfigOrBuilder()
    The route table for the connection manager is static and is specified in this property.
    String
    getStatPrefix()
    The human readable prefix to use when emitting statistics.
    com.google.protobuf.ByteString
    getStatPrefixBytes()
    The human readable prefix to use when emitting statistics.
    ThriftFilter
    getThriftFilters(int index)
    A list of individual Thrift filters that make up the filter chain for requests made to the Thrift proxy.
    int
    getThriftFiltersCount()
    A list of individual Thrift filters that make up the filter chain for requests made to the Thrift proxy.
    List<ThriftFilter>
    getThriftFiltersList()
    A list of individual Thrift filters that make up the filter chain for requests made to the Thrift proxy.
    ThriftFilterOrBuilder
    getThriftFiltersOrBuilder(int index)
    A list of individual Thrift filters that make up the filter chain for requests made to the Thrift proxy.
    List<? extends ThriftFilterOrBuilder>
    getThriftFiltersOrBuilderList()
    A list of individual Thrift filters that make up the filter chain for requests made to the Thrift proxy.
    TransportType
    getTransport()
    Supplies the type of transport that the Thrift proxy should use.
    int
    getTransportValue()
    Supplies the type of transport that the Thrift proxy should use.
    Trds
    getTrds()
    Use xDS to fetch the route configuration.
    TrdsOrBuilder
    getTrdsOrBuilder()
    Use xDS to fetch the route configuration.
    boolean
    hasMaxRequestsPerConnection()
    Optional maximum requests for a single downstream connection.
    boolean
    hasRouteConfig()
    The route table for the connection manager is static and is specified in this property.
    boolean
    hasTrds()
    Use xDS to fetch the route configuration.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getTransportValue

      int getTransportValue()
       Supplies the type of transport that the Thrift proxy should use. Defaults to
 :ref:`AUTO_TRANSPORT<envoy_v3_api_enum_value_extensions.filters.network.thrift_proxy.v3.TransportType.AUTO_TRANSPORT>`.
      .envoy.extensions.filters.network.thrift_proxy.v3.TransportType transport = 2 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for transport.

    • getTransport

      TransportType getTransport()
       Supplies the type of transport that the Thrift proxy should use. Defaults to
 :ref:`AUTO_TRANSPORT<envoy_v3_api_enum_value_extensions.filters.network.thrift_proxy.v3.TransportType.AUTO_TRANSPORT>`.
      .envoy.extensions.filters.network.thrift_proxy.v3.TransportType transport = 2 [(.validate.rules) = { ... }
      Returns:
      The transport.

    • getProtocolValue

      int getProtocolValue()
       Supplies the type of protocol that the Thrift proxy should use. Defaults to
 :ref:`AUTO_PROTOCOL<envoy_v3_api_enum_value_extensions.filters.network.thrift_proxy.v3.ProtocolType.AUTO_PROTOCOL>`.
      .envoy.extensions.filters.network.thrift_proxy.v3.ProtocolType protocol = 3 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for protocol.

    • getProtocol

      ProtocolType getProtocol()
       Supplies the type of protocol that the Thrift proxy should use. Defaults to
 :ref:`AUTO_PROTOCOL<envoy_v3_api_enum_value_extensions.filters.network.thrift_proxy.v3.ProtocolType.AUTO_PROTOCOL>`.
      .envoy.extensions.filters.network.thrift_proxy.v3.ProtocolType protocol = 3 [(.validate.rules) = { ... }
      Returns:
      The protocol.

    • getStatPrefix

      String getStatPrefix()
       The human readable prefix to use when emitting statistics.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      com.google.protobuf.ByteString getStatPrefixBytes()
       The human readable prefix to use when emitting statistics.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for statPrefix.

    • hasRouteConfig

      boolean hasRouteConfig()
       The route table for the connection manager is static and is specified in this property.
 It is invalid to define both ``route_config`` and ``trds``.
      .envoy.extensions.filters.network.thrift_proxy.v3.RouteConfiguration route_config = 4 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      Whether the routeConfig field is set.

    • getRouteConfig

      RouteConfiguration getRouteConfig()
       The route table for the connection manager is static and is specified in this property.
 It is invalid to define both ``route_config`` and ``trds``.
      .envoy.extensions.filters.network.thrift_proxy.v3.RouteConfiguration route_config = 4 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      The routeConfig.

    • getRouteConfigOrBuilder

      RouteConfigurationOrBuilder getRouteConfigOrBuilder()
       The route table for the connection manager is static and is specified in this property.
 It is invalid to define both ``route_config`` and ``trds``.
      .envoy.extensions.filters.network.thrift_proxy.v3.RouteConfiguration route_config = 4 [(.udpa.annotations.field_migrate) = { ... }

    • hasTrds

      boolean hasTrds()
       Use xDS to fetch the route configuration. It is invalid to define both ``route_config`` and ``trds``.
      .envoy.extensions.filters.network.thrift_proxy.v3.Trds trds = 8 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      Whether the trds field is set.

    • getTrds

      Trds getTrds()
       Use xDS to fetch the route configuration. It is invalid to define both ``route_config`` and ``trds``.
      .envoy.extensions.filters.network.thrift_proxy.v3.Trds trds = 8 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      The trds.

    • getTrdsOrBuilder

      TrdsOrBuilder getTrdsOrBuilder()
       Use xDS to fetch the route configuration. It is invalid to define both ``route_config`` and ``trds``.
      .envoy.extensions.filters.network.thrift_proxy.v3.Trds trds = 8 [(.udpa.annotations.field_migrate) = { ... }

    • getThriftFiltersList

      List<ThriftFilter> getThriftFiltersList()
       A list of individual Thrift filters that make up the filter chain for requests made to the
 Thrift proxy. Order matters as the filters are processed sequentially. For backwards
 compatibility, if no thrift_filters are specified, a default Thrift router filter
 (``envoy.filters.thrift.router``) is used.
 [#extension-category: envoy.thrift_proxy.filters]
      repeated .envoy.extensions.filters.network.thrift_proxy.v3.ThriftFilter thrift_filters = 5;

    • getThriftFilters

      ThriftFilter getThriftFilters(int index)
       A list of individual Thrift filters that make up the filter chain for requests made to the
 Thrift proxy. Order matters as the filters are processed sequentially. For backwards
 compatibility, if no thrift_filters are specified, a default Thrift router filter
 (``envoy.filters.thrift.router``) is used.
 [#extension-category: envoy.thrift_proxy.filters]
      repeated .envoy.extensions.filters.network.thrift_proxy.v3.ThriftFilter thrift_filters = 5;

    • getThriftFiltersCount

      int getThriftFiltersCount()
       A list of individual Thrift filters that make up the filter chain for requests made to the
 Thrift proxy. Order matters as the filters are processed sequentially. For backwards
 compatibility, if no thrift_filters are specified, a default Thrift router filter
 (``envoy.filters.thrift.router``) is used.
 [#extension-category: envoy.thrift_proxy.filters]
      repeated .envoy.extensions.filters.network.thrift_proxy.v3.ThriftFilter thrift_filters = 5;

    • getThriftFiltersOrBuilderList

      List<? extends ThriftFilterOrBuilder> getThriftFiltersOrBuilderList()
       A list of individual Thrift filters that make up the filter chain for requests made to the
 Thrift proxy. Order matters as the filters are processed sequentially. For backwards
 compatibility, if no thrift_filters are specified, a default Thrift router filter
 (``envoy.filters.thrift.router``) is used.
 [#extension-category: envoy.thrift_proxy.filters]
      repeated .envoy.extensions.filters.network.thrift_proxy.v3.ThriftFilter thrift_filters = 5;

    • getThriftFiltersOrBuilder

      ThriftFilterOrBuilder getThriftFiltersOrBuilder(int index)
       A list of individual Thrift filters that make up the filter chain for requests made to the
 Thrift proxy. Order matters as the filters are processed sequentially. For backwards
 compatibility, if no thrift_filters are specified, a default Thrift router filter
 (``envoy.filters.thrift.router``) is used.
 [#extension-category: envoy.thrift_proxy.filters]
      repeated .envoy.extensions.filters.network.thrift_proxy.v3.ThriftFilter thrift_filters = 5;

    • getPayloadPassthrough

      boolean getPayloadPassthrough()
       If set to true, Envoy will try to skip decode data after metadata in the Thrift message.
 This mode will only work if the upstream and downstream protocols are the same and the transports
 are Framed or Header, and the protocol is not Twitter. Otherwise Envoy will
 fallback to decode the data.
      bool payload_passthrough = 6;
      Returns:
      The payloadPassthrough.

    • hasMaxRequestsPerConnection

      boolean hasMaxRequestsPerConnection()
       Optional maximum requests for a single downstream connection. If not specified, there is no limit.
      .google.protobuf.UInt32Value max_requests_per_connection = 7;
      Returns:
      Whether the maxRequestsPerConnection field is set.

    • getMaxRequestsPerConnection

      com.google.protobuf.UInt32Value getMaxRequestsPerConnection()
       Optional maximum requests for a single downstream connection. If not specified, there is no limit.
      .google.protobuf.UInt32Value max_requests_per_connection = 7;
      Returns:
      The maxRequestsPerConnection.

    • getMaxRequestsPerConnectionOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getMaxRequestsPerConnectionOrBuilder()
       Optional maximum requests for a single downstream connection. If not specified, there is no limit.
      .google.protobuf.UInt32Value max_requests_per_connection = 7;

    • getAccessLogList

      List<AccessLog> getAccessLogList()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by Thrift proxy.
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 9;

    • getAccessLog

      AccessLog getAccessLog(int index)
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by Thrift proxy.
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 9;

    • getAccessLogCount

      int getAccessLogCount()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by Thrift proxy.
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 9;

    • getAccessLogOrBuilderList

      List<? extends AccessLogOrBuilder> getAccessLogOrBuilderList()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by Thrift proxy.
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 9;

    • getAccessLogOrBuilder

      AccessLogOrBuilder getAccessLogOrBuilder(int index)
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by Thrift proxy.
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 9;

    • getHeaderKeysPreserveCase

      boolean getHeaderKeysPreserveCase()
       If set to true, Envoy will preserve the case of Thrift header keys instead of serializing them to
 lower case as per the default behavior. Note that NUL, CR and LF characters will also be preserved
 as mandated by the Thrift spec.

 More info: https://github.com/apache/thrift/commit/e165fa3c85d00cb984f4d9635ed60909a1266ce1.
      bool header_keys_preserve_case = 10;
      Returns:
      The headerKeysPreserveCase.