v1

type Attribute struct {
	// Name of the attribute.
	//
	// Attribute Names must be unique and follow the following syntax rules:
	// One or more lowercase rfc1035/rfc1123 labels separated by '.' with a maximum length of 253 characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Attributes can apply only to one kind of resource
	// Currently available are:
	// * Listeners
	//
	// Types that are valid to be assigned to AttributeType:
	//	*Attribute_ListenerAttribute
	AttributeType isAttribute_AttributeType `protobuf_oneof:"attribute_type"`
	// Status indicates the validation status of the attribute resource.
	// Status is read-only by clients, and set by gloo during validation
	Status *Status `protobuf:"bytes,6,opt,name=status" json:"status,omitempty" testdiff:"ignore"`
	// Metadata contains the resource metadata for the attribute
	Metadata *Metadata `protobuf:"bytes,7,opt,name=metadata" json:"metadata,omitempty"`
}

type Attribute_ListenerAttribute struct {
	ListenerAttribute *ListenerAttribute `protobuf:"bytes,2,opt,name=listener_attribute,json=listenerAttribute,oneof"`
}

type Config struct {
	Upstreams       []*Upstream       `protobuf:"bytes,1,rep,name=upstreams" json:"upstreams,omitempty"`
	VirtualServices []*VirtualService `protobuf:"bytes,2,rep,name=virtual_services,json=virtualServices" json:"virtual_services,omitempty"`
	Roles           []*Role           `protobuf:"bytes,3,rep,name=roles" json:"roles,omitempty"`
	Attributes      []*Attribute      `protobuf:"bytes,4,rep,name=attributes" json:"attributes,omitempty"`
}

type ConfigObject interface {
	proto.Message
	GetName() string
	GetStatus() *Status
	GetMetadata() *Metadata
	SetName(name string)
	SetStatus(status *Status)
	SetMetadata(meta *Metadata)
}

type Destination struct {
	// Types that are valid to be assigned to DestinationType:
	//	*Destination_Function
	//	*Destination_Upstream
	DestinationType isDestination_DestinationType `protobuf_oneof:"destination_type"`
}

type Destination_Function struct {
	Function *FunctionDestination `protobuf:"bytes,1,opt,name=function,oneof"`
}

type Destination_Upstream struct {
	Upstream *UpstreamDestination `protobuf:"bytes,2,opt,name=upstream,oneof"`
}

