Package io.envoyproxy.envoy.extensions.filters.http.grpc_json_reverse_transcoder.v3

Interface GrpcJsonReverseTranscoderOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getApiVersionHeader()
    The name of the header field that has the API version of the request.
    com.google.protobuf.ByteString
    getApiVersionHeaderBytes()
    The name of the header field that has the API version of the request.
    com.google.protobuf.ByteString
    getDescriptorBinary()
    Supplies the binary content of :ref:`the proto descriptor set <config_grpc_json_reverse_transcoder_generate_proto_descriptor_set>` for the gRPC services.
    String
    getDescriptorPath()
    Supplies the filename of :ref:`the proto descriptor set <config_grpc_json_reverse_transcoder_generate_proto_descriptor_set>` for the gRPC services.
    com.google.protobuf.ByteString
    getDescriptorPathBytes()
    Supplies the filename of :ref:`the proto descriptor set <config_grpc_json_reverse_transcoder_generate_proto_descriptor_set>` for the gRPC services.
    com.google.protobuf.UInt32Value
    getMaxRequestBodySize()
    The maximum size of a request body to be transcoded, in bytes.
    com.google.protobuf.UInt32ValueOrBuilder
    getMaxRequestBodySizeOrBuilder()
    The maximum size of a request body to be transcoded, in bytes.
    com.google.protobuf.UInt32Value
    getMaxResponseBodySize()
    The maximum size of a response body to be transcoded, in bytes.
    com.google.protobuf.UInt32ValueOrBuilder
    getMaxResponseBodySizeOrBuilder()
    The maximum size of a response body to be transcoded, in bytes.
    GrpcJsonReverseTranscoder.PrintOptions
    getRequestJsonPrintOptions()
    Control options for upstream request JSON.
    GrpcJsonReverseTranscoder.PrintOptionsOrBuilder
    getRequestJsonPrintOptionsOrBuilder()
    Control options for upstream request JSON.
    boolean
    hasMaxRequestBodySize()
    The maximum size of a request body to be transcoded, in bytes.
    boolean
    hasMaxResponseBodySize()
    The maximum size of a response body to be transcoded, in bytes.
    boolean
    hasRequestJsonPrintOptions()
    Control options for upstream request JSON.

    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

    • getDescriptorPath

      String getDescriptorPath()
       Supplies the filename of
 :ref:`the proto descriptor set
 <config_grpc_json_reverse_transcoder_generate_proto_descriptor_set>` for the gRPC services.
 If set, takes precedence over the ``descriptor_binary`` field.
      string descriptor_path = 1;
      Returns:
      The descriptorPath.

    • getDescriptorPathBytes

      com.google.protobuf.ByteString getDescriptorPathBytes()
       Supplies the filename of
 :ref:`the proto descriptor set
 <config_grpc_json_reverse_transcoder_generate_proto_descriptor_set>` for the gRPC services.
 If set, takes precedence over the ``descriptor_binary`` field.
      string descriptor_path = 1;
      Returns:
      The bytes for descriptorPath.

    • getDescriptorBinary

      com.google.protobuf.ByteString getDescriptorBinary()
       Supplies the binary content of
 :ref:`the proto descriptor set
 <config_grpc_json_reverse_transcoder_generate_proto_descriptor_set>` for the gRPC services.
 If ``descriptor_path`` is set, this field is not used.
      bytes descriptor_binary = 2;
      Returns:
      The descriptorBinary.

    • hasMaxRequestBodySize

      boolean hasMaxRequestBodySize()
       The maximum size of a request body to be transcoded, in bytes. A body exceeding this size will
 provoke a ``gRPC status: ResourceExhausted`` response.

 Large values may cause envoy to use a lot of memory if there are many
 concurrent requests.

 If unset, the current stream buffer size is used.
      .google.protobuf.UInt32Value max_request_body_size = 3 [(.validate.rules) = { ... }
      Returns:
      Whether the maxRequestBodySize field is set.

    • getMaxRequestBodySize

      com.google.protobuf.UInt32Value getMaxRequestBodySize()
       The maximum size of a request body to be transcoded, in bytes. A body exceeding this size will
 provoke a ``gRPC status: ResourceExhausted`` response.

 Large values may cause envoy to use a lot of memory if there are many
 concurrent requests.

 If unset, the current stream buffer size is used.
      .google.protobuf.UInt32Value max_request_body_size = 3 [(.validate.rules) = { ... }
      Returns:
      The maxRequestBodySize.

    • getMaxRequestBodySizeOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getMaxRequestBodySizeOrBuilder()
       The maximum size of a request body to be transcoded, in bytes. A body exceeding this size will
 provoke a ``gRPC status: ResourceExhausted`` response.

 Large values may cause envoy to use a lot of memory if there are many
 concurrent requests.

 If unset, the current stream buffer size is used.
      .google.protobuf.UInt32Value max_request_body_size = 3 [(.validate.rules) = { ... }

    • hasMaxResponseBodySize

      boolean hasMaxResponseBodySize()
       The maximum size of a response body to be transcoded, in bytes. A body exceeding this size will
 provoke a ``gRPC status: Internal`` response.

 Large values may cause envoy to use a lot of memory if there are many
 concurrent requests.

 If unset, the current stream buffer size is used.
      .google.protobuf.UInt32Value max_response_body_size = 4 [(.validate.rules) = { ... }
      Returns:
      Whether the maxResponseBodySize field is set.

    • getMaxResponseBodySize

      com.google.protobuf.UInt32Value getMaxResponseBodySize()
       The maximum size of a response body to be transcoded, in bytes. A body exceeding this size will
 provoke a ``gRPC status: Internal`` response.

 Large values may cause envoy to use a lot of memory if there are many
 concurrent requests.

 If unset, the current stream buffer size is used.
      .google.protobuf.UInt32Value max_response_body_size = 4 [(.validate.rules) = { ... }
      Returns:
      The maxResponseBodySize.

    • getMaxResponseBodySizeOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getMaxResponseBodySizeOrBuilder()
       The maximum size of a response body to be transcoded, in bytes. A body exceeding this size will
 provoke a ``gRPC status: Internal`` response.

 Large values may cause envoy to use a lot of memory if there are many
 concurrent requests.

 If unset, the current stream buffer size is used.
      .google.protobuf.UInt32Value max_response_body_size = 4 [(.validate.rules) = { ... }

    • getApiVersionHeader

      String getApiVersionHeader()
       The name of the header field that has the API version of the request.
      string api_version_header = 5;
      Returns:
      The apiVersionHeader.

    • getApiVersionHeaderBytes

      com.google.protobuf.ByteString getApiVersionHeaderBytes()
       The name of the header field that has the API version of the request.
      string api_version_header = 5;
      Returns:
      The bytes for apiVersionHeader.

    • hasRequestJsonPrintOptions

      boolean hasRequestJsonPrintOptions()
       Control options for upstream request JSON. These options are passed directly to
 `JsonPrintOptions <https://developers.google.com/protocol-buffers/docs/reference/cpp/
 google.protobuf.util.json_util#JsonPrintOptions>`_.
      .envoy.extensions.filters.http.grpc_json_reverse_transcoder.v3.GrpcJsonReverseTranscoder.PrintOptions request_json_print_options = 6;
      Returns:
      Whether the requestJsonPrintOptions field is set.

    • getRequestJsonPrintOptions

      GrpcJsonReverseTranscoder.PrintOptions getRequestJsonPrintOptions()
       Control options for upstream request JSON. These options are passed directly to
 `JsonPrintOptions <https://developers.google.com/protocol-buffers/docs/reference/cpp/
 google.protobuf.util.json_util#JsonPrintOptions>`_.
      .envoy.extensions.filters.http.grpc_json_reverse_transcoder.v3.GrpcJsonReverseTranscoder.PrintOptions request_json_print_options = 6;
      Returns:
      The requestJsonPrintOptions.

    • getRequestJsonPrintOptionsOrBuilder

      GrpcJsonReverseTranscoder.PrintOptionsOrBuilder getRequestJsonPrintOptionsOrBuilder()
       Control options for upstream request JSON. These options are passed directly to
 `JsonPrintOptions <https://developers.google.com/protocol-buffers/docs/reference/cpp/
 google.protobuf.util.json_util#JsonPrintOptions>`_.
      .envoy.extensions.filters.http.grpc_json_reverse_transcoder.v3.GrpcJsonReverseTranscoder.PrintOptions request_json_print_options = 6;