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

Class GrpcJsonReverseTranscoder

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.grpc_json_reverse_transcoder.v3.GrpcJsonReverseTranscoder
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GrpcJsonReverseTranscoderOrBuilder, Serializable
public final class GrpcJsonReverseTranscoder extends com.google.protobuf.GeneratedMessageV3 implements GrpcJsonReverseTranscoderOrBuilder
 [#next-free-field: 7]
 ``GrpcJsonReverseTranscoder`` is the filter configuration for the gRPC JSON
 reverse transcoder. The reverse transcoder acts as a bridge between a gRPC
 client and an HTTP/JSON server, converting the gRPC request into HTTP/JSON
 for the HTTP backend and the HTTP/JSON response back to gRPC for the gRPC
 client. This effectively reverses the behavior of the
 :ref:`grpc_json_transcoder filter <config_http_filters_grpc_json_transcoder>`,
 allowing a gRPC client to communicate with an HTTP/JSON server.
Protobuf type envoy.extensions.filters.http.grpc_json_reverse_transcoder.v3.GrpcJsonReverseTranscoder
See Also:

  • Field Details

    • DESCRIPTOR_PATH_FIELD_NUMBER

      public static final int DESCRIPTOR_PATH_FIELD_NUMBER
      See Also:

    • DESCRIPTOR_BINARY_FIELD_NUMBER

      public static final int DESCRIPTOR_BINARY_FIELD_NUMBER
      See Also:

    • MAX_REQUEST_BODY_SIZE_FIELD_NUMBER

      public static final int MAX_REQUEST_BODY_SIZE_FIELD_NUMBER
      See Also:

    • MAX_RESPONSE_BODY_SIZE_FIELD_NUMBER

      public static final int MAX_RESPONSE_BODY_SIZE_FIELD_NUMBER
      See Also:

    • API_VERSION_HEADER_FIELD_NUMBER

      public static final int API_VERSION_HEADER_FIELD_NUMBER
      See Also:

    • REQUEST_JSON_PRINT_OPTIONS_FIELD_NUMBER

      public static final int REQUEST_JSON_PRINT_OPTIONS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getDescriptorPath

      public 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;
      Specified by:
      getDescriptorPath in interface GrpcJsonReverseTranscoderOrBuilder
      Returns:
      The descriptorPath.

    • getDescriptorPathBytes

      public 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;
      Specified by:
      getDescriptorPathBytes in interface GrpcJsonReverseTranscoderOrBuilder
      Returns:
      The bytes for descriptorPath.

    • getDescriptorBinary

      public 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;
      Specified by:
      getDescriptorBinary in interface GrpcJsonReverseTranscoderOrBuilder
      Returns:
      The descriptorBinary.

    • hasMaxRequestBodySize

      public 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) = { ... }
      Specified by:
      hasMaxRequestBodySize in interface GrpcJsonReverseTranscoderOrBuilder
      Returns:
      Whether the maxRequestBodySize field is set.

    • getMaxRequestBodySize

      public 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) = { ... }
      Specified by:
      getMaxRequestBodySize in interface GrpcJsonReverseTranscoderOrBuilder
      Returns:
      The maxRequestBodySize.

    • getMaxRequestBodySizeOrBuilder

      public 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) = { ... }
      Specified by:
      getMaxRequestBodySizeOrBuilder in interface GrpcJsonReverseTranscoderOrBuilder

    • hasMaxResponseBodySize

      public 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) = { ... }
      Specified by:
      hasMaxResponseBodySize in interface GrpcJsonReverseTranscoderOrBuilder
      Returns:
      Whether the maxResponseBodySize field is set.

    • getMaxResponseBodySize

      public 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) = { ... }
      Specified by:
      getMaxResponseBodySize in interface GrpcJsonReverseTranscoderOrBuilder
      Returns:
      The maxResponseBodySize.

    • getMaxResponseBodySizeOrBuilder

      public 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) = { ... }
      Specified by:
      getMaxResponseBodySizeOrBuilder in interface GrpcJsonReverseTranscoderOrBuilder

    • getApiVersionHeader

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

    • getApiVersionHeaderBytes

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

    • hasRequestJsonPrintOptions

      public 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;
      Specified by:
      hasRequestJsonPrintOptions in interface GrpcJsonReverseTranscoderOrBuilder
      Returns:
      Whether the requestJsonPrintOptions field is set.

    • getRequestJsonPrintOptions

      public 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;
      Specified by:
      getRequestJsonPrintOptions in interface GrpcJsonReverseTranscoderOrBuilder
      Returns:
      The requestJsonPrintOptions.

    • getRequestJsonPrintOptionsOrBuilder

      public 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;
      Specified by:
      getRequestJsonPrintOptionsOrBuilder in interface GrpcJsonReverseTranscoderOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static GrpcJsonReverseTranscoder parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrpcJsonReverseTranscoder parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrpcJsonReverseTranscoder parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrpcJsonReverseTranscoder parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrpcJsonReverseTranscoder parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrpcJsonReverseTranscoder parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GrpcJsonReverseTranscoder parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GrpcJsonReverseTranscoder parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GrpcJsonReverseTranscoder parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GrpcJsonReverseTranscoder parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GrpcJsonReverseTranscoder parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GrpcJsonReverseTranscoder parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public GrpcJsonReverseTranscoder.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static GrpcJsonReverseTranscoder.Builder newBuilder()

    • newBuilder

      public static GrpcJsonReverseTranscoder.Builder newBuilder(GrpcJsonReverseTranscoder prototype)

    • toBuilder

      public GrpcJsonReverseTranscoder.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected GrpcJsonReverseTranscoder.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static GrpcJsonReverseTranscoder getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<GrpcJsonReverseTranscoder> parser()

    • getParserForType

      public com.google.protobuf.Parser<GrpcJsonReverseTranscoder> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public GrpcJsonReverseTranscoder getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder