proto

type Action struct {

	// The name of the model this action belongs to.
	ModelName string `protobuf:"bytes,1,opt,name=model_name,json=modelName,proto3" json:"model_name,omitempty"`
	// The name of the action. Must be in lowerCamelCase and be unique across all actions
	// across all models within the schema. This is because in both RPC and GraphQL actions
	// are top-level and so two different models can't both define an actions with the same name.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// The type of this action.
	Type ActionType `protobuf:"varint,3,opt,name=type,proto3,enum=proto.ActionType" json:"type,omitempty"`
	// Whether this action will be auto-generated by Keel or implemented with a function.
	Implementation ActionImplementation `protobuf:"varint,4,opt,name=implementation,proto3,enum=proto.ActionImplementation" json:"implementation,omitempty"`
	// A list of permission rules to apply to this action
	Permissions []*PermissionRule `protobuf:"bytes,6,rep,name=permissions,proto3" json:"permissions,omitempty"`
	// A list of assignment expression to be executed as part of this action.
	// Only valid in `type` is ACTION_TYPE_CREATE or ACTION_TYPE_UPDATE
	SetExpressions []*Expression `protobuf:"bytes,7,rep,name=set_expressions,json=setExpressions,proto3" json:"set_expressions,omitempty"`
	// A list of logical expressions to be applied to the database query being
	// executed as part of the action.
	// Not valid if `type` is ACTION_TYPE_CREATE
	// If there are multiple entries in this field they are AND'd.
	WhereExpressions []*Expression `protobuf:"bytes,8,rep,name=where_expressions,json=whereExpressions,proto3" json:"where_expressions,omitempty"`
	// A list of expressions that perform some kind of validation (likely on the inputs).
	ValidationExpressions []*Expression `protobuf:"bytes,9,rep,name=validation_expressions,json=validationExpressions,proto3" json:"validation_expressions,omitempty"`
	// A ordered list of order by statements.
	OrderBy []*OrderByStatement `protobuf:"bytes,10,rep,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// The name of the input message type for this action.
	// This can be an empty string if there are no inputs and therefore no input message.
	InputMessageName string `protobuf:"bytes,11,opt,name=input_message_name,json=inputMessageName,proto3" json:"input_message_name,omitempty"`
	// The name of the response message type for this action when not a built-in action. This is because
	// built-in action responses are determined by the action type (get, list, create, update, delete).
	ResponseMessageName string `protobuf:"bytes,12,opt,name=response_message_name,json=responseMessageName,proto3" json:"response_message_name,omitempty"`
	// Embedded data can be attached to the response message of built in actions (get, list).
	ResponseEmbeds []string `protobuf:"bytes,13,rep,name=response_embeds,json=responseEmbeds,proto3" json:"response_embeds,omitempty"`
	// Field names to facet on as defined with @facet in the schema.
	Facets []string `protobuf:"bytes,14,rep,name=facets,proto3" json:"facets,omitempty"`
	// contains filtered or unexported fields
}

type ActionImplementation int32

type ActionType int32

type Api struct {
	Name      string      `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	ApiModels []*ApiModel `protobuf:"bytes,3,rep,name=api_models,json=apiModels,proto3" json:"api_models,omitempty"`
	// contains filtered or unexported fields
}

type ApiModel struct {
	ModelName    string            `protobuf:"bytes,1,opt,name=model_name,json=modelName,proto3" json:"model_name,omitempty"`
	ModelActions []*ApiModelAction `protobuf:"bytes,2,rep,name=model_actions,json=modelActions,proto3" json:"model_actions,omitempty"`
	// contains filtered or unexported fields
}

type ApiModelAction struct {
	ActionName string `protobuf:"bytes,1,opt,name=action_name,json=actionName,proto3" json:"action_name,omitempty"`
	// contains filtered or unexported fields
}

type DefaultValue struct {

	// If true then a "zero" value is used for the field, for example
	// a string has a zero value of "" and a date has a zero value of
	// today
	UseZeroValue bool `protobuf:"varint,1,opt,name=use_zero_value,json=useZeroValue,proto3" json:"use_zero_value,omitempty"`
	// This can be used to explicitly set the default value
	Expression *Expression `protobuf:"bytes,2,opt,name=expression,proto3" json:"expression,omitempty"`
	// contains filtered or unexported fields
}