type EventMatcher struct {
	// Event Type indicates the event type or topic to match
	EventType string `protobuf:"bytes,1,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
}

type Function struct {
	// Name of the function. Functions are referenced by name from routes and therefore must be unique within an upstream
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Spec for the function. Like [upstream specs](TODO), the content of function specs is specified by the [upstream plugin](TODO) for the upstream's type.
	Spec *google_protobuf.Struct `protobuf:"bytes,4,opt,name=spec" json:"spec,omitempty"`
}

type FunctionDestination struct {
	// Upstream Name is the name of the upstream the function belongs to
	UpstreamName string `protobuf:"bytes,1,opt,name=upstream_name,json=upstreamName,proto3" json:"upstream_name,omitempty"`
	// Function Name is the name of the function as defined on the upstream
	FunctionName string `protobuf:"bytes,2,opt,name=function_name,json=functionName,proto3" json:"function_name,omitempty"`
}

type FunctionSpec *types.Struct

type Listener struct {
	// the name of the listener. names must be unique for listeners within a role
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// the bind address for the listener.
	// both ipv4 and ipv6 formats are supported
	BindAddress string `protobuf:"bytes,2,opt,name=bind_address,json=bindAddress,proto3" json:"bind_address,omitempty"`
	// the port to bind on
	// ports numbers must be unique for listeners within a role
	BindPort uint32 `protobuf:"varint,3,opt,name=bind_port,json=bindPort,proto3" json:"bind_port,omitempty"`
	// defines the set of virtual services that will be accessible by clients connecting to this listener.
	// at least one virtual service must be specifiedfor HTTP-level features to be applied at the listener level
	VirtualServices []string `protobuf:"bytes,4,rep,name=virtual_services,json=virtualServices" json:"virtual_services,omitempty"`
	// Config contains top-level config to be applied to a listener
	// Listener config is applied to all TCP/HTTP traffic that
	// initiates via this listener.
	// Configuration such as gzip compression and TLS authentication is specified here
	Config *google_protobuf.Struct `protobuf:"bytes,5,opt,name=config" json:"config,omitempty"`
	// Apply Listener Attributes to listeners with selectors matching these label keys and values
	// If empty or not present, the Listener will inherit no configuration from Attributes.
	Labels map[string]string `` /* 146-byte string literal not displayed */
	// SSL Config is optional for the role. If provided, the listener will serve TLS for connections on this port
	// this is useful when there are no virtual services assigned to this listener, e.g. for the purpose of
	// securing a Listener functioning as a TCP Proxy
	// if no virtual services are defined and ssl_config is nil, the proxy will serve tcp connections insecurely on this port
	SslConfig *SSLConfig `protobuf:"bytes,6,opt,name=ssl_config,json=sslConfig" json:"ssl_config,omitempty"`
}

type ListenerAttribute struct {
	// Apply this attribute to listeners with label keys and values matching this
	// selector. If empty or not present, the attribute will not be applied to any listeners.
	Selector map[string]string `` /* 150-byte string literal not displayed */
	// Listeners can serve HTTP or raw TCP, but not both. If at least one Virtual Service is specified here,
	// the listener will become an HTTP listener serving routes defined in these virtual services.
	// Some Listener plugins may impose restrictions on the Virtual Services that can be applied to a listener.
	// For example, some plugins may require all applied virtual services only route to a specific upstream,
	// a common requirement for Service Meshes
	VirtualServices []string `protobuf:"bytes,4,rep,name=virtual_services,json=virtualServices" json:"virtual_services,omitempty"`
	// Config contains top-level config to be applied to a listener
	// Listener config is applied to all TCP/HTTP traffic that
	// initiates via this listener.
	// Configuration such as gzip compression and TLS authentication is specified here
	// This config struct will be merged with Role-specific Listener Conig. If two fields overlap between the
	// Listener config on the role and the config on the attribute, the config on the Role will supersede this one
	Config *google_protobuf.Struct `protobuf:"bytes,5,opt,name=config" json:"config,omitempty"`
}

type Metadata struct {
	// ResourceVersion keeps track of the resource version of a config resource. This mechanism is used by [gloo-storage](https://github.com/solo-io/gloo/pkg/storage) to ensure safety with concurrent writes/updates to a resource in storage.
	ResourceVersion string `protobuf:"bytes,1,opt,name=resource_version,json=resourceVersion,proto3" json:"resource_version,omitempty" testdiff:"ignore"`
	// Namespace is used for the namespacing of resources. Currently unused by gloo internally.
	Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// Annotations allow clients to tag resources for special use cases. gloo ignores annotations but preserved them on read/write from/to storage.
	Annotations map[string]string `` /* 156-byte string literal not displayed */
}

type RequestMatcher struct {
	// Path specifies the :path header in HTTP2, or the request URL path in HTTP 1
	//
	// Types that are valid to be assigned to Path:
	//	*RequestMatcher_PathPrefix
	//	*RequestMatcher_PathRegex
	//	*RequestMatcher_PathExact
	Path isRequestMatcher_Path `protobuf_oneof:"path"`
	// Headers specify a list of request headers and their values the request must contain to match this route
	// If a value is not specified (empty string) for a header, all values will match so long as the header is present on the request
	Headers map[string]string `` /* 148-byte string literal not displayed */
	// Query params work the same way as headers, but for query string parameters
	QueryParams map[string]string `` /* 175-byte string literal not displayed */
	// HTTP Verb(s) to match on. If none specified, the matcher will match all verbs
	Verbs []string `protobuf:"bytes,6,rep,name=verbs" json:"verbs,omitempty"`
}

type RequestMatcher_PathExact struct {
	PathExact string `protobuf:"bytes,3,opt,name=path_exact,json=pathExact,proto3,oneof"`
}

type RequestMatcher_PathPrefix struct {
	PathPrefix string `protobuf:"bytes,1,opt,name=path_prefix,json=pathPrefix,proto3,oneof"`
}

type RequestMatcher_PathRegex struct {
	PathRegex string `protobuf:"bytes,2,opt,name=path_regex,json=pathRegex,proto3,oneof"`
}

type Role struct {
	// Name of the role. Envoy nodes will be assigned a config matching the role they report to Gloo when registering
	// Envoy instances must specify their role in the prefix for their Node ID when they register to Gloo.
	//
	// Currently this is done in the format <Role>~<this portion is ignored>
	// which can be specified with the `--service-node` flag, or in the Envoy instance's bootstrap config.
	//
	// Role Names must be unique and follow the following syntax rules:
	// One or more lowercase rfc1035/rfc1123 labels separated by '.' with a maximum length of 253 characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// define each listener the proxy will create
	// listeners define a set of behaviors for a single address:port
	// where the proxy will listen
	// if no listeners are specified, the role will behave as a gateway
	// see (pkg/api/defaults/v1)[https://github.com/solo-io/gloo/tree/master/pkg/api/defaults/v1]
	// to see the default listeners that will be created for Gateway proxies
	// binding to the default HTTP (8080) and HTTPS (8443) ports on 0.0.0.0 (all interfaces)
	Listeners []*Listener `protobuf:"bytes,2,rep,name=listeners" json:"listeners,omitempty"`
	// Status indicates the validation status of the role resource.
	// Status is read-only by clients, and set by gloo during validation
	Status *Status `protobuf:"bytes,6,opt,name=status" json:"status,omitempty" testdiff:"ignore"`
	// Metadata contains the resource metadata for the role
	Metadata *Metadata `protobuf:"bytes,7,opt,name=metadata" json:"metadata,omitempty"`
}

type Route struct {
	// Matcher defines what properties of a request to match on.
	// Routes will route all requests they match.
	// If a request matches more than one route, the first route on the virtual service's route list will be selected.
	//
	// Types that are valid to be assigned to Matcher:
	//	*Route_RequestMatcher
	//	*Route_EventMatcher
	Matcher isRoute_Matcher `protobuf_oneof:"matcher"`
	// A route is only allowed to specify one of multiple_destinations or single_destination. Setting both will result in an error
	// Multiple Destinations is used when a user wants a route to balance requests between multiple destinations
	// Balancing is done by probability, where weights are specified for each destination
	MultipleDestinations []*WeightedDestination `protobuf:"bytes,3,rep,name=multiple_destinations,json=multipleDestinations" json:"multiple_destinations,omitempty"`
	// A single destination is specified when a route only routes to a single destination.
	SingleDestination *Destination `protobuf:"bytes,4,opt,name=single_destination,json=singleDestination" json:"single_destination,omitempty"`
	// PrefixRewrite can be specified to rewrite the matched path of the request path to a new prefix
	PrefixRewrite string `protobuf:"bytes,5,opt,name=prefix_rewrite,json=prefixRewrite,proto3" json:"prefix_rewrite,omitempty"`
	// Extensions provides a way to extend the behavior of a route. In addition to the core route extensions<!--(TODO)-->,
	// gloo provides the means for route plugins<!--(TODO)--> to be added to gloo which add new types of route extensions.
	// <!--See the route extensions section for a more detailed explanation-->
	Extensions *google_protobuf.Struct `protobuf:"bytes,6,opt,name=extensions" json:"extensions,omitempty"`
}

type Route_EventMatcher struct {
	EventMatcher *EventMatcher `protobuf:"bytes,2,opt,name=event_matcher,json=eventMatcher,oneof"`
}

type Route_RequestMatcher struct {
	RequestMatcher *RequestMatcher `protobuf:"bytes,1,opt,name=request_matcher,json=requestMatcher,oneof"`
}

type SSLConfig struct {
	// Types that are valid to be assigned to SslSecrets:
	//	*SSLConfig_SecretRef
	//	*SSLConfig_SslFiles
	SslSecrets isSSLConfig_SslSecrets `protobuf_oneof:"ssl_secrets"`
	// optional. the SNI domains that should be considered for TLS connections
	SniDomains []string `protobuf:"bytes,3,rep,name=sni_domains,json=sniDomains" json:"sni_domains,omitempty"`
}

type SSLConfig_SecretRef struct {
	SecretRef string `protobuf:"bytes,1,opt,name=secret_ref,json=secretRef,proto3,oneof"`
}

type SSLConfig_SslFiles struct {
	SslFiles *SSLFiles `protobuf:"bytes,2,opt,name=ssl_files,json=sslFiles,oneof"`
}

type SSLFiles struct {
	TlsCert string `protobuf:"bytes,1,opt,name=tls_cert,json=tlsCert,proto3" json:"tls_cert,omitempty"`
	TlsKey  string `protobuf:"bytes,2,opt,name=tls_key,json=tlsKey,proto3" json:"tls_key,omitempty"`
	// for client cert validation. optional
	RootCa string `protobuf:"bytes,3,opt,name=root_ca,json=rootCa,proto3" json:"root_ca,omitempty"`
}

type ServiceInfo struct {
	// Type indicates the type of service running on the upstream.
	// Current options include `REST`, `gRPC`, and `NATS`
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Properties contains properties that describe the service. The spec may be required
	// by the Upstream Plugin that handles the given Service Type
	// Most often the service properties will be a map<string, string>
	Properties *google_protobuf.Struct `protobuf:"bytes,2,opt,name=properties" json:"properties,omitempty"`
}

type Status struct {
	// State is the enum indicating the state of the resource
	State Status_State `protobuf:"varint,1,opt,name=state,proto3,enum=gloo.api.v1.Status_State" json:"state,omitempty"`
	// Reason is a description of the error for Rejected resources. If the resource is pending or accepted, this field will be empty
	Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
}

type Status_State int32

type Upstream struct {
	// Name of the upstream. Names must be unique and follow the following syntax rules:
	// One or more lowercase rfc1035/rfc1123 labels separated by '.' with a maximum length of 253 characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Type indicates the type of the upstream. Examples include static<!--(TODO)-->, kubernetes<!--(TODO)-->, and [aws](../plugins/aws.md)
	// Types are defined by the plugin<!--(TODO)--> associated with them.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Connection Timeout tells gloo to set a timeout for unresponsive connections created to this upstream.
	// If not provided by the user, it will set to a default value
	ConnectionTimeout time.Duration `protobuf:"bytes,3,opt,name=connection_timeout,json=connectionTimeout,stdduration" json:"connection_timeout"`
	// Spec contains properties that are specific to the upstream type. The spec is always required, but
	// the expected content is specified by the [upstream plugin] for the given upstream type.
	// Most often the upstream spec will be a map<string, string>
	Spec *google_protobuf.Struct `protobuf:"bytes,4,opt,name=spec" json:"spec,omitempty"`
	// Certain upstream types support (and may require) [functions](../introduction/concepts.md#Functions).
	// Functions allow function-level routing to be done. For example, the [AWS lambda](../plugins/aws.md) upstream type
	// Permits routing to AWS lambda function].
	// [routes](virtualservice.md#Route) on virtualservices can specify function destinations to route to specific functions.
	Functions []*Function `protobuf:"bytes,5,rep,name=functions" json:"functions,omitempty"`
	// Service Info contains information about the service running on the upstream
	// Service Info is optional, but is used by certain plugins (such as the gRPC plugin)
	// as well as discovery services to provide sophistocated routing features for well-known
	// types of services
	ServiceInfo *ServiceInfo `protobuf:"bytes,8,opt,name=service_info,json=serviceInfo" json:"service_info,omitempty"`
	// Status indicates the validation status of the upstream resource. Status is read-only by clients, and set by gloo during validation
	Status *Status `protobuf:"bytes,6,opt,name=status" json:"status,omitempty" testdiff:"ignore"`
	// Metadata contains the resource metadata for the upstream
	Metadata *Metadata `protobuf:"bytes,7,opt,name=metadata" json:"metadata,omitempty"`
}

type UpstreamDestination struct {
	// Name of the upstream
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
}

type UpstreamSpec *types.Struct

type VirtualService struct {
	// Name of the virtual service. Names must be unique and follow the following syntax rules:
	// One or more lowercase rfc1035/rfc1123 labels separated by '.' with a maximum length of 253 characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Domains represent the list of domains (host/authority header) that will match for all routes on this virtual service.
	// As in Envoy: wildcard hosts are supported in the form of “*.foo.com” or “*-bar.foo.com”.
	// If domains is empty, gloo will set the domain to "*", making that virtual service the "default" virtualservice.
	// The default virtualservice will be the fallback virtual service for all requests that do not match a domain on an existing virtual service.
	// Only one default virtual service can be defined (either with an empty domain list, or a domain list that includes "*")
	Domains []string `protobuf:"bytes,2,rep,name=domains" json:"domains,omitempty"`
	// Routes define the list of [routes](../) that live on this virtual service.
	Routes []*Route `protobuf:"bytes,3,rep,name=routes" json:"routes,omitempty"`
	// SSL Config is optional for the virtual service. If provided, the virtual service will listen on the envoy HTTPS listener port (default :8443)
	// If left empty, the virtual service will listen on the HTTP listener port (default :8080)
	SslConfig *SSLConfig `protobuf:"bytes,4,opt,name=ssl_config,json=sslConfig" json:"ssl_config,omitempty"`
	// indicates whether or not this virtual service should be assigned to gateway roles automatically
	// TODO: eventually this flag will be deprecated; gateway roles will have to explicitly state the virtual services
	// they have access to.
	DisableForGateways bool `protobuf:"varint,7,opt,name=disable_for_gateways,json=disableForGateways,proto3" json:"disable_for_gateways,omitempty"`
	// Status indicates the validation status of the virtual service resource. Status is read-only by clients, and set by gloo during validation
	Status *Status `protobuf:"bytes,5,opt,name=status" json:"status,omitempty" testdiff:"ignore"`
	// Metadata contains the resource metadata for the virtual service
	Metadata *Metadata `protobuf:"bytes,6,opt,name=metadata" json:"metadata,omitempty"`
}

type WeightedDestination struct {
	*Destination `protobuf:"bytes,1,opt,name=destination,embedded=destination" json:"destination,omitempty"`
	// Weight must be greater than zero
	// Routing to each destination will be balanced by the ratio of the destination's weight to the total weight on a route
	Weight uint32 `protobuf:"varint,2,opt,name=weight,proto3" json:"weight,omitempty"`
}