Documentation
¶
Index ¶
- Variables
- type AbstractTypeResolver
- type GraphQLConfig
- type GraphQLRouteConfig
- func (*GraphQLRouteConfig) Descriptor() ([]byte, []int)deprecated
- func (x *GraphQLRouteConfig) GetEnableIntrospection() bool
- func (x *GraphQLRouteConfig) GetResolutions() []*Resolution
- func (x *GraphQLRouteConfig) GetSchema() *v3.DataSource
- func (*GraphQLRouteConfig) ProtoMessage()
- func (x *GraphQLRouteConfig) ProtoReflect() protoreflect.Message
- func (x *GraphQLRouteConfig) Reset()
- func (x *GraphQLRouteConfig) String() string
- type JsonKeyValue
- func (*JsonKeyValue) Descriptor() ([]byte, []int)deprecated
- func (x *JsonKeyValue) GetKey() string
- func (x *JsonKeyValue) GetValue() *JsonValue
- func (*JsonKeyValue) ProtoMessage()
- func (x *JsonKeyValue) ProtoReflect() protoreflect.Message
- func (x *JsonKeyValue) Reset()
- func (x *JsonKeyValue) String() string
- type JsonNode
- type JsonValue
- func (*JsonValue) Descriptor() ([]byte, []int)deprecated
- func (m *JsonValue) GetJsonVal() isJsonValue_JsonVal
- func (x *JsonValue) GetList() *JsonValueList
- func (x *JsonValue) GetNode() *JsonNode
- func (x *JsonValue) GetValueProvider() *ValueProvider
- func (*JsonValue) ProtoMessage()
- func (x *JsonValue) ProtoReflect() protoreflect.Message
- func (x *JsonValue) Reset()
- func (x *JsonValue) String() string
- type JsonValueList
- type JsonValue_List
- type JsonValue_Node
- type JsonValue_ValueProvider
- type PathSegment
- func (*PathSegment) Descriptor() ([]byte, []int)deprecated
- func (x *PathSegment) GetAll() bool
- func (x *PathSegment) GetIndex() uint32
- func (x *PathSegment) GetKey() string
- func (m *PathSegment) GetSegment() isPathSegment_Segment
- func (*PathSegment) ProtoMessage()
- func (x *PathSegment) ProtoReflect() protoreflect.Message
- func (x *PathSegment) Reset()
- func (x *PathSegment) String() string
- type PathSegment_All
- type PathSegment_Index
- type PathSegment_Key
- type Query
- type QueryMatcher
- func (*QueryMatcher) Descriptor() ([]byte, []int)deprecated
- func (x *QueryMatcher) GetFieldMatcher() *QueryMatcher_FieldMatcher
- func (m *QueryMatcher) GetMatch() isQueryMatcher_Match
- func (*QueryMatcher) ProtoMessage()
- func (x *QueryMatcher) ProtoReflect() protoreflect.Message
- func (x *QueryMatcher) Reset()
- func (x *QueryMatcher) String() string
- type QueryMatcher_FieldMatcher
- func (*QueryMatcher_FieldMatcher) Descriptor() ([]byte, []int)deprecated
- func (x *QueryMatcher_FieldMatcher) GetField() string
- func (x *QueryMatcher_FieldMatcher) GetType() string
- func (*QueryMatcher_FieldMatcher) ProtoMessage()
- func (x *QueryMatcher_FieldMatcher) ProtoReflect() protoreflect.Message
- func (x *QueryMatcher_FieldMatcher) Reset()
- func (x *QueryMatcher_FieldMatcher) String() string
- type QueryMatcher_FieldMatcher_
- type RESTResolver
- func (*RESTResolver) Descriptor() ([]byte, []int)deprecated
- func (x *RESTResolver) GetRequestTransform() *RequestTemplate
- func (x *RESTResolver) GetServerUri() *v3.HttpUri
- func (x *RESTResolver) GetSpanName() string
- func (*RESTResolver) ProtoMessage()
- func (x *RESTResolver) ProtoReflect() protoreflect.Message
- func (x *RESTResolver) Reset()
- func (x *RESTResolver) String() string
- type RequestTemplate
- func (*RequestTemplate) Descriptor() ([]byte, []int)deprecated
- func (x *RequestTemplate) GetHeaders() map[string]*ValueProvider
- func (x *RequestTemplate) GetOutgoingBody() *JsonValue
- func (x *RequestTemplate) GetQueryParams() map[string]*ValueProvider
- func (*RequestTemplate) ProtoMessage()
- func (x *RequestTemplate) ProtoReflect() protoreflect.Message
- func (x *RequestTemplate) Reset()
- func (x *RequestTemplate) String() string
- type Resolution
- func (*Resolution) Descriptor() ([]byte, []int)deprecated
- func (x *Resolution) GetMatcher() *QueryMatcher
- func (x *Resolution) GetResolver() *v3.TypedExtensionConfig
- func (*Resolution) ProtoMessage()
- func (x *Resolution) ProtoReflect() protoreflect.Message
- func (x *Resolution) Reset()
- func (x *Resolution) String() string
- type ResponseTemplate
- type ValueProvider
- func (*ValueProvider) Descriptor() ([]byte, []int)deprecated
- func (x *ValueProvider) GetGraphqlArg() *ValueProvider_GraphQLArgExtraction
- func (x *ValueProvider) GetGraphqlParent() *ValueProvider_GraphQLParentExtraction
- func (m *ValueProvider) GetProvider() isValueProvider_Provider
- func (x *ValueProvider) GetProviderTemplate() string
- func (x *ValueProvider) GetTypedProvider() *ValueProvider_TypedValueProvider
- func (*ValueProvider) ProtoMessage()
- func (x *ValueProvider) ProtoReflect() protoreflect.Message
- func (x *ValueProvider) Reset()
- func (x *ValueProvider) String() string
- type ValueProvider_GraphQLArgExtraction
- func (*ValueProvider_GraphQLArgExtraction) Descriptor() ([]byte, []int)deprecated
- func (x *ValueProvider_GraphQLArgExtraction) GetArgName() string
- func (x *ValueProvider_GraphQLArgExtraction) GetPath() []*PathSegment
- func (x *ValueProvider_GraphQLArgExtraction) GetRequired() bool
- func (*ValueProvider_GraphQLArgExtraction) ProtoMessage()
- func (x *ValueProvider_GraphQLArgExtraction) ProtoReflect() protoreflect.Message
- func (x *ValueProvider_GraphQLArgExtraction) Reset()
- func (x *ValueProvider_GraphQLArgExtraction) String() string
- type ValueProvider_GraphQLParentExtraction
- func (*ValueProvider_GraphQLParentExtraction) Descriptor() ([]byte, []int)deprecated
- func (x *ValueProvider_GraphQLParentExtraction) GetPath() []*PathSegment
- func (*ValueProvider_GraphQLParentExtraction) ProtoMessage()
- func (x *ValueProvider_GraphQLParentExtraction) ProtoReflect() protoreflect.Message
- func (x *ValueProvider_GraphQLParentExtraction) Reset()
- func (x *ValueProvider_GraphQLParentExtraction) String() string
- type ValueProvider_GraphqlArg
- type ValueProvider_GraphqlParent
- type ValueProvider_TypedProvider
- type ValueProvider_TypedValueProvider
- func (*ValueProvider_TypedValueProvider) Descriptor() ([]byte, []int)deprecated
- func (x *ValueProvider_TypedValueProvider) GetHeader() string
- func (x *ValueProvider_TypedValueProvider) GetType() ValueProvider_TypedValueProvider_Type
- func (m *ValueProvider_TypedValueProvider) GetValProvider() isValueProvider_TypedValueProvider_ValProvider
- func (x *ValueProvider_TypedValueProvider) GetValue() string
- func (*ValueProvider_TypedValueProvider) ProtoMessage()
- func (x *ValueProvider_TypedValueProvider) ProtoReflect() protoreflect.Message
- func (x *ValueProvider_TypedValueProvider) Reset()
- func (x *ValueProvider_TypedValueProvider) String() string
- type ValueProvider_TypedValueProvider_Header
- type ValueProvider_TypedValueProvider_Type
- func (ValueProvider_TypedValueProvider_Type) Descriptor() protoreflect.EnumDescriptor
- func (x ValueProvider_TypedValueProvider_Type) Enum() *ValueProvider_TypedValueProvider_Type
- func (ValueProvider_TypedValueProvider_Type) EnumDescriptor() ([]byte, []int)deprecated
- func (x ValueProvider_TypedValueProvider_Type) Number() protoreflect.EnumNumber
- func (x ValueProvider_TypedValueProvider_Type) String() string
- func (ValueProvider_TypedValueProvider_Type) Type() protoreflect.EnumType
- type ValueProvider_TypedValueProvider_Value
Constants ¶
This section is empty.
Variables ¶
var ( ValueProvider_TypedValueProvider_Type_name = map[int32]string{ 0: "STRING", 1: "INT", 2: "FLOAT", 3: "BOOLEAN", } ValueProvider_TypedValueProvider_Type_value = map[string]int32{ "STRING": 0, "INT": 1, "FLOAT": 2, "BOOLEAN": 3, } )
Enum value maps for ValueProvider_TypedValueProvider_Type.
var File_github_com_solo_io_gloo_projects_gloo_api_external_envoy_extensions_graphql_graphql_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type AbstractTypeResolver ¶
type AbstractTypeResolver struct {
// contains filtered or unexported fields
}
NOT IMPLEMENTED Resolve an abstract type (union or interface) to a real type. When implemented, this message will be a field in the Resolution message.
func (*AbstractTypeResolver) Descriptor
deprecated
func (*AbstractTypeResolver) Descriptor() ([]byte, []int)
Deprecated: Use AbstractTypeResolver.ProtoReflect.Descriptor instead.
func (*AbstractTypeResolver) ProtoMessage ¶
func (*AbstractTypeResolver) ProtoMessage()
func (*AbstractTypeResolver) ProtoReflect ¶
func (x *AbstractTypeResolver) ProtoReflect() protoreflect.Message
func (*AbstractTypeResolver) Reset ¶
func (x *AbstractTypeResolver) Reset()
func (*AbstractTypeResolver) String ¶
func (x *AbstractTypeResolver) String() string
type GraphQLConfig ¶
type GraphQLConfig struct {
// contains filtered or unexported fields
}
Filter Listener config. Empty as the filter must be configured on the route level.
func (*GraphQLConfig) Descriptor
deprecated
func (*GraphQLConfig) Descriptor() ([]byte, []int)
Deprecated: Use GraphQLConfig.ProtoReflect.Descriptor instead.
func (*GraphQLConfig) ProtoMessage ¶
func (*GraphQLConfig) ProtoMessage()
func (*GraphQLConfig) ProtoReflect ¶
func (x *GraphQLConfig) ProtoReflect() protoreflect.Message
func (*GraphQLConfig) Reset ¶
func (x *GraphQLConfig) Reset()
func (*GraphQLConfig) String ¶
func (x *GraphQLConfig) String() string
type GraphQLRouteConfig ¶
type GraphQLRouteConfig struct { // Schema to use in string format. Schema *v3.DataSource `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"` // Do we enable introspection for the schema? general recommendation is to disable this for production // and hence it defaults to false. EnableIntrospection bool `protobuf:"varint,2,opt,name=enable_introspection,json=enableIntrospection,proto3" json:"enable_introspection,omitempty"` // The resolver map to use to resolve the schema. Resolutions []*Resolution `protobuf:"bytes,3,rep,name=resolutions,proto3" json:"resolutions,omitempty"` // contains filtered or unexported fields }
Filter Route config. Routes that have this config will execute graphql queries, and will not make it to the router filter. i.e. this filter will terminate the request for these routes.
func (*GraphQLRouteConfig) Descriptor
deprecated
func (*GraphQLRouteConfig) Descriptor() ([]byte, []int)
Deprecated: Use GraphQLRouteConfig.ProtoReflect.Descriptor instead.
func (*GraphQLRouteConfig) GetEnableIntrospection ¶ added in v1.10.0
func (x *GraphQLRouteConfig) GetEnableIntrospection() bool
func (*GraphQLRouteConfig) GetResolutions ¶ added in v1.10.0
func (x *GraphQLRouteConfig) GetResolutions() []*Resolution
func (*GraphQLRouteConfig) GetSchema ¶ added in v1.10.0
func (x *GraphQLRouteConfig) GetSchema() *v3.DataSource
func (*GraphQLRouteConfig) ProtoMessage ¶
func (*GraphQLRouteConfig) ProtoMessage()
func (*GraphQLRouteConfig) ProtoReflect ¶
func (x *GraphQLRouteConfig) ProtoReflect() protoreflect.Message
func (*GraphQLRouteConfig) Reset ¶
func (x *GraphQLRouteConfig) Reset()
func (*GraphQLRouteConfig) String ¶
func (x *GraphQLRouteConfig) String() string
type JsonKeyValue ¶
type JsonKeyValue struct { // PARTIALLY IMPLEMENTED // if empty, the value will be parsed as json and replace the entire // previously-parsed json value --> this part is only needed for gRPC // and thus not implemented yet Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` Value *JsonValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
func (*JsonKeyValue) Descriptor
deprecated
func (*JsonKeyValue) Descriptor() ([]byte, []int)
Deprecated: Use JsonKeyValue.ProtoReflect.Descriptor instead.
func (*JsonKeyValue) GetKey ¶
func (x *JsonKeyValue) GetKey() string
func (*JsonKeyValue) GetValue ¶
func (x *JsonKeyValue) GetValue() *JsonValue
func (*JsonKeyValue) ProtoMessage ¶
func (*JsonKeyValue) ProtoMessage()
func (*JsonKeyValue) ProtoReflect ¶
func (x *JsonKeyValue) ProtoReflect() protoreflect.Message
func (*JsonKeyValue) Reset ¶
func (x *JsonKeyValue) Reset()
func (*JsonKeyValue) String ¶
func (x *JsonKeyValue) String() string
type JsonNode ¶
type JsonNode struct { // if keys repeat, the latest one replaces any earlier values associated // with that key. // // repeated list, rather than a map, to have ordering to allow for merge // semantics within the data plane, for example: // - gRPC input uses special empty string for input key to set entire body // - gRPC wants to replace a certain field in parsed body from GraphQL arg KeyValues []*JsonKeyValue `protobuf:"bytes,1,rep,name=key_values,json=keyValues,proto3" json:"key_values,omitempty"` // contains filtered or unexported fields }
Represents a typed JSON structure
func (*JsonNode) Descriptor
deprecated
func (*JsonNode) GetKeyValues ¶
func (x *JsonNode) GetKeyValues() []*JsonKeyValue
func (*JsonNode) ProtoMessage ¶
func (*JsonNode) ProtoMessage()
func (*JsonNode) ProtoReflect ¶
func (x *JsonNode) ProtoReflect() protoreflect.Message
type JsonValue ¶
type JsonValue struct { // Types that are assignable to JsonVal: // *JsonValue_Node // *JsonValue_ValueProvider // *JsonValue_List JsonVal isJsonValue_JsonVal `protobuf_oneof:"json_val"` // contains filtered or unexported fields }
func (*JsonValue) Descriptor
deprecated
func (*JsonValue) GetJsonVal ¶
func (m *JsonValue) GetJsonVal() isJsonValue_JsonVal
func (*JsonValue) GetList ¶
func (x *JsonValue) GetList() *JsonValueList
func (*JsonValue) GetValueProvider ¶
func (x *JsonValue) GetValueProvider() *ValueProvider
func (*JsonValue) ProtoMessage ¶
func (*JsonValue) ProtoMessage()
func (*JsonValue) ProtoReflect ¶
func (x *JsonValue) ProtoReflect() protoreflect.Message
type JsonValueList ¶
type JsonValueList struct { Values []*JsonValue `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"` // contains filtered or unexported fields }
func (*JsonValueList) Descriptor
deprecated
func (*JsonValueList) Descriptor() ([]byte, []int)
Deprecated: Use JsonValueList.ProtoReflect.Descriptor instead.
func (*JsonValueList) GetValues ¶
func (x *JsonValueList) GetValues() []*JsonValue
func (*JsonValueList) ProtoMessage ¶
func (*JsonValueList) ProtoMessage()
func (*JsonValueList) ProtoReflect ¶
func (x *JsonValueList) ProtoReflect() protoreflect.Message
func (*JsonValueList) Reset ¶
func (x *JsonValueList) Reset()
func (*JsonValueList) String ¶
func (x *JsonValueList) String() string
type JsonValue_List ¶
type JsonValue_List struct {
List *JsonValueList `protobuf:"bytes,3,opt,name=list,proto3,oneof"`
}
type JsonValue_Node ¶
type JsonValue_Node struct {
Node *JsonNode `protobuf:"bytes,1,opt,name=node,proto3,oneof"`
}
type JsonValue_ValueProvider ¶
type JsonValue_ValueProvider struct {
ValueProvider *ValueProvider `protobuf:"bytes,2,opt,name=value_provider,json=valueProvider,proto3,oneof"`
}
type PathSegment ¶
type PathSegment struct { // Types that are assignable to Segment: // *PathSegment_Key // *PathSegment_Index // *PathSegment_All Segment isPathSegment_Segment `protobuf_oneof:"segment"` // contains filtered or unexported fields }
used to reference into json structures by key(s)
func (*PathSegment) Descriptor
deprecated
func (*PathSegment) Descriptor() ([]byte, []int)
Deprecated: Use PathSegment.ProtoReflect.Descriptor instead.
func (*PathSegment) GetAll ¶
func (x *PathSegment) GetAll() bool
func (*PathSegment) GetIndex ¶
func (x *PathSegment) GetIndex() uint32
func (*PathSegment) GetKey ¶
func (x *PathSegment) GetKey() string
func (*PathSegment) GetSegment ¶
func (m *PathSegment) GetSegment() isPathSegment_Segment
func (*PathSegment) ProtoMessage ¶
func (*PathSegment) ProtoMessage()
func (*PathSegment) ProtoReflect ¶
func (x *PathSegment) ProtoReflect() protoreflect.Message
func (*PathSegment) Reset ¶
func (x *PathSegment) Reset()
func (*PathSegment) String ¶
func (x *PathSegment) String() string
type PathSegment_All ¶
type PathSegment_All struct { // all selects all from the current element at in the path. This is useful for extracting list arguments / object arguments. All bool `protobuf:"varint,3,opt,name=all,proto3,oneof"` }
type PathSegment_Index ¶
type PathSegment_Index struct { // Index is used to extract an element at a certain index from a list Index uint32 `protobuf:"varint,2,opt,name=index,proto3,oneof"` }
type PathSegment_Key ¶
type PathSegment_Key struct { // Key is used to extract named values from a map Key string `protobuf:"bytes,1,opt,name=key,proto3,oneof"` }
type Query ¶ added in v1.10.0
type Query struct { Query *v3.DataSource `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` // contains filtered or unexported fields }
NOT IMPLEMENTED When we'll support prepared queries, this will be the type containing the query.
func (*Query) Descriptor
deprecated
added in
v1.10.0
func (*Query) GetQuery ¶ added in v1.10.0
func (x *Query) GetQuery() *v3.DataSource
func (*Query) ProtoMessage ¶ added in v1.10.0
func (*Query) ProtoMessage()
func (*Query) ProtoReflect ¶ added in v1.10.0
func (x *Query) ProtoReflect() protoreflect.Message
type QueryMatcher ¶
type QueryMatcher struct { // Types that are assignable to Match: // *QueryMatcher_FieldMatcher_ Match isQueryMatcher_Match `protobuf_oneof:"match"` // contains filtered or unexported fields }
func (*QueryMatcher) Descriptor
deprecated
func (*QueryMatcher) Descriptor() ([]byte, []int)
Deprecated: Use QueryMatcher.ProtoReflect.Descriptor instead.
func (*QueryMatcher) GetFieldMatcher ¶
func (x *QueryMatcher) GetFieldMatcher() *QueryMatcher_FieldMatcher
func (*QueryMatcher) GetMatch ¶
func (m *QueryMatcher) GetMatch() isQueryMatcher_Match
func (*QueryMatcher) ProtoMessage ¶
func (*QueryMatcher) ProtoMessage()
func (*QueryMatcher) ProtoReflect ¶
func (x *QueryMatcher) ProtoReflect() protoreflect.Message
func (*QueryMatcher) Reset ¶
func (x *QueryMatcher) Reset()
func (*QueryMatcher) String ¶
func (x *QueryMatcher) String() string
type QueryMatcher_FieldMatcher ¶
type QueryMatcher_FieldMatcher struct { // Object type. For example, Query. Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` // Field with in the object. Field string `protobuf:"bytes,2,opt,name=field,proto3" json:"field,omitempty"` // contains filtered or unexported fields }
func (*QueryMatcher_FieldMatcher) Descriptor
deprecated
func (*QueryMatcher_FieldMatcher) Descriptor() ([]byte, []int)
Deprecated: Use QueryMatcher_FieldMatcher.ProtoReflect.Descriptor instead.
func (*QueryMatcher_FieldMatcher) GetField ¶
func (x *QueryMatcher_FieldMatcher) GetField() string
func (*QueryMatcher_FieldMatcher) GetType ¶
func (x *QueryMatcher_FieldMatcher) GetType() string
func (*QueryMatcher_FieldMatcher) ProtoMessage ¶
func (*QueryMatcher_FieldMatcher) ProtoMessage()
func (*QueryMatcher_FieldMatcher) ProtoReflect ¶
func (x *QueryMatcher_FieldMatcher) ProtoReflect() protoreflect.Message
func (*QueryMatcher_FieldMatcher) Reset ¶
func (x *QueryMatcher_FieldMatcher) Reset()
func (*QueryMatcher_FieldMatcher) String ¶
func (x *QueryMatcher_FieldMatcher) String() string
type QueryMatcher_FieldMatcher_ ¶
type QueryMatcher_FieldMatcher_ struct {
FieldMatcher *QueryMatcher_FieldMatcher `protobuf:"bytes,1,opt,name=field_matcher,json=fieldMatcher,proto3,oneof"`
}
type RESTResolver ¶
type RESTResolver struct { ServerUri *v3.HttpUri `protobuf:"bytes,1,opt,name=server_uri,json=serverUri,proto3" json:"server_uri,omitempty"` // configuration used to compose the outgoing request to a REST API RequestTransform *RequestTemplate `protobuf:"bytes,2,opt,name=request_transform,json=requestTransform,proto3" json:"request_transform,omitempty"` // pre-execution engine transformations // // Request flow: GraphQL request -> request_transform (instantiate REST request) -> // REST API resp -> pre_execution_transform -> execution engine -> // complete GraphQL field response // //ResponseTemplate pre_execution_transform = 3; SpanName string `protobuf:"bytes,4,opt,name=span_name,json=spanName,proto3" json:"span_name,omitempty"` // contains filtered or unexported fields }
func (*RESTResolver) Descriptor
deprecated
func (*RESTResolver) Descriptor() ([]byte, []int)
Deprecated: Use RESTResolver.ProtoReflect.Descriptor instead.
func (*RESTResolver) GetRequestTransform ¶
func (x *RESTResolver) GetRequestTransform() *RequestTemplate
func (*RESTResolver) GetServerUri ¶
func (x *RESTResolver) GetServerUri() *v3.HttpUri
func (*RESTResolver) GetSpanName ¶
func (x *RESTResolver) GetSpanName() string
func (*RESTResolver) ProtoMessage ¶
func (*RESTResolver) ProtoMessage()
func (*RESTResolver) ProtoReflect ¶
func (x *RESTResolver) ProtoReflect() protoreflect.Message
func (*RESTResolver) Reset ¶
func (x *RESTResolver) Reset()
func (*RESTResolver) String ¶
func (x *RESTResolver) String() string
type RequestTemplate ¶
type RequestTemplate struct { // Use this attribute to set request headers to your REST service. It consists of a // map of strings to value providers. The string key determines the name of the // resulting header, the value provided will be the value. // // at least need ":method" and ":path" Headers map[string]*ValueProvider `` /* 155-byte string literal not displayed */ // Use this attribute to set query parameters to your REST service. It consists of a // map of strings to value providers. The string key determines the name of the // query param, the provided value will be the value. This value is appended to any // value set to the :path header in `headers`. // // Interpolation is done in envoy rather than the control plane to prevent escaped // character issues. Additionally, we may be providing values not known until // the request is being executed (e.g., graphql parent info). QueryParams map[string]*ValueProvider `` /* 182-byte string literal not displayed */ // Used to construct the outgoing body to the upstream from the // graphql value providers. OutgoingBody *JsonValue `protobuf:"bytes,3,opt,name=outgoing_body,json=outgoingBody,proto3" json:"outgoing_body,omitempty"` // contains filtered or unexported fields }
Defines a configuration for generating outgoing requests for a resolver.
func (*RequestTemplate) Descriptor
deprecated
func (*RequestTemplate) Descriptor() ([]byte, []int)
Deprecated: Use RequestTemplate.ProtoReflect.Descriptor instead.
func (*RequestTemplate) GetHeaders ¶
func (x *RequestTemplate) GetHeaders() map[string]*ValueProvider
func (*RequestTemplate) GetOutgoingBody ¶
func (x *RequestTemplate) GetOutgoingBody() *JsonValue
func (*RequestTemplate) GetQueryParams ¶
func (x *RequestTemplate) GetQueryParams() map[string]*ValueProvider
func (*RequestTemplate) ProtoMessage ¶
func (*RequestTemplate) ProtoMessage()
func (*RequestTemplate) ProtoReflect ¶
func (x *RequestTemplate) ProtoReflect() protoreflect.Message
func (*RequestTemplate) Reset ¶
func (x *RequestTemplate) Reset()
func (*RequestTemplate) String ¶
func (x *RequestTemplate) String() string
type Resolution ¶
type Resolution struct { // Match an object type and field Matcher *QueryMatcher `protobuf:"bytes,1,opt,name=matcher,proto3" json:"matcher,omitempty"` // The resolver to use. Resolver *v3.TypedExtensionConfig `protobuf:"bytes,2,opt,name=resolver,proto3" json:"resolver,omitempty"` // contains filtered or unexported fields }
This is the resolver map for the schema. For each Type.Field, we can define a resolver. if a field does not have resolver, the default resolver will be used. the default resolver takes the field with the same name from the parent, and uses that value to resolve the field. if a field with the same name does not exist in the parent, null will be used.
func (*Resolution) Descriptor
deprecated
func (*Resolution) Descriptor() ([]byte, []int)
Deprecated: Use Resolution.ProtoReflect.Descriptor instead.
func (*Resolution) GetMatcher ¶
func (x *Resolution) GetMatcher() *QueryMatcher
func (*Resolution) GetResolver ¶
func (x *Resolution) GetResolver() *v3.TypedExtensionConfig
func (*Resolution) ProtoMessage ¶
func (*Resolution) ProtoMessage()
func (*Resolution) ProtoReflect ¶
func (x *Resolution) ProtoReflect() protoreflect.Message
func (*Resolution) Reset ¶
func (x *Resolution) Reset()
func (*Resolution) String ¶
func (x *Resolution) String() string
type ResponseTemplate ¶
type ResponseTemplate struct {
// contains filtered or unexported fields
}
NOT IMPLEMENTED Defines a response transformation template.
func (*ResponseTemplate) Descriptor
deprecated
func (*ResponseTemplate) Descriptor() ([]byte, []int)
Deprecated: Use ResponseTemplate.ProtoReflect.Descriptor instead.
func (*ResponseTemplate) ProtoMessage ¶
func (*ResponseTemplate) ProtoMessage()
func (*ResponseTemplate) ProtoReflect ¶
func (x *ResponseTemplate) ProtoReflect() protoreflect.Message
func (*ResponseTemplate) Reset ¶
func (x *ResponseTemplate) Reset()
func (*ResponseTemplate) String ¶
func (x *ResponseTemplate) String() string
type ValueProvider ¶
type ValueProvider struct { // Types that are assignable to Provider: // *ValueProvider_GraphqlArg // *ValueProvider_TypedProvider // *ValueProvider_GraphqlParent Provider isValueProvider_Provider `protobuf_oneof:"provider"` // If non-empty, the template to interpolate the extracted value into. // For example, if the string is /api/pets/{}/name and the extracted value 123 is the pet // ID will then the extracted value is /api/pets/123/name // Use {} as the interpolation character (even repeated) regardless of the type of the // provided value. ProviderTemplate string `protobuf:"bytes,4,opt,name=provider_template,json=providerTemplate,proto3" json:"provider_template,omitempty"` // contains filtered or unexported fields }
In the future we may add support for regex and subgroups
func (*ValueProvider) Descriptor
deprecated
func (*ValueProvider) Descriptor() ([]byte, []int)
Deprecated: Use ValueProvider.ProtoReflect.Descriptor instead.
func (*ValueProvider) GetGraphqlArg ¶
func (x *ValueProvider) GetGraphqlArg() *ValueProvider_GraphQLArgExtraction
func (*ValueProvider) GetGraphqlParent ¶
func (x *ValueProvider) GetGraphqlParent() *ValueProvider_GraphQLParentExtraction
func (*ValueProvider) GetProvider ¶
func (m *ValueProvider) GetProvider() isValueProvider_Provider
func (*ValueProvider) GetProviderTemplate ¶
func (x *ValueProvider) GetProviderTemplate() string
func (*ValueProvider) GetTypedProvider ¶
func (x *ValueProvider) GetTypedProvider() *ValueProvider_TypedValueProvider
func (*ValueProvider) ProtoMessage ¶
func (*ValueProvider) ProtoMessage()
func (*ValueProvider) ProtoReflect ¶
func (x *ValueProvider) ProtoReflect() protoreflect.Message
func (*ValueProvider) Reset ¶
func (x *ValueProvider) Reset()
func (*ValueProvider) String ¶
func (x *ValueProvider) String() string
type ValueProvider_GraphQLArgExtraction ¶
type ValueProvider_GraphQLArgExtraction struct { // The argument name to fetch. The argument value fetched // will have a type from the schema that we validate in envoy. // If the name is invalid, returns the zero-value primitive or null. ArgName string `protobuf:"bytes,1,opt,name=arg_name,json=argName,proto3" json:"arg_name,omitempty"` // Optional: fetches the value in the argument selected at this key. // If the key is invalid, returns the zero-value primitive or null. Path []*PathSegment `protobuf:"bytes,2,rep,name=path,proto3" json:"path,omitempty"` // If this is set to true, then a schema error will be returned to user when the graphql arg is not found. // Defaults to false, so schema error will not be returned to user when the graphql arg is not found. Required bool `protobuf:"varint,3,opt,name=required,proto3" json:"required,omitempty"` // contains filtered or unexported fields }
func (*ValueProvider_GraphQLArgExtraction) Descriptor
deprecated
func (*ValueProvider_GraphQLArgExtraction) Descriptor() ([]byte, []int)
Deprecated: Use ValueProvider_GraphQLArgExtraction.ProtoReflect.Descriptor instead.
func (*ValueProvider_GraphQLArgExtraction) GetArgName ¶
func (x *ValueProvider_GraphQLArgExtraction) GetArgName() string
func (*ValueProvider_GraphQLArgExtraction) GetPath ¶
func (x *ValueProvider_GraphQLArgExtraction) GetPath() []*PathSegment
func (*ValueProvider_GraphQLArgExtraction) GetRequired ¶ added in v1.10.0
func (x *ValueProvider_GraphQLArgExtraction) GetRequired() bool
func (*ValueProvider_GraphQLArgExtraction) ProtoMessage ¶
func (*ValueProvider_GraphQLArgExtraction) ProtoMessage()
func (*ValueProvider_GraphQLArgExtraction) ProtoReflect ¶
func (x *ValueProvider_GraphQLArgExtraction) ProtoReflect() protoreflect.Message
func (*ValueProvider_GraphQLArgExtraction) Reset ¶
func (x *ValueProvider_GraphQLArgExtraction) Reset()
func (*ValueProvider_GraphQLArgExtraction) String ¶
func (x *ValueProvider_GraphQLArgExtraction) String() string
type ValueProvider_GraphQLParentExtraction ¶
type ValueProvider_GraphQLParentExtraction struct { // Fetches the value in the graphql parent at this key. The value will // always be accepted since the parent object is not strongly-typed. // If the key is invalid, returns null. Path []*PathSegment `protobuf:"bytes,1,rep,name=path,proto3" json:"path,omitempty"` // contains filtered or unexported fields }
Does not do type coercion, but instead if the type does not match the expected primitive type we throw an error. In the future we may add support for type coercion.
func (*ValueProvider_GraphQLParentExtraction) Descriptor
deprecated
func (*ValueProvider_GraphQLParentExtraction) Descriptor() ([]byte, []int)
Deprecated: Use ValueProvider_GraphQLParentExtraction.ProtoReflect.Descriptor instead.
func (*ValueProvider_GraphQLParentExtraction) GetPath ¶
func (x *ValueProvider_GraphQLParentExtraction) GetPath() []*PathSegment
func (*ValueProvider_GraphQLParentExtraction) ProtoMessage ¶
func (*ValueProvider_GraphQLParentExtraction) ProtoMessage()
func (*ValueProvider_GraphQLParentExtraction) ProtoReflect ¶
func (x *ValueProvider_GraphQLParentExtraction) ProtoReflect() protoreflect.Message
func (*ValueProvider_GraphQLParentExtraction) Reset ¶
func (x *ValueProvider_GraphQLParentExtraction) Reset()
func (*ValueProvider_GraphQLParentExtraction) String ¶
func (x *ValueProvider_GraphQLParentExtraction) String() string
type ValueProvider_GraphqlArg ¶
type ValueProvider_GraphqlArg struct { // type inferred from schema, no need to provide it. GraphqlArg *ValueProvider_GraphQLArgExtraction `protobuf:"bytes,1,opt,name=graphql_arg,json=graphqlArg,proto3,oneof"` }
type ValueProvider_GraphqlParent ¶
type ValueProvider_GraphqlParent struct { // Fetch value from the graphql_parent of the current field. GraphqlParent *ValueProvider_GraphQLParentExtraction `protobuf:"bytes,3,opt,name=graphql_parent,json=graphqlParent,proto3,oneof"` }
type ValueProvider_TypedProvider ¶
type ValueProvider_TypedProvider struct {
TypedProvider *ValueProvider_TypedValueProvider `protobuf:"bytes,2,opt,name=typed_provider,json=typedProvider,proto3,oneof"`
}
type ValueProvider_TypedValueProvider ¶
type ValueProvider_TypedValueProvider struct { // Type that the value will be coerced into. // For example if the extracted value is "9", and type is INT, // this value will be cast to an int type. Type ValueProvider_TypedValueProvider_Type `` /* 141-byte string literal not displayed */ // Types that are assignable to ValProvider: // *ValueProvider_TypedValueProvider_Header // *ValueProvider_TypedValueProvider_Value ValProvider isValueProvider_TypedValueProvider_ValProvider `protobuf_oneof:"val_provider"` // contains filtered or unexported fields }
func (*ValueProvider_TypedValueProvider) Descriptor
deprecated
func (*ValueProvider_TypedValueProvider) Descriptor() ([]byte, []int)
Deprecated: Use ValueProvider_TypedValueProvider.ProtoReflect.Descriptor instead.
func (*ValueProvider_TypedValueProvider) GetHeader ¶
func (x *ValueProvider_TypedValueProvider) GetHeader() string
func (*ValueProvider_TypedValueProvider) GetType ¶
func (x *ValueProvider_TypedValueProvider) GetType() ValueProvider_TypedValueProvider_Type
func (*ValueProvider_TypedValueProvider) GetValProvider ¶
func (m *ValueProvider_TypedValueProvider) GetValProvider() isValueProvider_TypedValueProvider_ValProvider
func (*ValueProvider_TypedValueProvider) GetValue ¶
func (x *ValueProvider_TypedValueProvider) GetValue() string
func (*ValueProvider_TypedValueProvider) ProtoMessage ¶
func (*ValueProvider_TypedValueProvider) ProtoMessage()
func (*ValueProvider_TypedValueProvider) ProtoReflect ¶
func (x *ValueProvider_TypedValueProvider) ProtoReflect() protoreflect.Message
func (*ValueProvider_TypedValueProvider) Reset ¶
func (x *ValueProvider_TypedValueProvider) Reset()
func (*ValueProvider_TypedValueProvider) String ¶
func (x *ValueProvider_TypedValueProvider) String() string
type ValueProvider_TypedValueProvider_Header ¶
type ValueProvider_TypedValueProvider_Header struct { // Fetches the request/response header's value. If not found, uses empty string Header string `protobuf:"bytes,2,opt,name=header,proto3,oneof"` }
type ValueProvider_TypedValueProvider_Type ¶
type ValueProvider_TypedValueProvider_Type int32
Type that the value will be coerced into. For example if the extracted value is "9", and type is INT, this value will be cast to an int type.
const ( ValueProvider_TypedValueProvider_STRING ValueProvider_TypedValueProvider_Type = 0 ValueProvider_TypedValueProvider_INT ValueProvider_TypedValueProvider_Type = 1 ValueProvider_TypedValueProvider_FLOAT ValueProvider_TypedValueProvider_Type = 2 ValueProvider_TypedValueProvider_BOOLEAN ValueProvider_TypedValueProvider_Type = 3 )
func (ValueProvider_TypedValueProvider_Type) Descriptor ¶
func (ValueProvider_TypedValueProvider_Type) Descriptor() protoreflect.EnumDescriptor
func (ValueProvider_TypedValueProvider_Type) EnumDescriptor
deprecated
func (ValueProvider_TypedValueProvider_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use ValueProvider_TypedValueProvider_Type.Descriptor instead.
func (ValueProvider_TypedValueProvider_Type) Number ¶
func (x ValueProvider_TypedValueProvider_Type) Number() protoreflect.EnumNumber
func (ValueProvider_TypedValueProvider_Type) String ¶
func (x ValueProvider_TypedValueProvider_Type) String() string
func (ValueProvider_TypedValueProvider_Type) Type ¶
func (ValueProvider_TypedValueProvider_Type) Type() protoreflect.EnumType
type ValueProvider_TypedValueProvider_Value ¶
type ValueProvider_TypedValueProvider_Value struct { // inline value, use as provided rather than extracting from another source Value string `protobuf:"bytes,3,opt,name=value,proto3,oneof"` }