type Entity interface {
	GetName() string
	GetFields() []*Field
	GetComputedFields() []*Field
	FindField(name string) *Field
	PrimaryKeyFieldName() string
	FieldNames() []string
	ForeignKeyFields() []*Field
	HasField(field string) bool
}

type Enum struct {
	Name   string       `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Values []*EnumValue `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

type EnumValue struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

type EnvironmentVariable struct {
	Name     string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Required bool   `protobuf:"varint,2,opt,name=required,proto3" json:"required,omitempty"`
	// contains filtered or unexported fields
}

type Event struct {

	// The name of this event, for example: account.created
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The name of the model.
	ModelName string `protobuf:"bytes,2,opt,name=model_name,json=modelName,proto3" json:"model_name,omitempty"`
	// Action type (create, update or delete).
	ActionType ActionType `protobuf:"varint,3,opt,name=action_type,json=actionType,proto3,enum=proto.ActionType" json:"action_type,omitempty"`
	// contains filtered or unexported fields
}

type Expression struct {
	Source string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	// contains filtered or unexported fields
}

type Field struct {

	// The name of the model or task this field belongs to.
	EntityName string `protobuf:"bytes,1,opt,name=entity_name,json=entityName,proto3" json:"entity_name,omitempty"`
	// The name of the field. Must be in lowerCamelCase and be unique within the model or task.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Info regarding the type of this field
	Type *TypeInfo `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// If true then this field is allowed to be null
	Optional bool `protobuf:"varint,4,opt,name=optional,proto3" json:"optional,omitempty"`
	// If true then this field will have a unique constraint added to it meaning
	// a given value can only exist in a single row.
	// Cannot be true if `type.repeated` is true
	Unique bool `protobuf:"varint,5,opt,name=unique,proto3" json:"unique,omitempty"`
	// If set then this field is part of a compount unique constraint with the
	// fields listed. The fields must be part of the same model and they must
	// list this field in their unique_with value.
	UniqueWith []string `protobuf:"bytes,8,rep,name=unique_with,json=uniqueWith,proto3" json:"unique_with,omitempty"`
	// If true then this field will be set as the primary key for the parent model
	PrimaryKey bool `protobuf:"varint,7,opt,name=primary_key,json=primaryKey,proto3" json:"primary_key,omitempty"`
	// If this field is of type TYPE_ENTITY then this field indicates which field on _this_
	// entity is the foriegn key. This field should always be populated on the many side of a
	// one-to-many relationship and on the unique side of a one-to-one.
	ForeignKeyFieldName *wrapperspb.StringValue `protobuf:"bytes,10,opt,name=foreign_key_field_name,json=foreignKeyFieldName,proto3" json:"foreign_key_field_name,omitempty"`
	// This describes how the default value of this field should be created
	DefaultValue *DefaultValue `protobuf:"bytes,9,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// This only applies to the foreign key fields that we auto inject.
	// If it is non null it *defines* this field as being a foreign key field,
	// and carries corresponding metadata.
	ForeignKeyInfo *ForeignKeyInfo `protobuf:"bytes,11,opt,name=foreign_key_info,json=foreignKeyInfo,proto3" json:"foreign_key_info,omitempty"`
	// If this field is of type ENTITY and the related entity has an inverse field
	// to this one, then this field is set to that field name.
	// For example if a Post model has a field called author which is of type Author,
	// and then Author has posts which is of type Post, on the Post.author field this
	// value will be "posts" and on the Author.posts field this value will be "author".
	InverseFieldName *wrapperspb.StringValue `protobuf:"bytes,12,opt,name=inverse_field_name,json=inverseFieldName,proto3" json:"inverse_field_name,omitempty"`
	// If computed then this field will contain the expression that will be evaluated to
	// determine the value of the field at runtime.
	ComputedExpression *Expression `protobuf:"bytes,13,opt,name=computed_expression,json=computedExpression,proto3" json:"computed_expression,omitempty"`
	// If this field is a sequence this contains information about how the sequence value should be generated
	Sequence *Sequence `protobuf:"bytes,14,opt,name=sequence,proto3" json:"sequence,omitempty"`
	// contains filtered or unexported fields
}

type Flow struct {

	// The name of the flow.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The inputs defined on the flow.
	InputMessageName string `protobuf:"bytes,2,opt,name=input_message_name,json=inputMessageName,proto3" json:"input_message_name,omitempty"`
	// A permission rule which need to be satisfied in order to run the flow.
	Permissions []*PermissionRule `protobuf:"bytes,3,rep,name=permissions,proto3" json:"permissions,omitempty"`
	// The schedule as an crontab expression.
	Schedule *Schedule `protobuf:"bytes,4,opt,name=schedule,proto3" json:"schedule,omitempty"`
	// contains filtered or unexported fields
}

type ForeignKeyInfo struct {
	RelatedEntityName  string `protobuf:"bytes,1,opt,name=related_entity_name,json=relatedEntityName,proto3" json:"related_entity_name,omitempty"`
	RelatedEntityField string `protobuf:"bytes,2,opt,name=related_entity_field,json=relatedEntityField,proto3" json:"related_entity_field,omitempty"`
	// contains filtered or unexported fields
}

type HttpMethod int32

type Job struct {

	// The name of the job.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The inputs defined on the job.
	InputMessageName string `protobuf:"bytes,2,opt,name=input_message_name,json=inputMessageName,proto3" json:"input_message_name,omitempty"`
	// A permission rule which need to be satisfied in order to run the job.
	Permissions []*PermissionRule `protobuf:"bytes,3,rep,name=permissions,proto3" json:"permissions,omitempty"`
	// The schedule as an crontab expression.
	Schedule *Schedule `protobuf:"bytes,4,opt,name=schedule,proto3" json:"schedule,omitempty"`
	// contains filtered or unexported fields
}

type Message struct {

	// Name of the input or response message. Either generated from built-in
	// actions, hard-coded into the runtime (e.g. AuthenticateResponseMessage),
	// or specified in the schema using the message keyword.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The input or response fields for this message.
	Fields []*MessageField `protobuf:"bytes,2,rep,name=fields,proto3" json:"fields,omitempty"`
	// The message could be a Keel type and not an object.
	// Cannot be provided along with fields.
	Type *TypeInfo `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

type MessageField struct {

	// Name of the parent message.
	MessageName string `protobuf:"bytes,1,opt,name=message_name,json=messageName,proto3" json:"message_name,omitempty"`
	// Name of the field.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// The type of this field.
	Type *TypeInfo `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// Set to true if this can be omitted.
	Optional bool `protobuf:"varint,4,opt,name=optional,proto3" json:"optional,omitempty"`
	// Set to true if this can be set to the null value.
	Nullable bool `protobuf:"varint,6,opt,name=nullable,proto3" json:"nullable,omitempty"`
	// Only valid for implicit inputs on built-in actions (ACTION_IMPLEMENTATION_AUTO)
	// This field can be set to a path, from the current entity, to a field that should
	// be read from or written to automatically by the runtime.
	// As an example if the parent model had a field called `item` which was a relationship to
	// an `Item` model which itself had a field called `price`, and this input wanted to filter
	// on the item price, then the value of `target` would be ["item", "price"].
	Target []string `protobuf:"bytes,5,rep,name=target,proto3" json:"target,omitempty"`
	// contains filtered or unexported fields
}

type Model struct {

	// The name of the model. Must be in PascalCase and be unique within the schema.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The fields this model contains
	Fields []*Field `protobuf:"bytes,2,rep,name=fields,proto3" json:"fields,omitempty"`
	// The actions this model defines. Contains both actions that will be auto
	// generated and also functions
	Actions     []*Action         `protobuf:"bytes,3,rep,name=actions,proto3" json:"actions,omitempty"`
	Permissions []*PermissionRule `protobuf:"bytes,4,rep,name=permissions,proto3" json:"permissions,omitempty"`
	// contains filtered or unexported fields
}

type OrderByStatement struct {

	// The name of the field to perform ordering on.
	FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// The direction in which to order.
	Direction OrderDirection `protobuf:"varint,2,opt,name=direction,proto3,enum=proto.OrderDirection" json:"direction,omitempty"`
	// contains filtered or unexported fields
}

type OrderDirection int32

type PermissionFilter = func(p *PermissionRule) bool

type PermissionRule struct {

	// Name of the entity this permission rule applies to
	EntityName string `protobuf:"bytes,1,opt,name=entity_name,json=entityName,proto3" json:"entity_name,omitempty"`
	// Name of the specific action this permission rule applies to.
	// If this field is populated then `action_types` is ignored.
	ActionName *wrapperspb.StringValue `protobuf:"bytes,2,opt,name=action_name,json=actionName,proto3" json:"action_name,omitempty"`
	// A name of a Role that has been defined in the schema.
	// Cannot be provided if `expression` is provided.
	RoleNames []string `protobuf:"bytes,3,rep,name=role_names,json=roleNames,proto3" json:"role_names,omitempty"`
	// An expression to evaluate at runtime.
	// Cannot be provided if `role_name` is provided.
	Expression *Expression `protobuf:"bytes,4,opt,name=expression,proto3" json:"expression,omitempty"`
	// A list of action types that this permission rule applies to
	// Should not be set if `action_name` is provided.
	ActionTypes []ActionType `protobuf:"varint,5,rep,packed,name=action_types,json=actionTypes,proto3,enum=proto.ActionType" json:"action_types,omitempty"`
	// contains filtered or unexported fields
}

type Role struct {

	// The name of the role
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A list of domains to match for this role e.g. myorg.com
	Domains []string `protobuf:"bytes,2,rep,name=domains,proto3" json:"domains,omitempty"`
	// A list of specific email addresses to match for this role eg. sarah@myorg.com
	Emails []string `protobuf:"bytes,3,rep,name=emails,proto3" json:"emails,omitempty"`
	// contains filtered or unexported fields
}

type Route struct {
	Method  HttpMethod `protobuf:"varint,1,opt,name=method,proto3,enum=proto.HttpMethod" json:"method,omitempty"`
	Pattern string     `protobuf:"bytes,2,opt,name=pattern,proto3" json:"pattern,omitempty"`
	Handler string     `protobuf:"bytes,3,opt,name=handler,proto3" json:"handler,omitempty"`
	// contains filtered or unexported fields
}

type Schedule struct {
	Expression string `protobuf:"bytes,1,opt,name=expression,proto3" json:"expression,omitempty"`
	// contains filtered or unexported fields
}

type Schema struct {
	Models               []*Model               `protobuf:"bytes,1,rep,name=models,proto3" json:"models,omitempty"`
	Roles                []*Role                `protobuf:"bytes,2,rep,name=roles,proto3" json:"roles,omitempty"`
	Apis                 []*Api                 `protobuf:"bytes,3,rep,name=apis,proto3" json:"apis,omitempty"`
	Enums                []*Enum                `protobuf:"bytes,4,rep,name=enums,proto3" json:"enums,omitempty"`
	EnvironmentVariables []*EnvironmentVariable `protobuf:"bytes,5,rep,name=environment_variables,json=environmentVariables,proto3" json:"environment_variables,omitempty"`
	Messages             []*Message             `protobuf:"bytes,6,rep,name=messages,proto3" json:"messages,omitempty"`
	Secrets              []*Secret              `protobuf:"bytes,7,rep,name=secrets,proto3" json:"secrets,omitempty"`
	Jobs                 []*Job                 `protobuf:"bytes,8,rep,name=jobs,proto3" json:"jobs,omitempty"`
	Subscribers          []*Subscriber          `protobuf:"bytes,9,rep,name=subscribers,proto3" json:"subscribers,omitempty"`
	Events               []*Event               `protobuf:"bytes,10,rep,name=events,proto3" json:"events,omitempty"`
	Routes               []*Route               `protobuf:"bytes,11,rep,name=routes,proto3" json:"routes,omitempty"`
	Flows                []*Flow                `protobuf:"bytes,12,rep,name=flows,proto3" json:"flows,omitempty"`
	Tasks                []*Task                `protobuf:"bytes,13,rep,name=tasks,proto3" json:"tasks,omitempty"`
	// contains filtered or unexported fields
}

type Secret struct {
	Name     string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Required bool   `protobuf:"varint,2,opt,name=required,proto3" json:"required,omitempty"`
	// contains filtered or unexported fields
}

type Sequence struct {
	Prefix   string `protobuf:"bytes,1,opt,name=prefix,proto3" json:"prefix,omitempty"`
	StartsAt uint32 `protobuf:"varint,2,opt,name=starts_at,json=startsAt,proto3" json:"starts_at,omitempty"`
	// contains filtered or unexported fields
}

type Subscriber struct {

	// The name of the subscriber function. e.g. sendWelcomeMail.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The input message for this function.
	// The structure of this is determined by the events handled by this subscriber.
	InputMessageName string `protobuf:"bytes,2,opt,name=input_message_name,json=inputMessageName,proto3" json:"input_message_name,omitempty"`
	// The events which are handled by this subscriber.
	EventNames []string `protobuf:"bytes,3,rep,name=event_names,json=eventNames,proto3" json:"event_names,omitempty"`
	// contains filtered or unexported fields
}

type Task struct {

	// The name of the task. Must be in PascalCase and be unique within the schema.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The fields this task contains
	Fields []*Field `protobuf:"bytes,2,rep,name=fields,proto3" json:"fields,omitempty"`
	// A list of permission rules for this task.
	Permissions []*PermissionRule `protobuf:"bytes,3,rep,name=permissions,proto3" json:"permissions,omitempty"`
	// A ordered list of order by statements.
	OrderBy []*OrderByStatement `protobuf:"bytes,4,rep,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// The message used to create a task; generated from the task's fields.
	InputMessageName string `protobuf:"bytes,5,opt,name=input_message_name,json=inputMessageName,proto3" json:"input_message_name,omitempty"`
	// contains filtered or unexported fields
}

type Type int32

type TypeInfo struct {

	// The type of the field.
	Type Type `protobuf:"varint,1,opt,name=type,proto3,enum=proto.Type" json:"type,omitempty"`
	// If `type` is set to TYPE_ENUM then this value is the name of the
	// the enum that the type refers to.
	EnumName *wrapperspb.StringValue `protobuf:"bytes,2,opt,name=enum_name,json=enumName,proto3" json:"enum_name,omitempty"`
	// If this field is set then this type is referring to another entity.
	// In the case of TYPE_ENTITY this type _is_ the entity named here.
	// In the case of other types e.g. TYPE_ID this type is referencing a field
	// on the entity named here, and the specific field being referenced is indicated
	// by `field_name`.
	EntityName *wrapperspb.StringValue `protobuf:"bytes,3,opt,name=entity_name,json=entityName,proto3" json:"entity_name,omitempty"`
	// This field indicates which field on `entity_name` this type is referencing.
	// This field should only be set if `entity_name` is set.
	FieldName *wrapperspb.StringValue `protobuf:"bytes,5,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	// Only valid within a Message
	MessageName *wrapperspb.StringValue `protobuf:"bytes,6,opt,name=message_name,json=messageName,proto3" json:"message_name,omitempty"`
	// If true then is type is an array of it's `type`
	Repeated bool `protobuf:"varint,4,opt,name=repeated,proto3" json:"repeated,omitempty"`
	// A union type describes a value that can be one of several types.
	// When TypeInfo's type property is set to UNION, then any one of the type names
	// listed here can be used as input. Currently only supports messages.
	UnionNames []*wrapperspb.StringValue `protobuf:"bytes,7,rep,name=union_names,json=unionNames,proto3" json:"union_names,omitempty"`
	// For types which are in a union, it is optional to provide a value to discriminate on.
	// This is only useful in TypeScript type generation, where this will make type a string literal type.
	StringLiteralValue *wrapperspb.StringValue `protobuf:"bytes,8,opt,name=string_literal_value,json=stringLiteralValue,proto3" json:"string_literal_value,omitempty"`
	// contains filtered or unexported fields
}