Class GrpcJsonTranscoder.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- 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 typeenvoy.config.filter.http.transcoder.v2.GrpcJsonTranscoder
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description GrpcJsonTranscoder.BuilderaddAllIgnoredQueryParameters(Iterable<String> values)A list of query parameters to be ignored for transcoding method mapping.GrpcJsonTranscoder.BuilderaddAllServices(Iterable<String> values)A list of strings that supplies the fully qualified service names (i.e.GrpcJsonTranscoder.BuilderaddIgnoredQueryParameters(String value)A list of query parameters to be ignored for transcoding method mapping.GrpcJsonTranscoder.BuilderaddIgnoredQueryParametersBytes(com.google.protobuf.ByteString value)A list of query parameters to be ignored for transcoding method mapping.GrpcJsonTranscoder.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)GrpcJsonTranscoder.BuilderaddServices(String value)A list of strings that supplies the fully qualified service names (i.e.GrpcJsonTranscoder.BuilderaddServicesBytes(com.google.protobuf.ByteString value)A list of strings that supplies the fully qualified service names (i.e.GrpcJsonTranscoderbuild()GrpcJsonTranscoderbuildPartial()GrpcJsonTranscoder.Builderclear()GrpcJsonTranscoder.BuilderclearAutoMapping()Whether to route methods without the ``google.api.http`` option.GrpcJsonTranscoder.BuilderclearConvertGrpcStatus()Whether to convert gRPC status headers to JSON.GrpcJsonTranscoder.BuilderclearDescriptorSet()GrpcJsonTranscoder.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)GrpcJsonTranscoder.BuilderclearIgnoredQueryParameters()A list of query parameters to be ignored for transcoding method mapping.GrpcJsonTranscoder.BuilderclearIgnoreUnknownQueryParameters()Whether to ignore query parameters that cannot be mapped to a corresponding protobuf field.GrpcJsonTranscoder.BuilderclearMatchIncomingRequestRoute()Whether to keep the incoming request route after the outgoing headers have been transformed to the match the upstream gRPC service.GrpcJsonTranscoder.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)GrpcJsonTranscoder.BuilderclearPrintOptions()Control options for response JSON.GrpcJsonTranscoder.BuilderclearProtoDescriptor()Supplies the filename of :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC services.GrpcJsonTranscoder.BuilderclearProtoDescriptorBin()Supplies the binary content of :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC services.GrpcJsonTranscoder.BuilderclearServices()A list of strings that supplies the fully qualified service names (i.e.GrpcJsonTranscoder.Builderclone()booleangetAutoMapping()Whether to route methods without the ``google.api.http`` option.booleangetConvertGrpcStatus()Whether to convert gRPC status headers to JSON.GrpcJsonTranscodergetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()GrpcJsonTranscoder.DescriptorSetCasegetDescriptorSetCase()StringgetIgnoredQueryParameters(int index)A list of query parameters to be ignored for transcoding method mapping.com.google.protobuf.ByteStringgetIgnoredQueryParametersBytes(int index)A list of query parameters to be ignored for transcoding method mapping.intgetIgnoredQueryParametersCount()A list of query parameters to be ignored for transcoding method mapping.com.google.protobuf.ProtocolStringListgetIgnoredQueryParametersList()A list of query parameters to be ignored for transcoding method mapping.booleangetIgnoreUnknownQueryParameters()Whether to ignore query parameters that cannot be mapped to a corresponding protobuf field.booleangetMatchIncomingRequestRoute()Whether to keep the incoming request route after the outgoing headers have been transformed to the match the upstream gRPC service.GrpcJsonTranscoder.PrintOptionsgetPrintOptions()Control options for response JSON.GrpcJsonTranscoder.PrintOptions.BuildergetPrintOptionsBuilder()Control options for response JSON.GrpcJsonTranscoder.PrintOptionsOrBuildergetPrintOptionsOrBuilder()Control options for response JSON.StringgetProtoDescriptor()Supplies the filename of :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC services.com.google.protobuf.ByteStringgetProtoDescriptorBin()Supplies the binary content of :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC services.com.google.protobuf.ByteStringgetProtoDescriptorBytes()Supplies the filename of :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC services.StringgetServices(int index)A list of strings that supplies the fully qualified service names (i.e.com.google.protobuf.ByteStringgetServicesBytes(int index)A list of strings that supplies the fully qualified service names (i.e.intgetServicesCount()A list of strings that supplies the fully qualified service names (i.e.com.google.protobuf.ProtocolStringListgetServicesList()A list of strings that supplies the fully qualified service names (i.e.booleanhasPrintOptions()Control options for response JSON.booleanhasProtoDescriptor()Supplies the filename of :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC services.booleanhasProtoDescriptorBin()Supplies the binary content of :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC services.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()GrpcJsonTranscoder.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)GrpcJsonTranscoder.BuildermergeFrom(com.google.protobuf.Message other)GrpcJsonTranscoder.BuildermergeFrom(GrpcJsonTranscoder other)GrpcJsonTranscoder.BuildermergePrintOptions(GrpcJsonTranscoder.PrintOptions value)Control options for response JSON.GrpcJsonTranscoder.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)GrpcJsonTranscoder.BuildersetAutoMapping(boolean value)Whether to route methods without the ``google.api.http`` option.GrpcJsonTranscoder.BuildersetConvertGrpcStatus(boolean value)Whether to convert gRPC status headers to JSON.GrpcJsonTranscoder.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)GrpcJsonTranscoder.BuildersetIgnoredQueryParameters(int index, String value)A list of query parameters to be ignored for transcoding method mapping.GrpcJsonTranscoder.BuildersetIgnoreUnknownQueryParameters(boolean value)Whether to ignore query parameters that cannot be mapped to a corresponding protobuf field.GrpcJsonTranscoder.BuildersetMatchIncomingRequestRoute(boolean value)Whether to keep the incoming request route after the outgoing headers have been transformed to the match the upstream gRPC service.GrpcJsonTranscoder.BuildersetPrintOptions(GrpcJsonTranscoder.PrintOptions value)Control options for response JSON.GrpcJsonTranscoder.BuildersetPrintOptions(GrpcJsonTranscoder.PrintOptions.Builder builderForValue)Control options for response JSON.GrpcJsonTranscoder.BuildersetProtoDescriptor(String value)Supplies the filename of :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC services.GrpcJsonTranscoder.BuildersetProtoDescriptorBin(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.GrpcJsonTranscoder.BuildersetProtoDescriptorBytes(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.GrpcJsonTranscoder.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)GrpcJsonTranscoder.BuildersetServices(int index, String value)A list of strings that supplies the fully qualified service names (i.e.GrpcJsonTranscoder.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>
-
clear
public GrpcJsonTranscoder.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>
-
getDefaultInstanceForType
public GrpcJsonTranscoder getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public GrpcJsonTranscoder build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public GrpcJsonTranscoder buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public GrpcJsonTranscoder.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>
-
setField
public GrpcJsonTranscoder.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>
-
clearField
public GrpcJsonTranscoder.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>
-
clearOneof
public GrpcJsonTranscoder.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>
-
setRepeatedField
public GrpcJsonTranscoder.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>
-
addRepeatedField
public GrpcJsonTranscoder.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>
-
mergeFrom
public GrpcJsonTranscoder.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<GrpcJsonTranscoder.Builder>
-
mergeFrom
public GrpcJsonTranscoder.Builder mergeFrom(GrpcJsonTranscoder other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<GrpcJsonTranscoder.Builder>- Throws:
IOException
-
getDescriptorSetCase
public GrpcJsonTranscoder.DescriptorSetCase getDescriptorSetCase()
- Specified by:
getDescriptorSetCasein interfaceGrpcJsonTranscoderOrBuilder
-
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:
hasProtoDescriptorin interfaceGrpcJsonTranscoderOrBuilder- 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:
getProtoDescriptorin interfaceGrpcJsonTranscoderOrBuilder- 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:
getProtoDescriptorBytesin interfaceGrpcJsonTranscoderOrBuilder- 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:
hasProtoDescriptorBinin interfaceGrpcJsonTranscoderOrBuilder- 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:
getProtoDescriptorBinin interfaceGrpcJsonTranscoderOrBuilder- 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:
getServicesListin interfaceGrpcJsonTranscoderOrBuilder- 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:
getServicesCountin interfaceGrpcJsonTranscoderOrBuilder- 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:
getServicesin interfaceGrpcJsonTranscoderOrBuilder- 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:
getServicesBytesin interfaceGrpcJsonTranscoderOrBuilder- 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:
hasPrintOptionsin interfaceGrpcJsonTranscoderOrBuilder- 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:
getPrintOptionsin interfaceGrpcJsonTranscoderOrBuilder- 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:
getPrintOptionsOrBuilderin interfaceGrpcJsonTranscoderOrBuilder
-
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:
getMatchIncomingRequestRoutein interfaceGrpcJsonTranscoderOrBuilder- 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:
getIgnoredQueryParametersListin interfaceGrpcJsonTranscoderOrBuilder- 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:
getIgnoredQueryParametersCountin interfaceGrpcJsonTranscoderOrBuilder- 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:
getIgnoredQueryParametersin interfaceGrpcJsonTranscoderOrBuilder- 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:
getIgnoredQueryParametersBytesin interfaceGrpcJsonTranscoderOrBuilder- 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:
getAutoMappingin interfaceGrpcJsonTranscoderOrBuilder- 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:
getIgnoreUnknownQueryParametersin interfaceGrpcJsonTranscoderOrBuilder- 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:
getConvertGrpcStatusin interfaceGrpcJsonTranscoderOrBuilder- 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:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>
-
mergeUnknownFields
public final GrpcJsonTranscoder.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>
-
-