import "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/http/grpc_json_transcoder/v3"
transcoder.pb.go transcoder.pb.validate.go
var ( GrpcJsonTranscoder_UrlUnescapeSpec_name = map[int32]string{ 0: "ALL_CHARACTERS_EXCEPT_RESERVED", 1: "ALL_CHARACTERS_EXCEPT_SLASH", 2: "ALL_CHARACTERS", } GrpcJsonTranscoder_UrlUnescapeSpec_value = map[string]int32{ "ALL_CHARACTERS_EXCEPT_RESERVED": 0, "ALL_CHARACTERS_EXCEPT_SLASH": 1, "ALL_CHARACTERS": 2, } )
Enum value maps for GrpcJsonTranscoder_UrlUnescapeSpec.
var File_envoy_extensions_filters_http_grpc_json_transcoder_v3_transcoder_proto protoreflect.FileDescriptor
type GrpcJsonTranscoder struct { // Types that are assignable to DescriptorSet: // *GrpcJsonTranscoder_ProtoDescriptor // *GrpcJsonTranscoder_ProtoDescriptorBin DescriptorSet isGrpcJsonTranscoder_DescriptorSet `protobuf_oneof:"descriptor_set"` // 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. Services []string `protobuf:"bytes,2,rep,name=services,proto3" json:"services,omitempty"` // 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>`_. PrintOptions *GrpcJsonTranscoder_PrintOptions `protobuf:"bytes,3,opt,name=print_options,json=printOptions,proto3" json:"print_options,omitempty"` // 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*. MatchIncomingRequestRoute bool `protobuf:"varint,5,opt,name=match_incoming_request_route,json=matchIncomingRequestRoute,proto3" json:"match_incoming_request_route,omitempty"` // 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``. IgnoredQueryParameters []string `protobuf:"bytes,6,rep,name=ignored_query_parameters,json=ignoredQueryParameters,proto3" json:"ignored_query_parameters,omitempty"` // 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``. AutoMapping bool `protobuf:"varint,7,opt,name=auto_mapping,json=autoMapping,proto3" json:"auto_mapping,omitempty"` // 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. IgnoreUnknownQueryParameters bool `protobuf:"varint,8,opt,name=ignore_unknown_query_parameters,json=ignoreUnknownQueryParameters,proto3" json:"ignore_unknown_query_parameters,omitempty"` // 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>`. ConvertGrpcStatus bool `protobuf:"varint,9,opt,name=convert_grpc_status,json=convertGrpcStatus,proto3" json:"convert_grpc_status,omitempty"` // URL unescaping policy. // This spec is only applied when extracting variable with multiple segments. // For example, in case of `/foo/{x=*}/bar/{y=prefix/*}/{z=**}` `x` variable is single segment and `y` and `z` are multiple segments. // For a path with `/foo/first/bar/prefix/second/third/fourth`, `x=first`, `y=prefix/second`, `z=third/fourth`. // If this setting is not specified, the value defaults to :ref:`ALL_CHARACTERS_EXCEPT_RESERVED<envoy_api_enum_value_extensions.filters.http.grpc_json_transcoder.v3.GrpcJsonTranscoder.UrlUnescapeSpec.ALL_CHARACTERS_EXCEPT_RESERVED>`. UrlUnescapeSpec GrpcJsonTranscoder_UrlUnescapeSpec `protobuf:"varint,10,opt,name=url_unescape_spec,json=urlUnescapeSpec,proto3,enum=envoy.extensions.filters.http.grpc_json_transcoder.v3.GrpcJsonTranscoder_UrlUnescapeSpec" json:"url_unescape_spec,omitempty"` // contains filtered or unexported fields }
[#next-free-field: 11]
func (*GrpcJsonTranscoder) Descriptor() ([]byte, []int)
Deprecated: Use GrpcJsonTranscoder.ProtoReflect.Descriptor instead.
func (x *GrpcJsonTranscoder) GetAutoMapping() bool
func (x *GrpcJsonTranscoder) GetConvertGrpcStatus() bool
func (m *GrpcJsonTranscoder) GetDescriptorSet() isGrpcJsonTranscoder_DescriptorSet
func (x *GrpcJsonTranscoder) GetIgnoreUnknownQueryParameters() bool
func (x *GrpcJsonTranscoder) GetIgnoredQueryParameters() []string
func (x *GrpcJsonTranscoder) GetMatchIncomingRequestRoute() bool
func (x *GrpcJsonTranscoder) GetPrintOptions() *GrpcJsonTranscoder_PrintOptions
func (x *GrpcJsonTranscoder) GetProtoDescriptor() string
func (x *GrpcJsonTranscoder) GetProtoDescriptorBin() []byte
func (x *GrpcJsonTranscoder) GetServices() []string
func (x *GrpcJsonTranscoder) GetUrlUnescapeSpec() GrpcJsonTranscoder_UrlUnescapeSpec
func (*GrpcJsonTranscoder) ProtoMessage()
func (x *GrpcJsonTranscoder) ProtoReflect() protoreflect.Message
func (x *GrpcJsonTranscoder) Reset()
func (x *GrpcJsonTranscoder) String() string
func (m *GrpcJsonTranscoder) Validate() error
Validate checks the field values on GrpcJsonTranscoder with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcJsonTranscoderValidationError struct {
// contains filtered or unexported fields
}
GrpcJsonTranscoderValidationError is the validation error returned by GrpcJsonTranscoder.Validate if the designated constraints aren't met.
func (e GrpcJsonTranscoderValidationError) Cause() error
Cause function returns cause value.
func (e GrpcJsonTranscoderValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcJsonTranscoderValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcJsonTranscoderValidationError) Field() string
Field function returns field value.
func (e GrpcJsonTranscoderValidationError) Key() bool
Key function returns key value.
func (e GrpcJsonTranscoderValidationError) Reason() string
Reason function returns reason value.
type GrpcJsonTranscoder_PrintOptions struct { // Whether to add spaces, line breaks and indentation to make the JSON // output easy to read. Defaults to false. AddWhitespace bool `protobuf:"varint,1,opt,name=add_whitespace,json=addWhitespace,proto3" json:"add_whitespace,omitempty"` // Whether to always print primitive fields. By default primitive // fields with default values will be omitted in JSON output. For // example, an int32 field set to 0 will be omitted. Setting this flag to // true will override the default behavior and print primitive fields // regardless of their values. Defaults to false. AlwaysPrintPrimitiveFields bool `protobuf:"varint,2,opt,name=always_print_primitive_fields,json=alwaysPrintPrimitiveFields,proto3" json:"always_print_primitive_fields,omitempty"` // Whether to always print enums as ints. By default they are rendered // as strings. Defaults to false. AlwaysPrintEnumsAsInts bool `protobuf:"varint,3,opt,name=always_print_enums_as_ints,json=alwaysPrintEnumsAsInts,proto3" json:"always_print_enums_as_ints,omitempty"` // Whether to preserve proto field names. By default protobuf will // generate JSON field names using the ``json_name`` option, or lower camel case, // in that order. Setting this flag will preserve the original field names. Defaults to false. PreserveProtoFieldNames bool `protobuf:"varint,4,opt,name=preserve_proto_field_names,json=preserveProtoFieldNames,proto3" json:"preserve_proto_field_names,omitempty"` // contains filtered or unexported fields }
func (*GrpcJsonTranscoder_PrintOptions) Descriptor() ([]byte, []int)
Deprecated: Use GrpcJsonTranscoder_PrintOptions.ProtoReflect.Descriptor instead.
func (x *GrpcJsonTranscoder_PrintOptions) GetAddWhitespace() bool
func (x *GrpcJsonTranscoder_PrintOptions) GetAlwaysPrintEnumsAsInts() bool
func (x *GrpcJsonTranscoder_PrintOptions) GetAlwaysPrintPrimitiveFields() bool
func (x *GrpcJsonTranscoder_PrintOptions) GetPreserveProtoFieldNames() bool
func (*GrpcJsonTranscoder_PrintOptions) ProtoMessage()
func (x *GrpcJsonTranscoder_PrintOptions) ProtoReflect() protoreflect.Message
func (x *GrpcJsonTranscoder_PrintOptions) Reset()
func (x *GrpcJsonTranscoder_PrintOptions) String() string
func (m *GrpcJsonTranscoder_PrintOptions) Validate() error
Validate checks the field values on GrpcJsonTranscoder_PrintOptions with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcJsonTranscoder_PrintOptionsValidationError struct {
// contains filtered or unexported fields
}
GrpcJsonTranscoder_PrintOptionsValidationError is the validation error returned by GrpcJsonTranscoder_PrintOptions.Validate if the designated constraints aren't met.
func (e GrpcJsonTranscoder_PrintOptionsValidationError) Cause() error
Cause function returns cause value.
func (e GrpcJsonTranscoder_PrintOptionsValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcJsonTranscoder_PrintOptionsValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcJsonTranscoder_PrintOptionsValidationError) Field() string
Field function returns field value.
func (e GrpcJsonTranscoder_PrintOptionsValidationError) Key() bool
Key function returns key value.
func (e GrpcJsonTranscoder_PrintOptionsValidationError) Reason() string
Reason function returns reason value.
type GrpcJsonTranscoder_ProtoDescriptor struct { // Supplies the filename of // :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC // services. ProtoDescriptor string `protobuf:"bytes,1,opt,name=proto_descriptor,json=protoDescriptor,proto3,oneof"` }
type GrpcJsonTranscoder_ProtoDescriptorBin struct { // Supplies the binary content of // :ref:`the proto descriptor set <config_grpc_json_generate_proto_descriptor_set>` for the gRPC // services. ProtoDescriptorBin []byte `protobuf:"bytes,4,opt,name=proto_descriptor_bin,json=protoDescriptorBin,proto3,oneof"` }
const ( // URL path parameters will not decode RFC 6570 reserved characters. // For example, segment `%2f%23/%20%2523` is unescaped to `%2f%23/ %23`. GrpcJsonTranscoder_ALL_CHARACTERS_EXCEPT_RESERVED GrpcJsonTranscoder_UrlUnescapeSpec = 0 // URL path parameters will be fully URI-decoded except in // cases of single segment matches in reserved expansion, where "%2F" will be // left encoded. // For example, segment `%2f%23/%20%2523` is unescaped to `%2f#/ %23`. GrpcJsonTranscoder_ALL_CHARACTERS_EXCEPT_SLASH GrpcJsonTranscoder_UrlUnescapeSpec = 1 // URL path parameters will be fully URI-decoded. // For example, segment `%2f%23/%20%2523` is unescaped to `/#/ %23`. GrpcJsonTranscoder_ALL_CHARACTERS GrpcJsonTranscoder_UrlUnescapeSpec = 2 )
func (GrpcJsonTranscoder_UrlUnescapeSpec) Descriptor() protoreflect.EnumDescriptor
func (x GrpcJsonTranscoder_UrlUnescapeSpec) Enum() *GrpcJsonTranscoder_UrlUnescapeSpec
func (GrpcJsonTranscoder_UrlUnescapeSpec) EnumDescriptor() ([]byte, []int)
Deprecated: Use GrpcJsonTranscoder_UrlUnescapeSpec.Descriptor instead.
func (x GrpcJsonTranscoder_UrlUnescapeSpec) Number() protoreflect.EnumNumber
func (x GrpcJsonTranscoder_UrlUnescapeSpec) String() string
func (GrpcJsonTranscoder_UrlUnescapeSpec) Type() protoreflect.EnumType
Package envoy_extensions_filters_http_grpc_json_transcoder_v3 imports 18 packages (graph) and is imported by 9 packages. Updated 2021-01-07. Refresh now. Tools for package owners.