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| Modifier and Type | Method and Description |
|---|---|
GrpcJsonTranscoder.Builder |
addAllIgnoredQueryParameters(Iterable<String> values)
A list of query parameters to be ignored for transcoding method mapping.
|
GrpcJsonTranscoder.Builder |
addAllServices(Iterable<String> values)
A list of strings that
supplies the fully qualified service names (i.e.
|
GrpcJsonTranscoder.Builder |
addIgnoredQueryParameters(String value)
A list of query parameters to be ignored for transcoding method mapping.
|
GrpcJsonTranscoder.Builder |
addIgnoredQueryParametersBytes(com.google.protobuf.ByteString value)
A list of query parameters to be ignored for transcoding method mapping.
|
GrpcJsonTranscoder.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
GrpcJsonTranscoder.Builder |
addServices(String value)
A list of strings that
supplies the fully qualified service names (i.e.
|
GrpcJsonTranscoder.Builder |
addServicesBytes(com.google.protobuf.ByteString value)
A list of strings that
supplies the fully qualified service names (i.e.
|
GrpcJsonTranscoder |
build() |
GrpcJsonTranscoder |
buildPartial() |
GrpcJsonTranscoder.Builder |
clear() |
GrpcJsonTranscoder.Builder |
clearAutoMapping()
Whether to route methods without the ``google.api.http`` option.
|
GrpcJsonTranscoder.Builder |
clearConvertGrpcStatus()
Whether to convert gRPC status headers to JSON.
|
GrpcJsonTranscoder.Builder |
clearDescriptorSet() |
GrpcJsonTranscoder.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
GrpcJsonTranscoder.Builder |
clearIgnoredQueryParameters()
A list of query parameters to be ignored for transcoding method mapping.
|
GrpcJsonTranscoder.Builder |
clearIgnoreUnknownQueryParameters()
Whether to ignore query parameters that cannot be mapped to a corresponding
protobuf field.
|
GrpcJsonTranscoder.Builder |
clearMatchIncomingRequestRoute()
Whether to keep the incoming request route after the outgoing headers have been transformed to
the match the upstream gRPC service.
|
GrpcJsonTranscoder.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
GrpcJsonTranscoder.Builder |
clearPrintOptions()
Control options for response JSON.
|
GrpcJsonTranscoder.Builder |
clearProtoDescriptor()
Supplies the filename of
:ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
services.
|
GrpcJsonTranscoder.Builder |
clearProtoDescriptorBin()
Supplies the binary content of
:ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
services.
|
GrpcJsonTranscoder.Builder |
clearServices()
A list of strings that
supplies the fully qualified service names (i.e.
|
GrpcJsonTranscoder.Builder |
clone() |
boolean |
getAutoMapping()
Whether to route methods without the ``google.api.http`` option.
|
boolean |
getConvertGrpcStatus()
Whether to convert gRPC status headers to JSON.
|
GrpcJsonTranscoder |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
GrpcJsonTranscoder.DescriptorSetCase |
getDescriptorSetCase() |
String |
getIgnoredQueryParameters(int index)
A list of query parameters to be ignored for transcoding method mapping.
|
com.google.protobuf.ByteString |
getIgnoredQueryParametersBytes(int index)
A list of query parameters to be ignored for transcoding method mapping.
|
int |
getIgnoredQueryParametersCount()
A list of query parameters to be ignored for transcoding method mapping.
|
com.google.protobuf.ProtocolStringList |
getIgnoredQueryParametersList()
A list of query parameters to be ignored for transcoding method mapping.
|
boolean |
getIgnoreUnknownQueryParameters()
Whether to ignore query parameters that cannot be mapped to a corresponding
protobuf field.
|
boolean |
getMatchIncomingRequestRoute()
Whether to keep the incoming request route after the outgoing headers have been transformed to
the match the upstream gRPC service.
|
GrpcJsonTranscoder.PrintOptions |
getPrintOptions()
Control options for response JSON.
|
GrpcJsonTranscoder.PrintOptions.Builder |
getPrintOptionsBuilder()
Control options for response JSON.
|
GrpcJsonTranscoder.PrintOptionsOrBuilder |
getPrintOptionsOrBuilder()
Control options for response JSON.
|
String |
getProtoDescriptor()
Supplies the filename of
:ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC
services.
|
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.
|
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 |
getServices(int index)
A list of strings that
supplies the fully qualified service names (i.e.
|
com.google.protobuf.ByteString |
getServicesBytes(int index)
A list of strings that
supplies the fully qualified service names (i.e.
|
int |
getServicesCount()
A list of strings that
supplies the fully qualified service names (i.e.
|
com.google.protobuf.ProtocolStringList |
getServicesList()
A list of strings that
supplies the fully qualified service names (i.e.
|
boolean |
hasPrintOptions()
Control options for response JSON.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
GrpcJsonTranscoder.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
GrpcJsonTranscoder.Builder |
mergeFrom(GrpcJsonTranscoder other) |
GrpcJsonTranscoder.Builder |
mergeFrom(com.google.protobuf.Message other) |
GrpcJsonTranscoder.Builder |
mergePrintOptions(GrpcJsonTranscoder.PrintOptions value)
Control options for response JSON.
|
GrpcJsonTranscoder.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
GrpcJsonTranscoder.Builder |
setAutoMapping(boolean value)
Whether to route methods without the ``google.api.http`` option.
|
GrpcJsonTranscoder.Builder |
setConvertGrpcStatus(boolean value)
Whether to convert gRPC status headers to JSON.
|
GrpcJsonTranscoder.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
GrpcJsonTranscoder.Builder |
setIgnoredQueryParameters(int index,
String value)
A list of query parameters to be ignored for transcoding method mapping.
|
GrpcJsonTranscoder.Builder |
setIgnoreUnknownQueryParameters(boolean value)
Whether to ignore query parameters that cannot be mapped to a corresponding
protobuf field.
|
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.
|
GrpcJsonTranscoder.Builder |
setPrintOptions(GrpcJsonTranscoder.PrintOptions.Builder builderForValue)
Control options for response JSON.
|
GrpcJsonTranscoder.Builder |
setPrintOptions(GrpcJsonTranscoder.PrintOptions value)
Control options for response JSON.
|
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.
|
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.
|
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.
|
GrpcJsonTranscoder.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
GrpcJsonTranscoder.Builder |
setServices(int index,
String value)
A list of strings that
supplies the fully qualified service names (i.e.
|
GrpcJsonTranscoder.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>public GrpcJsonTranscoder.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>public GrpcJsonTranscoder getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic GrpcJsonTranscoder build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic GrpcJsonTranscoder buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic GrpcJsonTranscoder.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>public GrpcJsonTranscoder.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>public GrpcJsonTranscoder.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>public GrpcJsonTranscoder.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>public GrpcJsonTranscoder.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>public GrpcJsonTranscoder.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>public GrpcJsonTranscoder.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<GrpcJsonTranscoder.Builder>public GrpcJsonTranscoder.Builder mergeFrom(GrpcJsonTranscoder other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>public GrpcJsonTranscoder.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<GrpcJsonTranscoder.Builder>IOExceptionpublic GrpcJsonTranscoder.DescriptorSetCase getDescriptorSetCase()
getDescriptorSetCase in interface GrpcJsonTranscoderOrBuilderpublic GrpcJsonTranscoder.Builder clearDescriptorSet()
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;getProtoDescriptor in interface GrpcJsonTranscoderOrBuilderpublic 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;getProtoDescriptorBytes in interface GrpcJsonTranscoderOrBuilderpublic 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;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;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;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;getProtoDescriptorBin in interface GrpcJsonTranscoderOrBuilderpublic 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;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;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) = { ... }getServicesList in interface GrpcJsonTranscoderOrBuilderpublic 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) = { ... }getServicesCount in interface GrpcJsonTranscoderOrBuilderpublic 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) = { ... }getServices in interface GrpcJsonTranscoderOrBuilderpublic 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) = { ... }getServicesBytes in interface GrpcJsonTranscoderOrBuilderpublic 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) = { ... }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) = { ... }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) = { ... }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) = { ... }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) = { ... }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;hasPrintOptions in interface GrpcJsonTranscoderOrBuilderpublic 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;getPrintOptions in interface GrpcJsonTranscoderOrBuilderpublic 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;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;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;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;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;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;getPrintOptionsOrBuilder in interface GrpcJsonTranscoderOrBuilderpublic 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;getMatchIncomingRequestRoute in interface GrpcJsonTranscoderOrBuilderpublic 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;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;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;getIgnoredQueryParametersList in interface GrpcJsonTranscoderOrBuilderpublic 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;getIgnoredQueryParametersCount in interface GrpcJsonTranscoderOrBuilderpublic 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;getIgnoredQueryParameters in interface GrpcJsonTranscoderOrBuilderpublic 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;getIgnoredQueryParametersBytes in interface GrpcJsonTranscoderOrBuilderpublic 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;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;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;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;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;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;getAutoMapping in interface GrpcJsonTranscoderOrBuilderpublic 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;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;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;getIgnoreUnknownQueryParameters in interface GrpcJsonTranscoderOrBuilderpublic 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;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;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;getConvertGrpcStatus in interface GrpcJsonTranscoderOrBuilderpublic 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;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;public final GrpcJsonTranscoder.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>public final GrpcJsonTranscoder.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GrpcJsonTranscoder.Builder>Copyright © 2018–2021 The Envoy Project. All rights reserved.