Package io.envoyproxy.envoy.config.filter.http.transcoder.v2

Class GrpcJsonTranscoder.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>
io.envoyproxy.envoy.config.filter.http.transcoder.v2.GrpcJsonTranscoder.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GrpcJsonTranscoderOrBuilder, Cloneable
Enclosing class:
GrpcJsonTranscoder
public static final class GrpcJsonTranscoder.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder> implements GrpcJsonTranscoderOrBuilder
 [#next-free-field: 10]
Protobuf type envoy.config.filter.http.transcoder.v2.GrpcJsonTranscoder

  • Method Details

    • 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.Builder<GrpcJsonTranscoder.Builder>

    • clear

      public GrpcJsonTranscoder.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>

    • getDefaultInstanceForType

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

    • build

      public GrpcJsonTranscoder build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public GrpcJsonTranscoder buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public GrpcJsonTranscoder.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>

    • setField

      public GrpcJsonTranscoder.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>

    • clearField

      public GrpcJsonTranscoder.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>

    • clearOneof

      public GrpcJsonTranscoder.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>

    • setRepeatedField

      public GrpcJsonTranscoder.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>

    • addRepeatedField

      public GrpcJsonTranscoder.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>

    • mergeFrom

      public GrpcJsonTranscoder.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GrpcJsonTranscoder.Builder>

    • mergeFrom

      public GrpcJsonTranscoder.Builder mergeFrom(GrpcJsonTranscoder other)

    • isInitialized

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

    • mergeFrom

      public GrpcJsonTranscoder.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GrpcJsonTranscoder.Builder>
      Throws:
      IOException

    • getDescriptorSetCase

      public GrpcJsonTranscoder.DescriptorSetCase getDescriptorSetCase()
      Specified by:
      getDescriptorSetCase in interface GrpcJsonTranscoderOrBuilder

    • clearDescriptorSet

      public GrpcJsonTranscoder.Builder clearDescriptorSet()

    • hasProtoDescriptor

      public boolean hasProtoDescriptor()
       Supplies the filename of
 :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
 services.
      string proto_descriptor = 1;
      Specified by:
      hasProtoDescriptor in interface GrpcJsonTranscoderOrBuilder
      Returns:
      Whether the protoDescriptor field is set.

    • getProtoDescriptor

      public String getProtoDescriptor()
       Supplies the filename of
 :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
 services.
      string proto_descriptor = 1;
      Specified by:
      getProtoDescriptor in interface GrpcJsonTranscoderOrBuilder
      Returns:
      The protoDescriptor.

    • getProtoDescriptorBytes

      public com.google.protobuf.ByteString getProtoDescriptorBytes()
       Supplies the filename of
 :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
 services.
      string proto_descriptor = 1;
      Specified by:
      getProtoDescriptorBytes in interface GrpcJsonTranscoderOrBuilder
      Returns:
      The bytes for protoDescriptor.

    • setProtoDescriptor

      public GrpcJsonTranscoder.Builder setProtoDescriptor(String value)
       Supplies the filename of
 :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
 services.
      string proto_descriptor = 1;
      Parameters:
      value - The protoDescriptor to set.
      Returns:
      This builder for chaining.

    • clearProtoDescriptor

      public GrpcJsonTranscoder.Builder clearProtoDescriptor()
       Supplies the filename of
 :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
 services.
      string proto_descriptor = 1;
      Returns:
      This builder for chaining.

    • setProtoDescriptorBytes

      public GrpcJsonTranscoder.Builder setProtoDescriptorBytes(com.google.protobuf.ByteString value)
       Supplies the filename of
 :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
 services.
      string proto_descriptor = 1;
      Parameters:
      value - The bytes for protoDescriptor to set.
      Returns:
      This builder for chaining.

    • hasProtoDescriptorBin

      public boolean hasProtoDescriptorBin()
       Supplies the binary content of
 :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
 services.
      bytes proto_descriptor_bin = 4;
      Specified by:
      hasProtoDescriptorBin in interface GrpcJsonTranscoderOrBuilder
      Returns:
      Whether the protoDescriptorBin field is set.

    • getProtoDescriptorBin

      public com.google.protobuf.ByteString getProtoDescriptorBin()
       Supplies the binary content of
 :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
 services.
      bytes proto_descriptor_bin = 4;
      Specified by:
      getProtoDescriptorBin in interface GrpcJsonTranscoderOrBuilder
      Returns:
      The protoDescriptorBin.

    • setProtoDescriptorBin

      public GrpcJsonTranscoder.Builder setProtoDescriptorBin(com.google.protobuf.ByteString value)
       Supplies the binary content of
 :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
 services.
      bytes proto_descriptor_bin = 4;
      Parameters:
      value - The protoDescriptorBin to set.
      Returns:
      This builder for chaining.

    • clearProtoDescriptorBin

      public GrpcJsonTranscoder.Builder clearProtoDescriptorBin()
       Supplies the binary content of
 :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
 services.
      bytes proto_descriptor_bin = 4;
      Returns:
      This builder for chaining.

    • getServicesList

      public com.google.protobuf.ProtocolStringList getServicesList()
       A list of strings that
 supplies the fully qualified service names (i.e. "package_name.service_name") that
 the transcoder will translate. If the service name doesn't exist in ``proto_descriptor``,
 Envoy will fail at startup. The ``proto_descriptor`` may contain more services than
 the service names specified here, but they won't be translated.
      repeated string services = 2 [(.validate.rules) = { ... }
      Specified by:
      getServicesList in interface GrpcJsonTranscoderOrBuilder
      Returns:
      A list containing the services.

    • getServicesCount

      public int getServicesCount()
       A list of strings that
 supplies the fully qualified service names (i.e. "package_name.service_name") that
 the transcoder will translate. If the service name doesn't exist in ``proto_descriptor``,
 Envoy will fail at startup. The ``proto_descriptor`` may contain more services than
 the service names specified here, but they won't be translated.
      repeated string services = 2 [(.validate.rules) = { ... }
      Specified by:
      getServicesCount in interface GrpcJsonTranscoderOrBuilder
      Returns:
      The count of services.

    • getServices

      public String getServices(int index)
       A list of strings that
 supplies the fully qualified service names (i.e. "package_name.service_name") that
 the transcoder will translate. If the service name doesn't exist in ``proto_descriptor``,
 Envoy will fail at startup. The ``proto_descriptor`` may contain more services than
 the service names specified here, but they won't be translated.
      repeated string services = 2 [(.validate.rules) = { ... }
      Specified by:
      getServices in interface GrpcJsonTranscoderOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The services at the given index.

    • getServicesBytes

      public com.google.protobuf.ByteString getServicesBytes(int index)
       A list of strings that
 supplies the fully qualified service names (i.e. "package_name.service_name") that
 the transcoder will translate. If the service name doesn't exist in ``proto_descriptor``,
 Envoy will fail at startup. The ``proto_descriptor`` may contain more services than
 the service names specified here, but they won't be translated.
      repeated string services = 2 [(.validate.rules) = { ... }
      Specified by:
      getServicesBytes in interface GrpcJsonTranscoderOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the services at the given index.

    • setServices

      public GrpcJsonTranscoder.Builder setServices(int index, String value)
       A list of strings that
 supplies the fully qualified service names (i.e. "package_name.service_name") that
 the transcoder will translate. If the service name doesn't exist in ``proto_descriptor``,
 Envoy will fail at startup. The ``proto_descriptor`` may contain more services than
 the service names specified here, but they won't be translated.
      repeated string services = 2 [(.validate.rules) = { ... }
      Parameters:
      index - The index to set the value at.
      value - The services to set.
      Returns:
      This builder for chaining.

    • addServices

      public GrpcJsonTranscoder.Builder addServices(String value)
       A list of strings that
 supplies the fully qualified service names (i.e. "package_name.service_name") that
 the transcoder will translate. If the service name doesn't exist in ``proto_descriptor``,
 Envoy will fail at startup. The ``proto_descriptor`` may contain more services than
 the service names specified here, but they won't be translated.
      repeated string services = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The services to add.
      Returns:
      This builder for chaining.

    • addAllServices

      public GrpcJsonTranscoder.Builder addAllServices(Iterable<String> values)
       A list of strings that
 supplies the fully qualified service names (i.e. "package_name.service_name") that
 the transcoder will translate. If the service name doesn't exist in ``proto_descriptor``,
 Envoy will fail at startup. The ``proto_descriptor`` may contain more services than
 the service names specified here, but they won't be translated.
      repeated string services = 2 [(.validate.rules) = { ... }
      Parameters:
      values - The services to add.
      Returns:
      This builder for chaining.

    • clearServices

      public GrpcJsonTranscoder.Builder clearServices()
       A list of strings that
 supplies the fully qualified service names (i.e. "package_name.service_name") that
 the transcoder will translate. If the service name doesn't exist in ``proto_descriptor``,
 Envoy will fail at startup. The ``proto_descriptor`` may contain more services than
 the service names specified here, but they won't be translated.
      repeated string services = 2 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • addServicesBytes

      public GrpcJsonTranscoder.Builder addServicesBytes(com.google.protobuf.ByteString value)
       A list of strings that
 supplies the fully qualified service names (i.e. "package_name.service_name") that
 the transcoder will translate. If the service name doesn't exist in ``proto_descriptor``,
 Envoy will fail at startup. The ``proto_descriptor`` may contain more services than
 the service names specified here, but they won't be translated.
      repeated string services = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes of the services to add.
      Returns:
      This builder for chaining.

    • hasPrintOptions

      public boolean hasPrintOptions()
       Control options for response JSON. These options are passed directly to
 `JsonPrintOptions <https://developers.google.com/protocol-buffers/docs/reference/cpp/
 google.protobuf.util.json_util#JsonPrintOptions>`_.
      .envoy.config.filter.http.transcoder.v2.GrpcJsonTranscoder.PrintOptions print_options = 3;
      Specified by:
      hasPrintOptions in interface GrpcJsonTranscoderOrBuilder
      Returns:
      Whether the printOptions field is set.

    • getPrintOptions

      public GrpcJsonTranscoder.PrintOptions getPrintOptions()
       Control options for response JSON. These options are passed directly to
 `JsonPrintOptions <https://developers.google.com/protocol-buffers/docs/reference/cpp/
 google.protobuf.util.json_util#JsonPrintOptions>`_.
      .envoy.config.filter.http.transcoder.v2.GrpcJsonTranscoder.PrintOptions print_options = 3;
      Specified by:
      getPrintOptions in interface GrpcJsonTranscoderOrBuilder
      Returns:
      The printOptions.

    • setPrintOptions

      public GrpcJsonTranscoder.Builder setPrintOptions(GrpcJsonTranscoder.PrintOptions value)
       Control options for response JSON. These options are passed directly to
 `JsonPrintOptions <https://developers.google.com/protocol-buffers/docs/reference/cpp/
 google.protobuf.util.json_util#JsonPrintOptions>`_.
      .envoy.config.filter.http.transcoder.v2.GrpcJsonTranscoder.PrintOptions print_options = 3;

    • setPrintOptions

      public GrpcJsonTranscoder.Builder setPrintOptions(GrpcJsonTranscoder.PrintOptions.Builder builderForValue)
       Control options for response JSON. These options are passed directly to
 `JsonPrintOptions <https://developers.google.com/protocol-buffers/docs/reference/cpp/
 google.protobuf.util.json_util#JsonPrintOptions>`_.
      .envoy.config.filter.http.transcoder.v2.GrpcJsonTranscoder.PrintOptions print_options = 3;

    • mergePrintOptions

      public GrpcJsonTranscoder.Builder mergePrintOptions(GrpcJsonTranscoder.PrintOptions value)
       Control options for response JSON. These options are passed directly to
 `JsonPrintOptions <https://developers.google.com/protocol-buffers/docs/reference/cpp/
 google.protobuf.util.json_util#JsonPrintOptions>`_.
      .envoy.config.filter.http.transcoder.v2.GrpcJsonTranscoder.PrintOptions print_options = 3;

    • clearPrintOptions

      public GrpcJsonTranscoder.Builder clearPrintOptions()
       Control options for response JSON. These options are passed directly to
 `JsonPrintOptions <https://developers.google.com/protocol-buffers/docs/reference/cpp/
 google.protobuf.util.json_util#JsonPrintOptions>`_.
      .envoy.config.filter.http.transcoder.v2.GrpcJsonTranscoder.PrintOptions print_options = 3;

    • getPrintOptionsBuilder

      public GrpcJsonTranscoder.PrintOptions.Builder getPrintOptionsBuilder()
       Control options for response JSON. These options are passed directly to
 `JsonPrintOptions <https://developers.google.com/protocol-buffers/docs/reference/cpp/
 google.protobuf.util.json_util#JsonPrintOptions>`_.
      .envoy.config.filter.http.transcoder.v2.GrpcJsonTranscoder.PrintOptions print_options = 3;

    • getPrintOptionsOrBuilder

      public GrpcJsonTranscoder.PrintOptionsOrBuilder getPrintOptionsOrBuilder()
       Control options for response JSON. These options are passed directly to
 `JsonPrintOptions <https://developers.google.com/protocol-buffers/docs/reference/cpp/
 google.protobuf.util.json_util#JsonPrintOptions>`_.
      .envoy.config.filter.http.transcoder.v2.GrpcJsonTranscoder.PrintOptions print_options = 3;
      Specified by:
      getPrintOptionsOrBuilder in interface GrpcJsonTranscoderOrBuilder

    • getMatchIncomingRequestRoute

      public boolean getMatchIncomingRequestRoute()
       Whether to keep the incoming request route after the outgoing headers have been transformed to
 the match the upstream gRPC service. Note: This means that routes for gRPC services that are
 not transcoded cannot be used in combination with *match_incoming_request_route*.
      bool match_incoming_request_route = 5;
      Specified by:
      getMatchIncomingRequestRoute in interface GrpcJsonTranscoderOrBuilder
      Returns:
      The matchIncomingRequestRoute.

    • setMatchIncomingRequestRoute

      public GrpcJsonTranscoder.Builder setMatchIncomingRequestRoute(boolean value)
       Whether to keep the incoming request route after the outgoing headers have been transformed to
 the match the upstream gRPC service. Note: This means that routes for gRPC services that are
 not transcoded cannot be used in combination with *match_incoming_request_route*.
      bool match_incoming_request_route = 5;
      Parameters:
      value - The matchIncomingRequestRoute to set.
      Returns:
      This builder for chaining.

    • clearMatchIncomingRequestRoute

      public GrpcJsonTranscoder.Builder clearMatchIncomingRequestRoute()
       Whether to keep the incoming request route after the outgoing headers have been transformed to
 the match the upstream gRPC service. Note: This means that routes for gRPC services that are
 not transcoded cannot be used in combination with *match_incoming_request_route*.
      bool match_incoming_request_route = 5;
      Returns:
      This builder for chaining.

    • getIgnoredQueryParametersList

      public com.google.protobuf.ProtocolStringList getIgnoredQueryParametersList()
       A list of query parameters to be ignored for transcoding method mapping.
 By default, the transcoder filter will not transcode a request if there are any
 unknown/invalid query parameters.

 Example :

 .. code-block:: proto

     service Bookstore {
       rpc GetShelf(GetShelfRequest) returns (Shelf) {
         option (google.api.http) = {
           get: "/shelves/{shelf}"
         };
       }
     }

     message GetShelfRequest {
       int64 shelf = 1;
     }

     message Shelf {}

 The request ``/shelves/100?foo=bar`` will not be mapped to ``GetShelf``` because variable
 binding for ``foo`` is not defined. Adding ``foo`` to ``ignored_query_parameters`` will allow
 the same request to be mapped to ``GetShelf``.
      repeated string ignored_query_parameters = 6;
      Specified by:
      getIgnoredQueryParametersList in interface GrpcJsonTranscoderOrBuilder
      Returns:
      A list containing the ignoredQueryParameters.

    • getIgnoredQueryParametersCount

      public int getIgnoredQueryParametersCount()
       A list of query parameters to be ignored for transcoding method mapping.
 By default, the transcoder filter will not transcode a request if there are any
 unknown/invalid query parameters.

 Example :

 .. code-block:: proto

     service Bookstore {
       rpc GetShelf(GetShelfRequest) returns (Shelf) {
         option (google.api.http) = {
           get: "/shelves/{shelf}"
         };
       }
     }

     message GetShelfRequest {
       int64 shelf = 1;
     }

     message Shelf {}

 The request ``/shelves/100?foo=bar`` will not be mapped to ``GetShelf``` because variable
 binding for ``foo`` is not defined. Adding ``foo`` to ``ignored_query_parameters`` will allow
 the same request to be mapped to ``GetShelf``.
      repeated string ignored_query_parameters = 6;
      Specified by:
      getIgnoredQueryParametersCount in interface GrpcJsonTranscoderOrBuilder
      Returns:
      The count of ignoredQueryParameters.

    • getIgnoredQueryParameters

      public String getIgnoredQueryParameters(int index)
       A list of query parameters to be ignored for transcoding method mapping.
 By default, the transcoder filter will not transcode a request if there are any
 unknown/invalid query parameters.

 Example :

 .. code-block:: proto

     service Bookstore {
       rpc GetShelf(GetShelfRequest) returns (Shelf) {
         option (google.api.http) = {
           get: "/shelves/{shelf}"
         };
       }
     }

     message GetShelfRequest {
       int64 shelf = 1;
     }

     message Shelf {}

 The request ``/shelves/100?foo=bar`` will not be mapped to ``GetShelf``` because variable
 binding for ``foo`` is not defined. Adding ``foo`` to ``ignored_query_parameters`` will allow
 the same request to be mapped to ``GetShelf``.
      repeated string ignored_query_parameters = 6;
      Specified by:
      getIgnoredQueryParameters in interface GrpcJsonTranscoderOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The ignoredQueryParameters at the given index.

    • getIgnoredQueryParametersBytes

      public com.google.protobuf.ByteString getIgnoredQueryParametersBytes(int index)
       A list of query parameters to be ignored for transcoding method mapping.
 By default, the transcoder filter will not transcode a request if there are any
 unknown/invalid query parameters.

 Example :

 .. code-block:: proto

     service Bookstore {
       rpc GetShelf(GetShelfRequest) returns (Shelf) {
         option (google.api.http) = {
           get: "/shelves/{shelf}"
         };
       }
     }

     message GetShelfRequest {
       int64 shelf = 1;
     }

     message Shelf {}

 The request ``/shelves/100?foo=bar`` will not be mapped to ``GetShelf``` because variable
 binding for ``foo`` is not defined. Adding ``foo`` to ``ignored_query_parameters`` will allow
 the same request to be mapped to ``GetShelf``.
      repeated string ignored_query_parameters = 6;
      Specified by:
      getIgnoredQueryParametersBytes in interface GrpcJsonTranscoderOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the ignoredQueryParameters at the given index.

    • setIgnoredQueryParameters

      public GrpcJsonTranscoder.Builder setIgnoredQueryParameters(int index, String value)
       A list of query parameters to be ignored for transcoding method mapping.
 By default, the transcoder filter will not transcode a request if there are any
 unknown/invalid query parameters.

 Example :

 .. code-block:: proto

     service Bookstore {
       rpc GetShelf(GetShelfRequest) returns (Shelf) {
         option (google.api.http) = {
           get: "/shelves/{shelf}"
         };
       }
     }

     message GetShelfRequest {
       int64 shelf = 1;
     }

     message Shelf {}

 The request ``/shelves/100?foo=bar`` will not be mapped to ``GetShelf``` because variable
 binding for ``foo`` is not defined. Adding ``foo`` to ``ignored_query_parameters`` will allow
 the same request to be mapped to ``GetShelf``.
      repeated string ignored_query_parameters = 6;
      Parameters:
      index - The index to set the value at.
      value - The ignoredQueryParameters to set.
      Returns:
      This builder for chaining.

    • addIgnoredQueryParameters

      public GrpcJsonTranscoder.Builder addIgnoredQueryParameters(String value)
       A list of query parameters to be ignored for transcoding method mapping.
 By default, the transcoder filter will not transcode a request if there are any
 unknown/invalid query parameters.

 Example :

 .. code-block:: proto

     service Bookstore {
       rpc GetShelf(GetShelfRequest) returns (Shelf) {
         option (google.api.http) = {
           get: "/shelves/{shelf}"
         };
       }
     }

     message GetShelfRequest {
       int64 shelf = 1;
     }

     message Shelf {}

 The request ``/shelves/100?foo=bar`` will not be mapped to ``GetShelf``` because variable
 binding for ``foo`` is not defined. Adding ``foo`` to ``ignored_query_parameters`` will allow
 the same request to be mapped to ``GetShelf``.
      repeated string ignored_query_parameters = 6;
      Parameters:
      value - The ignoredQueryParameters to add.
      Returns:
      This builder for chaining.

    • addAllIgnoredQueryParameters

      public GrpcJsonTranscoder.Builder addAllIgnoredQueryParameters(Iterable<String> values)
       A list of query parameters to be ignored for transcoding method mapping.
 By default, the transcoder filter will not transcode a request if there are any
 unknown/invalid query parameters.

 Example :

 .. code-block:: proto

     service Bookstore {
       rpc GetShelf(GetShelfRequest) returns (Shelf) {
         option (google.api.http) = {
           get: "/shelves/{shelf}"
         };
       }
     }

     message GetShelfRequest {
       int64 shelf = 1;
     }

     message Shelf {}

 The request ``/shelves/100?foo=bar`` will not be mapped to ``GetShelf``` because variable
 binding for ``foo`` is not defined. Adding ``foo`` to ``ignored_query_parameters`` will allow
 the same request to be mapped to ``GetShelf``.
      repeated string ignored_query_parameters = 6;
      Parameters:
      values - The ignoredQueryParameters to add.
      Returns:
      This builder for chaining.

    • clearIgnoredQueryParameters

      public GrpcJsonTranscoder.Builder clearIgnoredQueryParameters()
       A list of query parameters to be ignored for transcoding method mapping.
 By default, the transcoder filter will not transcode a request if there are any
 unknown/invalid query parameters.

 Example :

 .. code-block:: proto

     service Bookstore {
       rpc GetShelf(GetShelfRequest) returns (Shelf) {
         option (google.api.http) = {
           get: "/shelves/{shelf}"
         };
       }
     }

     message GetShelfRequest {
       int64 shelf = 1;
     }

     message Shelf {}

 The request ``/shelves/100?foo=bar`` will not be mapped to ``GetShelf``` because variable
 binding for ``foo`` is not defined. Adding ``foo`` to ``ignored_query_parameters`` will allow
 the same request to be mapped to ``GetShelf``.
      repeated string ignored_query_parameters = 6;
      Returns:
      This builder for chaining.

    • addIgnoredQueryParametersBytes

      public GrpcJsonTranscoder.Builder addIgnoredQueryParametersBytes(com.google.protobuf.ByteString value)
       A list of query parameters to be ignored for transcoding method mapping.
 By default, the transcoder filter will not transcode a request if there are any
 unknown/invalid query parameters.

 Example :

 .. code-block:: proto

     service Bookstore {
       rpc GetShelf(GetShelfRequest) returns (Shelf) {
         option (google.api.http) = {
           get: "/shelves/{shelf}"
         };
       }
     }

     message GetShelfRequest {
       int64 shelf = 1;
     }

     message Shelf {}

 The request ``/shelves/100?foo=bar`` will not be mapped to ``GetShelf``` because variable
 binding for ``foo`` is not defined. Adding ``foo`` to ``ignored_query_parameters`` will allow
 the same request to be mapped to ``GetShelf``.
      repeated string ignored_query_parameters = 6;
      Parameters:
      value - The bytes of the ignoredQueryParameters to add.
      Returns:
      This builder for chaining.

    • getAutoMapping

      public boolean getAutoMapping()
       Whether to route methods without the ``google.api.http`` option.

 Example :

 .. code-block:: proto

     package bookstore;

     service Bookstore {
       rpc GetShelf(GetShelfRequest) returns (Shelf) {}
     }

     message GetShelfRequest {
       int64 shelf = 1;
     }

     message Shelf {}

 The client could ``post`` a json body ``{"shelf": 1234}`` with the path of
 ``/bookstore.Bookstore/GetShelfRequest`` to call ``GetShelfRequest``.
      bool auto_mapping = 7;
      Specified by:
      getAutoMapping in interface GrpcJsonTranscoderOrBuilder
      Returns:
      The autoMapping.

    • setAutoMapping

      public GrpcJsonTranscoder.Builder setAutoMapping(boolean value)
       Whether to route methods without the ``google.api.http`` option.

 Example :

 .. code-block:: proto

     package bookstore;

     service Bookstore {
       rpc GetShelf(GetShelfRequest) returns (Shelf) {}
     }

     message GetShelfRequest {
       int64 shelf = 1;
     }

     message Shelf {}

 The client could ``post`` a json body ``{"shelf": 1234}`` with the path of
 ``/bookstore.Bookstore/GetShelfRequest`` to call ``GetShelfRequest``.
      bool auto_mapping = 7;
      Parameters:
      value - The autoMapping to set.
      Returns:
      This builder for chaining.

    • clearAutoMapping

      public GrpcJsonTranscoder.Builder clearAutoMapping()
       Whether to route methods without the ``google.api.http`` option.

 Example :

 .. code-block:: proto

     package bookstore;

     service Bookstore {
       rpc GetShelf(GetShelfRequest) returns (Shelf) {}
     }

     message GetShelfRequest {
       int64 shelf = 1;
     }

     message Shelf {}

 The client could ``post`` a json body ``{"shelf": 1234}`` with the path of
 ``/bookstore.Bookstore/GetShelfRequest`` to call ``GetShelfRequest``.
      bool auto_mapping = 7;
      Returns:
      This builder for chaining.

    • getIgnoreUnknownQueryParameters

      public boolean getIgnoreUnknownQueryParameters()
       Whether to ignore query parameters that cannot be mapped to a corresponding
 protobuf field. Use this if you cannot control the query parameters and do
 not know them beforehand. Otherwise use ``ignored_query_parameters``.
 Defaults to false.
      bool ignore_unknown_query_parameters = 8;
      Specified by:
      getIgnoreUnknownQueryParameters in interface GrpcJsonTranscoderOrBuilder
      Returns:
      The ignoreUnknownQueryParameters.

    • setIgnoreUnknownQueryParameters

      public GrpcJsonTranscoder.Builder setIgnoreUnknownQueryParameters(boolean value)
       Whether to ignore query parameters that cannot be mapped to a corresponding
 protobuf field. Use this if you cannot control the query parameters and do
 not know them beforehand. Otherwise use ``ignored_query_parameters``.
 Defaults to false.
      bool ignore_unknown_query_parameters = 8;
      Parameters:
      value - The ignoreUnknownQueryParameters to set.
      Returns:
      This builder for chaining.

    • clearIgnoreUnknownQueryParameters

      public GrpcJsonTranscoder.Builder clearIgnoreUnknownQueryParameters()
       Whether to ignore query parameters that cannot be mapped to a corresponding
 protobuf field. Use this if you cannot control the query parameters and do
 not know them beforehand. Otherwise use ``ignored_query_parameters``.
 Defaults to false.
      bool ignore_unknown_query_parameters = 8;
      Returns:
      This builder for chaining.

    • getConvertGrpcStatus

      public boolean getConvertGrpcStatus()
       Whether to convert gRPC status headers to JSON.
 When trailer indicates a gRPC error and there was no HTTP body, take ``google.rpc.Status``
 from the ``grpc-status-details-bin`` header and use it as JSON body.
 If there was no such header, make ``google.rpc.Status`` out of the ``grpc-status`` and
 ``grpc-message`` headers.
 The error details types must be present in the ``proto_descriptor``.

 For example, if an upstream server replies with headers:

 .. code-block:: none

     grpc-status: 5
     grpc-status-details-bin:
         CAUaMwoqdHlwZS5nb29nbGVhcGlzLmNvbS9nb29nbGUucnBjLlJlcXVlc3RJbmZvEgUKA3ItMQ

 The ``grpc-status-details-bin`` header contains a base64-encoded protobuf message
 ``google.rpc.Status``. It will be transcoded into:

 .. code-block:: none

     HTTP/1.1 404 Not Found
     content-type: application/json

     {"code":5,"details":[{"@type":"type.googleapis.com/google.rpc.RequestInfo","requestId":"r-1"}]}

 In order to transcode the message, the ``google.rpc.RequestInfo`` type from
 the ``google/rpc/error_details.proto`` should be included in the configured
 :ref:`proto descriptor set <config_grpc_json_generate_proto_descriptor_set>`.
      bool convert_grpc_status = 9;
      Specified by:
      getConvertGrpcStatus in interface GrpcJsonTranscoderOrBuilder
      Returns:
      The convertGrpcStatus.

    • setConvertGrpcStatus

      public GrpcJsonTranscoder.Builder setConvertGrpcStatus(boolean value)
       Whether to convert gRPC status headers to JSON.
 When trailer indicates a gRPC error and there was no HTTP body, take ``google.rpc.Status``
 from the ``grpc-status-details-bin`` header and use it as JSON body.
 If there was no such header, make ``google.rpc.Status`` out of the ``grpc-status`` and
 ``grpc-message`` headers.
 The error details types must be present in the ``proto_descriptor``.

 For example, if an upstream server replies with headers:

 .. code-block:: none

     grpc-status: 5
     grpc-status-details-bin:
         CAUaMwoqdHlwZS5nb29nbGVhcGlzLmNvbS9nb29nbGUucnBjLlJlcXVlc3RJbmZvEgUKA3ItMQ

 The ``grpc-status-details-bin`` header contains a base64-encoded protobuf message
 ``google.rpc.Status``. It will be transcoded into:

 .. code-block:: none

     HTTP/1.1 404 Not Found
     content-type: application/json

     {"code":5,"details":[{"@type":"type.googleapis.com/google.rpc.RequestInfo","requestId":"r-1"}]}

 In order to transcode the message, the ``google.rpc.RequestInfo`` type from
 the ``google/rpc/error_details.proto`` should be included in the configured
 :ref:`proto descriptor set <config_grpc_json_generate_proto_descriptor_set>`.
      bool convert_grpc_status = 9;
      Parameters:
      value - The convertGrpcStatus to set.
      Returns:
      This builder for chaining.

    • clearConvertGrpcStatus

      public GrpcJsonTranscoder.Builder clearConvertGrpcStatus()
       Whether to convert gRPC status headers to JSON.
 When trailer indicates a gRPC error and there was no HTTP body, take ``google.rpc.Status``
 from the ``grpc-status-details-bin`` header and use it as JSON body.
 If there was no such header, make ``google.rpc.Status`` out of the ``grpc-status`` and
 ``grpc-message`` headers.
 The error details types must be present in the ``proto_descriptor``.

 For example, if an upstream server replies with headers:

 .. code-block:: none

     grpc-status: 5
     grpc-status-details-bin:
         CAUaMwoqdHlwZS5nb29nbGVhcGlzLmNvbS9nb29nbGUucnBjLlJlcXVlc3RJbmZvEgUKA3ItMQ

 The ``grpc-status-details-bin`` header contains a base64-encoded protobuf message
 ``google.rpc.Status``. It will be transcoded into:

 .. code-block:: none

     HTTP/1.1 404 Not Found
     content-type: application/json

     {"code":5,"details":[{"@type":"type.googleapis.com/google.rpc.RequestInfo","requestId":"r-1"}]}

 In order to transcode the message, the ``google.rpc.RequestInfo`` type from
 the ``google/rpc/error_details.proto`` should be included in the configured
 :ref:`proto descriptor set <config_grpc_json_generate_proto_descriptor_set>`.
      bool convert_grpc_status = 9;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final GrpcJsonTranscoder.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>

    • mergeUnknownFields

      public final GrpcJsonTranscoder.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>